approvalRequest

Get approval request.

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. Expanding approval_policies also requires APPROVAL_POLICY.VIEW.

get/v{version}/approval-requests/{resourceId}

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/approval-requests/{resourceId}
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

resourceIdstring required

The ID of the resource to be requested.

Query parameters

expand[]string[]

The id fields of the resources that are going to be expanded.

Headers

x-platform-idstring

Platform ID.

Response

OK

object_typestring nullable
idstring nullable
approval_policy_idsstring[] nullable

The IDs of all the Approval Policies that were breached.

source_type'QUOTE_VERSION' | 'INVOICE' | 'PRICING_PLAN_SCHEDULE'

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

source_idstring nullable

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

status'PENDING_REVIEW' | 'APPROVED' | 'DECLINED' | 'CANCELLED'

The current status of the Approval Request.

owner_idstring nullable

The ID of the user who owns the Approval Request.

created_atstring nullable

The date that the Approval Request was created.

reviewed_atstring nullable
updated_atstring nullable

The date that the Approval Request was updated.

approval_strategy'ALL_LEVELS_MUST_APPROVE' | 'HIGHER_LEVEL_CAN_OVERRIDE' | 'ANYONE_CAN_DECIDE'

Approval Strategy applied in the Approval Request.

Changes

No recorded changes to this operation across all 1 revision of this API.