List an invoice's lines

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

MCP id sales-invoices.rows.indexAlso on this path: POST Add a line to an invoice

Returns one sales invoice's lines in their printed order, sort_order ascending.

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. view=detail makes it 3. Adds: each include +1, q +2.
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's lines, including its deleted ones

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

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

import requests
response = requests.request(
    'GET',
    'https://<your-url>/api/v2/sales-invoices/1/rows?trashed=with',
    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": "Sprint 42: development",
      "description": "Feature work on the customer portal.",
      "quantity": "12.50"
    }
  ],
  "meta": {
    "page": {
      "per_page": 1,
      "next_cursor": "…",
      "prev_cursor": "…",
      "total": 1,
      "current_page": 1,
      "last_page": 1
    }
  },
  "links": {
    "self": "https://<your-url>/api/v2/work-items/1",
    "next": "https://<your-url>/api/v2/work-items/1",
    "prev": "https://<your-url>/api/v2/work-items/1"
  }
}

12 more fields, listed under Response

There is no organisation-wide collection of invoice lines: a line only means anything under the invoice it belongs to, so this nested path is the only way to list them and filter[sales_invoice_id] does not exist. A deleted invoice answers 404 for the whole path unless trashed=with is passed, which also includes the invoice's deleted lines. Defaults to the summary view; pass include=sales_invoice to expand the invoice each line points at.

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.

21 parameters in 7 groups

Views

viewstring

Which field set to render.

summarydefaultdetail

Pagination

per_pageinteger1 to 100

Rows per page. At most 25 when include names a to-many relation; a larger value is 400 invalid-query-parameter.

Default: 25

cursorstring

Opaque keyset cursor from a previous page's links.next. Never construct one by hand.

pageinteger1 to 1000

Opt in to page-number paging: 1-based, at most 1000. Omit it, the default, to page by opaque cursor, which is what links.next hands you. Cannot be combined with cursor. Published only on collections that count their rows on every request. This collection's default sort is a display position that changes whenever someone drags the list into a new order in plnnrly, so a page number can skip or repeat a row if the list is reordered between two page requests. These collections rarely exceed one page; for a stable walk, send sort=id and follow links.next without page.

Filters

=: equals
[in]: any of a comma-separated list
[null]: true or false: whether it is empty
[gte][lt]: at least, less than

filter[budget_id]integer=[in][null]

Project budget this invoice line settles.

A comma-separated list of at most 100 values.

filter[created_at]timestamp (YYYY-MM-DDThh:mm:ssZ)=[gte][lt]

Creation timestamp. Pair with sort=id for a stable full export.

filter[is_aggregated_price]boolean

Whether the line carries one aggregated price rather than hours times an hourly rate.

filter[subscription_item_id]integer=[in][null]

Subscription line this invoice line was generated from.

A comma-separated list of at most 100 values.

filter[updated_at]timestamp (YYYY-MM-DDThh:mm:ssZ)=[gte][lt]

Last-write timestamp. Use for incremental sync.

Search

qstring

Free-text search over name. At most one substring match per request: q together with a contains filter is 400 invalid-query-parameter.

Sorting

sortstring

Up to three keys, comma-separated, each optionally prefixed with - for descending.

Default: sort_order

Key	Sorts by
`sort_order`	Position of the line within its invoice, first to last.
`name`	Line label, A→Z.
`id`	Id, ascending. An id never changes, so use this for a stable full export.
`updated_at`	Last-write timestamp; pair with the id tiebreaker for sync.

Prefix a key with - for descending.

Includes

includestring

Comma-separated names to inline, at most five.

Path	Adds	Cost
`sales_invoice`	The invoice this line belongs to.	+1

Other

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 page of SalesInvoiceRowList rows.

dataarray of SalesInvoiceRowList

The rows, each a SalesInvoiceRowList.

meta.pagePage

per_page, next_cursor, prev_cursor, total, current_page, last_page.

linksPageLinks

self, next, prev.

Each row is a SalesInvoiceRowList: 24 fields.

Headers

ETag: A weak validator (W/"…") of the rendered page.
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.