Skip to main content
Get the design (conception) view of one compensation plan. Returns the plan with its compensations (their periodicity, date range and the reporting metrics each one feeds) and its attributed members. This is the plan-structure counterpart to get_statement_compensation, which returns the calculated values on an existing statement. A plan you can’t access reads exactly like one that doesn’t exist, so the error never reveals anything outside your scope — a plan living in a sandbox you may not read included.

​
Parameters

Body

​
string
required
Id of the plan to open — the id list_plans returns.

​
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 periodicity, date range and the reporting metrics it feeds, plus the plan’s members. The rest of the calculation behind a compensation is not exposed there — read a statement’s computed breakdown with get_statement_compensation.
​
object[]
The plan’s compensations with their configuration.
​
object[]
The users and groups attributed to the plan.