TRANXACT.AI Help

CRM · Selling

Quotations

Read and maintain quotations records (crm.quotations).

Type REST18 operationsBase path /api/crm/quotationsPublished as /api/v1/quotations

Download specification (OpenAPI 3.1) Screen: Quotations

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 › Quotations 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.quotations · 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

18 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/crm/quotationsList quotations

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",
      "quote_no": "QUO-000001",
      "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "quote_date": "2026-10-30",
      "valid_until": "2026-10-30",
      "currency": "USD",
      "status": "draft",
      "subtotal": "1250.00",
      "tax_total": "1250.00",
      "total": "1250.00",
      "payment_terms_days": 10
    }
  ],
  "count": 1
}

Sample request

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

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",
  "quote_no": "QUO-000001",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "quote_date": "2026-10-30",
  "valid_until": "2026-10-30",
  "currency": "USD",
  "status": "draft",
  "subtotal": "1250.00",
  "tax_total": "1250.00",
  "total": "1250.00",
  "payment_terms_days": 10
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
account_iduuidYesAccount id
contact_iduuidNoContact
opportunity_iduuidNoOpportunity id
quote_datedateNoQuote date
valid_untildateNoValid until
currencytextYesCurrency
statustextNoStatus
payment_terms_daysintegerNoPayment terms (days)
notestextNoNotes
exchange_ratenumericNoExchange rate

Sample body

{
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "currency": "USD",
  "contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "quote_date": "2026-10-30",
  "valid_until": "2026-10-30"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "quote_no": "QUO-000001",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "quote_date": "2026-10-30",
  "valid_until": "2026-10-30",
  "currency": "USD",
  "status": "draft",
  "subtotal": "1250.00",
  "tax_total": "1250.00",
  "total": "1250.00",
  "payment_terms_days": 10
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/quotations" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","currency":"USD","contact_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","opportunity_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","quote_date":"2026-10-30","valid_until":"2026-10-30"}'
PUT/api/crm/quotations/{id}Change a quotations

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
account_iduuidYesAccount id
contact_iduuidNoContact
opportunity_iduuidNoOpportunity id
quote_datedateNoQuote date
valid_untildateNoValid until
currencytextYesCurrency
statustextNoStatus
payment_terms_daysintegerNoPayment terms (days)
notestextNoNotes
exchange_ratenumericNoExchange rate

Sample body

{
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "currency": "USD"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "quote_no": "QUO-000001",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "opportunity_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "quote_date": "2026-10-30",
  "valid_until": "2026-10-30",
  "currency": "USD",
  "status": "draft",
  "subtotal": "1250.00",
  "tax_total": "1250.00",
  "total": "1250.00",
  "payment_terms_days": 10
}

Sample request

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

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/quotations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/crm/quotations/{id}/approvalsApprovals

Path parameters

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

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/crm/quotations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approvals" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/quotations/{id}/submit-for-approvalSubmit for approval

Path parameters

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

No body is required.

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/quotations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/submit-for-approval" \
  -H "Authorization: Bearer $TOKEN"
GET/api/crm/quotations/{id}/config-lines/templateConfig lines template

Path parameters

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

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/crm/quotations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/config-lines/template" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/quotations/{id}/config-lines/importConfig lines import

Path parameters

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

No body is required.

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/quotations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/config-lines/import" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/quotations/{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/quotations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
GET/api/crm/quotations/{parentId}/linesLines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/crm/quotations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/quotations/{parentId}/linesLines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

No body is required.

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/quotations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/crm/quotations/{parentId}/lines/{lineId}Lines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, as a list returns it.

No body is required.

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 PUT "https://demo.tranxact.ai/api/crm/quotations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/crm/quotations/{parentId}/lines/{lineId}Lines

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, as a list returns it.

No body is required.

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 DELETE "https://demo.tranxact.ai/api/crm/quotations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/quotations/createCreate

Request body

The keys this action reads (* = required; "one of" lists the only values):

shipTo, shipToSiteId, shipFrom, quoteNo, accountId*, contactId, opportunityId, validUntil, currency, exchangeRate, costCenterId, warehouseId, locationId, notes; lines: [{ itemId, uom, currency, exchangeRate, description, quantity, unitPrice, discountPct, costCenterId, configId, configUnitPrice, configUnitCost }]

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/quotations/create" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"shipTo":"value","shipToSiteId":"value","shipFrom":"value","quoteNo":"value","accountId":"value","contactId":"value"}'
POST/api/crm/quotations/{id}/sendSend

Path parameters

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

No body is required.

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/quotations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/send" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/quotations/{id}/acceptAccept

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):

requestedDate, customerPoRef

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/quotations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/accept" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"requestedDate":"value","customerPoRef":"value"}'
POST/api/crm/quotations/{id}/rejectReject

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):

reason

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/quotations/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/reject" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reason":"value"}'

Data model

Every field of a quotations, 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 onlyOrg unit id
quote_notextread onlyQuote no
account_iduuidread, writeAccount id
contact_iduuidread, writeContact
opportunity_iduuidread, writeOpportunity id
quote_datedateread, writeQuote date
valid_untildateread, writeValid until
currencytextread, writeCurrency
statustextread, writeStatus
subtotalnumericread onlySubtotal
tax_totalnumericread onlyTax total
totalnumericread onlyTotal
payment_terms_daysintegerread, writePayment terms (days)
notestextread, writeNotes
created_byuuidread onlyCreated by
created_attimestamp with time zoneread onlyCreated at
location_iduuidread onlyLocation
warehouse_iduuidread onlyShips from warehouse
cost_center_iduuidread onlyCost center id
profit_center_iduuidread onlyProfit center id
cancelled_attimestamp with time zoneread onlyCancelled at
cancelled_byuuidread onlyCancelled by
cancel_reasontextread onlyCancel reason
reversed_by_iduuidread onlyReversed by id
reverses_iduuidread onlyReverses id
exchange_ratenumericread, writeExchange rate
base_totalnumericread onlyBase total
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
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
accepted_viatextread onlyAccepted via
accepted_by_portal_user_iduuidread onlyAccepted by portal user id
supplier_gstintextread onlySupplier gstin
buyer_gstintextread onlyBuyer gstin
place_of_supplytextread onlyPlace of supply
is_interstatebooleanread onlyIs interstate
is_reverse_chargebooleanread onlyIs reverse charge
export_typetextread onlyExport type
cgst_totalnumericread onlyCgst total
sgst_totalnumericread onlySgst total
igst_totalnumericread onlyIgst total
cess_totalnumericread onlyCess total
charges_totalnumericread onlyCharges total
accrued_charges_totalnumericread onlyAccrued charges total

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 › Quotations 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.