bank

33 endpoints at a glance

Method	Path	Summary
GET	/bank/accounts	List Bank Accounts
POST	/bank/accounts	Create Bank Account
DELETE	/bank/accounts/{account_id}	Delete Bank Account
PATCH	/bank/accounts/{account_id}	Update Bank Account
POST	/bank/accounts/{account_id}/set-default	Set Default Bank Account
POST	/bank/accounts/{account_id}/sync	Sync Account Now
GET	/bank/budget-summary	Budget Summary
GET	/bank/categories	List Categories
POST	/bank/categories	Create Category
DELETE	/bank/categories/{category_id}	Delete Category
PATCH	/bank/categories/{category_id}	Update Category
GET	/bank/connections	List Connections
POST	/bank/connections	Create Connection
DELETE	/bank/connections/{connection_id}	Delete Connection
POST	/bank/connections/{connection_id}/finalize	Finalize Connection
POST	/bank/import	Import Bank Statement
GET	/bank/institutions	List Institutions
GET	/bank/rules	List Rules
POST	/bank/rules	Create Rule
DELETE	/bank/rules/{rule_id}	Delete Rule
PATCH	/bank/rules/{rule_id}	Update Rule
POST	/bank/rules/apply	Apply Rules
POST	/bank/rules/from-transaction	Rule From Transaction
POST	/bank/rules/preview	Preview Rule
POST	/bank/rules/reorder	Reorder Rules
GET	/bank/targets	List Targets
POST	/bank/targets	Set Target
DELETE	/bank/targets/{target_id}	Delete Target
PATCH	/bank/targets/{target_id}	Update Target
GET	/bank/transactions	List Transactions
PATCH	/bank/transactions/{txn_id}	Patch Transaction
POST	/bank/transactions/{txn_id}/match	Match Transaction
POST	/bank/transactions/{txn_id}/unmatch	Unmatch Transaction

bank

---

Import Bank Statement

POST

/bank/import

Upload a CAMT.053 (XML) or bank CSV statement → deduped bank transactions on
the matching account (created by IBAN on first sight).

Parameters

Header Parameters

authorization

Request Body

multipart/form-data

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/bank/import

Playground

Headers

authorization

Body

Samples

---

List Bank Accounts

GET

/bank/accounts

Parameters

Header Parameters

authorization

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/bank/accounts

Playground

Headers

authorization

Samples

---

Create Bank Account

POST

/bank/accounts

Parameters

Header Parameters

authorization

Request Body

application/json

{

  

"iban": "string",

  

"account_name": "string",

  

"bank_name": "string",

  

"kind": "business"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/bank/accounts

Playground

Headers

authorization

Body

Samples

---

Delete Bank Account

DELETE

/bank/accounts/{account_id}

Parameters

Header Parameters

authorization

Path Parameters

account_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

DELETE

/bank/accounts/{account_id}

Playground

Headers

authorization

Variables

Key

Value

account_id*

Samples

---

Update Bank Account

PATCH

/bank/accounts/{account_id}

Parameters

Header Parameters

authorization

Path Parameters

account_id*

Type

string

Required

Request Body

application/json

{

  

"kind": "string",

  

"ledger_account_id": "string",

  

"account_name": "string",

  

"bank_name": "string"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

PATCH

/bank/accounts/{account_id}

Playground

Headers

authorization

Variables

Key

Value

account_id*

Body

Samples

---

Set Default Bank Account

POST

/bank/accounts/{account_id}/set-default

Parameters

Header Parameters

authorization

Path Parameters

account_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/bank/accounts/{account_id}/set-default

Playground

Headers

authorization

Variables

Key

Value

account_id*

Samples

---

List Transactions

GET

/bank/transactions

Parameters

Header Parameters

authorization

Query Parameters

account

status

q

page

Type

integer

Default

1

limit

Type

integer

Default

100

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/bank/transactions

Playground

Headers

authorization

Variables

Key

Value

account

status

q

page

limit

Samples

---

Match Transaction

POST

/bank/transactions/{txn_id}/match

Parameters

Header Parameters

authorization

Path Parameters

txn_id*

Type

string

Required

Request Body

application/json

{

  

"kind": "string",

  

"target_id": "string",

  

"ledger_account_id": "string",

  

"amount_cents": 0,

  

"date": "string"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/bank/transactions/{txn_id}/match

Playground

Headers

authorization

Variables

Key

Value

txn_id*

Body

Samples

---

Unmatch Transaction

POST

/bank/transactions/{txn_id}/unmatch

Parameters

Header Parameters

authorization

Path Parameters

txn_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/bank/transactions/{txn_id}/unmatch

Playground

Headers

authorization

Variables

Key

Value

txn_id*

Samples

---

Budget Summary

GET

/bank/budget-summary

Income/expense rollup for the Budget view. from is inclusive, to
exclusive. kind (business|personal) scopes to every account of that kind;
account scopes to one. Excluded rows (incl. detected transfers) are omitted.

Parameters

Header Parameters

authorization

Query Parameters

from

to

account

kind

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/bank/budget-summary

Playground

Headers

authorization

Variables

Key

Value

from

to

account

kind

Samples

---

Patch Transaction

PATCH

/bank/transactions/{txn_id}

Set the budgeting dimension on a transaction (category / exclude / note).
Independent of reconciliation — never touches match/status.

Parameters

Header Parameters

authorization

Path Parameters

txn_id*

Type

string

Required

Request Body

application/json

{

  

"category_id": "string",

  

"excluded": true,

  

"note": "string"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

PATCH

/bank/transactions/{txn_id}

Playground

Headers

authorization

Variables

Key

Value

txn_id*

Body

Samples

---

List Categories

GET

/bank/categories

Parameters

Header Parameters

authorization

Query Parameters

include_archived

Type

boolean

Default

false

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/bank/categories

Playground

Headers

authorization

Variables

Key

Value

include_archived

Samples

---

Create Category

POST

/bank/categories

Parameters

Header Parameters

authorization

Request Body

application/json

{

  

"name": "string",

  

"kind": "expense",

  

"color": "string",

  

"parent_id": "string"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/bank/categories

Playground

Headers

authorization

Body

Samples

---

Delete Category

DELETE

/bank/categories/{category_id}

Parameters

Header Parameters

authorization

Path Parameters

category_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

DELETE

/bank/categories/{category_id}

Playground

Headers

authorization

Variables

Key

Value

category_id*

Samples

---

Update Category

PATCH

/bank/categories/{category_id}

Parameters

Header Parameters

authorization

Path Parameters

category_id*

Type

string

Required

Request Body

application/json

{

  

"name": "string",

  

"kind": "string",

  

"color": "string",

  

"parent_id": "string",

  

"archived": true,

  

"order": 0

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

PATCH

/bank/categories/{category_id}

Playground

Headers

authorization

Variables

Key

Value

category_id*

Body

Samples

---

Preview Rule

POST

/bank/rules/preview

Count how many existing transactions a rule with these conditions would
match — powers the live "past op N transacties" hint before saving.

Parameters

Header Parameters

authorization

Request Body

application/json

{

  

"counterparty_contains": "string",

  

"counterparty_iban": "string",

  

"description_contains": "string"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/bank/rules/preview

Playground

Headers

authorization

Body

Samples

---

List Rules

GET

/bank/rules

Parameters

Header Parameters

authorization

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/bank/rules

Playground

Headers

authorization

Samples

---

Create Rule

POST

/bank/rules

Parameters

Header Parameters

authorization

Request Body

application/json

{

  

"counterparty_contains": "string",

  

"counterparty_iban": "string",

  

"description_contains": "string",

  

"category_id": "string",

  

"set_excluded": false

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/bank/rules

Playground

Headers

authorization

Body

Samples

---

Delete Rule

DELETE

/bank/rules/{rule_id}

Parameters

Header Parameters

authorization

Path Parameters

rule_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

DELETE

/bank/rules/{rule_id}

Playground

Headers

authorization

Variables

Key

Value

rule_id*

Samples

---

Update Rule

PATCH

/bank/rules/{rule_id}

Parameters

Header Parameters

authorization

Path Parameters

rule_id*

Type

string

Required

Request Body

application/json

{

  

"counterparty_contains": "string",

  

"counterparty_iban": "string",

  

"description_contains": "string",

  

"category_id": "string",

  

"set_excluded": true,

  

"enabled": true

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

PATCH

/bank/rules/{rule_id}

Playground

Headers

authorization

Variables

Key

Value

rule_id*

Body

Samples

---

Reorder Rules

POST

/bank/rules/reorder

Parameters

Header Parameters

authorization

Request Body

application/json

{

  

"ordered_ids": [

  

  

"string"

  

]

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/bank/rules/reorder

Playground

Headers

authorization

Body

Samples

---

Apply Rules

POST

/bank/rules/apply

Retroactively run transfer detection + rules over every account's
still-uncategorised rows.

Parameters

Header Parameters

authorization

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/bank/rules/apply

Playground

Headers

authorization

Samples

---

Rule From Transaction

POST

/bank/rules/from-transaction

'Categorize like this…' — build a rule from a transaction's counterparty /
IBAN / description, then apply it across all accounts.

Parameters

Header Parameters

authorization

Request Body

application/json

{

  

"txn_id": "string",

  

"category_id": "string",

  

"set_excluded": false,

  

"field": "counterparty"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/bank/rules/from-transaction

Playground

Headers

authorization

Body

Samples

---

List Targets

GET

/bank/targets

Parameters

Header Parameters

authorization

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/bank/targets

Playground

Headers

authorization

Samples

---

Set Target

POST

/bank/targets

Set the monthly target for a category (upsert — one target per category).

Parameters

Header Parameters

authorization

Request Body

application/json

{

  

"category_id": "string",

  

"amount_cents": 0

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/bank/targets

Playground

Headers

authorization

Body

Samples

---

Delete Target

DELETE

/bank/targets/{target_id}

Parameters

Header Parameters

authorization

Path Parameters

target_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

DELETE

/bank/targets/{target_id}

Playground

Headers

authorization

Variables

Key

Value

target_id*

Samples

---

Update Target

PATCH

/bank/targets/{target_id}

Parameters

Header Parameters

authorization

Path Parameters

target_id*

Type

string

Required

Request Body

application/json

{

  

"amount_cents": 0

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

PATCH

/bank/targets/{target_id}

Playground

Headers

authorization

Variables

Key

Value

target_id*

Body

Samples

---

List Institutions

GET

/bank/institutions

Parameters

Header Parameters

authorization

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/bank/institutions

Playground

Headers

authorization

Samples

---

List Connections

GET

/bank/connections

Parameters

Header Parameters

authorization

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/bank/connections

Playground

Headers

authorization

Samples

---

Create Connection

POST

/bank/connections

Parameters

Header Parameters

authorization

Request Body

application/json

{

  

"institution_id": "string",

  

"institution_name": "string"

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/bank/connections

Playground

Headers

authorization

Body

Samples

---

Finalize Connection

POST

/bank/connections/{connection_id}/finalize

Called after the user returns from bank consent: read the granted accounts
and create a bank_account (business by default) for each.

Parameters

Header Parameters

authorization

Path Parameters

connection_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/bank/connections/{connection_id}/finalize

Playground

Headers

authorization

Variables

Key

Value

connection_id*

Samples

---

Delete Connection

DELETE

/bank/connections/{connection_id}

Parameters

Header Parameters

authorization

Path Parameters

connection_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

DELETE

/bank/connections/{connection_id}

Playground

Headers

authorization

Variables

Key

Value

connection_id*

Samples

---

Sync Account Now

POST

/bank/accounts/{account_id}/sync

Parameters

Header Parameters

authorization

Path Parameters

account_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/bank/accounts/{account_id}/sync

Playground

Headers

authorization

Variables

Key

Value

account_id*

Samples

---