Xero Accounting Endpoint: CreditNotesExpanded: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (8 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
== Overview == | == Overview == | ||
The Xero '''CreditNotesExpanded''' [[Endpoints|endpoint]] provides the list of credit notes recorded within Xero. | The Xero '''CreditNotesExpanded''' [[Xero Accounting Endpoints|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. | 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 [[Xero Accounting Endpoint: CreditNotes|CreditNotes]] endpoint. | In most situations, it is recommended to use this endpoint instead of the [[Xero Accounting Endpoint: CreditNotes|CreditNotes]] endpoint. | ||
Note that an alternate endpoint named [[Xero Accounting Endpoint: CreditNotesExpandedTable|CreditNotesExpandedTable]] is available which provides a format that can more easily integrate with Tableau, SSIS and Azure Data Factory. | |||
| Line 11: | Line 13: | ||
The following fields are available for the CreditNotesExpanded endpoint. | The following fields are available for the CreditNotesExpanded endpoint. | ||
;DataFile | |||
:A [[Field Type: Record|record field]] that identifies the [[Field: DataFiles|source data file]] for this record. | |||
;CreditNoteID | ;CreditNoteID | ||
| Line 61: | Line 66: | ||
;Subtotal | ;Subtotal | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the tax exclusive amount of the transaction. | ||
;TotalTax | ;TotalTax | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the tax amount of the transaction. | ||
;Total | ;Total | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the total amount of the transaction. | ||
;RemainingCredit | ;RemainingCredit | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the remaining credit that can be applied to other invoices. | ||
;CurrencyCode | ;CurrencyCode | ||
| Line 76: | Line 81: | ||
;CurrencyRate | ;CurrencyRate | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the exchange rate applied to the transaction. | ||
;BrandingThemeID | ;BrandingThemeID | ||
| Line 96: | Line 101: | ||
;Amount | ;Amount | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the amount allocated to an invoice. | ||
;Date | ;Date | ||
| Line 108: | Line 113: | ||
The [[#Fields|LineItems Fields]] include the following sub fields. | The [[#Fields|LineItems Fields]] include the following sub fields. | ||
;LineItemID | |||
:A [[Field Type: GUID|guid field]] that provides an ID for the line. | |||
:This field can be linked with the [[Xero Accounting Endpoint: LinkedTransactions|LinkedTransactions]] endpoint to determine how billable expenses on purchase invoices are applied to sales invoices. | |||
;Description | ;Description | ||
| Line 113: | Line 122: | ||
;Quantity | ;Quantity | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the quantity of the line. | ||
;UnitAmount | ;UnitAmount | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the unit amount of the line. | ||
;LineAmount | ;LineAmount | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the amount of the line. | ||
;TaxAmount | ;TaxAmount | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the tax amount of the line. | ||
;AccountID | |||
:A [[Field Type: GUID|guid field]] that provides the [[Xero Accounting Endpoint: Accounts|account id]] of the line. | |||
;AccountCode | ;AccountCode | ||
:A [[Field Type: Text|text field]] that provides the [[Xero Accounting Endpoint: Accounts|account code]] of the line. | :A [[Field Type: Text|text field]] that provides the [[Xero Accounting Endpoint: Accounts|account code]] of the line. | ||
;Item | |||
:A [[Field Type: Record|record field]] that provides the [[Xero Accounting Endpoint: Items|item]] of the line. | |||
;ItemCode | ;ItemCode | ||
:A [[Field Type: Text|text field]] that provides the [[Xero Accounting Endpoint: Items|item code]] of the line. | :A [[Field Type: Text|text field]] that provides the [[Xero Accounting Endpoint: Items|item code]] of the line. | ||
:''This field is provided for backwards compatibility purposes only.'' | |||
;TaxType | ;TaxType | ||
| Line 158: | Line 174: | ||
:[[Xero Accounting Endpoint: ContactsExpanded|ContactsExpanded]] | :[[Xero Accounting Endpoint: ContactsExpanded|ContactsExpanded]] | ||
:[[Xero Accounting Endpoint: CreditNotes|CreditNotes]] | :[[Xero Accounting Endpoint: CreditNotes|CreditNotes]] | ||
:[[Xero Accounting Endpoint: CreditNotesExpandedTable|CreditNotesExpandedTable]] | |||
:[[Xero Accounting Endpoint: CreditNotesTable|CreditNotesTable]] | |||
:[[Xero Accounting Endpoint: Currencies|Currencies]] | :[[Xero Accounting Endpoint: Currencies|Currencies]] | ||
:[[Xero Accounting Endpoint: Items|Items]] | :[[Xero Accounting Endpoint: Items|Items]] | ||
| Line 165: | Line 183: | ||
:[[Xero Accounting Endpoint: TaxRates|TaxRates]] | :[[Xero Accounting Endpoint: TaxRates|TaxRates]] | ||
:[[Xero Accounting Endpoint: TrackingCategories|TrackingCategories]] | :[[Xero Accounting Endpoint: TrackingCategories|TrackingCategories]] | ||
== Related Topics == | |||
:[[Xero Accounting Models]] | |||
:[[Xero Accounting Endpoints]] | |||
Latest revision as of 20:17, 4 September 2025
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 that an alternate endpoint named CreditNotesExpandedTable 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 CreditNotesExpanded endpoint.
- DataFile
- A record field that identifies the source data file for this record.
- 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.
- 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.
- 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.
- Contact
- A record field that provides the Contacts associated with the credit note.
- SentToContact
- A true/false field that indicates if the credit note has been sent to the contact.
- Allocations
- A table field that provides the amount allocated to the invoice.
- See Allocations Fields for more information.
- 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-like lines entered against the credit note.
- See LineItems 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.
- 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.
- BrandingThemeID
- A guid field that indicates the branding theme of the transaction.
- HasAttachments
- A true/false field that indicates if attachments were uploaded against the transaction.
- FullyPaidOnDate
- A date time field that indicates the date and time credit note was fully applied.
- UpdatedDateUTC
- A date time field that indicates the date and time this credit note was created and/or updated.
Allocations Fields
The Allocations Fields include the following sub fields.
- Amount
- A decimal field that provides the amount allocated to an invoice.
- Date
- A date field that provides the date on which the amount was allocated to an invcoice.
- Invoice
- A record field that provides the invoice details.
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.
- 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.
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
- CreditNotesExpandedTable
- CreditNotesTable
- Currencies
- Items
- Invoices
- InvoicesExpanded
- Projects
- TaxRates
- TrackingCategories