Set when commission is earned and who earns it, for every group

PUT /commissions/settings

Each order snapshots the settings when it is placed, so a change moves only orders placed after it. Appends inventory.commission-settings-saved. Idempotent by content: a retry that changes nothing is acknowledged and appends nothing.

Access

Requires commissions:write.

How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.

Retries

Idempotent by content: a retry that changes nothing is acknowledged and appends nothing.

Why every write carries a key: Idempotency and retries.

Facts appended

inventory.commission-settings-saved

What a fact is: Facts and the journal.

AI agent tool

Agents call this as commissions_save_settings (Commissions: Save settings), in the commissions toolset.

Connecting an agent: AI agents.

Example

Pay commission when the customer pays, to their account manager.

curl

curl -X PUT 'https://inventory.getmanifold.io/commissions/settings' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "earnedOn": "paid",
  "earner": "account-manager"
}'

JavaScript (fetch)

const response = await fetch("https://inventory.getmanifold.io/commissions/settings", {
  method: "PUT",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "earnedOn": "paid",
    "earner": "account-manager"
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();

Request body · application/json

{
  "earnedOn": "paid",
  "earner": "account-manager"
}

Response · 200 · application/json

{
  "earnedOn": "paid",
  "earner": "account-manager"
}

The panel writes this call in other languages. It does not send it: Manifold's APIs do not take calls from a web page on another site, so run the call from your own code or terminal. The whole API as OpenAPI: inventory-manager.openapi.json. Base URL https://inventory.getmanifold.io.

Errors

Every refusal is a status and a JSON body whose _tag names it. A refused call changes nothing.

`401`

Refusal	What it means	What to do
`Unauthorized` reason	The token is missing, expired or not one Manifold issued.	Get a fresh token and send the call again.
`TokenAlreadyUsed` tokenId	A single-use app token was already spent.	Mint a new token for this call.

`402`

Refusal	What it means	What to do
`SubscriptionRequired` status	The organization's subscription has lapsed, so writes are refused.	An owner settles billing. Reads still work meanwhile.

`403`

Refusal	What it means	What to do
`TenantRequired` userId	The token names no organization.	Choose the organization, then get a new token.
`ScopeRequired` required	The token's roles do not grant the scope this call needs.	Ask an owner or admin for a role that grants it.

`409`

Refusal	What it means	What to do
`MirroredFromSource` source	This area is fed by your source system until the organization goes live.	Make the change in the source system, or go live first.

`503`

Refusal	What it means	What to do
`RequestLogUnavailable` tokenId, reason	The service could not record the request, so it did nothing.	Send the same request again shortly.

How refusals work everywhere: Errors.

Used in

Pay reps commission, step 1: Say when and to whom commission is paid