controlApprovalRequest

Requires at least one of the permissions approvals:bills:approve, approvals:credit:approve, approvals:credit_notes:approve, approvals:discounts:approve, approvals:large_orders:approve, approvals:order_changes:approve, approvals:payments:verify, approvals:stock_adjustments:approve, approvals:supplier_payments:approve, inventory:stock_adjustment:create, payments:collection:create, payments:collection:update, payments:payment:allocate, payments:payment:create, payments:payment:update, purchase:grn:create, purchase:grn:update, purchase:payment:allocate, purchase:payment:create, purchase:payment:update, purchase:purchase_invoice:create, purchase:purchase_invoice:update, purchase:purchase_order:approve, purchase:purchase_order:create, purchase:purchase_order:update, sales:credit_note:create, sales:sales_order:confirm, sales:sales_order:deliver, sales:sales_order:ship, sales:sales_order:update, sales:shipment:create, sales:shipment:update or settings:controls:manage.

One approval request with its signatures, what you may do with it, and the values its control saw when it was raised.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query ControlApprovalRequest($id: ID!) {
  controlApprovalRequest(id: $id) {
    id
    documentNumber
    appliedByName
    onBehalfOfName
    requesterName
    resolvedByName
    actions {
      id
      actorName
      onBehalfOfName
      createdAt
      actorUserId
      kind
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query ControlApprovalRequest($id: ID!) {\n  controlApprovalRequest(id: $id) {\n    id\n    documentNumber\n    appliedByName\n    onBehalfOfName\n    requesterName\n    resolvedByName\n    actions {\n      id\n      actorName\n      onBehalfOfName\n      createdAt\n      actorUserId\n      kind\n    }\n  }\n}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "controlApprovalRequest": {
      "id": "id",
      "documentNumber": "string",
      "appliedByName": "string",
      "onBehalfOfName": "string",
      "requesterName": "string",
      "resolvedByName": "string",
      "actions": [
        {
          "id": "id",
          "actorName": "string",
          "onBehalfOfName": "string",
          "createdAt": "2025-01-15T00:00:00Z",
          "actorUserId": "string",
          "kind": "APPROVE"
        }
      ]
    }
  }
}

controlApprovalRequest(
  id: ID!
): ControlApprovalRequest!

Arguments

controlApprovalRequest.id ● ID! non-null scalar

The approval request's ID.

Type

ControlApprovalRequest object

A request raised by a control that needs approval.