Kiipu · invoicing v1 read-only
kiipu.
Lists the latest invoices and payments of ONE client named by name: number, status, total, balance, and when and how they paid. With several matches it refuses with ambiguous and the candidates; with none, not_found.
Last updated
POST /api/v1/reads/kiipu.client_invoices_list- Token scope
kiipu.client_invoices_list@1- Workspace permission
api.kiipu.client_invoices_listoff by default- Who reads
- The person behind the token, with their role. Someone who leaves the workspace stops reading.
Three permissions
A token with that scope, the workspace owner having switched the read on, and the person's role seeing it in the product. None of them is enough alone. OAuth only →
Request
| field | type | rules | |
|---|---|---|---|
client | string | required | min 1 · max 200 |
Response — output when status is done
| field | type | rules | |
|---|---|---|---|
client | string | required | |
owedTotal | string | required | ^-?\d+\.\d{2}$ |
invoices | object[] | required | |
payments | object[] | required |
invoices[]
| field | type | rules | |
|---|---|---|---|
number | string | null | required | |
status | string | required | |
total | string | required | ^-?\d+\.\d{2}$ |
balance | string | required | ^-?\d+\.\d{2}$ |
currency | string | required | |
createdOn | string | required | ^\d{4}-\d{2}-\d{2}$ |
dueOn | string | null | required | |
daysOverdue | integer | null | required |
payments[]
| field | type | rules | |
|---|---|---|---|
invoice | string | null | required | |
paidOn | string | required | ^\d{4}-\d{2}-\d{2}$ |
amount | string | required | ^-?\d+\.\d{2}$ |
method | string | required | |
reversed | boolean | required |
Example
# Reads take an OAuth access token, not an API key, and no idempotency key: reading changes nothing.
curl -X POST https://niiko.org/api/v1/reads/kiipu.client_invoices_list \
-H "Authorization: Bearer $NIIKO_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"client": "…"
}'
# 200 → done · 4xx → refused, with a named reasonWhy it may refuse
Each reason names who can fix it and how; detail.message, when present, says what to do. Refusals & HTTP codes →
invalid_inputrole_forbiddengrant_offreads_need_a_personambiguousnot_found
In the clients
| @vorluno/niiko-sdk | niiko.listClientInvoices() |
| niiko (Python) | niiko.list_client_invoices() from 0.3.0 · not on the registry yet |
| niiko-cli | niiko read kiipu.client_invoices_list |
| n8n-nodes-niiko | No reads: the node holds a key, and reading needs a person through OAuth. |
| niiko-mcp-server | kiipu_client_invoices_list readOnlyHint |
History
- The SDKs and the CLI read
@vorluno/niiko-sdk,niikoandniiko-cli0.3.0 take an OAuth access token (accessToken,access_token=,niiko login --token) and have one read-only method per read:getCollections(),get_collections(),niiko read kiipu.collections_get. A read has two outcomes, done or refused, and takes no idempotency key. - Declared reads, OAuth only
POST /api/v1/reads/{id}answers nine declared reads — what is owed, what was collected, the agenda, the funnel, the month — never raw tables and never text someone wrote. Only with an OAuth token, on behalf of a person and with their role (an API key getsreads_need_a_person); each read has its own workspace switch, off by default. The MCP server lists them as read-only tools.