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.

WhoAgents can call this
RESTGET /v1/invoices
MCP toolinvoices_list
Writesno
AreaShop

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.

Input

FieldTypeRequired
shop_idstring (uuid)yes
statusstring (one of draft, sent, partially_paid, paid, partially_refunded, refunded, void)no
qstringno
limitintegerno
cursorstringno

Example

GET https://doingwork.work/v1/invoices?shop_id=00000000-0000-4000-8000-000000000000

Output

FieldTypeAlways there
dataarrayyes
data[].invoice_idstring (uuid)yes
data[].job_idstring (uuid)yes
data[].statusstring (one of draft, sent, partially_paid, paid, partially_refunded, refunded, void)yes
data[].customer['string', 'null']yes
data[].total_minorintegeryes
data[].total_textstringyes
data[].doc_nointegeryes
data[].doc_labelstringyes
data[].currencystringyes
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_atstring (date-time)yes
next_cursor['string', 'null']yes
time_zonestringyes
summarystringyes
displayobjectyes
display.kindstring (one of table, cards, timeline, checklist, map, calendar, chart)yes
display.titlestringyes
display.columnsarrayno
display.columns[].keystringyes
display.columns[].labelstringyes
display.fieldsarrayno
display.fields[].keystringyes
display.fields[].labelstringyes
{
  "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

CodeStatusWhat to do
invalid_input, invalid_token, rate_limitedCan happen on any call. See errors.