Cancel an Approval Request | Solvimon

{
  "object_type": "string",
  "id": "string",
  "approval_policy_ids": [
    "string"
  ],
  "approval_policies": [
    {
      "object_type": "string",
      "id": "string",
      "source_type": "QUOTE_VERSION",
      "reference": "string",
      "name": "string",
      "status": "DRAFT",
      "approval_type": "GROUP",
      "created_at": "string",
      "update_at": "string",
      "approvers": {
        "type": "ALL_LEVELS_MUST_APPROVE",
        "approval_groups": [
          {
            "level": 1,
            "approvers": [
              {
                "type": "USER",
                "user": {
                  "id": "string"
                }
              }
            ]
          }
        ]
      },
      "rule_groups": [
        {
          "rules": [
            {
              "type": "ALWAYS_APPROVE",
              "comparator": "LESS_THAN",
              "discount": {
                "percentage": "string",
                "amount": {
                  "quantity": "string",
                  "currency": "AED"
                }
              },
              "commitment": {
                "amount": {
                  "quantity": "string",
                  "currency": "AED"
                }
              },
              "pricing": {
                "has_override": true
              },
              "custom_field": {
                "id": "string",
                "value": "string"
              },
              "billing_entity": {
                "is_custom": true
              },
              "billing_period": {
                "is_custom": true
              },
              "due_date": {
                "is_custom": true
              },
              "payment_acceptor": {
                "is_custom": true
              }
            }
          ]
        }
      ]
    }
  ],
  "source_type": "QUOTE_VERSION",
  "source_id": "string",
  "status": "PENDING_REVIEW",
  "owner_id": "string",
  "created_at": "string",
  "updated_at": "string",
  "reviewers": [
    {
      "id": "string",
      "status": "string",
      "reviewed_at": "string",
      "level": 1
    }
  ],
  "approval_strategy": "ALL_LEVELS_MUST_APPROVE",
  "reviewed_at": "string"
}

Requires the QUOTE.VIEW, INVOICE.VIEW or PRICING_PLAN_SCHEDULE.VIEW permission. Which one depends on the source of the approval request: QUOTE_VERSION requires QUOTE.VIEW; INVOICE requires INVOICE.VIEW; PRICING_PLAN_SCHEDULE requires PRICING_PLAN_SCHEDULE.VIEW. The user who requested it can always cancel it; anyone else also requires the update permission of the source: QUOTE_VERSION requires QUOTE.UPDATE; INVOICE requires INVOICE.UPDATE; PRICING_PLAN_SCHEDULE requires PRICING_PLAN_SCHEDULE.UPDATE.

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

resourceIdstringRequiredDefaults to

The ID of the resource for which the action is posted.

Response

object_typestring or nullOptionalRead-only

idstring or nullOptionalRead-only

approval_policy_idslist of strings or nullOptionalRead-only

The IDs of all the Approval Policies that were breached.

approval_policieslist of objects or nullOptionalRead-only

The Approval Policies that were breached. Only present when expanded via expand[]=approval_policy_ids.

source_typeenum or nullOptionalRead-only

The object type in which this Approval Request was triggered. I.e. QUOTE_VERSION.

Allowed values:

source_idstring or nullOptionalRead-only

The ID of the object type that triggered this Approval Request.

statusenum or nullOptionalRead-only

The current status of the Approval Request.

Allowed values:

owner_idstring or nullOptionalRead-only

The ID of the user who owns the Approval Request.

created_atstring or nullOptionalRead-only

The date that the Approval Request was created.

updated_atstring or nullOptionalRead-only

The date that the Approval Request was updated.

reviewerslist of objects or nullOptionalRead-only

The list of users that have approved or declined the Approval Request.

approval_strategyenum or nullOptionalRead-only

Approval Strategy applied in the Approval Request.

Allowed values:

reviewed_atstring or nullOptionalRead-onlyDeprecated

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors