TRANXACT.AI Help

CRM · Selling

Quotation Approval Rules

Which quotations an approver has to check before they go to the customer, and who. A quotation a rule covers cannot be sent, or turned into an order, until every approver has signed; one no rule covers is sent as it always was.

Type REST6 operationsBase path /api/crm/quote-approval-rulesPublished as /api/v1/quote-approval-rules

Download specification (OpenAPI 3.1) Screen: Quotation Approval Rules

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 › Quotation Approval Rules 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.quote_approval_rules · 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/quote-approval-rulesList quotation approval rules

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",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "code": "COD-000001",
      "name": "Example",
      "priority": 10,
      "amount_threshold": "1250.00",
      "discount_pct_threshold": "12.0000",
      "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "approver_kind": "Anyone holding a role",
      "levels": 10,
      "approver_role": "text",
      "approver_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "due_in_hours": 10,
      "is_active": true
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/crm/quote-approval-rules?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/crm/quote-approval-rules/{id}Read one quotation approval rule

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "priority": 10,
  "amount_threshold": "1250.00",
  "discount_pct_threshold": "12.0000",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "approver_kind": "Anyone holding a role",
  "levels": 10,
  "approver_role": "text",
  "approver_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "due_in_hours": 10,
  "is_active": true
}

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

Sample request

curl "https://demo.tranxact.ai/api/crm/quote-approval-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/quote-approval-rulesCreate a quotation approval rule

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
org_unit_iduuidNoOrganizational unit — The quotations of this unit and every unit beneath it. The top of the company means every quotation.
codetextYesCode
nametextYesName
priorityintegerNoOrder — Every rule that matches applies; lower numbers collect their signatures first.
amount_thresholdnumericNoApplies from amount — The quotation's total in the company's own currency. 0 means every quotation.
discount_pct_thresholdnumericNoApplies from a discount of (%) — The largest discount on any line. Leave empty when discounts do not matter to this rule.
account_iduuidNoOnly for customer
approver_kindtextNoWho approves
Allowed: Anyone holding a role The raiser's reporting line (HRMS) A named person
levelsintegerNoLevels up the reporting line — 1 is the manager of whoever raised the quotation, 2 adds their manager, up to 5.
approver_roletextNoRole — For "anyone holding a role": a sign-in role, not a position in HRMS. On a reporting-line rule it is the last resort, used when the raiser has nobody above them in HRMS.
approver_employee_iduuidNoPerson — For "a named person". Somebody with no sign-in yet is still the approver; the quotation waits for them.
due_in_hoursintegerNoDue within (hours)
is_activebooleanNoActive
descriptiontextNoDescription

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "priority": 10,
  "amount_threshold": "1250.00",
  "discount_pct_threshold": "12.0000"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "priority": 10,
  "amount_threshold": "1250.00",
  "discount_pct_threshold": "12.0000",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "approver_kind": "Anyone holding a role",
  "levels": 10,
  "approver_role": "text",
  "approver_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "due_in_hours": 10,
  "is_active": true
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/quote-approval-rules" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","org_unit_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","priority":10,"amount_threshold":"1250.00","discount_pct_threshold":"12.0000"}'
PUT/api/crm/quote-approval-rules/{id}Change a quotation approval rule

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
org_unit_iduuidNoOrganizational unit — The quotations of this unit and every unit beneath it. The top of the company means every quotation.
codetextYesCode
nametextYesName
priorityintegerNoOrder — Every rule that matches applies; lower numbers collect their signatures first.
amount_thresholdnumericNoApplies from amount — The quotation's total in the company's own currency. 0 means every quotation.
discount_pct_thresholdnumericNoApplies from a discount of (%) — The largest discount on any line. Leave empty when discounts do not matter to this rule.
account_iduuidNoOnly for customer
approver_kindtextNoWho approves
Allowed: Anyone holding a role The raiser's reporting line (HRMS) A named person
levelsintegerNoLevels up the reporting line — 1 is the manager of whoever raised the quotation, 2 adds their manager, up to 5.
approver_roletextNoRole — For "anyone holding a role": a sign-in role, not a position in HRMS. On a reporting-line rule it is the last resort, used when the raiser has nobody above them in HRMS.
approver_employee_iduuidNoPerson — For "a named person". Somebody with no sign-in yet is still the approver; the quotation waits for them.
due_in_hoursintegerNoDue within (hours)
is_activebooleanNoActive
descriptiontextNoDescription

Sample body

{
  "code": "COD-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "priority": 10,
  "amount_threshold": "1250.00",
  "discount_pct_threshold": "12.0000",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "approver_kind": "Anyone holding a role",
  "levels": 10,
  "approver_role": "text",
  "approver_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "due_in_hours": 10,
  "is_active": true
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/crm/quote-approval-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example"}'
DELETE/api/crm/quote-approval-rules/{id}Delete a quotation approval rule

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/quote-approval-rules/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/quote-approval-rules/{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/quote-approval-rules/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 quotation approval rule, 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
org_unit_iduuidread, writeOrganizational unit — The quotations of this unit and every unit beneath it. The top of the company means every quotation.
codetextread, writeCode
nametextread, writeName
priorityintegerread, writeOrder — Every rule that matches applies; lower numbers collect their signatures first.
amount_thresholdnumericread, writeApplies from amount — The quotation's total in the company's own currency. 0 means every quotation.
discount_pct_thresholdnumericread, writeApplies from a discount of (%) — The largest discount on any line. Leave empty when discounts do not matter to this rule.
account_iduuidread, writeOnly for customer
approver_kindtextread, writeWho approves
Allowed: Anyone holding a role The raiser's reporting line (HRMS) A named person
levelsintegerread, writeLevels up the reporting line — 1 is the manager of whoever raised the quotation, 2 adds their manager, up to 5.
approver_roletextread, writeRole — For "anyone holding a role": a sign-in role, not a position in HRMS. On a reporting-line rule it is the last resort, used when the raiser has nobody above them in HRMS.
approver_employee_iduuidread, writePerson — For "a named person". Somebody with no sign-in yet is still the approver; the quotation waits for them.
due_in_hoursintegerread, writeDue within (hours)
is_activebooleanread, writeActive
descriptiontextread, writeDescription
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
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

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 › Quotation Approval Rules 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.