Create a new Approval Policy | Solvimon

curl -X POST https://test.api.solvimon.com/v1/approval-policies \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "source_type": "QUOTE_VERSION",
  "reference": "discounts_over_10_percent",
  "name": "Discounts over 10%",
  "approval_type": "GROUP",
  "rule_groups": [
    {
      "rules": [
        {
          "type": "DISCOUNT",
          "comparator": "GREATER_THAN",
          "discount": {
            "percentage": "10"
          }
        }
      ]
    }
  ],
  "approvers": {
    "type": "ALL_LEVELS_MUST_APPROVE",
    "approval_groups": [
      {
        "level": 1,
        "approvers": [
          {
            "type": "USER",
            "user": {
              "id": "user_ZwDeeN0tlgPrVJATeG2A"
            }
          }
        ]
      },
      {
        "level": 2,
        "approvers": [
          {
            "type": "USER",
            "user": {
              "id": "user_UwDeeN0tlgPrXKAIe91y"
            }
          }
        ]
      }
    ]
  }
}'

{
  "source_type": "QUOTE_VERSION",
  "reference": "discounts_over_10_percent",
  "name": "Discounts over 10%",
  "approval_type": "GROUP",
  "rule_groups": [
    {
      "rules": [
        {
          "type": "ALWAYS_APPROVE",
          "comparator": "LESS_THAN",
          "discount": {
            "percentage": "5",
            "amount": {
              "quantity": "1000.00",
              "currency": "USD"
            }
          },
          "commitment": {
            "amount": {
              "quantity": "5000.00",
              "currency": "USD"
            }
          },
          "pricing": {
            "has_override": false
          },
          "custom_field": {
            "id": "customfield_001",
            "value": "approved"
          },
          "billing_entity": {
            "is_custom": false
          },
          "billing_period": {
            "is_custom": false
          },
          "due_date": {
            "is_custom": false
          },
          "payment_acceptor": {
            "is_custom": false
          }
        }
      ]
    }
  ],
  "object_type": "APPROVAL_POLICY",
  "id": "apprpol_1234567890abcdef",
  "status": "DRAFT",
  "created_at": "2024-06-01T09:15:00Z",
  "update_at": "2024-06-01T09:15:00Z",
  "approvers": {
    "type": "ALL_LEVELS_MUST_APPROVE",
    "approval_groups": [
      {
        "level": 1,
        "approvers": [
          {
            "type": "USER",
            "user": {
              "id": "user_ZwDeeN0tlgPrVJATeG2A"
            }
          }
        ]
      }
    ]
  }
}

Requires the APPROVAL_POLICY.CREATE 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.

source_typeenumRequired

The object type of this approval policy.

Allowed values:

referencestringRequiredformat: "^\S+$"0-256 characters

The human-readable reference to this approval policy.

namestringRequired

The name of this approval policy.

approval_typeenumRequired

The type of approval process which needs to be followed if this approval policy is invoked.

Allowed values:

rule_groupslist of objectsRequired

The groups of rules that are applicable for this approval policy. These will be chained using OR.

statusenum or nullOptional

The current status of the approval policy.

Allowed values:

approversobjectOptional

The type of approve level and users who are allowed to approve/decline the approval review.

Response

Created

source_typeenum

The object type of this approval policy.

Allowed values:

referencestringformat: "^\S+$"0-256 characters

The human-readable reference to this approval policy.

namestring

The name of this approval policy.

approval_typeenum

The type of approval process which needs to be followed if this approval policy is invoked.

Allowed values:

rule_groupslist of objects

The groups of rules that are applicable for this approval policy. These will be chained using OR.

object_typestring or nullRead-only

idstring or nullRead-only

statusenum or null

The current status of the approval policy.

Allowed values:

created_atstring or nullRead-only

When the approval policy was created.

update_atstring or nullRead-only

When the approval policy was updated last.

approversobject

The type of approve level and users who are allowed to approve/decline the approval review.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors