Xero Accounting Endpoint: Overpayments: Difference between revisions
Jump to navigation
Jump to search
Created page with "== Overview == The Xero '''Overpayments''' endpoint provides the list of overpayments transactions recorded within Xero. This endpoint does not provide access..." |
No edit summary |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
== Overview == | == Overview == | ||
The Xero '''Overpayments''' [[Endpoints|endpoint]] provides the list of overpayments transactions recorded within Xero. | The Xero '''Overpayments''' [[Xero Accounting Endpoints|endpoint]] provides the list of overpayments transactions recorded within Xero. | ||
This endpoint does not provide access to all fields and details. It is optimised for small data files that do not have many overpayments. | This endpoint does not provide access to all fields and details. It is optimised for small data files that do not have many overpayments. | ||
| Line 31: | Line 31: | ||
:A [[Field Type: Text|text field]] that indicates the status of the overpayment. | :A [[Field Type: Text|text field]] that indicates the status of the overpayment. | ||
:Possible values are: | :Possible values are: | ||
:* '''AUTHORISED''': Indicates the transaction is authorised | :* '''AUTHORISED''': Indicates the transaction is authorised. | ||
:* ''' | :* '''PAID''': Indicates the transaction has been processed and paid. | ||
:* '''VOIDED''': Indicates the transaction has been deleted. | |||
;Contact | ;Contact | ||
| Line 46: | Line 47: | ||
;Subtotal | ;Subtotal | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the tax exclusive amount of the transaction. | ||
;TotalTax | ;TotalTax | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the tax amount of the transaction. | ||
;Total | ;Total | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the total amount of the transaction. | ||
;RemainingCredit | ;RemainingCredit | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the remaining credit that can be applied to other invoices. | ||
;CurrencyCode | ;CurrencyCode | ||
:A [[Field Type: Text|text field]] that indicates the [[Xero Accounting Endpoint: Currencies|currency]] of the | :A [[Field Type: Text|text field]] that indicates the [[Xero Accounting Endpoint: Currencies|currency]] of the transaction. | ||
;CurrencyRate | ;CurrencyRate | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the exchange rate applied to the transaction. | ||
;HasAttachments | ;HasAttachments | ||
| Line 67: | Line 68: | ||
;UpdatedDateUTC | ;UpdatedDateUTC | ||
:A [[Field Type: DateTimeOffset|date time field]] that indicates the date and time this | :A [[Field Type: DateTimeOffset|date time field]] that indicates the date and time this overpayment was created and/or updated. | ||
| Line 86: | Line 87: | ||
;Amount | ;Amount | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the amount associated with the payment. | ||
;CurrencyRate | ;CurrencyRate | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the exchange rate applicable. | ||
;Reference | ;Reference | ||
| Line 100: | Line 101: | ||
;Amount | ;Amount | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the amount allocated to an invoice. | ||
;Date | ;Date | ||
| Line 106: | Line 107: | ||
;Invoice | ;Invoice | ||
:A [[Field Type: Record|record field]] that provides the [[Xero Accounting | :A [[Field Type: Record|record field]] that provides the [[Xero Accounting Field: Invoices|invoice]] details. | ||
| Line 134: | Line 135: | ||
:[[Xero Accounting Endpoint: Payments|Payments]] | :[[Xero Accounting Endpoint: Payments|Payments]] | ||
:[[Xero Accounting Endpoint: OverpaymentsExpanded|OverpaymentsExpanded]] | :[[Xero Accounting Endpoint: OverpaymentsExpanded|OverpaymentsExpanded]] | ||
== Related Topics == | |||
:[[Xero Accounting Models]] | |||
:[[Xero Accounting Endpoints]] | |||
Latest revision as of 00:20, 22 September 2021
Overview
The Xero Overpayments endpoint provides the list of overpayments transactions recorded within Xero.
This endpoint does not provide access to all fields and details. It is optimised for small data files that do not have many overpayments.
In most situations, it is recommended to use the OverpaymentsExpanded. It provides many additional fields and is also optimised for larger data files.
Fields
The following fields are available for the Overpayments endpoint.
- OverpaymentID
- A guid field that provides the id of the overpayment.
- Type
- A text field that indicates the type of overpayment.
- Possible values are:
- RECEIVE-OVERPAYMENT: Indicates the overpayment is for accounts receivable / customer side.
- SPEND-OVERPAYMENT: Indicates the overpayment is for accounts payable / supplier side.
- Reference
- A text field that provides the reference of the overpayment.
- Date
- A date field that provides the date on which the overpayment occurred.
- Status
- A text field that indicates the status of the overpayment.
- Possible values are:
- AUTHORISED: Indicates the transaction is authorised.
- PAID: Indicates the transaction has been processed and paid.
- VOIDED: Indicates the transaction has been deleted.
- Contact
- A record field that provides the Contacts associated with the overpayment.
- Payments
- A table field that provides the payments information.
- See Payments Fields for more information.
- Allocations
- A table field that provides the amount allocated to the invoice.
- See Allocations Fields for more information.
- Subtotal
- A decimal field that provides the tax exclusive amount of the transaction.
- TotalTax
- A decimal field that provides the tax amount of the transaction.
- Total
- A decimal field that provides the total amount of the transaction.
- RemainingCredit
- A decimal field that provides the remaining credit that can be applied to other invoices.
- CurrencyCode
- A text field that indicates the currency of the transaction.
- CurrencyRate
- A decimal field that provides the exchange rate applied to the transaction.
- HasAttachments
- A true/false field that indicates if attachments were uploaded against the transaction.
- UpdatedDateUTC
- A date time field that indicates the date and time this overpayment was created and/or updated.
Payments Fields
The Payments Fields include the following sub fields.
- PaymentID
- A GUID field representing the internal id of a payment.
- This field can be linked to the Payments endpoint.
- BatchPaymentID
- A GUID field representing the internal id of a batch payment.
- This field can be linked to the BatchPayments endpoint.
- Date
- A date field that provides the date on which the link occurred.
- Amount
- A decimal field that provides the amount associated with the payment.
- CurrencyRate
- A decimal field that provides the exchange rate applicable.
- Reference
- A text field that provides the reference.
Allocations Fields
The Allocations Fields include the following sub fields.
- Amount
- A decimal field that provides the amount allocated to an invoice.
- Date
- A date field that provides the date on which the amount was allocated to an invcoice.
- Invoice
- A record field that provides the invoice details.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
Related Endpoints
- Accounts
- BankTransactions
- BankTransactionsExpanded
- BatchPayments
- Contacts
- ContactsExpanded
- Currencies
- Invoices
- InvoicesExpanded
- Payments
- OverpaymentsExpanded