Apply Discount Rate to Lines
POST/api/purchase-orders/:purchaseOrder/apply-discount-rate
Apply one discount rate to every line of a purchase order.
purchase-orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Body:
- discount (required, numeric, min:0, max:100): Discount percentage (e.g. 2 = 2%)
Lines already at the given rate are left untouched. When the order has already been received, the change is costed the same way editing a single line's price is: one cost change is raised for the whole order and your cost-change policy for PO price edits decides whether it applies immediately or is held as a pending cost change for review. An applied change re-costs every FIFO layer received against the changed lines and trues up the cost of goods sold for units already shipped; under a restate resolution each layer's revaluation is dated at its own receipt, under a going-forward resolution at the day the discount was entered.
Requires permission: purchase_orders.update
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
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.