Accounting Apex API Developer Reference

c2g.CODAAPICashEntry_7_0

global with sharing class CODAAPICashEntry_7_0

This service class provides cash entry functionality.

Properties

Name Type Description
VERSION_STRING string The API version of this service class.
SERVICE_NAME string The service name of this service class.

Methods

GetAPIVersion

webservice static string GetAPIVersion()

Used to get the latest API version.

GetServiceName

webservice static string GetServiceName()

Used to get the name of the service.

CreateCashEntry

webservice static c2g.CODAAPICommon.Reference CreateCashEntry(c2g.CODAAPICommon_7_0.Context context, c2g.CODAAPICashEntryTypes_7_0.CashEntry value)

This service allows you to create a cash entry. See "Cash Entry Fields" and "What is a Cash Entry" in the FinancialForce Help for more details.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_7_0.Context Identifies the FinancialForce company in which the current operation executes.
value c2g.CODAAPICashEntryTypes_7_0.CashEntry Holds details of the cash entry you want to create.

Return Value

This web service returns a CODAAPICommon.Reference object.

UpdateCashEntry

webservice static c2g.CODAAPICommon.Reference UpdateCashEntry(c2g.CODAAPICommon_7_0.Context context, c2g.CODAAPICashEntryTypes_7_0.CashEntry value)

This service allows you to update a cash entry.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_7_0.Context Identifies the FinancialForce company in which the current operation executes.
value c2g.CODAAPICashEntryTypes_7_0.CashEntry Identifies the cash entry you want to update.

Return Value

This web service returns a CODAAPICommon.Reference object.

PostCashEntry

webservice static void PostCashEntry(c2g.CODAAPICommon_7_0.Context context, c2g.CODAAPICommon.Reference value)

This service allows you to post a cash entry.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_7_0.Context Identifies the FinancialForce company in which the current operation executes.
value c2g.CODAAPICommon.Reference Holds details of the cash entry you want to post.

Return Value

This web service returns a CODAAPICommon.Reference object.

GetCashEntry

webservice static c2g.CODAAPICashEntryTypes_7_0.CashEntry GetCashEntry(c2g.CODAAPICommon_7_0.Context context, c2g.CODAAPICommon.Reference value)

This service allows you to retrieve a cash entry.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_7_0.Context Identifies the FinancialForce company in which the current operation executes.
value c2g.CODAAPICommon.Reference Identifies the cash entry you want to retrieve.

Return Value

This web service returns a CODAAPICommon.Reference object.

BulkCreateCashEntry

webservice static c2g.CODAAPICommon.Reference[] BulkCreateCashEntry(c2g.CODAAPICommon_7_0.Context context, c2g.CODAAPICashEntryTypes_7_0.CashEntry[] values)

This service allows you to create cash entries in bulk.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_7_0.Context Identifies the FinancialForce company in which the current operation executes.
values c2g.CODAAPICashEntryTypes_7_0.CashEntry[] Holds details of the cash entries you want to create.

Return Value

This web service returns a CODAAPICommon.Reference object.

BulkUpdateCashEntry

webservice static c2g.CODAAPICommon.Reference[] BulkUpdateCashEntry(c2g.CODAAPICommon_7_0.Context context, c2g.CODAAPICashEntryTypes_7_0.CashEntry[] values)

This service allows you to update cash entries in bulk. It also handles amending posted cash entries and their related transactions.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_7_0.Context Identifies the FinancialForce company in which the current operation executes.
values c2g.CODAAPICashEntryTypes_7_0.CashEntry[] Holds details of the cash entries you want to update.

Return Value

This web service returns a CODAAPICommon.Reference object.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

//In addition to making updates, BulkUpdate can be used to amend, as this example shows
//using a reference to an existing posted cash entry.
c2g.CODAAPICommon.Reference postedCashRef = c2g.CODAAPICommon.getRef('a3g1I000000TNDtQAO', null);
c2g.CODAAPICommon_7_0.Context context = new c2g.CODAAPICommon_7_0.Context();
c2g.CODAAPICashEntryTypes_7_0.CashEntry ce = c2g.CODAAPICashEntry_7_0.GetCashEntry(context, postedCashRef);

//detail the amendment
ce.Description = 'AmendedDescription';
List<c2g.CODAAPICashEntryTypes_7_0.CashEntry> cashEntries = new List<c2g.CODAAPICashEntryTypes_7_0.CashEntry>();
cashEntries.add(ce);

//call the API
c2g.CODAAPICashEntry_7_0.BulkUpdateCashEntry(context, cashEntries);

BulkPostCashEntry

webservice static void BulkPostCashEntry(c2g.CODAAPICommon_7_0.Context context, c2g.CODAAPICommon.Reference[] values)

This service allows you to post cash entries in bulk.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_7_0.Context Identifies the FinancialForce company in which the current operation executes.
values c2g.CODAAPICommon.Reference[] Identifies the cash entries you want to post.

Return Value

This web service returns a CODAAPICommon.Reference object.

© Copyright 2009–2018 FinancialForce.com, inc. All rights reserved. Various trademarks held by their respective owners.