Documentation
Invoices
invoices.issue
REST
ShippingPOST /api/v1/invoices/issueMCP tool
Liveinvoices.issueExposed 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
| Field | Type | Description |
|---|---|---|
| invoice_idrequired | stringuuid | The draft invoice, 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/issue \
-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/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;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"]{
"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.
| 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. |