create_plan - Qobra public API documentation

Create a compensation plan, the container compensations hang off, empty or with its members (attributions). A group attribution covers whoever is in the group at each period. The plan is created with no compensation. Add compensations with create_compensation, then open the plan with get_plan or find it again in list_plans. Rename it or change its membership later with update_plan. Nothing is created when the name, the section or any attribution row is refused. On the live environment, attributing someone refreshes their statements in the background, as update_plan does. Every write to the live environment is recorded in the audit trail as the Qobra MCP agent; writes to a sandbox are not audited.

Parameters

Body

string

required

Display name of the plan; a blank name is refused.

string

Id of the section to file the plan under, as a plan’s section carries it in list_plans (sections are per environment: read it with the same sandbox_id). Never a name. Omit it, or pass "", to leave the plan unfiled.

object[]

Members of the new plan: one row per continuous stretch for each user or group, rows of one user or group not overlapping. Omit it for a plan with nobody attributed; update_plan sets the membership later.

Show object properties

string

Id or email of the user, as list_users returns them. Exactly one of user_id and group_id.

string

Id of the group, as list_groups returns it. Exactly one of user_id and group_id.

string

required

YYYY-MM; the first month this membership covers.

string

YYYY-MM; the last month it covers, included. Omit it for a membership that stays open with no end.

string

Id of a sandbox from list_sandboxes, to create this in instead of the live environment. Omit it to create in live, the company’s real data. Never a name, never the live id.

Response

Body

object

The new plan, as a list_plans row.

Show object properties

string

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

string

boolean

True when the plan is archived.

object

The section the plan is filed under; null if unfiled.

Show object properties

string

integer

How many compensations the plan holds, drafts included; get_plan lists them.

object[]

The memberships the call created, one created row per declared stretch. Empty when the plan is created without attributions.

Show object properties

string

“created” for a membership this call added; “moved” for one that already existed and had its dates changed, the row showing the new ones; “removed” for one the declared set no longer holds. Only what actually changed is named — a membership already matching what was declared is absent from the list, which is how a re-sent set reads as the no-op it was.

object

The attribution as it now stands — its last state before removal for a “removed” row, since it no longer exists on 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

boolean

string

YYYY-MM; the month the attribution starts.

string

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

​Parameters

​Response

Parameters

Response