Read an invoice line

GEThttps://<your-url>/api/v2/sales-invoice-rows/{sales_invoice_row}

MCP id sales-invoice-rows.showAlso on this path: PATCH Update an invoice line, DELETE Delete an invoice line

Returns one invoice line 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 line with its invoice expanded

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

const response = await fetch('https://<your-url>/api/v2/sales-invoice-rows/1?include=sales_invoice', {
  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-invoice-rows/1?include=sales_invoice');

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

Response

The shape of the response, with sample values.

{
  "data": {
    "id": 1,
    "sales_invoice_id": 1,
    "sales_invoice": {
      "id": 1
    },
    "subscription_item_id": 1,
    "budget_id": 1,
    "exact_item_id": "…",
    "exact_vat_code": "…",
    "exact_cost_center": "…",
    "exact_gl_account": "…",
    "name": "…",
    "description": "…",
    "quantity": "1250.00"
  }
}

12 more fields, listed under Response

Lines are soft-deleted, so a deleted line is 404 unless trashed=with or trashed=only is passed; trashed=only 404s a live line. This flat path performs no lookup of the parent invoice: a line is readable by id to any caller holding sales_invoices::read, which is what plnnrly does too.

Path parameters

sales_invoice_rowintegerRequired

The SalesInvoiceRow's numeric id. 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

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 SalesInvoiceRow 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.

sales_invoice_idintegerServer-assigned

The invoice this line belongs to. Taken from the path on create and never writable afterwards: a line cannot be moved to another invoice.

sales_invoiceRef or SalesInvoiceSummary

The invoice this line belongs to.

subscription_item_idinteger or null

Subscription line this invoice line was generated from, when the row came out of a subscription renewal rather than being typed by hand.

budget_idinteger or null

Project budget this invoice line settles, when the row was generated from budget hours.

exact_item_idstring or null≤ 255

Exact Online article identifier this line bills against. Empty is accepted, but a row without it fails the whole invoice's Exact sync.

exact_vat_codestring or null≤ 255

Exact Online VAT code, by code rather than by id.

exact_cost_centerstring or null≤ 255

Exact Online cost-centre code.

exact_gl_accountstring or null≤ 255

Exact Online general-ledger revenue account for this line.

namestring≤ 255

The line label, as printed on the invoice. Exact Online prints this when description is empty.

descriptionstring or nullMultiline

Longer line text. Exact Online prints this in preference to name.

quantitydecimal (2 dp)

Number of units billed. Fractional and signed: a budget row carries hours, and a credit line carries a negative quantity.

2 decimal places, may be negative

unit_pricedecimal (2 dp)

Price per unit, excluding VAT. This is what actually bills.

2 decimal places, may be negative

hourly_ratedecimal (2 dp) or null

Rate plnnrly recomputes unit_price from when the aggregated-price toggle is switched on a budget row. Stored exactly as sent and null when omitted; it feeds no server-side computation.

2 decimal places, may be negative

billable_minutesinteger

Minutes of budget time this line settles. Zero on a hand-typed row.

is_aggregated_priceboolean

True: one line of quantity 1 priced at hours times rate. False: quantity carries the hours and unit_price the hourly rate.

vat_rateinteger

VAT percentage as a whole number: 21 means 21%.

vat_amountdecimal (2 dp)Server-assigned

VAT on this line: quantity times unit_price times vat_rate, rounded to two decimals. Recomputed by the server whenever one of those three changes.

2 decimal places, may be negative

total_amountdecimal (2 dp)Server-assigned

Line total excluding VAT (quantity times unit_price), which is the convention the invoice form writes. Recomputed by the server whenever quantity or unit_price changes.