Accounting Apex API Developer Reference

c2g.CODAAPIInvoiceTypes_10_0

global with sharing class CODAAPIInvoiceTypes_10_0

The service class relating to Sales Invoices.

Enums

enumInvoiceStatus

Possible sales invoice statuses.

Value Description
InProgress The document has been saved, but has not been posted.
ReadyToPost The document has been batched up for posting by a scheduled job.
Complete The document has been posted.
Discarded The document is no longer required, but evidence needs to be retained. You must provide discard reason.

enumPrintStatus

Possible sales invoice print statuses.

Value Description
NotPrinted The document has not been printed.
Printed The document has been printed.

c2g.CODAAPIInvoiceTypes_10_0.Invoice

global with sharing class Invoice

Represents information that applies to the whole sales invoice and acts as a container for a number of sales invoice line items. See "Sales Invoice Fields" and "What is a Sales Invoice" in the FinancialForce Help for more details.

Properties

Name Type Description
Id id Globally unique string that identifies a record.
OwnerId c2g.CODAAPICommon.Reference ID of the user who owns that object.
IsDeleted boolean Indicates whether the record has been moved to the Recycle Bin.
Name string Unique number allocated to this sales invoice.
CreatedDate datetime Date and time when this object was created.
CreatedById c2g.CODAAPICommon.Reference ID of the user who created this object.
LastModifiedDate datetime Date and time when this object was last modified by a user.
LastModifiedById c2g.CODAAPICommon.Reference ID of the user who last updated this object.
SystemModstamp datetime Date and time when this record was last modified by a user or by a workflow process (such as a trigger).
Account c2g.CODAAPICommon.Reference Reference to the customer Account for this sales invoice. Mandatory.
BillingAddress string For internal use only.
CopyAccountValues boolean For internal use only.
CopyDefaultPrintedTextDefinitions boolean For internal use only.
CreatingRecurringInvoice boolean For internal use only.
CustomerReference string Customer reference such as a customer order number. This will appear on the printed invoice.
DeriveCurrency boolean For internal use only.
DeriveDueDate boolean Setting true will derivate due date.
DerivePeriod boolean For internal use only.
Dimension1 c2g.CODAAPICommon.Reference Reference to the Dimension 1 record by which you want to analyze this account.
Dimension2 c2g.CODAAPICommon.Reference Reference to the Dimension 2 record by which you want to analyze this account.
Dimension3 c2g.CODAAPICommon.Reference Reference to the Dimension 3 record by which you want to analyze this account.
Dimension4 c2g.CODAAPICommon.Reference Reference to the Dimension 4 record by which you want to analyze this account.
DiscardReason string Reason why the invoice was discarded.
DueDate date Date the invoice is due for payment. Mandatory.
FirstDueDate date Date the first payment on a payment schedule is due.
GeneralLedgerAccount c2g.CODAAPICommon.Reference Name of general ledger account used on an income schedule.
IncomeScheduleGroup c2g.CODAAPICommon.Reference Reference to the Grouping Reference of type "Income Schedule Group".
IncomeSchedule c2g.CODAAPICommon.Reference Name of the income schedule definition to apply to this sales invoice.
Interval string Sets the interval for payments on a payments schedule.
InvoiceCurrency c2g.CODAAPICommon.Reference Reference to the Accounting Currency in which monetary values are expressed on the invoice. Mandatory.
InvoiceRate decimal The exchange rate for document to home currency.
DualRate decimal The exchange rate for home to dual currency.
InvoiceDate date Date of the invoice. Mandatory.
InvoiceDescription string Description of the invoice.
InvoiceGroup c2g.CODAAPICommon.Reference Reference to Grouping Reference custom object of type "Invoice Group".
InvoiceStatus c2g.CODAAPIInvoiceTypes_10_0.enumInvoiceStatus Current status of the invoice. Mandatory.
InvoiceTotal decimal Total invoice value, including the tax.
NumberOfPayments decimal The number of payments in a payment schedule.
NumberofJournals decimal Number of journals used to recognize revenue across periods. Must be a positive integer.
Opportunity c2g.CODAAPICommon.Reference Reference to the Opportunity from which the invoice was converted, if relevant.
OutstandingValue decimal Amount still owed on this document in document currency.
OwnerCompany c2g.CODAAPICommon.Reference Reference to the Company to which this object belongs.
PaymentSchedule string Indicates whether the sales invoice has a "Payment Schedule".
PaymentStatus string Is this document unpaid, part-paid, or paid in full?
PeriodInterval decimal Sets the interval for a payment schedule, such as "Weekly" or "Monthly".
Period c2g.CODAAPICommon.Reference Reference to the accounting period in which this document falls. Mandatory.
PrintStatus c2g.CODAAPIInvoiceTypes_10_0.enumPrintStatus Current print status.
PrintedText1AllowEdit boolean Indicates whether the text definition in text position 1 is editable. Mandatory.
PrintedText1Heading string Heading at text position 1.
PrintedText1TextDefinitionName string Name of selected text definition.
PrintedText1Text string Body text at text position 1.
PrintedText2AllowEdit boolean Indicates whether the text definition in text position 2 is editable. Mandatory.
PrintedText2Heading string Heading at text position 2.
PrintedText2TextDefinitionName string Name of selected text definition.
PrintedText2Text string Body text at text position 2.
PrintedText3AllowEdit boolean Indicates whether the text definition in text position 3 is editable. Mandatory.
PrintedText3Heading string Heading at text position 3.
PrintedText3TextDefinitionName string Name of selected text definition.
PrintedText3Text string Body text at text position 3.
PrintedText4AllowEdit boolean Indicates whether the text definition in text position 4 is editable. Mandatory.
PrintedText4Heading string Heading at text position 4.
PrintedText4TextDefinitionName string Name of selected text definition.
PrintedText4Text string Body text at text position 4.
PrintedText5AllowEdit boolean Indicates whether the text definition in text position 5 is editable. Mandatory.
PrintedText5Heading string Heading at text position 5.
PrintedText5TextDefinitionName string Name of selected text definition.
PrintedText5Text string Body text at text position 5.
ShippingAddress string For internal use only.
ShippingMethod string Method of delivery to the customer.
StartDate date Sets the invoice date on the first invoice in a recurring series. The invoice date for subsequent invoices will be set according to the schedule frequency.
TaxCode1 c2g.CODAAPICommon.Reference Tax code 1.
TaxCode2 c2g.CODAAPICommon.Reference Tax code 2.
TaxCode3 c2g.CODAAPICommon.Reference Tax code 3.
TaxTotal decimal Total value of tax on the sales invoice.
TransactionRef c2g.CODAAPICommon.Reference Reference to the Transaction created when the sales invoice was posted.
Usepartperiods boolean Indicates whether you want to use part periods at the beginning and end of an income schedule.
Year string Name of the year.
NetTotal decimal Total value of items on the invoice, before tax. SUM: Invoice Line Item: NetValue
PaymentScheduleTotal decimal For internal use only.
Tax1Total decimal Total value of tax posted to tax code 1. SUM: Invoice Line Item: TaxValue1
Tax2Total decimal Total value of tax posted to tax code 2. SUM: Invoice Line Item: TaxValue2
Tax3Total decimal Total value of tax posted to tax code 3. SUM: Invoice Line Item: TaxValue3
SalesTaxDocumentCode string A unique code that identifies the document in the external tax calculation system (if applicable).
SalesTaxStatus string The status of the external sales tax calculation (if applicable): Not Calculated, Calculated, Finalized.
MatchTypeRef string This field is set to "Credited" if the sales invoice has been fully matched to a sales credit note.
LineItems c2g.CODAAPIInvoiceLineItemTypes_10_0.InvoiceLineItems Reference to the associated sales invoice line items. Mandatory.
CustomFields List<c2g.CODAAPIInvoiceTypes_10_0.CustomField> Reference to the list of user-defined fields that have been exposed with a type 1 integration rule.
InvoiceInstallments List<c2g.CODAAPIInvoiceTypes_10_0.InvoiceInstallment> Reference to the details that will be used to create the invoices resulting from an income schedule.
RecurringInvoiceType string Type of schedule to apply for a recurring invoice: "Quantity Schedule" or "Revenue Schedule" or "None" for a single invoice.
RecurringInvoiceStartDate date Sets the invoice date on the first invoice in the series. The invoice date for subsequent invoices will be set according to the schedule frequency.
RecurringInvoiceInstallmentPeriod string Sets the interval for installments, such as "Weekly" or "Monthly".
RecurringInvoiceScheduleType string Defines whether the product revenue or quantity will be divided into multiple installments or repeated for multiple installments.
RecurringInvoiceNumberofInstallments integer Number of installments in the schedule.

c2g.CODAAPIInvoiceTypes_10_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.CODAAPIInvoiceTypes_10_0.InvoiceInstallment

global with sharing class InvoiceInstallment

Holds the details that will be used to create the invoices resulting from an income schedule.

Properties

Name Type Description
LineNumber Decimal The line number in the installment list.
DueDate Date The invoice due date.
Amount Decimal The invoice amount.

c2g.CODAAPIInvoiceTypes_10_0.InvoiceForAmend

global with sharing class InvoiceForAmend

Represents information that allows you to amend the header on a posted invoice.

Properties

Name Type Description
Invoice c2g.CODAAPICommon.Reference Reference to the sales invoice to be amended. Mandatory.
CustomerReference String Customer reference such as a customer order number. This will appear on the printed invoice.
DueDate Date Date the invoice is due for payment.
InvoiceDescription String Description of the invoice.
AccountDimension1 c2g.CODAAPICommon.Reference Reference to the Dimension1 record by which you want to analyze this account. Mandatory if AccountDimension1Specified is true.
AccountDimension1Specified Boolean If AccountDimension1Specified is true, the value in AccountDimension1 is applied to Dimension1 on the header. If AccountDimension1 is null, the value in Dimension1 on the header is deleted. If AccountDimension1Specified is false, the Dimension1 value on the header is not updated.
AccountDimension2 c2g.CODAAPICommon.Reference Reference to the Dimension2 record by which you want to analyze this account. Mandatory if AccountDimension2Specified is true.
AccountDimension2Specified Boolean If AccountDimension2Specified is true, the value in AccountDimension2 is applied to Dimension2 on the header. If AccountDimension2 is null, the value in Dimension2 on the header is deleted. If AccountDimension2Specified is false, the Dimension2 value on the header is not updated.
AccountDimension3 c2g.CODAAPICommon.Reference Reference to the Dimension3 record by which you want to analyze this account. Mandatory if AccountDimension3Specified is true.
AccountDimension3Specified Boolean If AccountDimension3Specified is true, the value in AccountDimension3 is applied to Dimension3 on the header. If AccountDimension3 is null, the value in Dimension3 on the header is deleted. If AccountDimension3Specified is false, the Dimension3 value on the header is not updated.
AccountDimension4 c2g.CODAAPICommon.Reference Reference to the Dimension4 record by which you want to analyze this account. Mandatory if AccountDimension4Specified is true.
AccountDimension4Specified Boolean If AccountDimension4Specified is true, the value in AccountDimension4 is applied to Dimension4 on the header. If AccountDimension4 is null, the value in Dimension4 on the header is deleted. If AccountDimension4Specified is false, the Dimension4 value on the header is not updated.
PaymentScheduledDueDates List<Date> List of due dates on a payment schedule.
© Copyright 2009–2019 FinancialForce.com, inc. Confidential – all rights reserved. Various trademarks held by their respective owners.