Xero Accounting Endpoint: OverpaymentsExpanded: Difference between revisions

(4 intermediate revisions by the same user not shown)

Line 1:

== 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.

Line 30:

: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.

:* '''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

Line 56:

Line 57:

;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

: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

: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

: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

: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

: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

Line 77:

Line 78:

;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.

Line 96:

Line 97:

;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

: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

Line 110:

Line 111:

;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

Line 130:

Line 131:

;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

: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

: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

Line 180:

Line 181:

:[[Xero Accounting Endpoint: TaxRates|TaxRates]]

:[[Xero Accounting Endpoint: TrackingCategories|TrackingCategories]]

== Related Topics ==

:[[Xero Accounting Models]]

:[[Xero Accounting Endpoints]]

@@ Line 1: / Line 1: @@
 == 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.
@@ Line 30: / Line 30: @@
 :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.
+:* '''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
@@ Line 56: / Line 57: @@
 ;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
-: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
-: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
-: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
-: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
-: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
@@ Line 77: / Line 78: @@
 ;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.
@@ Line 96: / Line 97: @@
 ;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
-: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
@@ Line 110: / Line 111: @@
 ;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
@@ Line 130: / Line 131: @@
 ;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
-: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
-: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
@@ Line 180: / Line 181: @@
 :[[Xero Accounting Endpoint: TaxRates|TaxRates]]
 :[[Xero Accounting Endpoint: TrackingCategories|TrackingCategories]]
+== Related Topics ==
+:[[Xero Accounting Models]]
+:[[Xero Accounting Endpoints]]