Documentation
Invoices
invoices.void
REST
ShippingPOST /api/v1/invoices/voidMCP tool
Liveinvoices.voidExposed on: REST API · Shop MCP server · Claude connector · Dash (in-app copilot) · Zapier. Part of the Invoices domain.
Operating contract
TERMINAL, AND IT IS THE STOP BUTTON FOR AUTOMATION. The invoice chaser, the recovery desk, the weekly digest, the dashboard's 'owing' tile and the customer's statement all select on open and partial, so voiding takes the bill out of every one of them in one write — which is what a shop needs after refunding a deposit, so nothing texts the customer about a balance they no longer owe.
Nothing reopens a void. reopenInvoice exists at the screen and is deliberately not a capability — un-saying 'this was collected' is a correction a person makes with the ledger in front of them.
REFUSED WHILE THE INVOICE IS HOLDING MONEY. The guard reads the payment rows net of refunds, not the balance rollup, so it is measuring what the shop actually has. Refund or void the payments first — both of which are a person at a screen — or, if the shop is keeping what was paid, credit off the rest instead.
Also refused when the invoice changed between your read and this write, which usually means a payment landed. Re-read with invoices.get and decide again rather than retrying.
reason is recorded on the audit trail and is worth writing: months later 'why is this bill void' is a real question with no other answer.
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
writeCounted against the write budget, which is tighter than a read.
Input
| Field | Type | Description |
|---|---|---|
| invoice_idrequired | stringuuid | The invoice to void, as returned by invoices.list or invoices.get. |
| reason | stringmax 500 chars | Why it is being voided, in the shop's own words. Recorded on the audit trail. |
Output
| Field | Type | Description |
|---|---|---|
| id | string | — |
| invoice_number | number | — |
| status | string | — |
| customer_id | string | — |
| job_id | string | null | — |
| quote_id | string | null | — |
| subtotal | number | — |
| discount_total | number | — |
| tax_total | number | — |
| total | number | — |
| amount_paid | number | — |
| balance | number | — |
| due_date | string | null | — |
| days_past_due | number | — |
| issued_at | string | null | — |
| paid_at | string | null | — |
| po_number | string | null | — |
| created_at | string | — |
| notes | string | null | — |
| terms | string | null | — |
| total_cost | number | — |
| updated_at | string | — |
Examples
Built from this capability's own schema — required fields and the ones carrying a default, and nothing invented. Paste one and it validates.
export SERVICEVIN_API_KEY=svk_live_…
curl -X POST https://www.servicevin.com/api/v1/invoices/void \
-H "Authorization: Bearer $SERVICEVIN_API_KEY" \
-H "Content-Type: application/json" \
-d '{"invoice_id":"9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"}'const res = await fetch("https://www.servicevin.com/api/v1/invoices/void", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"invoice_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;import os, requests
res = requests.post(
"https://www.servicevin.com/api/v1/invoices/void",
headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
json={
"invoice_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"
},
timeout=30,
)
payload = res.json()
if not res.ok:
raise RuntimeError(payload["error"]["code"])
data = payload["data"]{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "invoices.void",
"arguments": {
"invoice_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.
| 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. |
| 403 | insufficient_scope | The credential is read-only and this capability writes. |
| 422 | validation_error | An argument was wrong. The message names the field. |
| 429 | rate_limited | Too many write calls. Back off and retry. |
| 500 | internal_error | Something failed on our side. Nothing was changed. |