boolean to indicate if a overpayment has an attachment
Elements for Line Items
All of these elements are returned on a GET request.
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 value to the endpoint, i.e.
OverpaymentID - The Xero identifier for an overpayment
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
Use this endpoint to allocate part or full amounts of an overpayment to outstanding invoices.
Elements for Allocations
the invoice the overpayment is being allocated against
the amount being applied to the invoice
the date the overpayment is applied YYYY-MM-DD (read-only). This will be the latter of the invoice date and the overpayment date.
Below is an example of allocating $60.50 from an RECEIVE-OVERPAYMENT to an outstanding ACCREC invoice for the same contact. Note the URL needs to specify the overpayment that you are allocating e.g. PUT Overpayments/b356e488-2678-4be4-ad4b-d294df2d48d6/Allocations