Use this method to retrieve Overpayments
||See Overpayment Types
||The date the overpayment was made YYYY-MM-DD
||See Overpayment Status Codes
||See Overpayment Line Amount Types
||See Overpayment Line Items
||The subtotal of the overpayment excluding taxes
||The total tax on the overpayment
||The total of the overpayment (subtotal + total tax)
||UTC timestamp of last update to the overpayment
||Currency used for the overpayment
||Xero generated unique identifier
||The currency rate for a multicurrency overpayment. If no rate is specified, the XE.com day rate is used
||The remaining credit balance on the overpayment
||boolean to indicate if a overpayment has an attachment
|Elements for Line Items
||Description needs to be at least 1 char long. A line item with just a description (i.e no unit amount or quantity) can be created by specifying just a Description element that contains at least 1 character
||Lineitem unit amount. By default, unit amount will be rounded to two decimal places. You can opt in to use four decimal places by adding the querystring parameter unitdp=4 to your query. See the Rounding in Xero guide for more information.
||Used as an override if the default Tax Code for the selected AccountCode is not correct - see TaxTypes.
||The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. This value can be overriden if the calculated TaxAmount is not correct.
||If you wish to omit either of the Quantity or UnitAmount you can provide a LineAmount and Xero will calculate the missing amount for you.
||Optional Tracking Category - see Tracking. Any LineItem can have a maximum of 2 TrackingCategory elements.
Optional parameters for GET Overpayments
||You can specify an individual record by appending the OverpaymentID to the endpoint, i.e.
||The ModifiedAfter filter is actually an HTTP header: 'If-Modified-Since'.
A UTC timestamp (yyyy-mm-ddThh:mm:ss) . Only overpayments created or modified since this timestamp will be returned e.g. 2009-11-12T00:00:00
||Filter by an any element (see Filters)
||Order by any element returned (see Order By)
||e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment
Example response for retrieving Overpayments