TRANXACT.AI Help

Supply Chain · Reachable by link

Item · Sales

What may be ordered, at what price, promised how, and invoiced when.

Type REST6 operationsBase path /api/scm/item-salesPublished as /api/v1/item-sales

Download specification (OpenAPI 3.1) Screen: Item · Sales

Overview

PackageSupply Chain
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tablescm.item_sales · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
item_iduuidYesItem
org_unit_iduuidNoApplies 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_orderablebooleanNoOrderable
sales_uomtextNoSales unit of measure
sales_uom_conversionnumericNoConversion to stock unit
minimum_order_qtynumericNoMinimum order quantity
maximum_order_qtynumericNoMaximum order qty
order_multiplenumericNoOrder multiple
list_pricenumericNoList price
minimum_pricenumericNoMinimum price — The floor a salesperson may not go below without an approval.
max_discount_pctnumericNoMaximum discount %
price_list_iduuidNoPrice list id
atp_ruletextNoHow a date is promised
Allowed: none on_hand on_hand_plus_supply infinite capable_to_promise
allow_backorderbooleanNoAllow back-order
allow_partial_shipbooleanNoAllow partial shipment
ship_lead_daysintegerNoShipping lead days
sales_descriptiontextNoDescription on the order
is_shippablebooleanNoIs shippable
is_invoiceablebooleanNoIs invoiceable
invoicing_ruletextNoInvoiced
Allowed: on_shipment on_order on_delivery milestone subscription
returnable_daysintegerNoReturnable within days
warranty_monthsintegerNoWarranty months
is_configurablebooleanNoConfigurable product
is_kitbooleanNoKit
effective_fromdateNoIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateNoUntil — Leave empty for open-ended. Setting it ends this version rather than deleting it.
gst_tax_codetextNoGST 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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
item_iduuidYesItem
org_unit_iduuidNoApplies 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_orderablebooleanNoOrderable
sales_uomtextNoSales unit of measure
sales_uom_conversionnumericNoConversion to stock unit
minimum_order_qtynumericNoMinimum order quantity
maximum_order_qtynumericNoMaximum order qty
order_multiplenumericNoOrder multiple
list_pricenumericNoList price
minimum_pricenumericNoMinimum price — The floor a salesperson may not go below without an approval.
max_discount_pctnumericNoMaximum discount %
price_list_iduuidNoPrice list id
atp_ruletextNoHow a date is promised
Allowed: none on_hand on_hand_plus_supply infinite capable_to_promise
allow_backorderbooleanNoAllow back-order
allow_partial_shipbooleanNoAllow partial shipment
ship_lead_daysintegerNoShipping lead days
sales_descriptiontextNoDescription on the order
is_shippablebooleanNoIs shippable
is_invoiceablebooleanNoIs invoiceable
invoicing_ruletextNoInvoiced
Allowed: on_shipment on_order on_delivery milestone subscription
returnable_daysintegerNoReturnable within days
warranty_monthsintegerNoWarranty months
is_configurablebooleanNoConfigurable product
is_kitbooleanNoKit
effective_fromdateNoIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateNoUntil — Leave empty for open-ended. Setting it ends this version rather than deleting it.
gst_tax_codetextNoGST 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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
item_iduuidread, writeItem
org_unit_iduuidread, writeApplies 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_orderablebooleanread, writeOrderable
sales_uomtextread, writeSales unit of measure
sales_uom_conversionnumericread, writeConversion to stock unit
minimum_order_qtynumericread, writeMinimum order quantity
maximum_order_qtynumericread, writeMaximum order qty
order_multiplenumericread, writeOrder multiple
list_pricenumericread, writeList price
minimum_pricenumericread, writeMinimum price — The floor a salesperson may not go below without an approval.
max_discount_pctnumericread, writeMaximum discount %
price_list_iduuidread, writePrice list id
atp_ruletextread, writeHow a date is promised
Allowed: none on_hand on_hand_plus_supply infinite capable_to_promise
allow_backorderbooleanread, writeAllow back-order
allow_partial_shipbooleanread, writeAllow partial shipment
ship_lead_daysintegerread, writeShipping lead days
sales_descriptiontextread, writeDescription on the order
is_shippablebooleanread, writeIs shippable
is_invoiceablebooleanread, writeIs invoiceable
invoicing_ruletextread, writeInvoiced
Allowed: on_shipment on_order on_delivery milestone subscription
returnable_daysintegerread, writeReturnable within days
warranty_monthsintegerread, writeWarranty months
is_configurablebooleanread, writeConfigurable product
is_kitbooleanread, writeKit
created_attimestamp with time zoneread onlyCreated at
effective_fromdateread, writeIn force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead.
effective_todateread, writeUntil — Leave empty for open-ended. Setting it ends this version rather than deleting it.
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
gst_tax_codetextread, writeGST tax code (sales) — India: overrides the item’s own GST code for its sales. Left empty, the item’s is used.

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Supply Chain › Item · Sales for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.