Supply Chain · Reachable by link
Item · Sales
What may be ordered, at what price, promised how, and invoiced when.
/api/scm/item-salesPublished as /api/v1/item-salesOverview
| 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 › Item · Sales 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.item_sales · 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
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/scm/item-salesList item · sales
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",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_orderable": true,
"sales_uom": "text",
"sales_uom_conversion": "1250.00",
"minimum_order_qty": "12.0000",
"maximum_order_qty": "12.0000",
"order_multiple": "1250.00",
"list_price": "1250.00",
"minimum_price": "1250.00",
"max_discount_pct": "12.0000",
"price_list_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"atp_rule": "none"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/scm/item-sales?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/scm/item-sales/{id}Read one item sales
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",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_orderable": true,
"sales_uom": "text",
"sales_uom_conversion": "1250.00",
"minimum_order_qty": "12.0000",
"maximum_order_qty": "12.0000",
"order_multiple": "1250.00",
"list_price": "1250.00",
"minimum_price": "1250.00",
"max_discount_pct": "12.0000",
"price_list_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"atp_rule": "none"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/scm/item-sales/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/item-salesCreate a item sales
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
item_id | uuid | Yes | Item |
org_unit_id | uuid | No | Applies in — Leave empty and it applies company-wide. Choose a business unit and it overrides the company-wide row there — which is how one item behaves differently in two plants. |
is_orderable | boolean | No | Orderable |
sales_uom | text | No | Sales unit of measure |
sales_uom_conversion | numeric | No | Conversion to stock unit |
minimum_order_qty | numeric | No | Minimum order quantity |
maximum_order_qty | numeric | No | Maximum order qty |
order_multiple | numeric | No | Order multiple |
list_price | numeric | No | List price |
minimum_price | numeric | No | Minimum price — The floor a salesperson may not go below without an approval. |
max_discount_pct | numeric | No | Maximum discount % |
price_list_id | uuid | No | Price list id |
atp_rule | text | No | How a date is promised Allowed: none on_hand on_hand_plus_supply infinite capable_to_promise |
allow_backorder | boolean | No | Allow back-order |
allow_partial_ship | boolean | No | Allow partial shipment |
ship_lead_days | integer | No | Shipping lead days |
sales_description | text | No | Description on the order |
is_shippable | boolean | No | Is shippable |
is_invoiceable | boolean | No | Is invoiceable |
invoicing_rule | text | No | Invoiced Allowed: on_shipment on_order on_delivery milestone subscription |
returnable_days | integer | No | Returnable within days |
warranty_months | integer | No | Warranty months |
is_configurable | boolean | No | Configurable product |
is_kit | boolean | No | Kit |
effective_from | date | No | In force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead. |
effective_to | date | No | Until — Leave empty for open-ended. Setting it ends this version rather than deleting it. |
gst_tax_code | text | No | GST tax code (sales) — India: overrides the item’s own GST code for its sales. Left empty, the item’s is used. |
Sample body
{
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_orderable": true,
"sales_uom": "text",
"sales_uom_conversion": "1250.00"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_orderable": true,
"sales_uom": "text",
"sales_uom_conversion": "1250.00",
"minimum_order_qty": "12.0000",
"maximum_order_qty": "12.0000",
"order_multiple": "1250.00",
"list_price": "1250.00",
"minimum_price": "1250.00",
"max_discount_pct": "12.0000",
"price_list_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"atp_rule": "none"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/scm/item-sales" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","org_unit_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","is_orderable":true,"sales_uom":"text","sales_uom_conversion":"1250.00"}'PUT/api/scm/item-sales/{id}Change a item sales
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 |
|---|---|---|---|
item_id | uuid | Yes | Item |
org_unit_id | uuid | No | Applies in — Leave empty and it applies company-wide. Choose a business unit and it overrides the company-wide row there — which is how one item behaves differently in two plants. |
is_orderable | boolean | No | Orderable |
sales_uom | text | No | Sales unit of measure |
sales_uom_conversion | numeric | No | Conversion to stock unit |
minimum_order_qty | numeric | No | Minimum order quantity |
maximum_order_qty | numeric | No | Maximum order qty |
order_multiple | numeric | No | Order multiple |
list_price | numeric | No | List price |
minimum_price | numeric | No | Minimum price — The floor a salesperson may not go below without an approval. |
max_discount_pct | numeric | No | Maximum discount % |
price_list_id | uuid | No | Price list id |
atp_rule | text | No | How a date is promised Allowed: none on_hand on_hand_plus_supply infinite capable_to_promise |
allow_backorder | boolean | No | Allow back-order |
allow_partial_ship | boolean | No | Allow partial shipment |
ship_lead_days | integer | No | Shipping lead days |
sales_description | text | No | Description on the order |
is_shippable | boolean | No | Is shippable |
is_invoiceable | boolean | No | Is invoiceable |
invoicing_rule | text | No | Invoiced Allowed: on_shipment on_order on_delivery milestone subscription |
returnable_days | integer | No | Returnable within days |
warranty_months | integer | No | Warranty months |
is_configurable | boolean | No | Configurable product |
is_kit | boolean | No | Kit |
effective_from | date | No | In force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead. |
effective_to | date | No | Until — Leave empty for open-ended. Setting it ends this version rather than deleting it. |
gst_tax_code | text | No | GST tax code (sales) — India: overrides the item’s own GST code for its sales. Left empty, the item’s is used. |
Sample body
{
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_orderable": true,
"sales_uom": "text",
"sales_uom_conversion": "1250.00",
"minimum_order_qty": "12.0000",
"maximum_order_qty": "12.0000",
"order_multiple": "1250.00",
"list_price": "1250.00",
"minimum_price": "1250.00",
"max_discount_pct": "12.0000",
"price_list_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"atp_rule": "none"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/scm/item-sales/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","org_unit_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/scm/item-sales/{id}Delete a item sales
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/scm/item-sales/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/scm/item-sales/{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/item-sales/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 item sales, 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 |
item_id | uuid | read, write | Item |
org_unit_id | uuid | read, write | Applies in — Leave empty and it applies company-wide. Choose a business unit and it overrides the company-wide row there — which is how one item behaves differently in two plants. |
is_orderable | boolean | read, write | Orderable |
sales_uom | text | read, write | Sales unit of measure |
sales_uom_conversion | numeric | read, write | Conversion to stock unit |
minimum_order_qty | numeric | read, write | Minimum order quantity |
maximum_order_qty | numeric | read, write | Maximum order qty |
order_multiple | numeric | read, write | Order multiple |
list_price | numeric | read, write | List price |
minimum_price | numeric | read, write | Minimum price — The floor a salesperson may not go below without an approval. |
max_discount_pct | numeric | read, write | Maximum discount % |
price_list_id | uuid | read, write | Price list id |
atp_rule | text | read, write | How a date is promised Allowed: none on_hand on_hand_plus_supply infinite capable_to_promise |
allow_backorder | boolean | read, write | Allow back-order |
allow_partial_ship | boolean | read, write | Allow partial shipment |
ship_lead_days | integer | read, write | Shipping lead days |
sales_description | text | read, write | Description on the order |
is_shippable | boolean | read, write | Is shippable |
is_invoiceable | boolean | read, write | Is invoiceable |
invoicing_rule | text | read, write | Invoiced Allowed: on_shipment on_order on_delivery milestone subscription |
returnable_days | integer | read, write | Returnable within days |
warranty_months | integer | read, write | Warranty months |
is_configurable | boolean | read, write | Configurable product |
is_kit | boolean | read, write | Kit |
created_at | timestamp with time zone | read only | Created at |
effective_from | date | read, write | In force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead. |
effective_to | date | read, write | Until — Leave empty for open-ended. Setting it ends this version rather than deleting it. |
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 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
gst_tax_code | text | read, write | GST tax code (sales) — India: overrides the item’s own GST code for its sales. Left empty, the item’s is used. |
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 › Item · Sales 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.