Allows you to retrieve prepayments
GET {{baseUrl}}/Prepayments?where=<string>&order=<string>&page=<integer>&unitdp=<integer>
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
where | string | Filter by an any element | |
order | string | Order by an any element | |
page | string | e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment | |
unitdp | string | e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
If-Modified-Since | string | Only records created or modified since this timestamp will be returned | |
xero-tenant-id | string | (Required) Xero identifier for Tenant |
RESPONSES
status: OK
{"Id":"d7a9ca0c-6159-4c26-ad2e-715440c50b7d","Status":"OK","ProviderName":"Provider Name Example","DateTimeUTC":"/Date(1552489227595)/","Prepayments":[{"PrepaymentID":"ce0cddef-cf5a-4e59-b638-f225679115a7","ID":"ce0cddef-cf5a-4e59-b638-f225679115a7","Type":"RECEIVE-PREPAYMENT","Reference":"INV-0011","RemainingCredit":3450.0,"Allocations":[],"Payments":[],"HasAttachments":true,"Contact":{"ContactID":"be392c72-c121-4f83-9512-03ac71e54c20","Name":"Luke Skywalker","Addresses":[],"Phones":[],"ContactGroups":[],"ContactPersons":[],"HasValidationErrors":false},"DateString":"2019-03-13T00:00:00","Date":"/Date(1552435200000+0000)/","Status":"AUTHORISED","LineAmountTypes":"Exclusive","LineItems":[],"SubTotal":3000.0,"TotalTax":450.0,"Total":3450.0,"UpdatedDateUTC":"/Date(1552489187730+0000)/","CurrencyCode":"NZD"}]}