Skip to main content
Documentation

Invoices

invoices.statement

Draw one customer's account statement of invoices and payments
Read-onlyRead budget

REST

Shipping
POST /api/v1/invoices/statement

MCP tool

Live
invoices.statement

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

Operating contract

The customer's whole account with this shop as one document: every invoice oldest-first, every payment applied to them newest-first, the aging split, and the balance-due figure at the bottom.

This is the honest answer to 'what does this customer owe' — invoices.list filtered to one customer gives you the bills but not the payments against them, and a balance derived from bills alone reads too high.

SETTLED INVOICES ARE LEFT OFF by default, because a statement is a demand for money. Pass include_paid: true when the question is really 'what has this customer spent with us'.

INVOICES CARRIED IN BY A DATA IMPORT ARE ALSO LEFT OFF by default. A migrated balance has never been reconciled here, and putting one on a demand over this shop's signature is how a customer gets chased for somebody else's bookkeeping. include_imported: true is the deliberate opt-in.

ledger_truncated: true means the payment walk hit its ceiling, so every balance on this response reads TOO HIGH. Say so rather than quoting the figure — it is effectively unreachable on a real account (the ceiling is 20,000 rows) but it is reported rather than assumed.

This does not send anything. Putting the statement in front of the customer is a person's decision at /customers/[id]/statement.

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.

Input

FieldTypeDescription
customer_idrequiredstringuuid

The customer, as returned by customers.list or customers.find_by_contact.

include_paidboolean

True also includes settled invoices. Defaults to false.

include_importedboolean

True also includes invoices carried in by a data import. Defaults to false.

as_ofstring

Draw the statement as of this date, YYYY-MM-DD. Defaults to today.

Output

FieldTypeDescription
as_ofstring

liveboolean

ledger_truncatedboolean

customer_namestring

totalsobject

totals.invoicednumber

totals.paidnumber

totals.balance_duenumber

totals.past_duenumber

bucketsobject[]

buckets[].keystring

buckets[].labelstring

buckets[].countnumber

buckets[].amountnumber

invoicesobject[]

invoices[].invoice_idstring

invoices[].numberstring

invoices[].statusstring

invoices[].datestring | null

invoices[].due_datestring | null

invoices[].totalnumber

invoices[].paidnumber

invoices[].balancenumber

invoices[].days_past_duenumber

paymentsobject[]

payments[].payment_idstring

payments[].invoice_numberstring

payments[].received_atstring

payments[].methodstring

payments[].amountnumber

payments[].refundednumber

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/statement \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"customer_id":"9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"}'

TypeScript (fetch)
const res = await fetch("https://www.servicevin.com/api/v1/invoices/statement", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "customer_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"
  }),
});

// 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/statement",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={
    "customer_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"
},
    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.statement",
    "arguments": {
      "customer_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"
    }
  }
}

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.