Compensation Plans

3 actions. Each is callable by the agent as a tool, over HTTP via /api/invoke, and (usually) from a UI page.

`compensation_plans.list`

GET

List compensation plans (hourly / salary / contractor / equity / usage-based / subscription).

AI tool: compensation_plans_list
API: GET /api/invoke/compensation_plans.list

Input

Field	Type	Required	Description
`actorId`	string	—
`kind`	"hourly" \| "salary" \| "contractor" \| "equity" \| "usage-based" \| "subscription"	—

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "actorId": {
      "type": "string",
      "minLength": 1
    },
    "kind": {
      "type": "string",
      "enum": [
        "hourly",
        "salary",
        "contractor",
        "equity",
        "usage-based",
        "subscription"
      ]
    }
  }
}

`compensation_plans.upsert`

POST · mutating

Create or update a comp plan for an actor.

AI tool: compensation_plans_upsert
API: POST /api/invoke/compensation_plans.upsert

Input

Field	Type	Required
`id`	string	—
`actorId`	string	yes
`kind`	"hourly" \| "salary" \| "contractor" \| "equity" \| "usage-based" \| "subscription"	yes
`rate`	number	yes
`currency`	string	—
`period`	"monthly" \| "biweekly" \| "weekly" \| "annual"	—
`effectiveFrom`	any	—
`effectiveUntil`	any	—
`autoAccrualEnabled`	boolean	—
`notes`	string	—
`config`	object	—

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1
    },
    "actorId": {
      "type": "string",
      "minLength": 1
    },
    "kind": {
      "type": "string",
      "enum": [
        "hourly",
        "salary",
        "contractor",
        "equity",
        "usage-based",
        "subscription"
      ]
    },
    "rate": {
      "type": "number"
    },
    "currency": {
      "default": "USD",
      "type": "string"
    },
    "period": {
      "default": "monthly",
      "type": "string",
      "enum": [
        "monthly",
        "biweekly",
        "weekly",
        "annual"
      ]
    },
    "effectiveFrom": {},
    "effectiveUntil": {},
    "autoAccrualEnabled": {
      "type": "boolean"
    },
    "notes": {
      "type": "string"
    },
    "config": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    }
  },
  "required": [
    "actorId",
    "kind",
    "rate"
  ]
}

`compensation_plans.delete`

DELETE · mutating

Delete a compensation plan.

AI tool: compensation_plans_delete
API: DELETE /api/invoke/compensation_plans.delete

Input

Field	Type	Required	Description
`id`	string	yes

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "id"
  ]
}