Skip to main content
Documentation

Invoices

invoices.list

List invoices by status, customer or how overdue they are
Read-onlyRead budget

REST

Shipping
POST /api/v1/invoices/list

MCP tool

Live
invoices.list

Exposed on: REST API · Shop MCP server · Claude connector · Dash (in-app copilot) · Zapier. Part of the Invoices domain.

Operating contract

The shop's bills, newest-first, narrowed by any combination of the filters.

status takes one of draft, open, partial, paid, void, refunded. unpaid_only: true is the shortcut for the two that are still collecting — open and partial — which is what 'who owes us money' actually means; a draft is not owed and a void is not either.

overdue_only: true narrows further to the collectible bills whose due date has passed. min_days_past_due narrows again by age, which is how you ask for 'anything more than 60 days out'.

Every row carries balance (what is still owed) and days_past_due, both computed here — do not subtract total and amount_paid yourself, and never report total as what a customer owes.

id is the invoice_id that invoices.get, invoices.send, invoices.record_payment and invoices.void all take. customer_id is customers.get's.

TRUNCATION: total here is the exact count of MATCHING INVOICES (not a money figure — the money is on each row) and omitted is how many are not in this response. When omitted is not 0, call again with offset set to next_offset. Never total a shop's receivables from a response whose omitted is not 0 — use invoices.aging, which counts every one.

Who may call it

Permission
invoices.accessThe caller must hold Invoices at the ACT level. A read-only dashboard grant on the same section is refused.
Plan
Every planNo plan gate. Available on every Service VIN plan.
Retries
naturalNaturally idempotent — running it twice leaves the same world as running it once. A retrying integration needs no key.
Rate class
readCounted against the read budget — the widest of the four.

Partial answers

omitted is how many matching records are not in the response, and 0 is a real answer meaning you have all of them. Continue with next_offset.

Do not summarise from a truncated response

When `omitted` is not 0 there are more matching invoices. Call again with `offset` set to `next_offset`, or narrow the filters. For a complete money total use invoices.aging instead.

Input

FieldTypeDescription
statusstring

One invoice status. Omit to include every status.

One of: draft, open, partial, paid, void, refunded
unpaid_onlyboolean

True returns only invoices still collecting — open and partial.

overdue_onlyboolean

True returns only collectible invoices whose due date has passed.

min_days_past_dueinteger0–3650

Only invoices at least this many days past due. Implies overdue_only.

customer_idstringuuid

One customer's id, as returned by customers.list or customers.get.

limitinteger1–100

How many invoices to return, 1-100. Defaults to 25.

Default: 25
offsetintegermin 0

How many to skip. Pass the previous response's next_offset to continue.

Default: 0

Output

FieldTypeDescription
itemsobject[]

items[].idstring

items[].invoice_numbernumber

items[].statusstring

items[].customer_idstring

items[].job_idstring | null

items[].quote_idstring | null

items[].subtotalnumber

items[].discount_totalnumber

items[].tax_totalnumber

items[].totalnumber

items[].amount_paidnumber

items[].balancenumber

items[].due_datestring | null

items[].days_past_duenumber

items[].issued_atstring | null

items[].paid_atstring | null

items[].po_numberstring | null

items[].created_atstring

totalnumber

omittednumber

next_offsetnumber | null

Examples

Built from this capability's own schema — required fields and the ones carrying a default, and nothing invented. Paste one and it validates.

curl
export SERVICEVIN_API_KEY=svk_live_…

curl -X POST https://www.servicevin.com/api/v1/invoices/list \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":25,"offset":0}'

TypeScript (fetch)
const res = await fetch("https://www.servicevin.com/api/v1/invoices/list", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "limit": 25,
    "offset": 0
  }),
});

// Success and failure are both envelopes. Switch on error.code, never
// on error.message — the codes are stable, the messages are for people.
const payload = await res.json();
if (!res.ok) throw new Error(payload.error.code);
const data = payload.data;

Python (requests)
import os, requests

res = requests.post(
    "https://www.servicevin.com/api/v1/invoices/list",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={
    "limit": 25,
    "offset": 0
},
    timeout=30,
)
payload = res.json()
if not res.ok:
    raise RuntimeError(payload["error"]["code"])
data = payload["data"]

MCP tools/call — https://www.servicevin.com/api/mcp
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "invoices.list",
    "arguments": {
      "limit": 25,
      "offset": 0
    }
  }
}

Refusals

The four gates run in this order on every surface, and the order is not arbitrary — see Authentication.

StatusCodeWhen
404not_foundThe id is unknown, or the feature is not enabled for this account. Deliberately the same answer for both.
403forbiddenThis login does not hold invoices.access.
422validation_errorAn argument was wrong. The message names the field.
429rate_limitedToo many read calls. Back off and retry.
500internal_errorSomething failed on our side. Nothing was changed.