get_plan

string

Deep link to open this plan in the Qobra web app.

string

boolean

True when the plan has been archived. list_plans returns archived and live plans separately, never mixed.

object

Folder/group this plan is filed under (a concept shared with reports); null if unfiled.

Show object properties

string

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.

Show object properties

string

Deep link to open this compensation’s configuration in the Qobra web app.

string

boolean

True when the compensation has no window: it is calculated on each period of its cadence. False when it is bounded to one, from start_date to end_date. A compensation bounded to a window is calculated once, over the records of the whole window, on the statement closing the period of its cadence that holds end_date (with EACH_MONTH, the period of end_date itself): the statements of the periods before carry no line for it. A cadence that does not calculate on that period never calculates it: EACH_MONTH_EXCEPT_END_OF_QUARTER with an end_date in a quarter’s last month, or Q1-Q4 with an end_date outside that quarter, on the company’s fiscal calendar. To pay every period over a limited time, leave the compensation recurring on a plan of its own whose members are bounded to that time (the start_period and end_period of their attribution, create_plan, update_plan). An attribution is month-granular, and a period of the cadence it touches is calculated over all of its records: the limit is exact with EACH_MONTH, or when the attribution covers whole periods of the cadence, and a quarterly compensation limited from February to April still pays the records of January and of May and June. An attribution covers every compensation of its plan, so bounding the members of a shared plan ends all of them.

string

YYYY-MM-DD; the first day of the compensation’s window, null when it is recurring.

string

YYYY-MM-DD; the last day of the compensation’s window, included, null when it is recurring.

string

How often the compensation is calculated, on the company’s fiscal calendar. EACH_MONTH every month; EACH_MONTH_EXCEPT_END_OF_QUARTER every month but the one each quarter closes on; EACH_QUARTER, EACH_SEMESTER and EACH_YEAR at each period’s close; Q1-Q4 once a year, at that quarter’s close only. A compensation bounded to a window is calculated at most once: on the statement closing the period of its cadence that holds the window’s last day, and never when its cadence does not calculate on that period.

string

“live”: published. “draft”: not published (never published, or unpublished), so no statement carries it.

string

The compensation’s own free-text note, as written on the plan; null when it carries none.

object[]

The reporting metrics this compensation feeds, one per metric. A plan is missing from a metric’s report only when none of its compensations feeds it.

Show object properties

string

One of: float, amount, percentage, string, picklist, multipicklist, bool, date, user, object, group, record_status.

object[]

The users and groups attributed to the plan.

Show object properties

string

“user” for a user attribution, “group” for a group.

object

The attributed user; null for group attributions.

Show object properties

string

object

The attributed group; null for user attributions.

Show object properties

string

YYYY-MM; the month the attribution starts.

string

YYYY-MM; null while the attribution is still open.

Qobra MCP server

Parameters

Response

​Parameters

​Response

Parameters

Response