List customer receipts
GET
Returns customer payments received against credit sales. Filter by customerNumber and a received-date range (from, to); paginated with 0-based page and size (default 20).
BearerAuthheader
AuthorizationBearer <JWT>customerNumber?stringOnly receipts from this customer number.
from?stringStart date, YYYY-MM-DD.
Format
dateto?stringEnd date, YYYY-MM-DD.
Format
datepage?integerPage number, starting at 0. See Paging.
Format
int32Default
0size?integerNumber of records per page.
Format
int32Default
20X-TenantID*stringYour merchant's tenant code — the value typed in the Domain field on the iotoms login screen. See Concepts.
OK
*/*- response
status*stringOutcome of the call: SUCCESS when the request was processed; otherwise an error status.
message*stringShort human-readable message describing the outcome, e.g. which record was saved or why the call failed.
data?One page of customer receipts, latest received date first.
Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/receivables/receipts' \ -H 'X-TenantID: your-tenant-code'Example Response
{ "status": "string", "message": "string", "data": { "content": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "receiptNumber": "string", "customerNumber": "string", "amount": 0, "allocatedAmount": 0, "unallocatedAmount": 0, "mode": "CASH", "status": "POSTED", "reference": "string", "receivedOn": "2019-08-24", "notes": "string", "dayCycleId": "bbed7a30-80be-4ccf-810d-a33c370a67d1", "collectedBy": "string", "reversalOfId": "91205805-6131-4e22-87c1-99e3bbb30d9b", "reversalReason": "string", "allocations": [ { "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc", "invoiceNumber": "string", "amount": 0 } ], "createdAt": "2019-08-24T14:15:22Z", "createdBy": "string" } ], "page": 0, "size": 0, "totalElements": 0, "totalPages": 0 }}