Update an invoice line

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

MCP id sales-invoice-rows.updateAlso on this path: GET Read an invoice line, DELETE Delete an invoice line

Partially updates one line: absent keys are untouched.

Token scope: api:write:sales_invoices
Without it: 403 insufficient-token-scope.
Permission: sales_invoices::update
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 If-Match. 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: Correct the billed hours

curl -X PATCH \
  'https://<your-url>/api/v2/sales-invoice-rows/1' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'If-Match: *' \
  -d '{
    "quantity": "14.00"
  }'

const response = await fetch('https://<your-url>/api/v2/sales-invoice-rows/1', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'If-Match': '*',
  },
  body: JSON.stringify({
    "quantity": "14.00"
  }),
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->withHeader('If-Match', '*')
    ->patch('https://<your-url>/api/v2/sales-invoice-rows/1', [
        'quantity' => '14.00',
    ]);

import requests
response = requests.request(
    'PATCH',
    'https://<your-url>/api/v2/sales-invoice-rows/1',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json', 'Content-Type': 'application/json', 'If-Match': '*'},
    json={'quantity': '14.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": "…",
    "description": "…",
    "quantity": "14.00"
  }
}

{
  "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/precondition-failed",
  "title": "Precondition failed",
  "status": 412,
  "detail": "The record changed since the version named in If-Match. Re-read it and retry.",
  "instance": "/api/v2/work-items/812",
  "request_id": "01K4B7Q9YV3PZ2N8T1E6M0XR4S",
  "current_version": 12
}

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

Send If-Match with the ETag from your last read to detect a concurrent edit, which answers 412. vat_amount and total_amount are server-assigned: changing any of quantity, unit_price or vat_rate recomputes both, as the invoice form does. The invoice's subtotal, vat_total and total are recalculated in the same transaction. A line of 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. sales_invoice_id and sort_order are not accepted: a line cannot be moved to another invoice, and there is no way to reorder lines through the API.

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-Matchstring

The ETag a write is conditional on. A stale validator is 412 precondition-failed.

Request body

Unknown keys are refused with 422, naming the key.

namestring≤ 255

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

quantitydecimal (2 dp)-99999999.99 to 99999999.99

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

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