v1

latestOpenAPI 3.0.12026-07-26222700728.0 KB

Bank Reconciliations

Query reconciliations

Query reconciliations for the authenticated user

post/v6/banks/reconciliations/query

Request body

cursorstring nullable

Cursor from the previous paginated response

limitinteger

Page size, i.e. number of items to return per page

Response

Success

result'SUCCESS' | 'FAILURE'

The result of the action performed.

Example response

{
  "data": [
    {
      "id": "brc_28868401",
      "status": "ACTIVE",
      "reconciliationStatus": "IN_PROGRESS",
      "bankAccount": {
        "id": "bka_7542850",
        "name": "Business Checking",
        "displayName": "Business Checking *1687"
      },
      "bankStatement": {
        "id": "bst_28868401",
        "url": "https://cdn.sandbox.tight.com/statements/bst_28868401.pdf"
      },
      "period": {
        "beginDate": "2024-01-01",
        "endDate": "2024-01-31"
      },
      "endBalance": 12345.67,
      "createdByUser": {
        "id": "emp_28868401",
        "userId": "usr_28868401",
        "email": "editor@example.com"
      },
      "completedByUser": {
        "id": "emp_28868401",
        "userId": "usr_28868401",
        "email": "editor@example.com"
      },
      "customData": {
        "internal_key": "some_internal_key",
        "some_other_field": 23434
      }
    }
  ]
}