Retrieve either one or many BatchPayments for invoices
GET {{baseUrl}}/BatchPayments?where=<string>&order=<string>
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
where | string | Filter by an any element | |
order | string | Order by an any element |
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":"6ab84949-4fe5-4788-a135-4d8f690d24d7","Status":"OK","ProviderName":"Xero API Partner","DateTimeUTC":"/Date(1550866184006)/","BatchPayments":[{"Account":{"AccountID":"6f7594f2-f059-4d56-9e67-47ac9733bfe9"},"Reference":"Hello World","BatchPaymentID":"d0e9bbbf-5b8a-48b6-906a-035591fcb061","DateString":"2017-11-28T00:00:00","Date":"/Date(1511827200000+0000)/","Payments":[{"Invoice":{"InvoiceID":"0975dec2-0cf6-498d-9c9f-c6775b45c61d","Payments":[],"CreditNotes":[],"Prepayments":[],"Overpayments":[],"HasErrors":false,"IsDiscounted":false,"LineItems":[]},"PaymentID":"97ec2ef8-f4d6-4de5-9f2a-385d41cdc2fc","Amount":200.0},{"Invoice":{"InvoiceID":"600982d9-6605-4e11-afa1-d8dec2be7b52","Payments":[],"CreditNotes":[],"Prepayments":[],"Overpayments":[],"HasErrors":false,"IsDiscounted":false,"LineItems":[]},"PaymentID":"e232795f-b919-4865-a754-12f6ae8402c0","Amount":200.0},{"Invoice":{"InvoiceID":"99a2bd54-4ab1-413c-90bb-57f6464fe5d6","Payments":[],"CreditNotes":[],"Prepayments":[],"Overpayments":[],"HasErrors":false,"IsDiscounted":false,"LineItems":[]},"PaymentID":"c2d571a5-38ff-4d37-9d43-dfadb4ad53ff","Amount":200.0},{"Invoice":{"InvoiceID":"c81942c8-bfc5-4c88-a21a-b892a4a8c1c5","Payments":[],"CreditNotes":[],"Prepayments":[],"Overpayments":[],"HasErrors":false,"IsDiscounted":false,"LineItems":[]},"PaymentID":"0f3c18dc-49bd-47a4-a875-03c84a29978f","Amount":200.0},{"Invoice":{"InvoiceID":"6c9a1d89-8319-42f6-87d6-7690e748af85","Payments":[],"CreditNotes":[],"Prepayments":[],"Overpayments":[],"HasErrors":false,"IsDiscounted":false,"LineItems":[]},"PaymentID":"43541eed-f3ac-44ac-88cb-9fe1cb7ed8b8","Amount":200.0}],"Type":"RECBATCH","Status":"AUTHORISED","TotalAmount":1000.0,"UpdatedDateUTC":"/Date(1511893792820+0000)/","IsReconciled":false}]}