OverpaymentAllocations
Used to query the allocation of overpayments within Xero. This helps track excess payments made by customers and how they are applied to outstanding invoices.
Columns
| Name | Type | Description |
| Id [KEY] | String | A unique identifier for the allocation, combining the allocation index and the Xero-generated identifier for the overpayment. This ensures the allocation can be distinctly tracked. |
| OverpaymentId | String | The unique identifier for the overpayment. This links the allocation to a specific overpayment transaction in Xero. |
| Allocation_AppliedAmount | Decimal | The amount of the overpayment to be applied to a specific invoice. This field shows how much of the overpayment is being allocated toward settling the invoice balance. |
| Allocation_Date | Date | The date when the allocation was made. This indicates when the overpayment was applied to the invoice, helping track payment history. |
| Allocation_InvoiceId | String | The identifier of the invoice to which the overpayment is applied. This links the allocation to the specific invoice that is being settled. |
| Allocation_InvoiceNumber | String | The invoice number associated with the allocation. This field provides a reference to the invoice being credited with the overpayment. |
| TenantId | String | The unique identifier for the tenant. This ensures the query retrieves data specific to a particular tenant, especially in multi-tenant environments, ensuring proper data isolation. |