Accounting Apex API Developer Reference

c2g.CODAAPIJournal_12_0

global with sharing class CODAAPIJournal_12_0

The service class relating to Journals.

Properties

Name Type Description
VERSION_STRING String The API version.
SERVICE_NAME String The name of the service.

Methods

GetAPIVersion

webservice static String GetAPIVersion()

Used to get the latest API version.

Return Value

Text

GetServiceName

webservice static String GetServiceName()

Used to get the name of the service.

Return Value

Text

CreateJournal

Deprecated: Use the Salesforce API for CRUD operations.

webservice static c2g.CODAAPICommon.Reference CreateJournal(c2g.CODAAPICommon_10_0.Context context, c2g.CODAAPIJournalTypes_12_0.Journal value)

This service allows you to create a journal. See "Journal Fields" and "What is a Journal?" in the FinancialForce Help for more details.
This version of the service allows you to create a journal in a company that is not selected as the current company. You must specify the company name using the context.CompanyName input parameter.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_10_0.Context Identifies the FinancialForce company in which the current operation executes.
value c2g.CODAAPIJournalTypes_12_0.Journal Holds details of the journal you want to create.

Return Value

This web service returns a CODAAPICommon.Reference object.

UpdateJournal

Deprecated: Use the Salesforce API for CRUD operations.

webservice static c2g.CODAAPICommon.Reference UpdateJournal(c2g.CODAAPICommon_10_0.Context context, c2g.CODAAPIJournalTypes_12_0.Journal value)

This service allows you to update a journal.
This version of the service allows you to update a journal in a company that is not selected as the current company. You must specify the company name using the context.CompanyName input parameter.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_10_0.Context Identifies the FinancialForce company in which the current operation executes.
value c2g.CODAAPIJournalTypes_12_0.Journal Holds details of the journal you want to update.

Return Value

This web service returns a CODAAPICommon.Reference object.

PostJournal

webservice static void PostJournal(c2g.CODAAPICommon_10_0.Context context, c2g.CODAAPICommon.Reference value)

This service allows you to post a journal.
This version of the service allows you to post a journal in a company that is not selected as the current company. You must specify the company name using the context.CompanyName input parameter.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_10_0.Context Identifies the FinancialForce company in which the current operation executes.
value c2g.CODAAPICommon.Reference Identifies the journal you want to post.

Return Value

This web service does not return a value.

GetJournal

Deprecated: Use the Salesforce API for CRUD operations.

webservice static c2g.CODAAPIJournalTypes_12_0.Journal GetJournal(c2g.CODAAPICommon_10_0.Context context, c2g.CODAAPICommon.Reference value)

This service allows you to retrieve a journal.
This version of the service allows you to retrieve a journal from a company that is not selected as the current company. You must specify the company name using the context.CompanyName input parameter.

Input Parameters

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

Return Value

This web service returns a c2g.CODAAPIJournalTypes_12_0.Journal object.

BulkCancelJournal

webservice static List<c2g.CODAAPICommon.Reference> BulkCancelJournal(c2g.CODAAPICommon_10_0.Context context, List<c2g.CODAAPIJournalTypes_12_0.CancellingInformation> cancellingInformationList)

This service allows you to cancel posted journals.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_10_0.Context Identifies the FinancialForce company in which the current operation executes.
cancellingInformationList List<c2g.CODAAPIJournalTypes_12_0.CancellingInformation> Holds information used to cancel posted journals.

Return Value

This web service returns a list of CODAAPICommon.Reference objects.

BulkReverseJournal

webservice static List<c2g.CODAAPICommon.Reference> BulkReverseJournal(c2g.CODAAPICommon_10_0.Context context, List<c2g.CODAAPIJournalTypes_12_0.ReversingInformation> reversingInformationList)

This service allows you to reverse journals.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_10_0.Context Identifies the FinancialForce company in which the current operation executes.
reversingInformationList List<c2g.CODAAPIJournalTypes_12_0.ReversingInformation> Holds information used to reverse journals.

Return Value

This web service returns a list of CODAAPICommon.Reference objects.

BulkCreateJournal

Deprecated: Use the Salesforce API for CRUD operations.

webservice static c2g.CODAAPICommon.Reference[] BulkCreateJournal(c2g.CODAAPICommon_10_0.Context context, c2g.CODAAPIJournalTypes_12_0.Journal[] values)

This service allows you to create journals in bulk.

Input Parameters

Name Type Description
context c2g.CODAAPICommon_10_0.Context Identifies the FinancialForce company in which the current operation executes.
values c2g.CODAAPIJournalTypes_12_0.Journal[] Holds details of the journals you want to create.

Return Value

This web service returns an array of CODAAPICommon.Reference objects.

BulkUpdateJournal

Deprecated: Use the Salesforce API for CRUD operations.

webservice static c2g.CODAAPICommon.Reference[] BulkUpdateJournal(c2g.CODAAPICommon_10_0.Context context, c2g.CODAAPIJournalTypes_12_0.Journal[] values)

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

Input Parameters

Name Type Description
context c2g.CODAAPICommon_10_0.Context Identifies the FinancialForce company in which the current operation executes.
values c2g.CODAAPIJournalTypes_12_0.Journal[] Holds details of the journals you want to update.

Return Value

This web service returns an array of CODAAPICommon.Reference objects.

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 journal.
c2g.CODAAPICommon.Reference postedCashRef = c2g.CODAAPICommon.getRef('a4M1I000000TN1PUAW', null);
c2g.CODAAPICommon_10_0.Context context = new c2g.CODAAPICommon_10_0.Context();
c2g.CODAAPIJournalTypes_12_0.Journal journal = c2g.CODAAPIJournal_12_0.GetJournal(context, postedCashRef);

//detail the amendment
journal.JournalDescription = 'AmendedDescription';
List<c2g.CODAAPIJournalTypes_12_0.Journal> journals = new List<c2g.CODAAPIJournalTypes_12_0.Journal>();
journals.add(journal);

//call the API
c2g.CODAAPIJournal_12_0.BulkUpdateJournal(context, journals);

BulkPostJournal

webservice static void BulkPostJournal(c2g.CODAAPICommon_10_0.Context context, c2g.CODAAPICommon.Reference[] values)

This service allows you to post journals in bulk.

Input Parameters

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

Return Value

This web service does not return a value.

© Copyright 2009–2020 FinancialForce.com, inc. Confidential – all rights reserved. Various trademarks held by their respective owners.