CRM · Pricing Procedures
Pricing Condition Types
The kinds of element a procedure stacks: a price, discounts, surcharges -- and charges on the document (freight, insurance, packing, inspection, duty) for quotations, sales orders and purchase orders. PR00 is the list price. Liquidated damages (LD): 0.5% of the late goods’ net value for every week late, at most 5% of the order’s net value, no VAT/GST, found for an order by its own condition records.
/api/crm/pricing-condition-typesPublished as /api/v1/pricing-condition-typesDownload specification (OpenAPI 3.1) Screen: Pricing Condition Types
Overview
| 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 › Pricing Condition Types 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.pricing_condition_types · 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/crm/pricing-condition-typesList pricing condition types
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",
"code": "COD-000001",
"name": "Example",
"class": "Price",
"calc": "Percent of the running price",
"source": "Condition records",
"access_sequence_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_active": true,
"description": "text",
"created_at": "2026-10-30T09:00:00Z",
"charge_kind": "Freight",
"charge_to": "On this document (billed by the customer’s or supplier’s invoice)",
"applies_to": "Quotations and sales orders",
"landed_cost_charge_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/crm/pricing-condition-types?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/pricing-condition-types/{id}Read one pricing condition types
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",
"code": "COD-000001",
"name": "Example",
"class": "Price",
"calc": "Percent of the running price",
"source": "Condition records",
"access_sequence_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_active": true,
"description": "text",
"created_at": "2026-10-30T09:00:00Z",
"charge_kind": "Freight",
"charge_to": "On this document (billed by the customer’s or supplier’s invoice)",
"applies_to": "Quotations and sales orders",
"landed_cost_charge_type_id": "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/pricing-condition-types/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/pricing-condition-typesCreate a pricing condition types
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
class | text | No | Class Allowed: Price Discount Surcharge Charge on the document Liquidated damages (penalty for late delivery) |
calc | text | No | Calculated as Allowed: Percent of the running price Amount per unit Amount per unit ordered (charges) |
source | text | No | Value from Allowed: Condition records The price list lookup |
access_sequence_id | uuid | No | Access sequence |
is_active | boolean | No | Active |
description | text | No | Description |
charge_kind | text | No | Kind of charge Allowed: Freight Insurance Packing and forwarding Inspection Customs duty Handling Other |
charge_to | text | No | Paid to Allowed: On this document (billed by the customer’s or supplier’s invoice) Accrued (paid to a carrier, customs or another party) |
applies_to | text | No | Used on Allowed: Quotations and sales orders Purchase orders Both |
landed_cost_charge_type_id | uuid | No | Landed cost charge |
Sample body
{
"code": "COD-000001",
"name": "Example",
"class": "Price",
"calc": "Percent of the running price",
"source": "Condition records",
"access_sequence_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"class": "Price",
"calc": "Percent of the running price",
"source": "Condition records",
"access_sequence_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_active": true,
"description": "text",
"created_at": "2026-10-30T09:00:00Z",
"charge_kind": "Freight",
"charge_to": "On this document (billed by the customer’s or supplier’s invoice)",
"applies_to": "Quotations and sales orders",
"landed_cost_charge_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/pricing-condition-types" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","class":"Price","calc":"Percent of the running price","source":"Condition records","access_sequence_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/crm/pricing-condition-types/{id}Change a pricing condition types
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 |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
class | text | No | Class Allowed: Price Discount Surcharge Charge on the document Liquidated damages (penalty for late delivery) |
calc | text | No | Calculated as Allowed: Percent of the running price Amount per unit Amount per unit ordered (charges) |
source | text | No | Value from Allowed: Condition records The price list lookup |
access_sequence_id | uuid | No | Access sequence |
is_active | boolean | No | Active |
description | text | No | Description |
charge_kind | text | No | Kind of charge Allowed: Freight Insurance Packing and forwarding Inspection Customs duty Handling Other |
charge_to | text | No | Paid to Allowed: On this document (billed by the customer’s or supplier’s invoice) Accrued (paid to a carrier, customs or another party) |
applies_to | text | No | Used on Allowed: Quotations and sales orders Purchase orders Both |
landed_cost_charge_type_id | uuid | No | Landed cost charge |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"class": "Price",
"calc": "Percent of the running price",
"source": "Condition records",
"access_sequence_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"is_active": true,
"description": "text",
"created_at": "2026-10-30T09:00:00Z",
"charge_kind": "Freight",
"charge_to": "On this document (billed by the customer’s or supplier’s invoice)",
"applies_to": "Quotations and sales orders",
"landed_cost_charge_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/crm/pricing-condition-types/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/crm/pricing-condition-types/{id}Delete a pricing condition types
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/pricing-condition-types/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/pricing-condition-types/{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/pricing-condition-types/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 pricing condition types, 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 |
code | text | read, write | Code |
name | text | read, write | Name |
class | text | read, write | Class Allowed: Price Discount Surcharge Charge on the document Liquidated damages (penalty for late delivery) |
calc | text | read, write | Calculated as Allowed: Percent of the running price Amount per unit Amount per unit ordered (charges) |
source | text | read, write | Value from Allowed: Condition records The price list lookup |
access_sequence_id | uuid | read, write | Access sequence |
is_active | boolean | read, write | Active |
description | text | read, write | Description |
created_at | timestamp with time zone | read only | Created at |
charge_kind | text | read, write | Kind of charge Allowed: Freight Insurance Packing and forwarding Inspection Customs duty Handling Other |
charge_to | text | read, write | Paid to Allowed: On this document (billed by the customer’s or supplier’s invoice) Accrued (paid to a carrier, customs or another party) |
applies_to | text | read, write | Used on Allowed: Quotations and sales orders Purchase orders Both |
landed_cost_charge_type_id | uuid | read, write | Landed cost charge |
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 › Pricing Condition Types 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.