invoices.list
Invoices in one shop, newest first. Filter by status or by a customer name or invoice id. Read only. A shop you are not a member of is refused. Seeing the amounts needs see_prices, the same as invoices.get.
| |
|---|
| Who | Agents can call this |
| REST | GET /v1/invoices |
| MCP tool | invoices_list |
| Writes | no |
| Area | Shop |
When to use it
Invoices in one shop, newest first. Filter by status or by a customer name or invoice id.
What to tell the owner
Tell them what you found in plain words. Don't read back raw fields.
| Field | Type | Required |
|---|
shop_id | string (uuid) | yes |
status | string (one of draft, sent, partially_paid, paid, partially_refunded, refunded, void) | no |
q | string | no |
limit | integer | no |
cursor | string | no |
Example
GET https://doingwork.work/v1/invoices?shop_id=00000000-0000-4000-8000-000000000000
Output
| Field | Type | Always there |
|---|
data | array | yes |
data[].invoice_id | string (uuid) | yes |
data[].job_id | string (uuid) | yes |
data[].status | string (one of draft, sent, partially_paid, paid, partially_refunded, refunded, void) | yes |
data[].customer | ['string', 'null'] | yes |
data[].total_minor | integer | yes |
data[].total_text | string | yes |
data[].doc_no | integer | yes |
data[].doc_label | string | yes |
data[].currency | string | yes |
data[].issued_at | ['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')'] | yes |
data[].due_on | ['string', 'null', ' ', '(', 'd', 'a', 't', 'e', ')'] | yes |
data[].created_at | string (date-time) | yes |
next_cursor | ['string', 'null'] | yes |
time_zone | string | yes |
summary | string | yes |
display | object | yes |
display.kind | string (one of table, cards, timeline, checklist, map, calendar, chart) | yes |
display.title | string | yes |
display.columns | array | no |
display.columns[].key | string | yes |
display.columns[].label | string | yes |
display.fields | array | no |
display.fields[].key | string | yes |
display.fields[].label | string | yes |
{
"data": [
{
"invoice_id": "00000000-0000-4000-8000-000000000000",
"job_id": "00000000-0000-4000-8000-000000000000",
"status": "draft",
"customer": "...",
"total_minor": 50000,
"total_text": "...",
"doc_no": 1,
"doc_label": "...",
"currency": "...",
"issued_at": "...",
"due_on": "...",
"created_at": "..."
}
],
"next_cursor": "...",
"time_zone": "...",
"summary": "...",
"display": {
"kind": "table",
"title": "..."
}
}
Errors
| Code | Status | What to do |
|---|
invalid_input, invalid_token, rate_limited | | Can happen on any call. See errors. |