c2g.CODAAPIInvoiceLineItemTypes_10_0

global with sharing class CODAAPIInvoiceLineItemTypes_10_0

InvoiceLineItem
InvoiceLineItems
CustomField
InvoiceLineItemForAmend

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.