Skip to main content

Settle PO Line Billing

POST 
/api/purchase-order-lines/:purchase_order_line/settle-billing

Mark a purchase order line as billing-settled. A billing-settled line counts as fully invoiced for reconciliation regardless of any residual short-billed quantity.

Required scope: purchase-orders:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token. Requires the purchase_orders.update permission.

Request body fields:

  • reason (optional, nullable, string, max 500): free-text note recorded on the settlement and shown in the audit trail.
  • kind (optional, string): how the line is being settled. final_invoice (default) records that the supplier's final bill is in and no more bills will follow; billed_outside_sku records that the supplier's bill already exists in your accounting provider only (a transition-period bill entered there before your ledger began, or one reconciled to a card or wire payment there), so the received-not-invoiced accrual is released from the settlement date without creating a bill; not_billable records an over-receipt nobody will ever bill (a fulfilment centre over-counted or mis-scanned the shipment while the supplier's invoice covers everything it shipped), releasing the accrual from the settlement date in the same way.
  • settled_at (optional, date): the settlement's effective date. Defaults to now. For billed_outside_sku pass the provider bill's date; for not_billable pass the date the over-count was recognised. The purchase clearing report honours this date: the line leaves the goods-received-not-invoiced position from that day.

Stamps billing_settled_at, billing_settlement_kind, billing_settled_reason, and billing_settled_by (the acting user) on the line, then re-derives the parent purchase order's invoice_status.

Validation errors (422): an unknown kind, an unparseable settled_at, or a line that cannot be settled — already billing-settled, or already fully invoiced through quantity/credit so settlement is unnecessary.

Returns the updated purchase order line billing-settlement view (with billing_settled_by and purchase_order).

Request​

Responses​

Created