Skip to main content
Documentation

Invoices

invoices.get

Get one whole invoice, its balance and its terms
Read-onlyRead budget

REST

Shipping
POST /api/v1/invoices/get

MCP tool

Live
invoices.get

Exposed 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

FieldTypeDescription
invoice_idrequiredstringuuid

The invoice's id, as returned by invoices.list or invoices.create_from_job.

Output

FieldTypeDescription
idstring

invoice_numbernumber

statusstring

customer_idstring

job_idstring | null

quote_idstring | null

subtotalnumber

discount_totalnumber

tax_totalnumber

totalnumber

amount_paidnumber

balancenumber

due_datestring | null

days_past_duenumber

issued_atstring | null

paid_atstring | null

po_numberstring | null

created_atstring

notesstring | null

termsstring | null

total_costnumber

updated_atstring

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

TypeScript (fetch)
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;

Python (requests)
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"]

MCP tools/call — https://www.servicevin.com/api/mcp
{
  "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.

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.