Xero Accounting Endpoint: Overpayments: Difference between revisions

(5 intermediate revisions by the same user not shown)

Line 1:

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

Line 31:

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

Line 47:

;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 67:

Line 68:

;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 86:

Line 87:

;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 100:

Line 101:

;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 106:

Line 107:

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

Line 134:

Line 135:

:[[Xero Accounting Endpoint: Payments|Payments]]

:[[Xero Accounting Endpoint: OverpaymentsExpanded|OverpaymentsExpanded]]

== Related Topics ==

:[[Xero Accounting Models]]

:[[Xero Accounting Endpoints]]

@@ Line 1: / Line 1: @@
 == 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.
@@ Line 31: / Line 31: @@
 :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 46: / Line 47: @@
 ;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 67: / Line 68: @@
 ;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 86: / Line 87: @@
 ;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 100: / Line 101: @@
 ;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 106: / Line 107: @@
 ;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.
@@ Line 134: / Line 135: @@
 :[[Xero Accounting Endpoint: Payments|Payments]]
 :[[Xero Accounting Endpoint: OverpaymentsExpanded|OverpaymentsExpanded]]
+== Related Topics ==
+:[[Xero Accounting Models]]
+:[[Xero Accounting Endpoints]]