Transactions

Lists all transactions.

get/transactions

Query parameters

reconciliation_status'reconciled' | 'unreconciled'
Example:reconciled

Filter by reconciliation status. reconciled returns transactions where unallocated_amount is 0. unreconciled returns transactions where unallocated_amount is not 0. Omit for all transactions.

accountstring
Example:ext_account_YWJjMTIz

Filter by account id or external_id. If the account does not exist, returns an empty list.

Response

Success

Example response

{
  "data": [
    {
      "id": "txn_dHhuX2ZyYWdfMDAx",
      "external_id": "bank_txn_123",
      "account": {
        "id": "ext_account_YWJjMTIz",
        "external_id": "acct_external_123"
      },
      "posted": "2024-01-13T00:00:00Z",
      "currency": "USD",
      "amount": "-1000",
      "allocations": [
        {
          "invoice_id": "inv_abc123",
          "amount": "1000",
          "type": "invoice_payin",
          "user": {
            "id": "user_abc123",
            "external_id": "user_ext_001"
          }
        }
      ],
      "tags": [
        {
          "key": "department",
          "value": "engineering"
        }
      ],
      "unallocated_amount": "-1000",
      "created": "2024-01-13T00:00:00Z",
      "modified": "2024-01-13T00:00:00Z",
      "version": 1
    }
  ]
}

Changes

Changed in 6 of the 38 revisions of this API.17

    • the response property data/items/allocations/items/user/external_id became required for the status 200

      response-property-became-required

    This revision also has 18 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the required property data/items/tags to the response with the 200 status

      response-required-property-added

    • added the optional property data/items/allocations/items/user/external_id to the response with the 200 status

      response-optional-property-added

    • the data/items/allocations/items/user response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • removed subschema #1 subschema #2 from the data/items/allocations/items/user response property anyOf list for the response status 200

      response-property-any-of-removed

    • added the required property data/items/allocations/items/user/id to the response with the 200 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the required property data/items/version to the response with the 200 status

      response-required-property-added

    • endpoint added

      endpoint-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog