v1

latestOpenAPI 3.1.02026-08-04103211436.0 KB

Transactions

List transactions

Returns the bank transactions of a company. Results are paginated: use limit to control page size and pass the returned nextPageToken to fetch the next page. startValueDate/endValueDate filter by value date, startOperationDate/endOperationDate filter by the date the transaction was booked, and startUpdatedAt/endUpdatedAt filter by last modification time, which is useful for incremental synchronization. Each start bound is inclusive and each end bound is exclusive. Transactions marked as hidden, or whose product no longer exists, are excluded from the results.

get/transactions/{companyId}

Path parameters

companyIdstring required

Query parameters

productIdstring

Filter transactions belonging to a given product (productId).

syncboolean

Filter by synchronization status with your ERP. false also matches transactions where the value is not set.

startValueDatestring date

Only return transactions whose value date is on or after this date (inclusive). Cannot be later than endValueDate, and cannot be in the future when used without endValueDate.

endValueDatestring date

Only return transactions whose value date is before this date (exclusive).

startOperationDatestring date

Only return transactions booked on or after this date (inclusive). Cannot be later than endOperationDate, and cannot be in the future when used without endOperationDate.

endOperationDatestring date

Only return transactions booked before this date (exclusive).

startUpdatedAtstring date-time

Only return transactions last modified on or after this timestamp (inclusive). Cannot be later than endUpdatedAt, and cannot be in the future when used without endUpdatedAt.

endUpdatedAtstring date-time

Only return transactions last modified before this timestamp (exclusive).

limitinteger

Maximum number of objects to return in the response. Default 500, maximum 2000.

nextPageTokenstring

Token to fetch the next page of results, taken from the nextPageToken returned by the previous request with the same filters. Omit it to fetch the first page. An invalid or malformed token is rejected with 404.

Response

Successful Response

nextPageTokenstring nullable

Token to fetch the next page of results. null when there are no more pages.

Example response

{
  "data": [
    {
      "balance": 15234.67,
      "concept": "Invoice #2024-001 payment",
      "amount": 1250.5,
      "accountingAmount": 1250.5,
      "exchangeRate": 1,
      "product": {
        "id": "prod_8f3a1c",
        "product": "Cuenta Corriente",
        "bankFullName": "Banco Bilbao Vizcaya Argentaria",
        "alias": "Main checking account"
      },
      "attributes": [
        {
          "customId": "cost-center",
          "value": "Marketing",
          "valueCustomId": "marketing"
        }
      ],
      "categories": [
        {
          "value": 150
        }
      ],
      "groupAmount": 1180.25,
      "groupExchangeRate": 1.06,
      "currencyExchangeData": {
        "originalAmount": 500,
        "grossAmount": 460.25,
        "fees": 3.5
      }
    }
  ]
}