Skip to docs content

Tool reference

Bank feed and rules

Bank transactions, what still needs review, categorization rules and reconciliations, each a REST route with the same parameters and the same answer.

list_bank_transactions

Bank feed transactions of one entity, optionally within [from, to). amount is a decimal string in the bank feed convention: positive is money out.

REST
GET https://auth.42six.ai/functions/v1/api/v1/bank-transactions
ParameterDescription
entityRequiredEntity id (uuid), from list_entities.
fromOptionalStart date, YYYY-MM-DD, inclusive.
toOptionalEnd date, YYYY-MM-DD, exclusive.
cursorOptionalThe next_cursor of the previous page.
limitOptionalRows per page, 1 to 1000 (default 1000).

needs_review

Bank feed transactions of one entity still waiting for a category: neither posted to the ledger nor excluded. amount is a decimal string in the bank feed convention: positive is money out.

REST
GET https://auth.42six.ai/functions/v1/api/v1/needs-review
ParameterDescription
entityRequiredEntity id (uuid), from list_entities.
cursorOptionalThe next_cursor of the previous page.
limitOptionalRows per page, 1 to 1000 (default 1000).

list_rules

Categorization rules of one entity, active and inactive: the keyword and how it matches, direction, bank account, the account (or split) it posts to, priority and how often it has matched.

REST
GET https://auth.42six.ai/functions/v1/api/v1/rules
ParameterDescription
entityRequiredEntity id (uuid), from list_entities.
cursorOptionalThe next_cursor of the previous page.
limitOptionalRows per page, 1 to 1000 (default 1000).

reconciliation_status

Saved bank and card reconciliations of one entity: account, statement date, statement balance, book balance, difference and when it was reconciled (null while open), as decimal strings.

REST
GET https://auth.42six.ai/functions/v1/api/v1/reconciliations
ParameterDescription
entityRequiredEntity id (uuid), from list_entities.
cursorOptionalThe next_cursor of the previous page.
limitOptionalRows per page, 1 to 1000 (default 1000).