Get Transaction Metadata

Retrieves a set of transaction metadata.

Note that your datetime filters will be clamped to a maximum range of one year 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/metadata
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": {
    "transactionIds": ["B1488"]
  }
}

Filters Honored

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

Returns

On Success

The requested list of transactions.

Response Body

[
  {
    "transactionId": "B1467",
    "recordedAtUtc": "2021-11-16T22:51:35.16",
    "tags": [],
    "files": [],
    "lineItems": [
      {
        "lineItemId": 3527998,
        "recordedAtUtc": "2021-11-16T22:51:35.193",
        "occurredAtUtc": "2021-11-16T22:51:31",
        "occurredAtLocal": "2021-11-16T10:51:31",
        "tags": [],
        "files": []
      }
    ]
  }
]