Transactions

Retrieve the list of Transactions, their matches, and their reconciliation status.

POST	/v1/api/:orgId/transactions

Attribute	Definition
orgId UUID	Organization ID, can be found on the Developers page.

Request Body

{
  "datasetId": UUID,
  "limit": 0,
  "offest": 0,
  "from": 0,
  "to": 0,
  "search": [],
  "columns": []
}

Attribute	Definition
datasetId UUID	Source ID, see Sources for more details
limit integer	Number of records to fetch, see Pagination for more details optional
offset integer	Number of records to fetch, see Pagination for more details optional
from integer	Transaction epoch timestamp in milliseconds from which to fetch optional
to integer	Transaction epoch timestamp in milliseconds to which to fetch optional
search SearchQuery[]	An array of filters, with an AND operator between criteria. See Querying for more details optional
columns SearchQuery[]	List of columns to include in the response optional

Response Body

[{
  "id": "",
  "datasetId": "",
  "reconciliationStatus": "",
  "incomingMatches": [],
  "outgoingMatches": [],
  "description": "",
  "type": "",
  "timestamp": 0
}]

Attribute	Definition
id UUID	Ledge ID for the line
datasetId UUID	Source ID, see Sources for more details
reconciliationStatus string	One of the following values: none, partial, full, informative, out of scope
incomingMatches Match[]	List of matches in which the listed transaction is the origin.
outgoingMatches Match[]	List of matches in which the listed transaction is the target.
description string	The value of the description field of the transaction.
type string	The value of the type field of the transaction.
timestamp integer	Epoch timestamp in milliseconds.

Example

Request:

{
  "datasetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "limit": 100
  "offest": 0,
  "from": 1704067200000,
  "to": 1706745600,
  "search": [{
    "path": "Description",
    "search": {
      "type": "string",
      "value": "INV-340174"
    }
  }]
}

Response:

[{
  "id": "bb3e52d3-ce21-44be-b16c-e28f7d3d44da",
  "datasetId": "8872aec1-6a21-423b-a7ad-e813f4419f75",
  "reconciliationStatus": "none",
  "incomingMatches": [],
  "outgoingMatches": [],
  "description": "Transfer to Vendor A/INV-12345/Jan-2024 PYMT",
  "type": "ACH Credit",
  "timestamp": 1704067200000
}]