Evaluate the active approval policies against a quote version | Solvimon

curl -X POST https://test.api.solvimon.com/v1/approval-policies/evaluate \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "quote_version_id": "quve_xwDeeN0vxxHyb5Cetq1A"
}'

{
  "object_type": "string",
  "status": "NO_APPROVAL_REQUIRED",
  "triggered_approval_policy_ids": [
    "string"
  ],
  "approval_strategy": "ALL_LEVELS_MUST_APPROVE",
  "approvers": [
    {
      "level": 1,
      "user": {
        "id": "string"
      }
    }
  ],
  "evaluated_policies": [
    {
      "id": "string",
      "name": "string",
      "status": "NO_APPROVAL_REQUIRED",
      "approval_strategy": "ALL_LEVELS_MUST_APPROVE",
      "approvers": [
        {
          "level": 1,
          "user": {
            "id": "string"
          }
        }
      ],
      "rule_groups": [
        {
          "index": 1,
          "triggered": true,
          "rules": [
            {
              "index": 1,
              "type": "ALWAYS_APPROVE",
              "source_field": "string",
              "comparator": "LESS_THAN",
              "status": "EVALUATED",
              "satisfied": true,
              "threshold": {
                "value": "string",
                "currency": "string",
                "detail": {
                  "subscription": "string",
                  "platform_default": "string"
                }
              },
              "actual": {
                "value": "string",
                "currency": "string",
                "detail": {
                  "subscription": "string",
                  "platform_default": "string"
                }
              },
              "converted_actual": {
                "value": "string",
                "currency": "string",
                "detail": {
                  "subscription": "string",
                  "platform_default": "string"
                }
              },
              "scope": {
                "type": "INVOICE",
                "ids": [
                  "string"
                ]
              },
              "reason": "string"
            }
          ]
        }
      ]
    }
  ]
}

Reports which approval policies finalizing this quote version would breach, why, and who would have to approve. Creates and changes nothing. Requires QUOTE.VIEW as well as APPROVAL_POLICY.VIEW, because the answer reports the quote version’s own values. Requires the APPROVAL_POLICY.VIEW permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

Request

This endpoint expects an object.

quote_version_idstringRequired

The ID of the quote version to evaluate the active approval policies against.

Response

object_typestring or nullOptionalRead-only

statusenum or nullOptionalRead-only

What finalizing this quote version would do about approval.

Allowed values:

triggered_approval_policy_idslist of strings or nullOptionalRead-only

The IDs of the approval policies that would be breached.

approval_strategyenum or nullOptionalRead-only

The approval strategy that would be applied to the approval request, the most restrictive of the triggered policies.

Allowed values:

approverslist of objects or nullOptionalRead-only

The users who would receive the approval request, across all triggered approval policies.

evaluated_policieslist of objects or nullOptionalRead-only

Every active approval policy for quote versions, whether it triggered or not.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors