Xero Accounting Endpoint: OverpaymentsExpanded - Revision history

Nic at 05:20, 22 September 2021

2021-09-22T05:20:38Z

← Older revision		Revision as of 00:20, 22 September 2021
Line 1:		Line 1:
	== Overview ==		== Overview ==

	The Xero '''OverpaymentsExpanded''' [[Endpoints\|endpoint]] provides the list of overpayments transactions recorded within Xero.		The Xero '''OverpaymentsExpanded''' [[Xero Accounting Endpoints\|endpoint]] provides the list of overpayments transactions recorded within Xero.

	This endpoints provides access to all fields and details. It is also optimised for larger data files.		This endpoints provides access to all fields and details. It is also optimised for larger data files.
Line 181:		Line 181:
	:[[Xero Accounting Endpoint: TaxRates\|TaxRates]]		:[[Xero Accounting Endpoint: TaxRates\|TaxRates]]
	:[[Xero Accounting Endpoint: TrackingCategories\|TrackingCategories]]		:[[Xero Accounting Endpoint: TrackingCategories\|TrackingCategories]]


			== Related Topics ==

			:[[Xero Accounting Models]]
			:[[Xero Accounting Endpoints]]

Nic at 04:28, 22 September 2021

2021-09-22T04:28:07Z

← Older revision		Revision as of 23:28, 21 September 2021
Line 57:		Line 57:

	;Subtotal		;Subtotal
	:A [[Field Type: Decimal\|decimal ~~value~~]] that provides the tax exclusive amount of the transaction.		:A [[Field Type: Decimal\|decimal field]] that provides the tax exclusive amount of the transaction.

	;TotalTax		;TotalTax
	:A [[Field Type: Decimal\|decimal ~~value~~]] that provides the tax amount of the transaction.		:A [[Field Type: Decimal\|decimal field]] that provides the tax amount of the transaction.

	;Total		;Total
	:A [[Field Type: Decimal\|decimal ~~value~~]] that provides the total amount of the transaction.		:A [[Field Type: Decimal\|decimal field]] that provides the total amount of the transaction.

	;RemainingCredit		;RemainingCredit
	:A [[Field Type: Decimal\|decimal ~~value~~]] that provides the remaining credit that can be applied to other invoices.		:A [[Field Type: Decimal\|decimal field]] that provides the remaining credit that can be applied to other invoices.

	;CurrencyCode		;CurrencyCode
Line 72:		Line 72:

	;CurrencyRate		;CurrencyRate
	:A [[Field Type: Decimal\|decimal ~~value~~]] that provides the exchange rate applied to the transaction.		:A [[Field Type: Decimal\|decimal field]] that provides the exchange rate applied to the transaction.

	;HasAttachments		;HasAttachments
Line 97:		Line 97:

	;Amount		;Amount
	:A [[Field Type: Decimal\|decimal ~~value~~]] that provides the amount associated with the payment.		:A [[Field Type: Decimal\|decimal field]] that provides the amount associated with the payment.

	;CurrencyRate		;CurrencyRate
	:A [[Field Type: Decimal\|decimal ~~value~~]] that provides the exchange rate applicable.		:A [[Field Type: Decimal\|decimal field]] that provides the exchange rate applicable.

	;Reference		;Reference
Line 111:		Line 111:

	;Amount		;Amount
	:A [[Field Type: Decimal\|decimal ~~value~~]] that provides the amount allocated to an invoice.		:A [[Field Type: Decimal\|decimal field]] that provides the amount allocated to an invoice.

	;Date		;Date
Line 131:		Line 131:

	;UnitAmount		;UnitAmount
	:A [[Field Type: Decimal\|decimal ~~value~~]] that provides the unit amount of the line.		:A [[Field Type: Decimal\|decimal field]] that provides the unit amount of the line.

	;LineAmount		;LineAmount
	:A [[Field Type: Decimal\|decimal ~~value~~]] that provides the amount of the line.		:A [[Field Type: Decimal\|decimal field]] that provides the amount of the line.

	;TaxAmount		;TaxAmount
	:A [[Field Type: Decimal\|decimal ~~value~~]] that provides the tax amount of the line.		:A [[Field Type: Decimal\|decimal field]] that provides the tax amount of the line.

	;AccountID		;AccountID

Nic at 06:38, 21 September 2021

2021-09-21T06:38:59Z

← Older revision		Revision as of 01:38, 21 September 2021
Line 69:		Line 69:

	;CurrencyCode		;CurrencyCode
	:A [[Field Type: Text\|text field]] that indicates the [[Xero Accounting Endpoint: Currencies\|currency]] of the ~~bank~~ transaction.		:A [[Field Type: Text\|text field]] that indicates the [[Xero Accounting Endpoint: Currencies\|currency]] of the transaction.

	;CurrencyRate		;CurrencyRate

Nic at 05:42, 21 September 2021

2021-09-21T05:42:46Z

← Older revision		Revision as of 00:42, 21 September 2021
Line 78:		Line 78:

	;UpdatedDateUTC		;UpdatedDateUTC
	:A [[Field Type: DateTimeOffset\|date time field]] that indicates the date and time this ~~batch payment~~ was created and/or updated.		:A [[Field Type: DateTimeOffset\|date time field]] that indicates the date and time this overpayment was created and/or updated.

Nic at 05:32, 21 September 2021

2021-09-21T05:32:48Z

← Older revision		Revision as of 00:32, 21 September 2021
Line 30:		Line 30:
	: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 ~~and~~ has been processed.		:* '''AUTHORISED''': Indicates the transaction is authorised.
	:* '''~~DELETED~~''': Indicates the transaction has been deleted.		:* '''PAID''': Indicates the transaction has been processed and paid.
			:* '''VOIDED''': Indicates the transaction has been deleted.

	;Contact		;Contact

Nic at 05:30, 21 September 2021

2021-09-21T05:30:12Z

← Older revision		Revision as of 00:30, 21 September 2021
Line 116:		Line 116:

	;Invoice		;Invoice
	:A [[Field Type: Record\|record field]] that provides the [[Xero Accounting ~~Endpoint~~: Invoices\|invoice]] details.		:A [[Field Type: Record\|record field]] that provides the [[Xero Accounting Field: Invoices\|invoice]] details.

Nic: Created page with "== Overview == The Xero '''OverpaymentsExpanded''' endpoint provides the list of overpayments transactions recorded within Xero. This endpoints provides access..."

2021-09-21T05:24:14Z

Created page with "== Overview == The Xero '''OverpaymentsExpanded''' endpoint provides the list of overpayments transactions recorded within Xero. This endpoints provides access..."

New page

== Overview ==

The Xero '''OverpaymentsExpanded''' [[Endpoints|endpoint]] provides the list of overpayments transactions recorded within Xero.

This endpoints provides access to all fields and details. It is also optimised for larger data files.

In most situations, it is recommended to use this endpoint instead of the [[Xero Accounting Endpoint: Overpayments|Overpayments]] endpoint.

== Fields ==

The following fields are available for the OverpaymentsExpanded endpoint.

;OverpaymentID
:A [[Field Type: GUID|guid field]] that provides the id of the overpayment.

;Type
:A [[Field Type: Text|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 [[Field Type: Text|text field]] that provides the reference of the overpayment.

;Date
:A [[Field Type: Date|date field]] that provides the date on which the overpayment occurred.

;Status
:A [[Field Type: Text|text field]] that indicates the status of the overpayment.
:Possible values are:
:* '''AUTHORISED''': Indicates the transaction is authorised and has been processed.
:* '''DELETED''': Indicates the transaction has been deleted.

;Contact
:A [[Field Type: Record|record field]] that provides the [[Xero Accounting Field: Contacts|Contacts]] associated with the overpayment.

;Payments
:A [[Field Type: Table|table field]] that provides the payments information.
:See [[#Payments Fields|Payments Fields]] for more information.

;Allocations
:A [[Field Type: Table|table field]] that provides the amount allocated to the invoice.
:See [[#Allocations Fields|Allocations Fields]] for more information.

;LineAmountTypes
:A [[Field Type: Text|text field]] that indicates the type of values on the lines.
:Possible values are:
:* '''Exclusive''': Indicates that line items are exclusive of tax.
:* '''Inclusive''': Indicates that line items are inclusive tax.
:* '''NoTax''': Indicates that line items have no tax.

;LineItems
:A [[Field Type: Table|table field]] that provides the invoice-like lines entered against the overpayment.
:See [[#LineItems Fields|LineItems Fields]] for more information.

;Subtotal
:A [[Field Type: Decimal|decimal value]] that provides the tax exclusive amount of the transaction.

;TotalTax
:A [[Field Type: Decimal|decimal value]] that provides the tax amount of the transaction.

;Total
:A [[Field Type: Decimal|decimal value]] that provides the total amount of the transaction.

;RemainingCredit
:A [[Field Type: Decimal|decimal value]] that provides the remaining credit that can be applied to other invoices.

;CurrencyCode
:A [[Field Type: Text|text field]] that indicates the [[Xero Accounting Endpoint: Currencies|currency]] of the bank transaction.

;CurrencyRate
:A [[Field Type: Decimal|decimal value]] that provides the exchange rate applied to the transaction.

;HasAttachments
:A [[Field Type: Boolean|true/false field]] that indicates if attachments were uploaded against the transaction.

;UpdatedDateUTC
:A [[Field Type: DateTimeOffset|date time field]] that indicates the date and time this batch payment was created and/or updated.

== Payments Fields ==

The [[#Fields|Payments Fields]] include the following sub fields.

;PaymentID
:A [[Field Type: GUID|GUID field]] representing the internal id of a payment.
:This field can be linked to the [[Xero Accounting Endpoint: Payments|Payments]] endpoint.

;BatchPaymentID
:A [[Field Type: GUID|GUID field]] representing the internal id of a batch payment.
:This field can be linked to the [[Xero Accounting Endpoint: BatchPayments|BatchPayments]] endpoint.

;Date
:A [[Field Type: Date|date field]] that provides the date on which the link occurred.

;Amount
:A [[Field Type: Decimal|decimal value]] that provides the amount associated with the payment.

;CurrencyRate
:A [[Field Type: Decimal|decimal value]] that provides the exchange rate applicable.

;Reference
:A [[Field Type: Text|text field]] that provides the reference.

== Allocations Fields ==

The [[#Fields|Allocations Fields]] include the following sub fields.

;Amount
:A [[Field Type: Decimal|decimal value]] that provides the amount allocated to an invoice.

;Date
:A [[Field Type: Date|date field]] that provides the date on which the amount was allocated to an invcoice.

;Invoice
:A [[Field Type: Record|record field]] that provides the [[Xero Accounting Endpoint: Invoices|invoice]] details.

== LineItems Fields ==

The [[#Fields|LineItems Fields]] include the following sub fields.

;LineItemID
:A [[Field Type: Text|text field]] that provides the internal id of the line.

;Description
:A [[Field Type: Text|text field]] that provides the description of the line.

;UnitAmount
:A [[Field Type: Decimal|decimal value]] that provides the unit amount of the line.

;LineAmount
:A [[Field Type: Decimal|decimal value]] that provides the amount of the line.

;TaxAmount
:A [[Field Type: Decimal|decimal value]] that provides the tax amount of the line.

;AccountID
:A [[Field Type: Text|text field]] that provides the [[Xero Accounting Endpoint: Accounts|account id]] of the line.

;AccountCode
:A [[Field Type: Text|text field]] that provides the [[Xero Accounting Endpoint: Accounts|account code]] of the line.

;TaxType
:A [[Field Type: Text|text field]] that provides the [[Xero Accounting Field: TaxTypes|tax type]] of the line.

;Tracking
:A [[Field Type: Table|table field]] that provides the [[Xero Accounting Endpoint: TrackingCategories|tracking category options]] assigned to the line.

== Xero API ==

For a detailed run through of the endpoint, you can see the [https://developer.xero.com/documentation/api/accounting/overpayments Xero API].

== Related Fields ==

:[[Xero Accounting Field: Accounts|Accounts]]
:[[Xero Accounting Field: Contacts|Contacts]]
:[[Xero Accounting Field: Invoices|Invoices]]
:[[Xero Accounting Field: TaxTypes|TaxTypes]]
:[[Xero Accounting Field: TrackingCategories|TrackingCategories]]

== Related Endpoints ==

:[[Xero Accounting Endpoint: Accounts|Accounts]]
:[[Xero Accounting Endpoint: BankTransactions|BankTransactions]]
:[[Xero Accounting Endpoint: BankTransactionsExpanded|BankTransactionsExpanded]]
:[[Xero Accounting Endpoint: BatchPayments|BatchPayments]]
:[[Xero Accounting Endpoint: Contacts|Contacts]]
:[[Xero Accounting Endpoint: ContactsExpanded|ContactsExpanded]]
:[[Xero Accounting Endpoint: Currencies|Currencies]]
:[[Xero Accounting Endpoint: Invoices|Invoices]]
:[[Xero Accounting Endpoint: InvoicesExpanded|InvoicesExpanded]]
:[[Xero Accounting Endpoint: Payments|Payments]]
:[[Xero Accounting Endpoint: Overpayments|Overpayments]]
:[[Xero Accounting Endpoint: TaxRates|TaxRates]]
:[[Xero Accounting Endpoint: TrackingCategories|TrackingCategories]]