Allows you to retrieve overpayments
GET {{baseUrl}}/Overpayments?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 overpayments 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":"c0ce675e-e5bc-4b2a-a20e-76a9eaedf89d","Status":"OK","ProviderName":"Provider Name Example","DateTimeUTC":"/Date(1552428951416)/","Overpayments":[{"OverpaymentID":"098b4dcb-5622-4699-87f8-9d40c4ccceb3","ID":"098b4dcb-5622-4699-87f8-9d40c4ccceb3","Type":"SPEND-OVERPAYMENT","RemainingCredit":500.0,"Allocations":[],"Payments":[],"HasAttachments":false,"Contact":{"ContactID":"af3ffcc1-c578-4658-82f3-5d8d458cc7af","Name":"Daddy Warbucks","Addresses":[],"Phones":[],"ContactGroups":[],"ContactPersons":[],"HasValidationErrors":false},"DateString":"2019-03-12T00:00:00","Date":"/Date(1552348800000+0000)/","Status":"AUTHORISED","LineAmountTypes":"NoTax","LineItems":[],"SubTotal":500.0,"TotalTax":0.0,"Total":500.0,"UpdatedDateUTC":"/Date(1552428535123+0000)/","CurrencyCode":"NZD"},{"OverpaymentID":"2a8bda49-8908-473b-8bcf-1f90990460eb","ID":"2a8bda49-8908-473b-8bcf-1f90990460eb","Type":"RECEIVE-OVERPAYMENT","RemainingCredit":20.0,"Allocations":[],"Payments":[],"HasAttachments":false,"Contact":{"ContactID":"430fa14a-f945-44d3-9f97-5df5e28441b8","Name":"Liam Gallagher","Addresses":[],"Phones":[],"ContactGroups":[],"ContactPersons":[],"HasValidationErrors":false},"DateString":"2019-03-13T00:00:00","Date":"/Date(1552435200000+0000)/","Status":"AUTHORISED","LineAmountTypes":"NoTax","LineItems":[],"SubTotal":20.0,"TotalTax":0.0,"Total":20.0,"UpdatedDateUTC":"/Date(1552428568250+0000)/","CurrencyCode":"NZD"},{"OverpaymentID":"ed7f6041-c915-4667-bd1d-54c48e92161e","ID":"ed7f6041-c915-4667-bd1d-54c48e92161e","Type":"SPEND-OVERPAYMENT","RemainingCredit":3000.0,"Allocations":[],"Payments":[],"HasAttachments":false,"Contact":{"ContactID":"430fa14a-f945-44d3-9f97-5df5e28441b8","Name":"Liam Gallagher","Addresses":[],"Phones":[],"ContactGroups":[],"ContactPersons":[],"HasValidationErrors":false},"DateString":"2019-03-12T00:00:00","Date":"/Date(1552348800000+0000)/","Status":"AUTHORISED","LineAmountTypes":"NoTax","LineItems":[],"SubTotal":3000.0,"TotalTax":0.0,"Total":3000.0,"UpdatedDateUTC":"/Date(1552428781527+0000)/","CurrencyCode":"NZD"},{"OverpaymentID":"0859adbc-ea00-40cd-a877-258cf8644975","ID":"0859adbc-ea00-40cd-a877-258cf8644975","Type":"RECEIVE-OVERPAYMENT","RemainingCredit":20.0,"Allocations":[],"Payments":[],"HasAttachments":false,"Contact":{"ContactID":"430fa14a-f945-44d3-9f97-5df5e28441b8","Name":"Liam Gallagher","Addresses":[],"Phones":[],"ContactGroups":[],"ContactPersons":[],"HasValidationErrors":false},"DateString":"2019-03-13T00:00:00","Date":"/Date(1552435200000+0000)/","Status":"AUTHORISED","LineAmountTypes":"NoTax","LineItems":[],"SubTotal":20.0,"TotalTax":0.0,"Total":20.0,"UpdatedDateUTC":"/Date(1552428842190+0000)/","CurrencyCode":"NZD"},{"OverpaymentID":"687b877f-634a-415d-92b2-74e62977de30","ID":"687b877f-634a-415d-92b2-74e62977de30","Type":"RECEIVE-OVERPAYMENT","RemainingCredit":20.0,"Allocations":[],"Payments":[],"HasAttachments":false,"Contact":{"ContactID":"430fa14a-f945-44d3-9f97-5df5e28441b8","Name":"Liam Gallagher","Addresses":[],"Phones":[],"ContactGroups":[],"ContactPersons":[],"HasValidationErrors":false},"DateString":"2019-03-13T00:00:00","Date":"/Date(1552435200000+0000)/","Status":"AUTHORISED","LineAmountTypes":"NoTax","LineItems":[],"SubTotal":20.0,"TotalTax":0.0,"Total":20.0,"UpdatedDateUTC":"/Date(1552428950730+0000)/","CurrencyCode":"NZD"}]}