# Overpayments

### Columns

| **Name**                                  | **Type**   | **Description**                                                                                                                                                   |
| ----------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| OverpaymentId \[KEY]                      | _String_   | The Id of the overpayment.                                                                                                                                        |
| Date                                      | _Date_     | The date the overpayment was made.                                                                                                                                |
| Type                                      | _String_   | The overpayment type. The valid values are RECEIVE-OVERPAYMENT and SPEND-OVERPAYMENT.                                                                             |
| RemainingCredit                           | _Decimal_  | The remaining credit balance on the overpayment.                                                                                                                  |
| Contact\_ContactId                        | _String_   | The Id of the contact.                                                                                                                                            |
| Contact\_Name                             | _String_   | The name of the contact.                                                                                                                                          |
| Status                                    | _String_   | The status of the overpayment. Valid values are AUTHORISED, PAID, and VOIDED.                                                                                     |
| SubTotal                                  | _Decimal_  | The subtotal for the overpayment, which excludes taxes.                                                                                                           |
| TotalTax                                  | _Decimal_  | The total tax for the overpayment.                                                                                                                                |
| Total                                     | _Decimal_  | The total for the overpayment, including tax -- the sum of SubTotal and TotalTax.                                                                                 |
| LineItem\_LineItemId                      | _String_   | The Xero generated identifier for a LineItem. If LineItemIDs are not included with line items in an update request then the line items are deleted and recreated. |
| LineItem\_Description                     | _String_   | The description for the line item. This field must contain at least 1 character and is required to create an approved invoice.                                    |
| LineItem\_Quantity                        | _Double_   | The quantity of the associated item in the line item. This field is required for invoice approval and must be zero or positive.                                   |
| LineItem\_UnitAmount                      | _Decimal_  | The unit amount of the associated item in the line item. This field is required for invoice approval.                                                             |
| LineItem\_ItemCode                        | _String_   | The code that identifies the associated item.                                                                                                                     |
| LineItem\_AccountCode                     | _String_   | The account code. This must be active for the organisation. This field is required for invoice approval.                                                          |
| LineItem\_TaxType                         | _String_   | The tax type. This field is used to override AccountCode, the default tax code for the selected account.                                                          |
| LineItem\_TaxAmount                       | _Decimal_  | The automatically calculated percentage of tax, based on the tax rate, for the line amount.                                                                       |
| LineItem\_LineAmount                      | _Decimal_  | The total of the quantity multiplied by the unit amount with any discounts applied.                                                                               |
| LineItem\_TrackingCategory1\_CategoryId   | _String_   | The Id of a tracking category. The API allows two optional tracking categories to be defined.                                                                     |
| LineItem\_TrackingCategory1\_CategoryName | _String_   | The name of a tracking category. The API allows two optional tracking categories to be defined.                                                                   |
| LineItem\_TrackingCategory1\_OptionId     | _String_   | The Id of a tracking category. The API allows two optional tracking categories to be defined.                                                                     |
| LineItem\_TrackingCategory1\_OptionName   | _String_   | The option of a tracking category. The API allows two optional tracking categories to be defined.                                                                 |
| LineItem\_TrackingCategory1\_Option\_Stat | _String_   | The status of a tracking category. The API allows two optional tracking categories to be defined.                                                                 |
| LineItem\_TrackingCategory2\_CategoryId   | _String_   | The Id of a tracking category. The API allows two optional tracking categories to be defined.                                                                     |
| LineItem\_TrackingCategory2\_CategoryName | _String_   | The name of a tracking category. The API allows two optional tracking categories to be defined.                                                                   |
| LineItem\_TrackingCategory2\_OptionId     | _String_   | The Id of a tracking category. The API allows two optional tracking categories to be defined.                                                                     |
| LineItem\_TrackingCategory2\_OptionName   | _String_   | The option of a tracking category. The API allows two optional tracking categories to be defined.                                                                 |
| LineItem\_TrackingCategory2\_Option\_Stat | _String_   | The status of a tracking category. The API allows two optional tracking categories to be defined.                                                                 |
| LineItem\_DiscountRate                    | _Double_   | The discount percentage being applied to the line item. Discounts are only supported on ACCREC-type (sales) invoices.                                             |
| LineAmountTypes                           | _String_   | The LineAmount Type of the overpayment. Valid values are Exclusive, Inclusive, and NoTax.                                                                         |
| CurrencyCode                              | _String_   | Currency used for the overpayment.                                                                                                                                |
| CurrencyRate                              | _String_   | The currency rate for a multicurrency overpayment. If no rate is specified, the XE.com day rate is used.                                                          |
| UpdatedDateUTC                            | _Datetime_ | The date when the overpayment was last updated.                                                                                                                   |
| Allocation1\_AppliedAmount                | _Decimal_  | The amount to be applied from this credit note to a given invoice.                                                                                                |
| Allocation1\_Date                         | _Date_     | The date the allocation was made.                                                                                                                                 |
| Allocation1\_InvoiceId                    | _String_   | The Id of the invoice this allocation has been applied to.                                                                                                        |
| Allocation1\_InvoiceNumber                | _String_   | The Invoice this allocation has been applied to.                                                                                                                  |
| Allocation2\_AppliedAmount                | _Decimal_  | The amount to be applied from this credit note to a given invoice.                                                                                                |
| Allocation2\_Date                         | _Date_     | The date the allocation was made.                                                                                                                                 |
| Allocation2\_InvoiceId                    | _String_   | The Id of the invoice this allocation has been applied to.                                                                                                        |
| Allocation2\_InvoiceNumber                | _String_   | The Invoice this allocation has been applied to.                                                                                                                  |
| HasAttachments                            | _Boolean_  | Boolean to indicate if a overpayment has an attachment.                                                                                                           |
| TenantId                                  | _String_   | The ID of the tenant to query instead of the connection tenant                                                                                                    |
