Accounting Apex API Developer Reference

c2g.CODAAPIInvoiceLineItemTypes_10_0

global with sharing class CODAAPIInvoiceLineItemTypes_10_0

The service class relating to Sales Invoice Line Items.

c2g.CODAAPIInvoiceLineItemTypes_10_0.InvoiceLineItem

global with sharing class InvoiceLineItem

Holds details of line items on the sales invoice. They must be created in the context of a sales invoice. 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 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 line item.
CreatedDate datetime Date and time when this record was created.
CreatedById c2g.CODAAPICommon.Reference ID of the user who created this record.
LastModifiedDate datetime Date and time when this record was last modified by a user.
LastModifiedById c2g.CODAAPICommon.Reference ID of the user who last updated this record.
SystemModstamp datetime Date and time when this record was last modified by a user or by a workflow process (such as a trigger).
Invoice c2g.CODAAPICommon.Reference Reference to the sales invoice to which this line item belongs. Mandatory.
CalculateIncomeSchedule boolean For internal use only.
CalculateTaxValue1FromRate boolean For internal use only.
CalculateTaxValue2FromRate boolean For internal use only.
CalculateTaxValue3FromRate boolean For internal use only.
DeriveTaxRate1FromCode boolean For internal use only.
DeriveTaxRate2FromCode boolean For internal use only.
DeriveTaxRate3FromCode boolean For internal use only.
DeriveUnitPriceFromProduct boolean For internal use only.
Dimension1 c2g.CODAAPICommon.Reference Name of the Dimension 1 record by which you want to analyze this line item.
Dimension2 c2g.CODAAPICommon.Reference Name of the Dimension 2 record by which you want to analyze this line item.
Dimension3 c2g.CODAAPICommon.Reference Name of the Dimension 3 record by which you want to analyze this line item.
Dimension4 c2g.CODAAPICommon.Reference Name of the Dimension 4 record by which you want to analyze this line item.
GeneralLedgerAccount c2g.CODAAPICommon.Reference Reference to a related general ledger account.
LocalGLA c2g.CODAAPICommon.Reference Reference to a Local GLA associated to corporate GLA through COA.
IncomeScheduleGroup c2g.CODAAPICommon.Reference System-generated integer used to group together related income schedule journals.
IncomeSchedule c2g.CODAAPICommon.Reference Reference to a related income schedule definition.
InternalCalculateIS boolean For internal use only.
LineDescription string Description of the line item.
NetValue decimal The unit price multiplied by the quantity.
NumberofJournals decimal Income schedules. Number of journals used to recognize revenue across periods. Must be a positive integer.
OwnerCompany c2g.CODAAPICommon.Reference Company to which this line item belongs.
PeriodInterval decimal Income schedules. Interval (in periods) between journal postings. Must be a positive integer.
Product c2g.CODAAPICommon.Reference Name of the selected product. Mandatory.
Quantity decimal Quantity of the product sold, to two decimal places. Mandatory.
ScheduleNetTotal decimal For internal use only.
SetTaxCode1ToDefault boolean For internal use only.
SetTaxCode2ToDefault boolean For internal use only.
SetTaxCode3ToDefault boolean For internal use only.
StartDate date Income schedules. Sets the journal date for the first journal in the schedule. The default is the invoice date. Subsequent journals are created with journal dates on the first day of the remaining accounting periods in the schedule.
TaxCode1 c2g.CODAAPICommon.Reference Tax code 1.
TaxCode2 c2g.CODAAPICommon.Reference Tax code 2.
TaxCode3 c2g.CODAAPICommon.Reference Tax code 3.
TaxRate1 decimal Tax rate for tax code 1.
TaxRate2 decimal Tax rate for tax code 2.
TaxRate3 decimal Tax rate for tax code 3.
TaxRateTotal decimal Composite tax rate for this line item.
TaxValue1 decimal Total value of items posted to tax code 1, before tax. Mandatory.
TaxValue2 decimal Total value of items posted to tax code 2, before tax.
TaxValue3 decimal Total value of items posted to tax code 3, before tax.
TaxValueTotal decimal Total value of tax relating to this line item, to two decimal places.
UnitPrice decimal Unit price of the selected product. Mandatory.
UsePartPeriods boolean Income schedules. Indicates whether you want to use part periods at the beginning and end of the schedule.
UseProductInformation boolean For internal use only.
CustomFields List<c2g.CODAAPIInvoiceLineItemTypes_10_0.CustomField> Reference to the list of user-defined fields that have been exposed with a type 1 integration rule.

c2g.CODAAPIInvoiceLineItemTypes_10_0.InvoiceLineItems

global with sharing class InvoiceLineItems

Holds the collection of InvoiceLineItem objects on this sales invoice.

Properties

Name Type Description
LineItemList c2g.CODAAPIInvoiceLineItemTypes_10_0.InvoiceLineItem[] The collection of InvoiceLineItem objects.

c2g.CODAAPIInvoiceLineItemTypes_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.CODAAPIInvoiceLineItemTypes_10_0.InvoiceLineItemForAmend

global with sharing class InvoiceLineItemForAmend

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

Properties

Name Type Description
InvoiceLineItem c2g.CODAAPICommon.Reference Reference to the sales invoice line item to be amended. Mandatory.
LineDescription String Description of the invoice line item.
Dimension1 c2g.CODAAPICommon.Reference Reference to the Dimension1 record by which you want to analyze this account. Mandatory if Dimension1Specified is true.
Dimension1Specified Boolean If Dimension1Specified is true, the value in Dimension1 is applied to the Dimension1 on the line item. If Dimension1 is null, the value in the Dimension1 field on the line is deleted. If Dimension1Specified is false, the Dimension1 value on the line is not updated.
Dimension2 c2g.CODAAPICommon.Reference Reference to the Dimension2 record by which you want to analyze this account. Mandatory if Dimension2Specified is true.
Dimension2Specified Boolean If Dimension2Specified is true, the value in Dimension2 is applied to the Dimension2 on the line item. If Dimension2 is null, the value in the Dimension2 field on the line is deleted. If Dimension2Specified is false, the Dimension2 value on the line is not updated.
Dimension3 c2g.CODAAPICommon.Reference Reference to the Dimension3 record by which you want to analyze this account. Mandatory if Dimension3Specified is true.
Dimension3Specified Boolean If Dimension3Specified is true, the value in Dimension3 is applied to the Dimension3 on the line item. If Dimension3 is null, the value in the Dimension3 field on the line is deleted. If Dimension3Specified is false, the Dimension3 value on the line is not updated.
Dimension4 c2g.CODAAPICommon.Reference Reference to the Dimension4 record by which you want to analyze this account. Mandatory if Dimension4Specified is true.
Dimension4Specified Boolean If Dimension4Specified is true, the value in Dimension4 is applied to the Dimension4 on the line item. If Dimension4 is null, the value in the Dimension4 field on the line is deleted. If Dimension4Specified is false, the Dimension4 value on the line is not updated.
© Copyright 2009–2018 FinancialForce.com, inc. Confidential – all rights reserved. Various trademarks held by their respective owners.