Skip to main content
Documentation

Invoices

invoices.issue

Issue a draft invoice so the balance becomes owed
WritesWrite budget

REST

Shipping
POST /api/v1/invoices/issue

MCP tool

Live
invoices.issue

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

Operating contract

Moves a DRAFT bill to open and stamps its due date from the shop's own net terms. Until this runs, nothing is owed, nothing appears in the aging, and no chaser will ever mention it.

THIS IS THE STEP THAT IS EASY TO FORGET. A draft raised by invoices.create_from_job looks like a bill on every screen and is invisible to every collection path. If a shop owner asks why an invoice is not showing up as owed, check its status here first.

A draft can already carry settled payments — a booking deposit re-pointed onto it, or a deposit taken in the quoting flow — so this may land the invoice on partial or paid rather than open. The issue stands either way; read the status back with invoices.get.

There is NO CLOSED STATE in this product, and no capability that makes one. An invoice leaves the collectible set by being paid in full or by being voided, and nothing else.

Issuing does not tell the customer anything. invoices.send is what does that, and it is a separate call for exactly that reason.

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

FieldTypeDescription
invoice_idrequiredstringuuid

The draft invoice, 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/issue \
  -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/issue", {
  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/issue",
    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.issue",
    "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.
403insufficient_scopeThe credential is read-only and this capability writes.
422validation_errorAn argument was wrong. The message names the field.
429rate_limitedToo many write calls. Back off and retry.
500internal_errorSomething failed on our side. Nothing was changed.