Accounting Apex API Developer Reference

c2g.CODAAPIJournalTypes_12_0

global with sharing class CODAAPIJournalTypes_12_0

The service class relating to Journals.

Enums

enumJournalStatus

Possible journal statuses.

Value Description
InProgress The document has been saved, but has not been posted.
Complete The document has been posted.
Discarded The document is no longer required, but evidence needs to be retained. You must provide discard reason.

enumType

Types of journal.

Value Description
ManualJournal The journal was created by a user.
CashMatchingJournal The journal was automatically generated when the matching process involved a settlement discount, write-off or currency write-off.
CancellingJournal The journal was automatically generated during the process of cancelling a journal that was posted in error.
IncomeSchedule The journal was automatically generated when a sales invoice journal that has an income schedule was posted.
ReversingJournal The journal was automatically generated during the process of creating a reversing journal.
ReconciliationJournal The journal was automatically generated during the process of committing a bank reconciliation that contains bank or interest charges.
YearEndJournal The journal was automatically generated during year end processing.

c2g.CODAAPIJournalTypes_12_0.Journal

global with sharing class Journal

Holds information that applies to the whole journal document and acts as a container for a number of journal line items. See "Journal Fields" and "What is a Journal?" in the FinancialForce Help for more details.

Properties

Name Type Description
Id id Globally unique string that identifies the record.
OwnerId c2g.CODAAPICommon.Reference ID of the user who owns the record.
IsDeleted boolean Indicates whether the record has been moved to the Recycle Bin (true) or not (false).
Name string Unique number allocated to this journal.
CreatedDate datetime Date and time when the record was created.
CreatedById c2g.CODAAPICommon.Reference ID of the user who created the record.
LastModifiedDate datetime Date and time when the record was last modified by a user.
LastModifiedById c2g.CODAAPICommon.Reference ID of the user who last modified the record.
SystemModstamp datetime Date and time when the record was last modified by a user or by a workflow process (such as a trigger).
DiscardReason string Reason this document was discarded.
IncomeScheduleGroup c2g.CODAAPICommon.Reference Reference to Grouping Reference custom object of type "Income Schedule Group".
JournalCurrency c2g.CODAAPICommon.Reference Reference to the currency of this journal. Mandatory.
JournalDate date Date of this journal.
JournalDescription string Description of this journal.
JournalStatus c2g.CODAAPIJournalTypes_12_0.enumJournalStatus Current status of this journal.
OriginalJournal c2g.CODAAPICommon.Reference Reference to the original journal related to this cancelling journal.
JournalRate decimal The exchange rate used on this document for journal to home currency.
DualRate decimal The exchange rate used on this document for home to dual currency.
OverrideCurrency1 c2g.CODAAPICommon.Reference Reference to the currency of override debit value 1. Cannot be document currency.
OverrideCurrency2 c2g.CODAAPICommon.Reference Reference to the currency of override debit value 2. Cannot be document currency.
OverrideCurrency3 c2g.CODAAPICommon.Reference Reference to the currency of override debit value 3. Cannot be document currency.
OverrideDebitValue1 decimal Positive (debit) override value in the corresponding currency.
OverrideDebitValue2 decimal Positive (debit) override value in the corresponding currency.
OverrideDebitValue3 decimal Positive (debit) override value in the corresponding currency.
OwnerCompany c2g.CODAAPICommon.Reference Company to which this document belongs.
Period c2g.CODAAPICommon.Reference Reference to the accounting period in which this document falls. Mandatory.
Reference string Any significant reference that might be useful, such as the original invoice or cash entry number.
SourceJournal c2g.CODAAPICommon.Reference Reference to the journal from which this reversing journal was created, if relevant.
TransactionRef c2g.CODAAPICommon.Reference Reference to the related Transaction, when the journal is "Complete".
TypeRef c2g.CODAAPIJournalTypes_12_0.enumType Type of journal.
Year string Name of the year.
Credits decimal Total of credit (-) values in document currency. SUM: JournalLineItem: Value Filter: Value less than zero
Debits decimal Total of debit (+) values in document currency. SUM: JournalLineItem: Value Filter: Value greater than zero
Total decimal The sum of all the line item values. SUM: JournalLineItem: Value
LineItems c2g.CODAAPIJournalLineItemTypes_12_0.JournalLineItems Reference to the associated journal line items. Mandatory.
CustomFields List<c2g.CODAAPIJournalTypes_12_0.CustomField> Reference to the list of user-defined fields that have been exposed with a type 1 integration rule.

c2g.CODAAPIJournalTypes_12_0.CustomField

global with sharing class CustomField implements CODAAPICommon.IAPICustomField

Holds the information about the user-defined fields that have been exposed with a type 1 integration rule. See "Integration Rules - Type 1" in the FinancialForce Help for more details.
The same read and write permissions granted for the FinancialForce application extend to the FinancialForce API.

Properties

Name Type Description
FieldName string Name of the user-defined field.
Value string Value of the user-defined field.

c2g.CODAAPIJournalTypes_12_0.CancellingInformation

global with sharing class CancellingInformation

Holds information used to cancel a posted journal.

Properties

Name Type Description
OriginalJournalRef c2g.CODAAPICommon.Reference Reference to the original journal.
CancellingDescription string Description of the cancelling journal.
CancellingReference string Reference on the cancelling journal.
CancellingPeriod c2g.CODAAPICommon.Reference Reference to the period in which the cancelling journal will be created.

c2g.CODAAPIJournalTypes_12_0.ReversingInformation

global with sharing class ReversingInformation

Holds information used to reverse a new or existing journal.

Properties

Name Type Description
OriginalJournal c2g.CODAAPIJournalTypes_12_0.Journal The original journal that is being reversed. Pass either OriginalJournal or OriginalJournalRef but not both.
OriginalJournalRef c2g.CODAAPICommon.Reference Reference to the original journal. Pass either OriginalJournal or OriginalJournalRef but not both.
ReversingDescription string Description of the reversing journal.
ReversingReference string Reference on the reversing journal.
ReversingPeriod c2g.CODAAPICommon.Reference Reference to the period in which the reversing journal will be created.
ReversingDate date Date of the reversing journal.
© Copyright 2009–2018 FinancialForce.com, inc. Confidential – all rights reserved. Various trademarks held by their respective owners.