Skip to content

expenses

10 endpoints at a glance
MethodPathSummary
GET/expensesList Expenses
POST/expensesCreate Expense
DELETE/expenses/{expense_id}Delete Expense
GET/expenses/{expense_id}Get Expense
PATCH/expenses/{expense_id}Update Expense
POST/expenses/{expense_id}/bookBook Expense
POST/expenses/{expense_id}/creditCredit Expense
POST/expenses/{expense_id}/paymentRegister Payment
POST/expenses/captureCapture Expense
POST/expenses/capture-from-emailCapture Expense From Email

expenses


List Expenses

GET
/expenses

Parameters

Header Parameters

authorization

Query Parameters

status
supplier_id
q
page
Type
integer
Default
1
limit
Type
integer
Default
50

Responses

Successful Response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground

Headers
Variables
Key
Value

Samples


Create Expense

POST
/expenses

Parameters

Header Parameters

authorization

Request Body

application/json
JSON
{
  
"supplier_ref": {
  
  
"type": "string",
  
  
"id": "string",
  
  
"ref": {
  
  
  
"additionalProperties": "string"
  
  
},
  
  
"label": "string"
  
},
  
"issue_date": "string",
  
"due_date": "string",
  
"supplier_invoice_number": "string",
  
"notes": "string",
  
"lines": [
  
  
{
  
  
  
"description": "",
  
  
  
"amount_cents": 0,
  
  
  
"incl_btw": false,
  
  
  
"btw_code": "string",
  
  
  
"expense_account_id": "string"
  
  
}
  
]
}

Responses

Successful Response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground

Headers
Body

Samples


Capture Expense

POST
/expenses/capture

Upload a receipt (image or PDF) → prefilled draft expense with the receipt
attached. Digital PDFs read their text layer (no OCR); images/scans use
tesseract (501 when it's not installed).

Parameters

Header Parameters

authorization

Request Body

multipart/form-data

Responses

Successful Response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground

Headers
Body

Samples


Capture Expense From Email

POST
/expenses/capture-from-email

Capture a receipt straight from an email attachment (PDF/image) — the
common path for emailed invoices — into a prefilled draft expense.

Parameters

Header Parameters

authorization

Request Body

application/json
JSON
{
  
"email_id": "string",
  
"part_id": "string"
}

Responses

Successful Response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground

Headers
Body

Samples


Get Expense

GET
/expenses/{expense_id}

Parameters

Header Parameters

authorization

Path Parameters

expense_id*
Type
string
Required

Responses

Successful Response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground

Headers
Variables
Key
Value

Samples


Delete Expense

DELETE
/expenses/{expense_id}

Parameters

Header Parameters

authorization

Path Parameters

expense_id*
Type
string
Required

Responses

Successful Response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground

Headers
Variables
Key
Value

Samples


Update Expense

PATCH
/expenses/{expense_id}

Parameters

Header Parameters

authorization

Path Parameters

expense_id*
Type
string
Required

Request Body

application/json
JSON
{
  
"supplier_ref": {
  
  
"type": "string",
  
  
"id": "string",
  
  
"ref": {
  
  
  
"additionalProperties": "string"
  
  
},
  
  
"label": "string"
  
},
  
"issue_date": "string",
  
"due_date": "string",
  
"supplier_invoice_number": "string",
  
"notes": "string",
  
"lines": [
  
  
{
  
  
  
"description": "",
  
  
  
"amount_cents": 0,
  
  
  
"incl_btw": false,
  
  
  
"btw_code": "string",
  
  
  
"expense_account_id": "string"
  
  
}
  
]
}

Responses

Successful Response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground

Headers
Variables
Key
Value
Body

Samples


Book Expense

POST
/expenses/{expense_id}/book

Parameters

Header Parameters

authorization

Path Parameters

expense_id*
Type
string
Required

Responses

Successful Response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground

Headers
Variables
Key
Value

Samples


Register Payment

POST
/expenses/{expense_id}/payment

Parameters

Header Parameters

authorization

Path Parameters

expense_id*
Type
string
Required

Request Body

application/json
JSON
{
  
"amount_cents": 0,
  
"date": "string",
  
"account_id": "string"
}

Responses

Successful Response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground

Headers
Variables
Key
Value
Body

Samples


Credit Expense

POST
/expenses/{expense_id}/credit

Parameters

Header Parameters

authorization

Path Parameters

expense_id*
Type
string
Required

Request Body

application/json
JSON
{
  
"date": "string"
}

Responses

Successful Response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground

Headers
Variables
Key
Value
Body

Samples


Kancil — one workspace for contacts, work and money.