TRANXACT.AI Help

CRM · Pricing

Price List Entries

Priced by item or by whole category, with quantity breaks. A category line is what makes "10% off all fasteners" one row rather than four hundred.

Type REST6 operationsBase path /api/crm/price-list-linesPublished as /api/v1/price-list-lines

Download specification (OpenAPI 3.1) Screen: Price List Entries

Overview

PackageCRM
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 CRM › Price List Entries 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.
Tablecrm.price_list_lines · 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/crm/price-list-linesList price list entries

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",
      "price_list_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "category_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "uom": "text",
      "min_quantity": "12.0000",
      "max_quantity": "12.0000",
      "unit_price": "1250.00",
      "discount_pct": "12.0000",
      "markup_pct": "1250.00",
      "price_basis": "fixed",
      "is_negotiable": true,
      "min_margin_pct": "1250.00",
      "created_at": "2026-10-30T09:00:00Z"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/crm/price-list-lines?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/crm/price-list-lines/{id}Read one price list lines

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "price_list_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "category_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "uom": "text",
  "min_quantity": "12.0000",
  "max_quantity": "12.0000",
  "unit_price": "1250.00",
  "discount_pct": "12.0000",
  "markup_pct": "1250.00",
  "price_basis": "fixed",
  "is_negotiable": true,
  "min_margin_pct": "1250.00",
  "created_at": "2026-10-30T09:00:00Z"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/crm/price-list-lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/price-list-linesCreate a price list lines

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
price_list_iduuidYesPrice list
item_iduuidNoItem
category_iduuidNoOr a whole category
uomtextNoUom
min_quantitynumericNoFrom quantity
max_quantitynumericNoUp to quantity
unit_pricenumericNoUnit price
discount_pctnumericNoDiscount %
markup_pctnumericNoMarkup %
price_basistextNoBasis
Allowed: fixed list_less_discount cost_plus formula
is_negotiablebooleanNoNegotiable
min_margin_pctnumericNoMinimum margin %
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.
formula_basetextNoFormula starts from
Allowed: The list price The item’s cost The entry’s own unit price
surcharge_amountnumericNoPlus a fixed amount

Sample body

{
  "price_list_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "category_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "uom": "text",
  "min_quantity": "12.0000"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "price_list_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "category_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "uom": "text",
  "min_quantity": "12.0000",
  "max_quantity": "12.0000",
  "unit_price": "1250.00",
  "discount_pct": "12.0000",
  "markup_pct": "1250.00",
  "price_basis": "fixed",
  "is_negotiable": true,
  "min_margin_pct": "1250.00",
  "created_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/price-list-lines" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"price_list_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","category_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","uom":"text","min_quantity":"12.0000"}'
PUT/api/crm/price-list-lines/{id}Change a price list lines

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
price_list_iduuidYesPrice list
item_iduuidNoItem
category_iduuidNoOr a whole category
uomtextNoUom
min_quantitynumericNoFrom quantity
max_quantitynumericNoUp to quantity
unit_pricenumericNoUnit price
discount_pctnumericNoDiscount %
markup_pctnumericNoMarkup %
price_basistextNoBasis
Allowed: fixed list_less_discount cost_plus formula
is_negotiablebooleanNoNegotiable
min_margin_pctnumericNoMinimum margin %
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.
formula_basetextNoFormula starts from
Allowed: The list price The item’s cost The entry’s own unit price
surcharge_amountnumericNoPlus a fixed amount

Sample body

{
  "price_list_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "price_list_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "category_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "uom": "text",
  "min_quantity": "12.0000",
  "max_quantity": "12.0000",
  "unit_price": "1250.00",
  "discount_pct": "12.0000",
  "markup_pct": "1250.00",
  "price_basis": "fixed",
  "is_negotiable": true,
  "min_margin_pct": "1250.00",
  "created_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/crm/price-list-lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"price_list_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
DELETE/api/crm/price-list-lines/{id}Delete a price list lines

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/crm/price-list-lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/price-list-lines/{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/crm/price-list-lines/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 price list lines, 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
price_list_iduuidread, writePrice list
item_iduuidread, writeItem
category_iduuidread, writeOr a whole category
uomtextread, writeUom
min_quantitynumericread, writeFrom quantity
max_quantitynumericread, writeUp to quantity
unit_pricenumericread, writeUnit price
discount_pctnumericread, writeDiscount %
markup_pctnumericread, writeMarkup %
price_basistextread, writeBasis
Allowed: fixed list_less_discount cost_plus formula
is_negotiablebooleanread, writeNegotiable
min_margin_pctnumericread, writeMinimum margin %
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.
org_unit_iduuidread onlyOrg unit id
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
formula_basetextread, writeFormula starts from
Allowed: The list price The item’s cost The entry’s own unit price
surcharge_amountnumericread, writePlus a fixed amount

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 CRM › Price List Entries 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.