Skip to main content
Documentation

Invoices

invoices.line_items

List what one invoice actually charged for, line by line
Read-onlyRead budget

REST

Shipping
POST /api/v1/invoices/line_items

MCP tool

Live
invoices.line_items

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

Operating contract

The itemisation behind the total: each line's description, quantity, unit price, whether it was taxed, and any discount applied to it.

READ THIS BEFORE ARGUING ABOUT A BILL. 'Your total is $3,556' answers nothing when the customer's question is what the $3,556 was for; these are the lines their copy of the invoice prints.

line_total is the line's own figure when the invoice stored one. The INVOICE carries the authoritative totals — do not re-add the lines and report the sum as the bill, because tax, shipping and invoice-level discounts do not live here.

AN EMPTY LIST IS NOT AN EMPTY INVOICE. An invoice raised from an accepted quote may carry no lines of its own and print the quote's instead; quotes.list_lines on the invoice's quote_id is then the itemisation, and the invoice's own totals are still correct either way.

unit_cost is not returned. That is the shop's margin, and it has no business on a read whose whole purpose is explaining a bill to the person paying it.

One invoice's lines, entirely returned, so nothing is truncated.

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 to itemise, as returned by invoices.list or invoices.get.

Output

FieldTypeDescription
invoice_idstring

itemsobject[]

items[].idstring

items[].descriptionstring

items[].detailsstring | null

items[].quantitynumber

items[].unitstring

items[].unit_pricenumber

items[].line_totalnumber | null

items[].taxableboolean

items[].discount_kindstring | null

items[].discount_valuenumber | null

totalnumber

itemizedboolean

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/line_items \
  -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/line_items", {
  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/line_items",
    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.line_items",
    "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.