Read a sales invoice

GEThttps://<your-url>/api/v2/sales-invoices/{sales_invoice}

MCP id sales-invoices.showAlso on this path: PATCH Update a sales invoice, DELETE Delete a sales invoice

Returns one invoice in the detail view.

Token scope: api:read:sales_invoices
Without it: 403 insufficient-token-scope.
Permission: sales_invoices::read
Without it: 403 insufficient-permission.
Feature: Needs the billing feature on your organisation.
Without it: 404 endpoint-not-found.
Rate cost: 1 unit, read bucket.
Also: If-None-Match answers 304 when nothing changed. Never cached: private, no-store. Unknown query parameters are refused, never ignored.

Both are checked, scope first. A token never does more than its user. How access is checked

Request

Example: One invoice with its customer

curl -G \
  'https://<your-url>/api/v2/sales-invoices/1' \
  --data-urlencode 'include=customer' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'

const response = await fetch('https://<your-url>/api/v2/sales-invoices/1?include=customer', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
  },
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->get('https://<your-url>/api/v2/sales-invoices/1?include=customer');

import requests
response = requests.request(
    'GET',
    'https://<your-url>/api/v2/sales-invoices/1?include=customer',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json'},
)

Response

The shape of the response, with sample values.

{
  "data": {
    "id": 1,
    "customer_id": 1,
    "customer": {
      "id": 1
    },
    "project_id": 1,
    "customer_subscription_id": 1,
    "invoice_number": "…",
    "reference": "PO-4471",
    "description": "Development work, January 2026",
    "invoice_date": "2026-02-01",
    "due_date": "2026-03-03",
    "status": "draft",
    "should_email": false
  },
  "meta": {
    "actions": [
      "restore"
    ]
  }
}

18 more fields, listed under Response

It is addressable by numeric id and by invoice number on the same path, so sales-invoices/B-26-00001 and sales-invoices/L-1234 both resolve. Invoices are soft-deleted, so a deleted invoice is 404 unless trashed=with or trashed=only is passed; trashed=only 404s a live one. The line rows are not part of this payload: rows_count reports how many there are, and links.rows is where they live.

Path parameters

sales_invoiceinteger or stringRequired

The SalesInvoice's numeric id. Or its invoice_number, matching [A-Z]+-[0-9]{2}-[0-9]{5}|L-[0-9]+. Accepts a soft-deleted record.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

viewstring

Which field set to render.

summarydetaildefault

trashedstring

Whether soft-deleted rows are included.

withoutdefaultwithonly

metaarray of string

Optional meta members to compute for this response.

actions

New values may be added.

Request headers

X-Request-Idstringpattern

A correlation id of your own. It is recorded in our logs next to the server's request id but never returned: the response header always carries the server's id. A value that does not match the pattern is discarded silently, never rejected.

If-None-Matchstring

The ETag a read is conditional on. A match is answered 304 with no body.

Response 200

Returns a SalesInvoice in the detail view.

Headers

ETag: A strong validator of exactly this representation.
RateLimit: The IETF httpapi-ratelimit-headers form of your remaining allowance on the tightest bucket this request touched.
RateLimit-Policy: The ceiling and window of that bucket, as <limit>;w=<seconds>.
X-Request-Id: The server-generated ULID correlating this response with our logs.

Every response also carries Cache-Control, Vary, X-Content-Type-Options, X-Plnnrly-Api-Version, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Headers and versioning

idinteger

Unique identifier.

customer_idinteger

Customer this invoice is billed to.

customerRef or CustomerSummary

The customer this invoice is billed to. Expanding it with ?include=customer additionally requires the customers::read permission and a token scope covering the customers prefix.

project_idinteger or null

Project this invoice was raised for, when it was raised from one.

customer_subscription_idinteger or null

Customer subscription this invoice was generated from, when it was generated from a renewal.

invoice_numberstring≤ 255Server-assigned

Invoice number, allocated by the server from the organisation's yearly sequence: B-26-00001 for an invoice raised in this flow, L-1234 for one converted from a legacy invoice. It also works in the path: GET sales-invoices/B-26-00001 works. This is the field ?q= searches.

referencestring or null≤ 255

The customer's own reference, typically a purchase-order number, reproduced on the invoice.

descriptionstring or null≤ 255

One-line description of what was invoiced.

invoice_datedate (YYYY-MM-DD)

Invoice date, a zone-free calendar date. Newest first is the default sort.

due_datedate (YYYY-MM-DD) or null

Date payment is due, a zone-free calendar date. Null when no term was applied.

statusstringServer-assigned

Lifecycle status. Resolved by the server on create and never writable: a caller without sales_invoices::finalize creates a pending_approval invoice, and any update by such a caller returns the invoice to pending_approval.

draftpending_approvalsentpaidoverduecancelled

New values may be added.

should_emailboolean

Whether the invoice is emailed to the customer when it syncs. The email is sent through the accounting integration, so it is forced to false in an organisation with no integration configured. Writing it requires sales_invoices::finalize.

subtotaldecimal (2 dp)Server-assigned

Sum of the row line totals excluding VAT, as a decimal string. Recomputed from the rows; never written directly.

2 decimal places, may be negative

vat_totaldecimal (2 dp)Server-assigned

Sum of the row VAT amounts, as a decimal string. Recomputed from the rows; never written directly.

2 decimal places, may be negative

totaldecimal (2 dp)Server-assigned

Subtotal plus VAT, as a decimal string. Recomputed from the rows; never written directly.

2 decimal places, may be negative

exact_invoice_idstring or null≤ 255Server-assigned

The accounting system's own identifier for this invoice, written by the sync. Not a local id.

exact_journalstring or null≤ 255Server-assigned

Sales journal the invoice is booked in, resolved from the organisation's accounting settings on create. Null in an organisation with no integration configured.

sync_statusstringServer-assigned

How far the invoice has got through the accounting sync. Set on create: local in an organisation with no integration configured, pending otherwise.

pendingsyncedfailedlocal

New values may be added.

sync_errorstring or nullDetail onlyServer-assignedMultiline

Why the last sync attempt failed, verbatim from the accounting system. Null while nothing has failed.

synced_attimestamp (YYYY-MM-DDThh:mm:ssZ) or nullServer-assigned

When the invoice last synced successfully.

sync_attempted_attimestamp (YYYY-MM-DDThh:mm:ssZ) or nullServer-assigned

When the invoice was last handed to the sync, successfully or not.

paid_attimestamp (YYYY-MM-DDThh:mm:ssZ) or nullServer-assigned

When the invoice was settled. Set on create for a local invoice that is immediately definitive; otherwise written when payment is registered.

is_legacybooleanServer-assigned

Whether this invoice was converted from a legacy invoice. Such an invoice is read-only: PATCH and DELETE answer 409 state-conflict with reason locked_by_legacy.

legacy_invoice_idinteger or nullServer-assigned

The id of the legacy invoice this invoice was converted from, so it can be matched with GET /api/v2/invoices. The legacy invoice may since have been removed.