Skip to main content
Get the design (conception) view of one compensation plan. Returns the plan with its compensations (their periodicity and date range) and its attributed members. This is the plan-structure counterpart to get_statement_compensation, which returns the calculated values on an existing statement. Identify the plan by name (or a substring) or by its id; a name that matches several plans is rejected so you can refine it. A plan you can’t access reads exactly like one that doesn’t exist, so the error never reveals anything outside your scope.

​
Parameters

Body

​
string
required
The plan to open, matched against the plan name (case-insensitive substring) or, when it is a valid ObjectId, against the plan id. Must resolve to exactly one plan.

​
Response

Body

​
string
​
string
Deep link to open this plan in the Qobra web app.
​
string
​
boolean
​
string
Folder/group this plan is filed under (a concept shared with reports); null if unfiled.
​
integer
How many compensations the plan holds. Open the plan with get_plan for each compensation’s design (scopes, variables, formulas) and the plan’s members.
​
object[]
The plan’s compensations with their configuration.
​
object[]
The users and groups attributed to the plan.