Add a line to an invoice

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

MCP id sales-invoices.rows.storeAlso on this path: GET List an invoice's lines

Creates one line on the invoice named in the path and returns it in the detail view, with a Location header pointing at the flat item path.

Token scope: api:write:sales_invoices
Without it: 403 insufficient-token-scope.
Permission: sales_invoices::create
Without it: 403 insufficient-permission.
Feature: Needs the billing feature on your organisation.
Without it: 404 endpoint-not-found.
Rate cost: 1 unit, write bucket. A write costs the same whatever view you ask for.
Also: Accepts Idempotency-Key. Never cached: private, no-store. Unknown body keys are refused, never dropped.

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

Request

Example: A hand-typed line at the organisation's default VAT rate

curl -X POST \
  'https://<your-url>/api/v2/sales-invoices/1/rows' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: <key>' \
  -d '{
    "name": "Sprint 42: development",
    "description": "Feature work on the customer portal.",
    "quantity": "12.50",
    "unit_price": "95.00"
  }'

const response = await fetch('https://<your-url>/api/v2/sales-invoices/1/rows', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Idempotency-Key': '<key>',
  },
  body: JSON.stringify({
    "name": "Sprint 42: development",
    "description": "Feature work on the customer portal.",
    "quantity": "12.50",
    "unit_price": "95.00"
  }),
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->withHeader('Idempotency-Key', '<key>')
    ->post('https://<your-url>/api/v2/sales-invoices/1/rows', [
        'name' => 'Sprint 42: development',
        'description' => 'Feature work on the customer portal.',
        'quantity' => '12.50',
        'unit_price' => '95.00',
    ]);

import requests
response = requests.request(
    'POST',
    'https://<your-url>/api/v2/sales-invoices/1/rows',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json', 'Content-Type': 'application/json', 'Idempotency-Key': '<key>'},
    json={'name': 'Sprint 42: development', 'description': 'Feature work on the customer portal.', 'quantity': '12.50', 'unit_price': '95.00'},
)

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"
  }
}

{
  "type": "https://developers.plnnrly.com/api/v2/problems/state-conflict",
  "title": "State conflict",
  "status": 409,
  "detail": "The target status is not reachable from this work item's current status.",
  "instance": "/api/v2/work-items/812/actions/transition",
  "request_id": "01K4B7Q9YV3PZ2N8T1E6M0XR4S",
  "conflict": {
    "reason": "illegal_transition",
    "from_workflow_status_id": 3,
    "to_workflow_status_id": 9
  }
}

{
  "type": "https://developers.plnnrly.com/api/v2/problems/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "3 fields failed validation.",
  "instance": "/api/v2/worklogs",
  "request_id": "01K4B7Q9YV3PZ2N8T1E6M0XR4S",
  "errors": [
    {
      "pointer": "/date",
      "code": "date_format",
      "detail": "The date does not match the format Y-m-d."
    },
    {
      "pointer": "/minutes",
      "code": "min",
      "detail": "The minutes must be at least 1."
    },
    {
      "pointer": "/description",
      "code": "required",
      "detail": "The description field is required."
    }
  ]
}

12 more fields, listed under Response

The invoice comes from the path, so sales_invoice_id is not accepted in the body and a line can never be moved between invoices. vat_rate defaults to the organisation's configured VAT percentage. vat_amount and total_amount are server-assigned, always computed from quantity, unit_price and vat_rate; total_amount excludes VAT. The invoice's own subtotal, vat_total and total are recalculated from all of its lines in the same transaction. A deleted invoice answers 404, and a legacy or synced invoice answers 409 state-conflict. A caller without sales_invoices::finalize also returns the invoice to pending_approval, as editing the invoice itself does. exact_item_id is optional here as it is in plnnrly, but in an organisation using Exact a line without it fails the whole invoice's sync, and naming an exact_item_id does not auto-fill the VAT code, GL account or hourly rate plnnrly would fill in from it.

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

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.

Idempotency-Keystring≤ 255

A caller-chosen key that makes this POST safe to retry. Replaying it returns the original response with Idempotency-Replayed: true.

Request body

Unknown keys are refused with 422, naming the key.

namestring≤ 255Required

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

quantitydecimal (2 dp)-99999999.99 to 99999999.99Required

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

At least -99999999.99. At most 99999999.99.

unit_pricedecimal (2 dp)-99999999.99 to 99999999.99Required

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

2 decimal places, may be negative

At least -99999999.99. At most 99999999.99.

descriptionstring or null

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

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≥ 0

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_rateinteger0 to 100

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

budget_idinteger or null → Budget.id

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

subscription_item_idinteger or null → SubscriptionItem.id

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

Response 201

Returns a SalesInvoiceRow in the detail view.

Headers

ETag: A strong validator of exactly this representation.
Idempotency-Replayed: true when this response was replayed from a stored Idempotency-Key rather than produced by a new write.
Location: The absolute URL of the created or queued resource.
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.