iotoms Docs

List transactions

GET
/api/v1/transaction/transactions

Returns sales, paginated with 0-based page and size (default 20). Filter by one of dayCycleId, registerId, a businessDateFrom/businessDateTo range or a single businessDate; if several are sent, they are applied in that order of priority and the rest are ignored. Filtered results come newest first; with no filter the order is not guaranteed. Entries carry header totals only; use Get a transaction for lines and payments.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

businessDate?string

Single trading date to list, YYYY-MM-DD. Ignored when a day cycle, register or full date range is given.

businessDateFrom?string

Start of a trading date range, YYYY-MM-DD. Used only together with businessDateTo.

businessDateTo?string

End of a trading date range, YYYY-MM-DD (inclusive). Used only together with businessDateFrom.

dayCycleId?string

Only sales of this day cycle (a salesperson's working day). Takes priority over all other filters.

Formatuuid
registerId?integer

Only sales made on this register, from List registers. Ignored when dayCycleId is given.

Formatint64
page?integer

Page number, starting at 0. See Paging.

Formatint32
Default0
size?integer

Number of records per page.

Formatint32
Default20

Header Parameters

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request was handled, ERROR otherwise.

message*string

Short human-readable message describing the outcome, e.g. which record was fetched or saved.

data?array<>|

The sales on this page, newest first.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/transaction/transactions'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",      "cartId": "string",      "clientTransactionId": "string",      "channel": "LINE_DISTRIBUTION",      "contextType": "STORE_VISIT",      "businessDate": "2019-08-24",      "dayCycleId": "bbed7a30-80be-4ccf-810d-a33c370a67d1",      "storeId": 0,      "storeName": "string",      "registerId": 0,      "customerNumber": "string",      "invoiceNumber": "string",      "subtotal": 0,      "taxTotal": 0,      "discountTotal": 0,      "grandTotal": 0,      "paymentStatus": "Paid",      "cashCollected": 0,      "creditIssued": 0,      "paymentMode": "string",      "syncStatus": "string",      "soldBy": "string",      "createdAt": "2019-08-24T14:15:22Z",      "lines": [        {          "itemId": "string",          "description": "string",          "quantitySold": 0,          "unitPrice": 0,          "discountAmount": 0,          "taxAmount": 0,          "lineSubtotal": 0,          "lineTotal": 0,          "quantityReturned": 0,          "quantityReturnable": 0        }      ],      "payments": [        {          "mode": "CASH",          "amount": 0        }      ],      "returnSummary": {        "totalReturnedAmount": 0,        "returnCount": 0,        "status": "string"      }    }  ]}