Name Description Type Additional information
TransactionId The Id/key of the invoice/transaction. This data is returned only and cannot be added or updated when issuing a POST or PUT. integer

None.

LastUpdatedId A data field used to check concurreny when performing updates. This data is returned only and used for concurrency checking when performing an update/PUT. string

None.

Currency The currrency code of the amounts. Eg. AUD. string

None.

InvoiceNumber Invoice number. Use a value of <Auto Number> to automatically generate an invoice number. string

None.

InvoiceType Available types are: "Pre-Quote Opportunity", "Quote" , "Purchase Order", "Sale Order", "Tax Invoice", "Adjustment Note", "RCT Invoice", "Money In (Income)", "Money Out (Expense)". string

Required

TransactionType The transaction type of the invoice. Supported types are: 'S' = sale, 'P' = purchase. string

Required

Layout The Layout of the invoice. I = Item Sale, S = Service Sale. string

Required

Summary Invoice summary. string

None.

TotalAmount Total amount of the invoice. decimal number

None.

TotalTaxAmount Total tax amount of the invoice. decimal number

None.

IsTaxInc Indicates if tax is included in the amounts. On an invoice insert or update, if this element is not included or specified, then false is assumed. boolean

None.

AmountPaid Total amount paid. decimal number

None.

AmountOwed Total amount owed. decimal number

None.

FxRate FXRate (Foreign exchange rate) applied to this invoice. decimal number

None.

AutoPopulateFxRate Determines whether the FxRate is automatically populated using the Fx feed. boolean

None.

RequiresFollowUp Indicates whether the invoice requires follow up. boolean

None.

SentToContact Indicates whether the invoice was sent to the contact. boolean

None.

TransactionDate Date of this transaction. date

Required

BillingContactId The Id/key of the billing contact. integer

None.

BillingContactFirstName Billing contact first name. This data is returned only and cannot be added or updated when issuing a POST or PUT. string

None.

BillingContactLastName Billing contact last name. This data is returned only and cannot be added or updated when issuing a POST or PUT. string

None.

BillingContactOrganisationName Billing contact organisation name. This data is returned only and cannot be added or updated when issuing a POST or PUT. string

None.

ShippingContactId The Id/key of the shipping contact. integer

None.

ShippingContactFirstName Shipping contact first name. This data is returned only and cannot be added or updated when issuing a POST or PUT. string

None.

ShippingContactLastName Shipping contact last name. This data is returned only and cannot be added or updated when issuing a POST or PUT. string

None.

ShippingContactOrganisationName Shipping contact organisation name. This data is returned only and cannot be added or updated when issuing a POST or PUT. string

None.

CreatedDateUtc The date and time this resource was created in UTC. This data is returned only and cannot be added or updated when issuing a POST or PUT. date

None.

LastModifiedDateUtc The date and time this resource was last modified in UTC. This data is returned only and cannot be added or updated when issuing a POST or PUT. date

None.

PaymentStatus The payment status of this invoice. Supported types are: 'A' = all, 'P' = paid, 'U' = unpaid. This data is returned only and cannot be added or updated when issuing a POST or PUT. string

None.

DueDate The date that this invoice is due. date

None.

InvoiceStatus Not required for inserting/adding an invoice as it is determined by the "InvoiceType'. Indicator specifying: Q = Quote, O = Order, I = Invoice. Note: This field is deprecated (is readonly) and is inferred from InvoiceType. It is here for backwards compatibility only. This data is returned only and cannot be added or updated when issuing a POST or PUT. string

None.

PurchaseOrderNumber The purchase order number. string

None.

PaymentCount The number of payments applied (if any). This data is returned only and cannot be added or updated when issuing a POST or PUT. integer

None.

Tags List of tags associated with this resource. Collection of string

None.

_links Hypermedia links. Contains contextual links to possible next actions related to this resource. Only present in responses. This data is not to be sent to the server. Collection of Link

None.