BIbigchange
PurchaseOrders

Mark a purchase order as cancelled

Changed on

Mark a purchase order as cancelled (required scope finance:write)

put/v1/finance/purchaseOrders/{purchaseOrderId}/cancel

Request

  • Base URL
    https://api.bigchange.com
  • URL
    https://api.bigchange.com/v1/finance/purchaseOrders/{purchaseOrderId}/cancel
  • Auth
    HTTP bearer

Path parameters

purchaseOrderIdinteger required

Headers

Customer-Idinteger required

The customer identifier

Request body

cancelledAtstring date-time nullable

The date and time of the cancellation, cannot be in the future. If null defaults to UTC now

reasonstring nullable

The reason for cancelling the purchase order

Example request

{
  "cancelledAt": "2022-11-29T16:50:16.0000000+00:00",
  "reason": "No longer needed"
}

Response

No Content

Changes