approveControlRequest

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 or purchase:purchase_order:approve.

Approves a pending approval request. Approving records your signature only: the held action still has to be run. You cannot approve a request you raised, or one you already acted on, and you need the approval permission the request names.

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

mutation ApproveControlRequest($id: ID!) {
  approveControlRequest(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": "mutation ApproveControlRequest($id: ID!) {\n  approveControlRequest(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": {
    "approveControlRequest": {
      "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"
        }
      ]
    }
  }
}

approveControlRequest(
  id: ID!
  note: String
): ControlApprovalRequest!

Arguments

approveControlRequest.id ● ID! non-null scalar

The approval request's ID.

approveControlRequest.note ● String scalar

An optional note, up to 500 characters.

Type

ControlApprovalRequest object

A request raised by a control that needs approval.