Skip to main content

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.

Required scope: purchase-orders:write

Grant 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​

OK

Response Headers
    Content-Type