Documentation
Invoices
invoices.get
REST
ShippingPOST /api/v1/invoices/getMCP tool
Liveinvoices.getExposed on: REST API · Shop MCP server · Claude connector · Dash (in-app copilot) · Zapier. Part of the Invoices domain.
Operating contract
The complete bill: its number, its status, every total, what has been paid, what is still owed, the due date, the purchase-order number, and the notes and terms the customer sees on the portal page.
balance is the figure to quote a customer. total is what the bill came to, which is a different number the moment anything has been paid against it.
total_cost is the shop's own cost of the work and is STAFF-ONLY — it is margin, not price. Never read it out to a customer or put it in a message.
quote_id is set when this bill came from an accepted quote and job_id when it came from a job; either one is the way back to what was actually agreed.
For the payments applied to it call payments.list with this invoice_id. For the customer's whole account call invoices.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
| Field | Type | Description |
|---|---|---|
| invoice_idrequired | stringuuid | The invoice's id, as returned by invoices.list or invoices.create_from_job. |
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/get \
-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/get", {
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/get",
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.get",
"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. |
| 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. |