Xero Accounting Endpoint: CreditNotesExpandedTable
Overview
The Xero CreditNotesExpanded endpoint provides the list of credit notes 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 CreditNotes endpoint.
Note this endpoint is an alternate format of the CreditNotesExpanded endpoint. It provides a format that can more easily integrate with Tableau, SSIS and Azure Data Factory.
Fields
The following fields are available for the CreditNotesExpanded endpoint.
- DataFileID
- A guid field that provides the id of the xero data file as setup in OdataLink.
- DataFileName
- A text field provides the name of the xero data file as setup in OdataLink.
- DataFileCode
- A text field provides the code of the xero data file as setup in OdataLink.
- CreditNoteID
- A guid field that provides the id of the credit note.
- Type
- A text field that indicates the type of credit note.
- Possible values are:
- ACCPAYCREDIT: Indicates the credit note is for accounts payable / supplier side.
- ACCRECCREDIT: Indicates the credit note is for accounts receivable / customer side.
- CreditNoteNumber
- A text field that provides the credit note number.
- Reference
- A text field that provides the reference of the credit note.
- Status
- A text field that indicates the status of the credit note.
- Possible values are:
- AUTHORISED: Indicates the transaction is authorised and has been processed.
- DELETED: Indicates the transaction has been deleted.
- Date
- A date field that provides the date on which the credit note occurred.
- DueDate
- A date field that provides the due date of the credit note.
- FullyPaidOnDate
- A date time field that indicates the date and time credit note was fully applied.
- ContactID
- A GUID field representing the internal id of a contact.
- ContactName
- A text field provides the name of the contact.
- 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.
- LineID
- 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.
- LineDescription
- A text field that provides the description of the line.
- LineQuantity
- A decimal field that provides the quantity of the line.
- LineUnitAmount
- A decimal field that provides the unit amount of the line.
- LineAmount
- A decimal field that provides the amount of the line.
- LineTaxAmount
- A decimal field that provides the tax amount of the line.
- LineAccountID
- A guid field that provides the account id of the line.
- LineAccountCode
- A text field that provides the account code of the line.
- LineItemID
- A guid field that provides the item id of the line.
- LineItemCode
- A text field that provides the item code of the line.
- LineItemName
- A text field that provides the item name of the line.
- LineTaxType
- A text field that provides the tax type of the line.
- LineTracking
- A table field that provides the tracking category options assigned to the line.
- TrackingCategory1ID
- A GUID field representing the internal id of a tracking category.
- TrackingCategory1Name
- A text field provides the name of the tracking category.
- TrackingOption1Name
- A text field provides the option of the tracking category.
- TrackingCategory2ID
- A GUID field representing the internal id of a tracking category.
- TrackingCategory2Name
- A text field provides the name of the tracking category.
- TrackingOption2Name
- A text field provides the option of the tracking category.
- 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.
- RemainingCredit
- A decimal field that provides the remaining credit that can be applied to other invoices.
- 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 credit note has been sent to the contact.
- BrandingThemeID
- A guid field that indicates the branding theme of the transaction.
- UpdatedDateUTC
- A date time field that indicates the date and time this credit note was created and/or updated.
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
- CreditNotesTable
- Currencies
- Items
- TaxRates
- TrackingCategories