c2g.CODAAPIInvoiceTypes_10_0

global with sharing class CODAAPIInvoiceTypes_10_0

Invoice
CustomField
InvoiceInstallment
InvoiceForAmend

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.
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.
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.
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.
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.
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.
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.