Accounting Apex API Developer Reference

c2g.CODAAPIPurchaseInvoiceTypes_9_0

global with sharing class CODAAPIPurchaseInvoiceTypes_9_0

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

Enums

enumIncomeTaxType

category of 1099 income tax. these types relate to the boxes on form 1099-misc.

enumInvoiceStatus

possible purchase invoice 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 a discard reason.

c2g.CODAAPIPurchaseInvoiceTypes_9_0.PurchaseInvoice

global with sharing class PurchaseInvoice

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

Properties

Name Type Description
AccountInvoiceNumber string number of the invoice sent by the vendor.
Account c2g.CODAAPICommon.Reference reference to the vendor account for this purchase invoice. mandatory.
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.
DualRate decimal the exchange rate for home to dual currency.
DueDate date date the purchase credit note is due for payment. mandatory.
ExpensesNetTotal decimal total value of expense line items on the purchase invoice, before tax.
ExpensesTax1Total decimal total value of tax on expense line items posted to (vat) tax code 1.
IncomeTaxTypeRef c2g.CODAAPIPurchaseInvoiceTypes_9_0.enumIncomeTaxType default category of 1099 income tax withheld for this account or not reportable. these types relate to the boxes on Form 1099-MISC.
InvoiceCurrency c2g.CODAAPICommon.Reference reference to the currency in which monetary values are expressed on the invoice. mandatory.
InvoiceDate date date of the invoice. mandatory.
InvoiceDescription string description of the invoice.
InvoiceRate decimal the exchange rate for document to home currency.
InvoiceStatus c2g.CODAAPIPurchaseInvoiceTypes_9_0.enumInvoiceStatus current status of the invoice. mandatory.
InvoiceTotal decimal total invoice value, including the tax.
ItemsNetTotal decimal total value of product line items on the purchase invoice, before tax.
ItemsTax1Total decimal total value of tax on product line items posted to (vat) tax code 1.
MatchTypeRef string this value is "credited" if the purchase invoice has been fully matched to a purchase credit note.
NetTotal decimal total value of items on the purchase invoice, before tax.
OutstandingValue decimal amount still owed on this document in document currency.
OwnerCompany c2g.CODAAPICommon.Reference reference to the company to which this document belongs.
PaymentStatus string is this document "unpaid", "part paid", or "paid"?
Period c2g.CODAAPICommon.Reference reference to the accounting period in which this document falls. mandatory.
Reference1 string the vendor's order number, your organization or company's order number, the buyer's name, or any other reference detail.
Reference2 string the vendor's order number, your organization or company's order number, the buyer's name, or any other reference detail.
RegisteredDate date date the purchase credit note was entered.
TaxCode1 c2g.CODAAPICommon.Reference reference to the (vat) tax code to use, along with the invoice date, to derive the tax for this line.
TaxTotal decimal total value of tax on the purchase invoice.
TransactionRef c2g.CODAAPICommon.Reference reference to the transaction created when the purchase invoice was posted.
Year string name of the year.
CreatedById c2g.CODAAPICommon.Reference id of the user who created the record.
LastModifiedById c2g.CODAAPICommon.Reference id of the user who last modified the record.
CreatedDate datetime date and time when the record was created.
Id id globally unique string that identifies the record.
LastModifiedDate datetime date and time when the record was last modified by a user.
SystemModstamp datetime date and time when the record was last modified by a user or by a workflow process (such as a trigger).
Name string unique number allocated to this purchase invoice.
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).
LineItems c2g.CODAAPIPurchaseInvoiceLineItemTypes_9_0.PurchaseInvoiceLineItems reference to the associated purchase invoice line items (products). mandatory.
ExpLineItems c2g.CODAAPIPurchaseInvoiceExpLineTypes_9_0.PurchaseInvoiceExpenseLineItems reference to the associated purchase expense invoice line items.
CustomFields List<c2g.CODAAPIPurchaseInvoiceTypes_9_0.CustomField> reference to the list of user-defined fields that have been exposed with a type 1 integration rule.

c2g.CODAAPIPurchaseInvoiceTypes_9_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.
© Copyright 2009–2022 FinancialForce.com, inc. All rights reserved. Various trademarks held by their respective owners.