read

Imported bank transactions of one entity, by booking date, with their dismissal state.

A transaction dismissed as not_a_transaction or duplicate_of stays listed with dismissal set, so a mirror can tombstone it; the change feed carries the same dismissal as an event. Amounts are { "amount": "<decimal string>", "currency": "<ISO 4217>" } — never a JSON number. Keyset-paged: pass page.next_cursor back as cursor while page.has_more is true. page.truncated is true only when a server-side bound cut this page short of what was asked; it is never a silent cut.

The GET form of finance_bank_transactions_list: the same arguments as query parameters.

get/api/v1/finance/bank-transactions

Request

  • Base URL: https://app.magistry.io
  • URL: https://app.magistry.io/api/v1/finance/bank-transactions
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.magistry.io/api/oauth/authorize, token URL https://app.magistry.io/api/oauth/token, scopes: finance:read)

Query parameters

entity_idstring uuid required

The entity, one of those this app was granted (GET /api/v1/finance/entities lists them). In a GET query string entity is accepted too.

bank_account_idstring uuid

Only this bank account.

transaction_idstring uuid

Only this transaction.

import_idstring uuid

Only the rows of this import.

fromstring date

Inclusive lower bound on booking_date.

tostring date

Inclusive upper bound on booking_date.

cursorstring

The next_cursor of the previous page. Opaque.

limitinteger

Items per page.

entitystring uuid

Alias of entity_id; give one of the two.

Response

Result

okboolean required
resultunknown required

Changes

No recorded changes to this operation across all 3 revisions of this API.