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}/reports/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": {
    "transactionIdentifiers": ["B1488"]
  }
}

Filters Honored

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

Returns

On Success

The requested list of transaction metadata.

Response Body

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

Note

occurredAtLocal is machine-local time despite the shortened suffix. It predates the ...LocalTime naming convention described in DateTime Handling (contrast occurredAtLocalTime on the Transactions report). timeZone gives the zone it's expressed in.

On Error

HTTP Code	Error Code	Definition
400	DESERIALIZATION_ERROR	One or more of the provided transactionIdentifiers filter values could not be parsed as a valid transaction identifier.
403	DATA_ACCESS_VIOLATION	One or more of the specified transaction IDs belong to an organization you do not have access to.