Manage Invoice Reminders
PATCH/api/purchase-orders/:purchase_order/invoice-reminders
Set the automated invoice-reminder mode for a purchase order: inherit (use the supplier/tenant setting), on, or off. Setting on arms the recurring chase when the PO is still awaiting its invoice; off stops it.
Authentication: Requires Bearer token. Requires permission: purchase_orders.update. Throttled: 60 requests/min.
Body fields:
- mode (string, required) — one of: inherit, on, off
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.