Cancel a purchase order

Cancels a purchase order and returns it under purchase_order.

POST /purchase_orders/{purchase_order_id}/cancel

cURL

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/purchase_orders/PURCHASE_ORDER_ID/cancel" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

200

{
  "purchase_order": {
    "account": {
      "code": "<string>",
      "href": "<string>",
      "id": "<string>",
      "name": "<string>",
      "object": "<string>"
    },
    "activity_logs": [
      "<unknown>"
    ],
    "bill_total": "<string>",
    "code": "<string>",
    "created_by": {
      "name": "<string>",
      "object": "<string>"
    },
    "created_on": "<string>",
    "currency": {
      "code": "<string>",
      "href": "<string>",
      "id": "<string>",
      "name": "<string>",
      "object": "<string>"
    },
    "custom_attributes": [
      {
        "href": "<string>",
        "id": "<string>",
        "name": "<string>",
        "object": "<string>",
        "type": "<string>",
        "value": "<string>"
      }
    ],
    "custom_form": {
      "object": "<string>",
      "id": "<string>",
      "name": "<string>",
      "href": "<string>"
    },
    "due_date": "<string>",
    "due_total": "<string>",
    "expected_completion_date": "<string>",
    "href": "<string>",
    "id": "<string>",
    "is_price_tax_inclusive": true,
    "issue_date": "<string>",
    "kpis": {
      "estimated_total": "<string>",
      "issue_date": "<unknown>",
      "last_cancelled_on": "<unknown>",
      "last_changed_on": "<unknown>",
      "last_deleted_on": "<unknown>",
      "last_invoice_issue_date": "<unknown>",
      "last_invoice_total": "<string>",
      "last_reactivated_on": "<unknown>",
      "object": "<string>",
      "total_expense": "<string>",
      "total_outstanding": "<string>",
      "total_overdue": "<string>",
      "total_purchase_invoice": 123
    },
    "last_updated_by": {
      "name": "<string>",
      "object": "<string>"
    },
    "last_updated_on": "<string>",
    "object": "<string>",
    "operational_status": "<string>",
    "origin": "<string>",
    "paid_amount": "<string>",
    "purchase_order_note": "<string>",
    "sale_order": "<unknown>",
    "status": "<string>",
    "subtotal": "<string>",
    "supplier_invoice_id": "<string>",
    "tax_total": "<string>",
    "total": "<string>",
    "version": 123,
    "warehouse": "<unknown>"
  }
}

Cancels the purchase order, which sets its status to inactive. Send an empty object as the body. Reactivate it with the reactivate call.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token. To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its -d payload.

Authorizations

Authorization · string · header · required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

purchase_order_id · string · required

The purchase order's id.

Body

application/json

The body is of type object.

Response

200 - application/json

The cancelled purchase order, under purchase_order.

purchase_order · object

Show child attributes