Overpayments
Used to query overpayments made within a Xero organization. This helps manage and apply payments that exceed the amount owed.
Columns
| Name | Type | Description |
| OverpaymentId [KEY] | String | The unique identifier for the overpayment transaction in Xero. This ID is used to link the overpayment to related transactions and for tracking within the system. |
| Date | Date | The date when the overpayment was made. This field tracks the actual payment date and is essential for financial record-keeping. |
| Type | String | The type of the overpayment transaction. Valid values include 'RECEIVE-OVERPAYMENT' (payments received in excess) and 'SPEND-OVERPAYMENT' (overpayments made during a purchase). |
| RemainingCredit | Decimal | The remaining credit balance on the overpayment. This field helps track how much of the overpayment is still available to apply to other invoices or transactions. |
| Contact_ContactId | String | The identifier for the contact associated with the overpayment. This links the overpayment to the specific customer or supplier involved in the transaction. |
| Contact_Name | String | The name of the contact associated with the overpayment. This provides the necessary reference to identify the party involved in the overpayment. |
| Status | String | The current status of the overpayment. Valid status values include 'AUTHORISED', 'PAID', and 'VOIDED', reflecting whether the overpayment has been approved, paid, or canceled. |
| SubTotal | Decimal | The subtotal for the overpayment, excluding taxes. This represents the value of the overpayment before taxes are applied. |
| TotalTax | Decimal | The total tax amount on the overpayment. This is calculated based on the applicable tax rates and included in the overall total of the overpayment. |
| Total | Decimal | The total amount of the overpayment, including tax. This is the sum of 'SubTotal' and 'TotalTax', representing the full value of the overpayment. |
| LineItem_LineItemId | String | The unique Xero identifier for a line item within the overpayment. This links the overpayment to specific line items for detailed tracking. |
| LineItem_Description | String | The description of the line item for the overpayment. This field provides details about the item or service being paid for, helping users understand the overpayment breakdown. |
| LineItem_Quantity | Double | The quantity of the associated item in the line item. This field specifies how much of the item is being paid for in the overpayment transaction. |
| LineItem_UnitAmount | Decimal | The unit price of the associated item in the line item. This value helps determine the total cost for the item, which is used to calculate the overpayment amount. |
| LineItem_ItemCode | String | The code that identifies the associated item in the line item. This is used to reference inventory or services that the overpayment applies to. |
| LineItem_AccountCode | String | The account code used for the line item. The account must be active for the organisation and is necessary for the invoice approval process. |
| LineItem_TaxType | String | The tax type applied to the line item. This field allows overriding the default tax code for the selected account, enabling more accurate tax reporting. |
| LineItem_TaxAmount | Decimal | The calculated tax amount for the line item. This is derived based on the tax type and is included in the total tax amount of the overpayment. |
| LineItem_LineAmount | Decimal | The total amount for the line item, including any quantity multiplied by the unit price with applicable discounts or adjustments. |
| LineItem_TrackingCategory1_CategoryId | String | The ID of the first tracking category associated with the line item. Tracking categories help with additional reporting and categorization of expenses. |
| LineItem_TrackingCategory1_CategoryName | String | The name of the first tracking category. This further categorizes the line item for reporting purposes. |
| LineItem_TrackingCategory1_OptionId | String | The ID of the option within the first tracking category. This allows for further granularity in tracking and reporting. |
| LineItem_TrackingCategory1_OptionName | String | The name of the option selected for the first tracking category. This helps specify the exact category option the line item is associated with. |
| LineItem_TrackingCategory1_Option_Stat | String | The status of the option within the first tracking category. It indicates whether the option is active or inactive for reporting. |
| LineItem_TrackingCategory2_CategoryId | String | The ID of the second tracking category. This allows a second level of categorization for the line item. |
| LineItem_TrackingCategory2_CategoryName | String | The name of the second tracking category. This enables more detailed reporting and categorization of expenses. |
| LineItem_TrackingCategory2_OptionId | String | The ID of the option within the second tracking category. This helps further refine the classification of the line item. |
| LineItem_TrackingCategory2_OptionName | String | The name of the option selected for the second tracking category. This further defines the line item's categorization. |
| LineItem_TrackingCategory2_Option_Stat | String | The status of the option within the second tracking category. It reflects whether the option is currently active or inactive. |
| LineItem_DiscountRate | Double | The percentage discount applied to the line item. This is only applicable to 'ACCREC' (sales) invoices, and it reduces the total amount due. |
| LineAmountTypes | String | Specifies the line amount type for the overpayment. The valid values are 'Exclusive' (tax is excluded), 'Inclusive' (tax is included), and 'NoTax' (no tax is applied). |
| CurrencyCode | String | The ISO 4217 currency code for the overpayment. This identifies the currency used for the transaction (for example, 'USD' or 'EUR'). |
| CurrencyRate | String | The currency exchange rate for a multicurrency overpayment. If not specified, the XE.com daily rate is used as the default. |
| UpdatedDateUTC | Datetime | The timestamp when the overpayment was last updated. This ensures that the data is current and reflects the latest changes. |
| Allocation1_AppliedAmount | Decimal | The amount of the overpayment applied to a specific invoice. This is part of the allocation process, where the overpayment is applied to outstanding invoices. |
| Allocation1_Date | Date | The date when the overpayment was applied to the invoice. This helps track the timing of the allocation. |
| Allocation1_InvoiceId | String | The unique identifier of the invoice to which the overpayment has been applied. This links the overpayment to a specific invoice. |
| Allocation1_InvoiceNumber | String | The invoice number associated with the allocation. This provides a reference to the invoice receiving the overpayment. |
| Allocation2_AppliedAmount | Decimal | The amount of the overpayment applied to another invoice. This is part of a second allocation, if applicable. |
| Allocation2_Date | Date | The date the second allocation was made. |
| Allocation2_InvoiceId | String | The identifier of the second invoice to which the overpayment has been applied. |
| Allocation2_InvoiceNumber | String | The invoice number for the second invoice receiving the overpayment. |
| PaymentIds | String | A comma-delimited list of payment IDs associated with the overpayment. This tracks the payments that are linked to the overpayment. |
| HasAttachments | Boolean | Indicates whether the overpayment has any attachments, such as receipts or supporting documents. This field helps identify overpayments with additional documentation. |
| TenantId | String | The unique identifier of the tenant. This ensures the query retrieves data specific to a particular tenant in multi-tenant environments. |