CRM · Forecasting & Quotas
Quota Plans
A plan per fiscal year, cut into months, quarters or the year from the company's fiscal calendar. Activate one and the forecast board and the weekly snapshot read it.
/api/crm/quota-plansPublished as /api/v1/quota-plansOverview
| Package | CRM |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold CRM › Quota Plans on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | crm.quota_plans · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
9 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/crm/quota-plansList quota plans
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"plan_no": "PLA-000001",
"name": "Example",
"fiscal_year": "text",
"period_type": "quarter",
"measure": "amount",
"currency": "USD",
"status": "draft",
"notes": "text",
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"updated_at": "2026-10-30T09:00:00Z",
"updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/crm/quota-plans?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/quota-plans/{id}Read one quota plans
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"plan_no": "PLA-000001",
"name": "Example",
"fiscal_year": "text",
"period_type": "quarter",
"measure": "amount",
"currency": "USD",
"status": "draft",
"notes": "text",
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"updated_at": "2026-10-30T09:00:00Z",
"updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/crm/quota-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/quota-plansCreate a quota plans
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
name | text | Yes | Name |
fiscal_year | text | Yes | Fiscal year — The year label of the fiscal calendar, e.g. 2026. |
period_type | text | No | Cut into Allowed: quarter month year |
measure | text | No | Measured in Allowed: amount units both |
currency | text | No | Currency — Blank: the company's own. |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"fiscal_year": "text",
"period_type": "quarter",
"measure": "amount",
"currency": "USD",
"notes": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"plan_no": "PLA-000001",
"name": "Example",
"fiscal_year": "text",
"period_type": "quarter",
"measure": "amount",
"currency": "USD",
"status": "draft",
"notes": "text",
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"updated_at": "2026-10-30T09:00:00Z",
"updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/quota-plans" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","fiscal_year":"text","period_type":"quarter","measure":"amount","currency":"USD","notes":"text"}'PUT/api/crm/quota-plans/{id}Change a quota plans
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
name | text | Yes | Name |
fiscal_year | text | Yes | Fiscal year — The year label of the fiscal calendar, e.g. 2026. |
period_type | text | No | Cut into Allowed: quarter month year |
measure | text | No | Measured in Allowed: amount units both |
currency | text | No | Currency — Blank: the company's own. |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"fiscal_year": "text"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"plan_no": "PLA-000001",
"name": "Example",
"fiscal_year": "text",
"period_type": "quarter",
"measure": "amount",
"currency": "USD",
"status": "draft",
"notes": "text",
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"updated_at": "2026-10-30T09:00:00Z",
"updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/crm/quota-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","fiscal_year":"text"}'DELETE/api/crm/quota-plans/{id}Delete a quota plans
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/crm/quota-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/quota-plans/{id}/generate-periodsGenerate periods
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/quota-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/generate-periods" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/quota-plans/{id}/activateActivate
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/quota-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/activate" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/quota-plans/{id}/closeClose
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/quota-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/close" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/quota-plans/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/quota-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a quota plans, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
plan_no | text | read only | Plan no |
name | text | read, write | Name |
fiscal_year | text | read, write | Fiscal year — The year label of the fiscal calendar, e.g. 2026. |
period_type | text | read, write | Cut into Allowed: quarter month year |
measure | text | read, write | Measured in Allowed: amount units both |
currency | text | read, write | Currency — Blank: the company's own. |
status | text | read only | Status |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold CRM › Quota Plans for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.