Inbox

List the bank transactions linked to a document

Authorization

bearerAuth

AuthorizationBearer <token>

Session JWT or OAuth2 access token

In: header

Path Parameters

id*string

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/v1/inbox/497f6eca-6276-4993-bfeb-53cbbbba6f08/transactions"

{  "data": [    {      "inbox_id": "5127f22b-d152-46dd-aeaa-3a852d9fbfc2",      "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",      "origin": "manual",      "actor_id": "04f37679-bfbf-4906-b749-01756515cecf",      "action_id": "52d6fa12-2c88-46da-984a-4cc821c7837a",      "created_at": "string",      "transaction": {        "name": "string",        "booking_date": "string",        "amount": "string",        "currency": "string"      }    }  ]}

Link a bank transaction to a document

Records that the bank transaction paid the document. A link carries no amount; linking an existing pair changes nothing. This does not move money or alter approvals, categories, or source files.

Authorization

bearerAuth

AuthorizationBearer <token>

Session JWT or OAuth2 access token

In: header

Path Parameters

id*string

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

transaction_id*string

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/v1/inbox/497f6eca-6276-4993-bfeb-53cbbbba6f08/transactions" \  -H "Content-Type: application/json" \  -d '{    "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482"  }'

{  "data": {    "outcome": "linked",    "links": [      {        "inbox_id": "5127f22b-d152-46dd-aeaa-3a852d9fbfc2",        "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",        "origin": "manual",        "actor_id": "04f37679-bfbf-4906-b749-01756515cecf",        "action_id": "52d6fa12-2c88-46da-984a-4cc821c7837a",        "created_at": "string",        "transaction": {          "name": "string",          "booking_date": "string",          "amount": "string",          "currency": "string"        }      }    ]  }}

List the documents linked to a bank transaction

Authorization

bearerAuth

AuthorizationBearer <token>

Session JWT or OAuth2 access token

In: header

Query Parameters

transaction_id*string

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/v1/inbox/links?transaction_id=497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "data": [    {      "inbox_id": "5127f22b-d152-46dd-aeaa-3a852d9fbfc2",      "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",      "origin": "manual",      "actor_id": "04f37679-bfbf-4906-b749-01756515cecf",      "action_id": "52d6fa12-2c88-46da-984a-4cc821c7837a",      "created_at": "string",      "transaction": {        "name": "string",        "booking_date": "string",        "amount": "string",        "currency": "string"      }    }  ]}

Unlink a bank transaction from a document

Removes one link; other links and the source document remain. A person removing a link keeps matching from proposing that pair again; linking it explicitly stays available.

Authorization

bearerAuth

AuthorizationBearer <token>

Session JWT or OAuth2 access token

In: header

Path Parameters

id*string

Formatuuid

transaction_id*string

Formatuuid

Query Parameters

reason*string

Length3 <= length <= 1000

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/inbox/497f6eca-6276-4993-bfeb-53cbbbba6f08/transactions/497f6eca-6276-4993-bfeb-53cbbbba6f08?reason=string"

{  "data": {    "outcome": "linked",    "links": [      {        "inbox_id": "5127f22b-d152-46dd-aeaa-3a852d9fbfc2",        "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",        "origin": "manual",        "actor_id": "04f37679-bfbf-4906-b749-01756515cecf",        "action_id": "52d6fa12-2c88-46da-984a-4cc821c7837a",        "created_at": "string",        "transaction": {          "name": "string",          "booking_date": "string",          "amount": "string",          "currency": "string"        }      }    ]  }}

List inbox items

List inbox items with filtering, search, and pagination

Authorization

bearerAuth

AuthorizationBearer <token>

Session JWT or OAuth2 access token

In: header

Query Parameters

cursor?string

Pagination cursor

limit?integer

Number of items per page (1-100; higher values cap at 100)

Range1 <= value

Default20

start_date?string

Start date (YYYY-MM-DD)

end_date?string

End date (YYYY-MM-DD)

amount?string

amount[eq]?string

amount[neq]?string

amount[gt]?string

amount[gte]?string

amount[lt]?string

amount[lte]?string

amount[in]?string

amount[nin]?string

base_amount?string

base_amount[eq]?string

base_amount[neq]?string

base_amount[gt]?string

base_amount[gte]?string

base_amount[lt]?string

base_amount[lte]?string

base_amount[in]?string

base_amount[nin]?string

date?string

date[eq]?string

date[neq]?string

date[gt]?string

date[gte]?string

date[lt]?string

date[lte]?string

date[in]?string

date[nin]?string

status?string

status[eq]?string

status[neq]?string

status[gt]?string

status[gte]?string

status[lt]?string

status[lte]?string

status[in]?string

status[nin]?string

document_type?string

document_type[eq]?string

document_type[neq]?string

document_type[gt]?string

document_type[gte]?string

document_type[lt]?string

document_type[lte]?string

document_type[in]?string

document_type[nin]?string

category_id?string

category_id[eq]?string

category_id[neq]?string

category_id[gt]?string

category_id[gte]?string

category_id[lt]?string

category_id[lte]?string

category_id[in]?string

category_id[nin]?string

project_id?string

project_id[eq]?string

project_id[neq]?string

project_id[gt]?string

project_id[gte]?string

project_id[lt]?string

project_id[lte]?string

project_id[in]?string

project_id[nin]?string

supplier_id?string

supplier_id[eq]?string

supplier_id[neq]?string

supplier_id[gt]?string

supplier_id[gte]?string

supplier_id[lt]?string

supplier_id[lte]?string

supplier_id[in]?string

supplier_id[nin]?string

type?string

type[eq]?string

type[neq]?string

type[gt]?string

type[gte]?string

type[lt]?string

type[lte]?string

type[in]?string

type[nin]?string

currency?string

currency[eq]?string

currency[neq]?string

currency[gt]?string

currency[gte]?string

currency[lt]?string

currency[lte]?string

currency[in]?string

currency[nin]?string

q?string

Search query (FTS)

statuses?string

Statuses (comma-separated) - legacy, use status[in]

document_types?string

Document types (comma-separated) - legacy, use document_type[in]

sort?string

Sort column

Default"date"

Value in

"date"
"amount"
"created_at"

order?string

Sort order

Default"desc"

Value in

"asc"
"desc"

Response Body

`application/json`

curl -X GET "https://example.com/v1/inbox"

{  "data": [    {      "id": "string",      "organization_id": "string",      "amount": 0,      "currency": "string",      "display_name": "string",      "status": "string",      "meta": null,      "created_at": "string",      "date": "string",      "due_date": "string",      "type": "string",      "website": "string",      "transaction_ids": [        "4c280fa4-a296-4efd-9aa0-fe3648ca9a76"      ],      "document_type": "string",      "payment_terms": "string",      "original_currency": "string",      "reference_number": "string",      "category_id": "string",      "items": null,      "notes": "string",      "exclude_from_analytics": true,      "base_amount": 0,      "base_currency": "string",      "project_id": "string",      "cluster_id": "string",      "cluster_index": 0,      "primary_document_id": "string",      "primary_document": {        "id": "string",        "file_path": "string",        "file_name": "string",        "content_type": "string",        "size": 0      },      "category": {        "id": "string",        "name": "string",        "color": "string"      },      "project": {        "id": "string",        "name": "string"      },      "match_candidates": [        {          "inbox_id": "string",          "confidence_score": "string",          "status": "string"        }      ],      "supplier_id": "string",      "buyer": {        "name": "string",        "country": "string",        "tax_id": "string",        "tax_type": "string"      },      "seller": {        "name": "string",        "country": "string",        "tax_id": "string",        "tax_type": "string"      },      "subtotal": 0,      "tax_amount": 0,      "reference_document_number": "string",      "source": "string",      "source_reference_id": "string",      "approval_action": "string",      "approval_at": "string",      "approval_actor": {        "id": "string",        "full_name": "string",        "email": "string",        "avatar_url": "string"      },      "approval_reason": "string"    }  ],  "meta": {    "count": 0,    "next_cursor": "string"  }}

Create inbox item

Create a new inbox item. When primary_document_id is provided without amount, shared document understanding supplies verified financial facts.

Authorization

bearerAuth

AuthorizationBearer <token>

Session JWT or OAuth2 access token

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

primary_document_id?string

Document ID to link. When provided without amount, OCR runs automatically to extract financial data.

Formatuuid

source?string|null

source_reference_id?string|null

display_name?string

amount?number|null

currency?string|null

date?string|null

due_date?string|null

type?|

Value in

"credit"
"debit"
null

document_type?|

Value in

"invoice"
"credit_note"
"receipt"
"purchase_order"
"other"
null

category_id?string|null

project_id?string|null

notes?string|null

items?unknown

address?string|null

website?string|null

reference_number?string|null

supplier_id?|

Formatuuid

buyer?|null

seller?|null

subtotal?number|null

tax_amount?number|null

reference_document_number?string|null

status?string

Value in

"processing"
"pending"
"archived"
"new"
"deleted"
"failed"

Response Body

`application/json`

curl -X POST "https://example.com/v1/inbox" \  -H "Content-Type: application/json" \  -d '{}'

{  "data": {    "id": "string",    "organization_id": "string",    "amount": 0,    "currency": "string",    "display_name": "string",    "status": "string",    "meta": null,    "created_at": "string",    "date": "string",    "due_date": "string",    "type": "string",    "website": "string",    "transaction_ids": [      "4c280fa4-a296-4efd-9aa0-fe3648ca9a76"    ],    "document_type": "string",    "payment_terms": "string",    "original_currency": "string",    "reference_number": "string",    "category_id": "string",    "items": null,    "notes": "string",    "exclude_from_analytics": true,    "base_amount": 0,    "base_currency": "string",    "project_id": "string",    "cluster_id": "string",    "cluster_index": 0,    "primary_document_id": "string",    "primary_document": {      "id": "string",      "file_path": "string",      "file_name": "string",      "content_type": "string",      "size": 0    },    "category": {      "id": "string",      "name": "string",      "color": "string"    },    "project": {      "id": "string",      "name": "string"    },    "match_candidates": [      {        "inbox_id": "string",        "confidence_score": "string",        "status": "string"      }    ],    "supplier_id": "string",    "buyer": {      "name": "string",      "country": "string",      "tax_id": "string",      "tax_type": "string"    },    "seller": {      "name": "string",      "country": "string",      "tax_id": "string",      "tax_type": "string"    },    "subtotal": 0,    "tax_amount": 0,    "reference_document_number": "string",    "source": "string",    "source_reference_id": "string",    "approval_action": "string",    "approval_at": "string",    "approval_actor": {      "id": "string",      "full_name": "string",      "email": "string",      "avatar_url": "string"    },    "approval_reason": "string"  }}

Get inbox item

Get a single inbox item by ID

Authorization

bearerAuth

AuthorizationBearer <token>

Session JWT or OAuth2 access token

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/inbox/string"

{  "data": {    "id": "string",    "organization_id": "string",    "amount": 0,    "currency": "string",    "display_name": "string",    "status": "string",    "meta": null,    "created_at": "string",    "date": "string",    "due_date": "string",    "type": "string",    "website": "string",    "transaction_ids": [      "4c280fa4-a296-4efd-9aa0-fe3648ca9a76"    ],    "document_type": "string",    "payment_terms": "string",    "original_currency": "string",    "reference_number": "string",    "category_id": "string",    "items": null,    "notes": "string",    "exclude_from_analytics": true,    "base_amount": 0,    "base_currency": "string",    "project_id": "string",    "cluster_id": "string",    "cluster_index": 0,    "primary_document_id": "string",    "primary_document": {      "id": "string",      "file_path": "string",      "file_name": "string",      "content_type": "string",      "size": 0    },    "category": {      "id": "string",      "name": "string",      "color": "string"    },    "project": {      "id": "string",      "name": "string"    },    "match_candidates": [      {        "inbox_id": "string",        "confidence_score": "string",        "status": "string"      }    ],    "supplier_id": "string",    "buyer": {      "name": "string",      "country": "string",      "tax_id": "string",      "tax_type": "string"    },    "seller": {      "name": "string",      "country": "string",      "tax_id": "string",      "tax_type": "string"    },    "subtotal": 0,    "tax_amount": 0,    "reference_document_number": "string",    "source": "string",    "source_reference_id": "string",    "approval_action": "string",    "approval_at": "string",    "approval_actor": {      "id": "string",      "full_name": "string",      "email": "string",      "avatar_url": "string"    },    "approval_reason": "string"  }}

Update inbox item

Update inbox item fields

Authorization

bearerAuth

AuthorizationBearer <token>

Session JWT or OAuth2 access token

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

display_name?string|null

amount?number|null

currency?string|null

date?string|null

due_date?string|null

type?|

Value in

"credit"
"debit"
null

document_type?|

Value in

"invoice"
"credit_note"
"receipt"
"purchase_order"
"other"
null

category_id?string|null

project_id?string|null

notes?string|null

items?unknown

status?string

Value in

"processing"
"pending"
"archived"
"new"
"deleted"
"failed"

supplier_id?|

Formatuuid

buyer?|null

seller?|null

subtotal?number|null

tax_amount?number|null

reference_document_number?string|null

Response Body

`application/json`

curl -X PATCH "https://example.com/v1/inbox/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "data": {    "id": "string",    "organization_id": "string",    "amount": 0,    "currency": "string",    "display_name": "string",    "status": "string",    "meta": null,    "created_at": "string",    "date": "string",    "due_date": "string",    "type": "string",    "website": "string",    "transaction_ids": [      "4c280fa4-a296-4efd-9aa0-fe3648ca9a76"    ],    "document_type": "string",    "payment_terms": "string",    "original_currency": "string",    "reference_number": "string",    "category_id": "string",    "items": null,    "notes": "string",    "exclude_from_analytics": true,    "base_amount": 0,    "base_currency": "string",    "project_id": "string",    "cluster_id": "string",    "cluster_index": 0,    "primary_document_id": "string",    "primary_document": {      "id": "string",      "file_path": "string",      "file_name": "string",      "content_type": "string",      "size": 0    },    "category": {      "id": "string",      "name": "string",      "color": "string"    },    "project": {      "id": "string",      "name": "string"    },    "match_candidates": [      {        "inbox_id": "string",        "confidence_score": "string",        "status": "string"      }    ],    "supplier_id": "string",    "buyer": {      "name": "string",      "country": "string",      "tax_id": "string",      "tax_type": "string"    },    "seller": {      "name": "string",      "country": "string",      "tax_id": "string",      "tax_type": "string"    },    "subtotal": 0,    "tax_amount": 0,    "reference_document_number": "string",    "source": "string",    "source_reference_id": "string",    "approval_action": "string",    "approval_at": "string",    "approval_actor": {      "id": "string",      "full_name": "string",      "email": "string",      "avatar_url": "string"    },    "approval_reason": "string"  }}

Delete inbox item

Delete an inbox item by ID

Authorization

bearerAuth

AuthorizationBearer <token>

Session JWT or OAuth2 access token

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/inbox/string"

Empty

200application/json

403application/json

404application/json

409application/json

200application/json

403application/json

404application/json

409application/json

200application/json

403application/json

404application/json

409application/json

200application/json

403application/json

404application/json

409application/json

200application/json

403application/json

200application/json

201application/json

400application/json

402application/json

403application/json

422application/json

200application/json

403application/json

404application/json

200application/json

400application/json

403application/json

404application/json

204

403application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`