v1

latestOpenAPI 3.0.02026-07-2436163302.7 KB

Get a list of transactions

Used to search for transactions.

get/v1/transactions

Query parameters

backfillboolean

Search by whether the transaction is a backfill

country_codestring

Search by transaction country code.

data_sourcestring

Search by the input source of the transaction, e.g. API, CSV, TAX_AUTHORITY, DIGITAL_EXCHANGE

decimal_amountsboolean

A flag to be used in a migration phase. It signals in which format amounts should be parsed. If true amounts are parsed as decimals, if false amounts are parsed as an integer representing the minor currency unit.

directionstring

Search by the Transaction direction, can either be inbound (RECEIVED) or outbound (SENT)

error_typesstring[]

Search by specific error types

limitinteger

Define page size - default 25

next_cursorstring

Define the next cursor to be fetched

operation_idstring

Search by internal operation unique identifier.

reporting_date_fromstring

Search for records where the transaction was reported after a given RFC3339 date

reporting_date_tostring

Search for records where the transaction was reported before a given RFC3339 date

sort_bystring

Order search results by a given field

sort_orderstring

Define sort order - default ascending

supplier_company_idstring

Search by company using Fonoa unique identifier.

supplier_company_namestring

Search by company name.

transaction_date_fromstring

Search for records where the transaction was executed after a given RFC3339 date

transaction_date_tostring

Search for records where the transaction was executed before a given RFC3339 date

transaction_idstring[]

Search by external transaction unique identifier(s).

transaction_numberstring[]

Search by transaction number(s).

transaction_reference_idstring

Search by transactions that references the given fonoa id.

transaction_scenariostring

Search by the effect the document has, either debiting or crediting

transaction_statusstring

Search by Transaction status.

transaction_typestring

Search by a single transaction type or multiple transaction types

updated_at_fromstring

Search for records updated at or after a given RFC3339 date

updated_at_tostring

Search for records updated at or before a given RFC3339 date

workflow_operationsstring

Search by workflow operations as a comma-separated string, e.g. DOCUMENT_GENERATION,TA_NOTIFICATION.

workflow_statusstring

Search by Transaction workflow status.

Response

Ok - transactions for the provided search criteria were returned.

limitinteger
next_cursorstring