Get Transactions

Retrieves a set of transactions.

Note that your datetime filters will be clamped to a maximum range of thirty-one days following the processes laid out in DateTime Handling. Page sizes larger than 100 will be clamped down for performance reasons.

Verb	POST
Endpoint	{base-url}/transactions/
Max Page Size	100

Request Body

{
  "requestFilter": {
    "organizationIds": [1],
    "accountIds": [1],
    "siteIds": [1],
    "machineIdentifiers": ["1", "PROSE123456789"],
    "startDate": "2021-11-15T18:07:05.477",
    "endDate": "2021-11-15T18:07:05.477"
  },
  "routeFilter": {
    "transactionIdentifiers": ["B1488"]
  }
}

Filters Honored

• RequestFilter
  • organizationIds
  • accountIds
  • siteIds
  • machineIdentifiers
  • startDate
  • endDate
• TransactionFilter
  • transactionIdentifiers

Returns

On Success

The requested list of transactions.

Response Body

[
  {
    "id": "B1467",
    "recordedAtUtc": "2021-11-16T22:51:35.16",
    "siteId": 1658,
    "siteExternalId": "",
    "siteName": "Khadeer 1",
    "machineId": 11252,
    "machineExternalId": null,
    "machineName": "Khadeer Machine 1",
    "machineModel": "VCController_10_10_69",
    "totalPrice": 1.0,
    "totalTax": 0.0,
    "lineItems": [
      {
        "id": 3527998,
        "selection": "10",
        "vendOrder": 1,
        "productId": 18333,
        "productName": "Chicken",
        "productUpc": "9046d33f79574eb9af9abf827e6c292d",
        "size": "1 fl. oz.",
        "taxRate": 0.0,
        "taxCharged": 0.0,
        "commission": 0.0,
        "quantity": 1,
        "unitPrice": 1.0,
        "totalPrice": 1.0,
        "vendWasSuccessful": true,
        "recordedAtUtc": "2021-11-16T22:51:35.193",
        "occurredAtUtc": "2021-11-16T22:51:31",
        "occurredAtLocalTime": "2021-11-16T10:51:31"
      }
    ],
    "paymentInformation": {
      "type": "A ",
      "creditInformation": {
        "gateway": "A",
        "invoiceNumber": 511005,
        "cardToken": null,
        "authorizationNumber": null,
        "referenceNumber1": "",
        "referenceNumber2": null,
        "paymentStatus": "charged"
      },
      "accountInformation": {
        "accountNumber": "1234",
        "nameOnAccount": "Bobbin Bob"
      }
    }
  }
]