CreditNoteAllocations
Allows for querying credit note allocations within a Xero organization. Credit note allocations are used to match credit notes with invoices or payments.
Columns
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for this specific credit note allocation entry. It is typically a composite of the credit note's ID and an allocation index, ensuring each allocation (especially if one credit note is applied to multiple invoices) can be uniquely identified and referenced. |
| CreditNoteId | String | Unique identifier of the credit note from which credit is being allocated. This internal ID (usually a GUID in Xero's system) links the allocation to a specific credit note record. It is used in Xero's internal system and in API calls, and is not usually visible to users. |
| Allocation_AppliedAmount | Decimal | The portion of the credit note's total amount that is applied to this particular invoice, reducing the invoice's outstanding balance by that same value. It indicates how much of the credit note was used on this invoice and decreases the remaining credit available on that credit note. |
| Allocation_Date | Date | The date on which the credit note was applied to the invoice. Xero typically sets this to the later of the credit note's date or the invoice's date, ensuring both the credit note and the invoice exist by that date. This date determines which accounting period the allocation falls into, thereby affecting when this credit application is reflected in financial reports. |
| Allocation_InvoiceId | String | Unique identifier of the invoice that the credit note is allocated to. This internal invoice ID links the allocation record to a specific invoice in Xero's system. It's used by the system and in API calls to ensure the credit is applied to the correct invoice, as opposed to using the human-readable invoice number. |
| Allocation_InvoiceNumber | String | The reference number of the invoice that received the credit note allocation. This is the user-facing invoice number (for example 'INV-1001') assigned to the invoice, which appears in Xero and on the invoice document. It provides an easily recognizable reference for the credited invoice, unlike the internal InvoiceId. |
| TenantId | String | The unique identifier of the Xero organization (tenant) associated with this record. In scenarios where multiple Xero organizations are connected, this ID specifies which tenant's data is being accessed. It ensures the credit allocation is recorded under the correct Xero company (organization). |