Nic: Created page with "== Overview == The Xero '''CreditNotesExpanded''' endpoint provides the list of credit notes recorded within Xero. This endpoints provides acc..."

2025-09-05T01:14:58Z

Created page with "== Overview == The Xero '''CreditNotesExpanded''' endpoint provides the list of credit notes recorded within Xero. This endpoints provides acc..."

New page

== Overview ==

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.

In most situations, it is recommended to use this endpoint instead of the [[Xero Accounting Endpoint: CreditNotes|CreditNotes]] endpoint.

Note this endpoint is an alternate format of the [[Xero Accounting Endpoint: CreditNotesExpanded|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 [[Field Type: GUID|guid field]] that provides the id of the xero data file as setup in OdataLink.

;DataFileName
:A [[Field Type: Text|text field]] provides the name of the xero data file as setup in OdataLink.

;DataFileCode
:A [[Field Type: Text|text field]] provides the code of the xero data file as setup in OdataLink.

;CreditNoteID
:A [[Field Type: GUID|guid field]] that provides the id of the credit note.

;Type
:A [[Field Type: Text|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 [[Field Type: Text|text field]] that provides the credit note number.

;Reference
:A [[Field Type: Text|text field]] that provides the reference of the credit note.

;Status
:A [[Field Type: Text|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 [[Field Type: Date|date field]] that provides the date on which the credit note occurred.

;DueDate
:A [[Field Type: Date|date field]] that provides the due date of the credit note.

;FullyPaidOnDate
:A [[Field Type: DateTimeOffset|date time field]] that indicates the date and time credit note was fully applied.

;ContactID
:A [[Field Type: GUID|GUID field]] representing the internal id of a contact.

;ContactName
:A [[Field Type: Text|text field]] provides the name of the contact.

;LineAmountTypes
:A [[Field Type: Text|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 [[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.

;LineDescription
:A [[Field Type: Text|text field]] that provides the description of the line.

;LineQuantity
:A [[Field Type: Decimal|decimal field]] that provides the quantity of the line.

;LineUnitAmount
:A [[Field Type: Decimal|decimal field]] that provides the unit amount of the line.

;LineAmount
:A [[Field Type: Decimal|decimal field]] that provides the amount of the line.

;LineTaxAmount
:A [[Field Type: Decimal|decimal field]] that provides the tax amount of the line.

;LineAccountID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Accounting Endpoint: Accounts|account id]] of the line.

;LineAccountCode
:A [[Field Type: Text|text field]] that provides the [[Xero Accounting Endpoint: Accounts|account code]] of the line.

;LineItemID
:A [[Field Type: GUID|guid field]] that provides the [[Xero Accounting Endpoint: Items|item id]] of the line.

;LineItemCode
:A [[Field Type: Text|text field]] that provides the [[Xero Accounting Endpoint: Items|item code]] of the line.

;LineItemName
:A [[Field Type: Text|text field]] that provides the [[Xero Accounting Endpoint: Items|item name]] of the line.

;LineTaxType
:A [[Field Type: Text|text field]] that provides the [[Xero Accounting Field: TaxTypes|tax type]] of the line.

;LineTracking
:A [[Field Type: Table|table field]] that provides the [[Xero Accounting Endpoint: TrackingCategories|tracking category options]] assigned to the line.

;TrackingCategory1ID
:A [[Field Type: GUID|GUID field]] representing the internal id of a tracking category.

;TrackingCategory1Name
:A [[Field Type: Text|text field]] provides the name of the tracking category.

;TrackingOption1Name
:A [[Field Type: Text|text field]] provides the option of the tracking category.

;TrackingCategory2ID
:A [[Field Type: GUID|GUID field]] representing the internal id of a tracking category.

;TrackingCategory2Name
:A [[Field Type: Text|text field]] provides the name of the tracking category.

;TrackingOption2Name
:A [[Field Type: Text|text field]] provides the option of the tracking category.

;Subtotal
:A [[Field Type: Decimal|decimal field]] that provides the tax exclusive amount of the transaction.

;TotalTax
:A [[Field Type: Decimal|decimal field]] that provides the tax amount of the transaction.

;Total
:A [[Field Type: Decimal|decimal field]] that provides the total amount of the transaction.

;RemainingCredit
:A [[Field Type: Decimal|decimal field]] that provides the remaining credit that can be applied to other invoices.

;CurrencyCode
:A [[Field Type: Text|text field]] that indicates the [[Xero Accounting Endpoint: Currencies|currency]] of the transaction.

;CurrencyRate
:A [[Field Type: Decimal|decimal field]] that provides the exchange rate applied to the transaction.

;HasAttachments
:A [[Field Type: Boolean|true/false field]] that indicates if attachments were uploaded against the transaction.

;SentToContact
:A [[Field Type: Boolean|true/false field]] that indicates if the credit note has been sent to the contact.

;BrandingThemeID
:A [[Field Type: GUID|guid field]] that indicates the [[Xero Accounting Endpoint: BrandingThemes|branding theme]] of the transaction.

;UpdatedDateUTC
:A [[Field Type: DateTimeOffset|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 [https://developer.xero.com/documentation/api/accounting/creditnotes Xero API].

== Related Fields ==

:[[Xero Accounting Field: Accounts|Accounts]]
:[[Xero Accounting Field: Contacts|Contacts]]
:[[Xero Accounting Field: TaxTypes|TaxTypes]]
:[[Xero Accounting Field: TrackingCategories|TrackingCategories]]

== Related Endpoints ==

:[[Xero Accounting Endpoint: Accounts|Accounts]]
:[[Xero Accounting Endpoint: BrandingThemes|BrandingThemes]]
:[[Xero Accounting Endpoint: Contacts|Contacts]]
:[[Xero Accounting Endpoint: ContactsExpanded|ContactsExpanded]]
:[[Xero Accounting Endpoint: CreditNotes|CreditNotes]]
:[[Xero Accounting Endpoint: CreditNotesExpanded|CreditNotesExpanded]]
:[[Xero Accounting Endpoint: CreditNotesTable|CreditNotesTable]]
:[[Xero Accounting Endpoint: Currencies|Currencies]]
:[[Xero Accounting Endpoint: Items|Items]]
:[[Xero Accounting Endpoint: TaxRates|TaxRates]]
:[[Xero Accounting Endpoint: TrackingCategories|TrackingCategories]]

== Related Topics ==

:[[Xero Accounting Models]]
:[[Xero Accounting Endpoints]]

Xero Accounting Endpoint: CreditNotesExpandedTable - Revision history

Nic: Created page with "== Overview == The Xero '''CreditNotesExpanded''' endpoint provides the list of credit notes recorded within Xero. This endpoints provides acc..."