invoices.aging

Total every unpaid invoice, split by how overdue it is

Read-onlyRead budget

REST

Shipping

POST /api/v1/invoices/aging

MCP tool

Live

invoices.aging

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

Operating contract

THE READ FOR 'HOW MUCH ARE WE OWED'. It walks every collectible invoice in the shop — not a page of them — and returns the four aging buckets the Reports chart and the customer statement both use: current, 1-30 days, 31-60 days, and 60+ days.

Use this rather than adding up invoices.list. That read is capped and will quietly answer about part of the book; this one counts all of it, which is why it has no limit and nothing to truncate.

balance_due is the whole receivable. past_due is the part of it whose due date has gone. Those two are the sentence a shop owner wants; the buckets are the follow-up.

An invoice with no due date ages as current rather than being guessed into a bucket — an undated bill is not overdue, it is unscheduled.

Drafts, voids, refunded and paid invoices are all excluded, because none of them is money anybody owes.

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

This capability takes no arguments.

Output

Field	Type	Description
balance_due	number	—
past_due	number	—
invoice_count	number	—
buckets	object[]	—
buckets[].key	string	—
buckets[].label	string	—
buckets[].count	number	—
buckets[].amount	number	—

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/aging \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

TypeScript (fetch)

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

// 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/aging",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={},
    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.aging",
    "arguments": {}
  }
}

Refusals

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

Status	Code	When
404	`not_found`	The id is unknown, or the feature is not enabled for this account. Deliberately the same answer for both.
403	`forbidden`	This login does not hold invoices.access.
422	`validation_error`	An argument was wrong. The message names the field.
429	`rate_limited`	Too many read calls. Back off and retry.
500	`internal_error`	Something failed on our side. Nothing was changed.

Operating contract#

Who may call it#

Input#

Output#

Examples#