Withdraw Bill Payment Request
POST/api/bills/:bill/payment-request/withdraw
Withdraw a landed-cost bill's pending payment request. Only the requester or an administrator may withdraw, and only before anyone has approved part of it. A bill with an earlier approved amount returns to approved for that amount; otherwise it goes back to not requested.
purchase-orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Fields:
- reason (optional, string, max 500)
Authentication: Requires Bearer token.
Answers the bill (same shape as Get Bill) with its updated payment_approval_status and approval summary. Returns 409 approval_state_conflict when the tenant's bill payment approval policy is off — without the policy, landed-cost bills are paid without a payment request. The one bill payment approval policy covers purchase invoices and landed-cost bills alike.
Request
Responses
- 200
- 401
- 403
- 404
- 409
- 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
Response Headers
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Conflict
Response Headers
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.