Skip to main content

controlApprovalRequests

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.

Your approvals inbox, newest first: TO_DECIDE lists pending requests you may decide now, RAISED_BY_ME the ones you raised, ALL every request (needs settings:controls:manage). Each request says whether you may decide, recall or apply it.

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:

query ControlApprovalRequests($filter: ControlApprovalRequestsFilter!) {
  controlApprovalRequests(filter: $filter) {
    total
    items {
      id
      documentNumber
      appliedByName
      onBehalfOfName
      requesterName
      resolvedByName
    }
  }
}

Variables:

{
  "filter": {
    "box": "ALL",
    "skip": 0,
    "take": 0
  }
}

Response:

{
  "data": {
    "controlApprovalRequests": {
      "total": 0,
      "items": [
        {
          "id": "id",
          "documentNumber": "string",
          "appliedByName": "string",
          "onBehalfOfName": "string",
          "requesterName": "string",
          "resolvedByName": "string"
        }
      ]
    }
  }
}
controlApprovalRequests(
  filter: ControlApprovalRequestsFilter!
): ControlApprovalRequestConnection!

Arguments​

controlApprovalRequests.filter ● ControlApprovalRequestsFilter! non-null input​

Which box, states and page.

Type​

ControlApprovalRequestConnection object​

A page of approval requests.