Settle Whole PO Billing (Final Invoice)
POST/api/purchase-orders/:purchase_order/settle-billing
Bulk-settle the billing axis for every eligible line on a purchase order in one call — the whole-PO equivalent of the per-line settle endpoint. Each still-open, short-billed line is stamped billing-settled; lines already fully invoiced or already settled are left untouched.
purchase-orders:writeGrant 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 every line settled by this call.
After settling, the purchase order's invoice_status is re-derived and returned.
Response fields:
settled_count: number of lines newly billing-settled by this call.purchase_order:{ id, invoice_status, fully_invoiced }after re-derivation.lines[]: the billing-settlement view of each line that was settled (each eager-loaded withbillingSettledByandpurchaseOrder).
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.