Xero Accounting Endpoint: CreditNotes: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
== Overview == | == Overview == | ||
The Xero '''CreditNotes''' [[Endpoints|endpoint]] provides the list of credit notes recorded within Xero. | The Xero '''CreditNotes''' [[Xero Accounting Endpoints|endpoint]] provides the list of credit notes recorded within Xero. | ||
This endpoint does not provide access to all fields and details. It is optimised for small data files that do not have many credit notes. | This endpoint does not provide access to all fields and details. It is optimised for small data files that do not have many credit notes. | ||
In most situations, it is recommended to use the [[Xero Accounting Endpoint: CreditNotesExpanded|CreditNotesExpanded]]. It provides many additional fields and is also optimised for larger data files. | In most situations, it is recommended to use the [[Xero Accounting Endpoint: CreditNotesExpanded|CreditNotesExpanded]]. It provides many additional fields and is also optimised for larger data files. | ||
Note that an alternate endpoint named [[Xero Accounting Endpoint: CreditNotesTable|CreditNotesTable]] 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 CreditNotes endpoint. | The following fields are available for the CreditNotes endpoint. | ||
;DataFile | |||
:A [[Field Type: Record|record field]] that identifies the [[Field: DataFiles|source data file]] for this record. | |||
;CreditNoteID | ;CreditNoteID | ||
| Line 50: | Line 55: | ||
;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 65: | Line 70: | ||
;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 85: | Line 90: | ||
;Amount | ;Amount | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the amount allocated to an invoice. | ||
;Date | ;Date | ||
| Line 111: | Line 116: | ||
:[[Xero Accounting Endpoint: ContactsExpanded|ContactsExpanded]] | :[[Xero Accounting Endpoint: ContactsExpanded|ContactsExpanded]] | ||
:[[Xero Accounting Endpoint: CreditNotesExpanded|CreditNotesExpanded]] | :[[Xero Accounting Endpoint: CreditNotesExpanded|CreditNotesExpanded]] | ||
:[[Xero Accounting Endpoint: CreditNotesExpandedTable|CreditNotesExpandedTable]] | |||
:[[Xero Accounting Endpoint: CreditNotesTable|CreditNotesTable]] | |||
:[[Xero Accounting Endpoint: Currencies|Currencies]] | :[[Xero Accounting Endpoint: Currencies|Currencies]] | ||
:[[Xero Accounting Endpoint: Invoices|Invoices]] | :[[Xero Accounting Endpoint: Invoices|Invoices]] | ||
:[[Xero Accounting Endpoint: InvoicesExpanded|InvoicesExpanded]] | :[[Xero Accounting Endpoint: InvoicesExpanded|InvoicesExpanded]] | ||
:[[Xero Projects Endpoint: Projects|Projects]] | :[[Xero Projects Endpoint: Projects|Projects]] | ||
== Related Topics == | |||
:[[Xero Accounting Models]] | |||
:[[Xero Accounting Endpoints]] | |||
Latest revision as of 20:17, 4 September 2025
Overview
The Xero CreditNotes endpoint provides the list of credit notes recorded within Xero.
This endpoint does not provide access to all fields and details. It is optimised for small data files that do not have many credit notes.
In most situations, it is recommended to use the CreditNotesExpanded. It provides many additional fields and is also optimised for larger data files.
Note that an alternate endpoint named CreditNotesTable 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 CreditNotes 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.
- 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.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
Related Endpoints
- BrandingThemes
- Contacts
- ContactsExpanded
- CreditNotesExpanded
- CreditNotesExpandedTable
- CreditNotesTable
- Currencies
- Invoices
- InvoicesExpanded
- Projects