Xero Accounting Endpoint: InvoicesExpanded
Overview
The Xero InvoicesExpanded endpoint provides the list of invoices (both sales and purchases) recorded within Xero.
This endpoints provides access to all fields and details. It is also optimised for larger data files.
In most situations, it is recommended to use this endpoint instead of the Invoices endpoint.
Note that an alternate endpoint named InvoicesExpandedTable is available which provides a format that can more easily integrate with Tableau, SSIS and Azure Data Factory.
Fields
The following fields are available for the InvoicesExpanded endpoint.
- DataFile
- A record field that identifies the source data file for this record.
- InvoiceID
- A guid field that provides the id of the invoice.
- Type
- A text field that indicates the type of invoice
- Possible values are:
- ACCPAY: Indicates the invoice is for accounts payable / supplier side.
- ACCREC: Indicates the invoice is for accounts receivable / customer side.
- InvoiceNumber
- A text field that provides the invoice number.
- Reference
- A text field that provides the reference of the invoice.
- Status
- A text field that indicates the status of the invoice.
- Possible values are:
- DRAFT: Indicates the invoice is a draft.
- SUBMITTED: Indicates the invoice is awaiting approval.
- AUTHORISED: Indicates the invoice is approved and awaiting payment or partially paid.
- PAID: Indicates the invoice is completely paid.
- VOIDED: Indicates the invoice is voided.
- DELETED: Indicates the invoice is deleted.
- Date
- A date field that provides the date on which the invoice occurred.
- DueDate
- A date field that provides the due date of the invoice.
- ExpectedPaymentDate
- A date field that provides the expected payment date of the invoice.
- Only applies to sales invoice.
- PlannedPaymentDate
- A date field that provides the planned payment date of the invoice.
- Only applies to bills invoice.
- FullyPaidOnDate
- A date field that provides the date the invoice was fully paid.
- Contact
- A record field that provides the Contacts associated with the invoice.
- LineAmountTypes
- A text field that indicates the type of values on the lines.
- Possible values are:
- Exclusive: Indicates that line items are exclusive of tax.
- Inclusive: Indicates that line items are inclusive tax.
- NoTax: Indicates that line items have no tax.
- LineItems
- A table field that provides the invoice lines.
- See LineItems Fields for more information.
- Payments
- A table field that provides the list of payments applied to the invoice.
- See Payments Fields for more information.
- CreditNotes
- A table field that provides the list of credit notes applied to the invoice.
- See CreditNotes Fields for more information.
- Prepayments
- A table field that provides the list of prepayments applied to the invoice.
- See Prepayments Fields for more information.
- Overpayments
- A table field that provides the list of Overpayments applied to the invoice.
- See Overpayments Fields for more information.
- Subtotal
- A decimal field that provides the tax exclusive amount of the transaction.
- TotalTax
- A decimal field that provides the tax amount of the transaction.
- Total
- A decimal field that provides the total amount of the transaction.
- AmountDue
- A decimal field that provides the total amount due.
- AmountPaid
- A decimal field that provides the total amount paid.
- AmountCredited
- A decimal field that provides the total amount credited.
- CurrencyCode
- A text field that indicates the currency of the transaction.
- CurrencyRate
- A decimal field that provides the exchange rate applied to the transaction.
- HasAttachments
- A true/false field that indicates if attachments were uploaded against the transaction.
- SentToContact
- A true/false field that indicates if the invoice has been sent to the contact.
- CISDeduction
- A decimal field that provides the CIS deduction amount (UK only).
- RepeatingInvoiceID
- A guid field that indicates the repeating invoice id of the invoice.
- BrandingThemeID
- A guid field that indicates the branding theme of the invoice.
- Url
- A text field that provides the url of the uploaded document.
- UpdatedDateUTC
- A date time field that indicates the date and time this invoice was created and/or updated.
LineItems Fields
The LineItems Fields include the following sub fields.
- LineItemID
- A guid field that provides an ID for the line.
- This field can be linked with the LinkedTransactions endpoint to determine how billable expenses on purchase invoices are applied to sales invoices.
- Description
- A text field that provides the description of the line.
- Quantity
- A decimal field that provides the quantity of the line.
- UnitAmount
- A decimal field that provides the unit amount of the line.
- LineAmount
- A decimal field that provides the amount of the line.
- TaxAmount
- A decimal field that provides the tax amount of the line.
- DiscountRate
- A decimal field that provides the discount rate applied to the line.
- AccountID
- A guid field that provides the account id of the line.
- AccountCode
- A text field that provides the account code of the line.
- Item
- A record field that provides the item of the line.
- ItemCode
- A text field that provides the item code of the line.
- This field is provided for backwards compatibility purposes only.
- TaxType
- A text field that provides the tax type of the line.
- Tracking
- A table field that provides the tracking category options assigned to the line.
Payments Fields
The Payments Fields include the following sub fields.
- PaymentID
- A GUID field representing the internal id of a payment.
- This field can be linked to the Payments endpoint.
- BatchPaymentID
- A GUID field representing the internal id of a batch payment.
- This field can be linked to the BatchPayments endpoint.
- Date
- A date field that provides the date on which the link occurred.
- Amount
- A decimal field that provides the amount associated with the payment.
- CurrencyRate
- A decimal field that provides the exchange rate applicable.
- Reference
- A text field that provides the reference.
CreditNotes Fields
The CreditNotes Fields include the following sub fields.
- CreditNoteID
- A GUID field representing the internal id of a credit note.
- This field can be linked to the CreditNotes and CreditNotesExpanded endpoints.
- CreditNoteNumber
- A text field that provides the credit note number.
- AppliedAmount
- A decimal field that provides the amount applied to the invoice.
- Date
- A date field that provides the date on which it was applied.
- Total
- A decimal field that provides the total amount of the credit note.
Prepayments Fields
The Payments Fields include the following sub fields.
- PrepaymentID
- A GUID field representing the internal id of a prepayment.
- This field can be linked to the Prepayments and PrepaymentsExpanded endpoints.
- AppliedAmount
- A decimal field that provides the amount applied to the invoice.
- Date
- A date field that provides the date on which it was applied.
- Total
- A decimal field that provides the total amount of the prepayment.
Overpayments Fields
The Payments Fields include the following sub fields.
- OverpaymentID
- A GUID field representing the internal id of a overpayment.
- This field can be linked to the Overpayments and OverpaymentsExpanded endpoints.
- AppliedAmount
- A decimal field that provides the amount applied to the invoice.
- Date
- A date field that provides the date on which it was applied.
- Total
- A decimal field that provides the total amount of the overpayment.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
Related Endpoints
- Accounts
- BrandingThemes
- Contacts
- ContactsExpanded
- CreditNotes
- CreditNotesExpanded
- Currencies
- Items
- Invoices
- LinkedTransactions
- Overpayments
- OverpaymentsExpanded
- Payments
- Prepayments
- PrepaymentsExpanded
- Projects
- PurchaseOrders
- Quotes
- RepeatingInvoices
- TaxRates
- TrackingCategories