Supply Chain · Supply Planning
Projected Stock
What is on hand, what is coming, what is wanted, week by week for six months. The single most useful screen in planning and the one thing reorder advice could never show.
/api/scm/projected-availabilityPublished as /api/v1/projected-availabilityDownload specification (OpenAPI 3.1) Screen: Projected Stock
Overview
| Package | Supply Chain |
|---|---|
| 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 Supply Chain › Projected Stock 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 | scm.projected_availability · kept per company (and organisational unit where it has one) |
| Record | Read only; key item_id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/projected-availabilityList projected stock
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": [
{
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_no": "ITE-000001",
"item_name": "Example",
"uom": "text",
"safety_stock": "1250.00",
"reorder_point": "1250.00",
"week_start": "2026-10-30",
"opening_available": "1250.00",
"demand_in_week": "1250.00",
"supply_in_week": "1250.00",
"planned_in_week": "1250.00",
"projected_available": "1250.00"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/projected-availability?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/projected-availability/{item_id}Read one projection
Path parameters
| Name | Type | Description |
|---|---|---|
item_id | string (uuid) | The record's item_id, as a list returns it. |
Response 200
{
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_no": "ITE-000001",
"item_name": "Example",
"uom": "text",
"safety_stock": "1250.00",
"reorder_point": "1250.00",
"week_start": "2026-10-30",
"opening_available": "1250.00",
"demand_in_week": "1250.00",
"supply_in_week": "1250.00",
"planned_in_week": "1250.00",
"projected_available": "1250.00"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/projected-availability/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/projected-availabilityPost projected stock
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/scm/projected-availability" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/projected-availability/{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/scm/projected-availability/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'PUT/api/scm/projected-availability/{id}Put projected stock
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 PUT "https://demo.tranxact.ai/api/scm/projected-availability/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/scm/projected-availability/{id}Delete projected stock
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 DELETE "https://demo.tranxact.ai/api/scm/projected-availability/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a projection, 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 |
|---|---|---|---|
org_id | uuid | read only | Org id |
item_id | uuid | read only | Item id |
item_no | text | read only | Item no |
item_name | text | read only | Item name |
uom | text | read only | Uom |
safety_stock | numeric | read only | Safety stock |
reorder_point | numeric | read only | Reorder point |
week_start | date | read only | Week start |
opening_available | numeric | read only | Opening available |
demand_in_week | numeric | read only | Demand in week |
supply_in_week | numeric | read only | Supply in week |
planned_in_week | numeric | read only | Planned in week |
projected_available | numeric | read only | Projected available |
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 Supply Chain › Projected Stock 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.