TRANXACT.AI Help

CRM · Sales

Opportunities

Read and maintain opportunities records (crm.opportunities).

Type REST14 operationsBase path /api/crm/opportunitiesPublished as /api/v1/opportunities

Download specification (OpenAPI 3.1) Screen: Opportunities

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 › Opportunities 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.opportunities · 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

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

GET/api/crm/opportunitiesList opportunities

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",
      "opp_no": "OPP-000001",
      "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "name": "Example",
      "stage": "text",
      "amount": "1250.00",
      "currency": "USD",
      "probability": 10,
      "close_date": "2026-10-30",
      "owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "loss_reason": "text",
      "ar_invoice_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "created_at": "2026-10-30T09:00:00Z",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "opp_no": "OPP-000001",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "name": "Example",
  "stage": "text",
  "amount": "1250.00",
  "currency": "USD",
  "probability": 10,
  "close_date": "2026-10-30",
  "owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "loss_reason": "text",
  "ar_invoice_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "created_at": "2026-10-30T09:00:00Z",
  "org_unit_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/opportunities/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/opportunitiesCreate a opportunities

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
account_iduuidYesAccount id
nametextYesName
amountnumericNoAmount
close_datedateNoClose date
team_iduuidNoTeam id
territory_iduuidNoTerritory id
product_linetextNoProduct line

Sample body

{
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "name": "Example",
  "amount": "1250.00",
  "close_date": "2026-10-30",
  "team_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "territory_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "opp_no": "OPP-000001",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "name": "Example",
  "stage": "text",
  "amount": "1250.00",
  "currency": "USD",
  "probability": 10,
  "close_date": "2026-10-30",
  "owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "loss_reason": "text",
  "ar_invoice_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "created_at": "2026-10-30T09:00:00Z",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/opportunities" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","name":"Example","amount":"1250.00","close_date":"2026-10-30","team_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","territory_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/crm/opportunities/{id}Change a opportunities

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
nametextYesName
amountnumericNoAmount
close_datedateNoClose date
team_iduuidNoTeam id
territory_iduuidNoTerritory id
product_linetextNoProduct line

Sample body

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "opp_no": "OPP-000001",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "name": "Example",
  "stage": "text",
  "amount": "1250.00",
  "currency": "USD",
  "probability": 10,
  "close_date": "2026-10-30",
  "owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "loss_reason": "text",
  "ar_invoice_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "created_at": "2026-10-30T09:00:00Z",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

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

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

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

category, 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 PUT "https://demo.tranxact.ai/api/crm/opportunities/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/forecast-category" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"category":"value","reason":"value"}'
POST/api/crm/opportunities/{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/opportunities/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/opportunities/{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/opportunities/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/opportunities/{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/opportunities/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/crm/opportunities/{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/opportunities/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/crm/opportunities/{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/opportunities/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/crm/opportunities/{id}/linesLines

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

Request body

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

accountId*, name, closeDate; lines: [{ itemId, quantity, unitPrice, description }]

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/opportunities/create" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"accountId":"value","name":"value","closeDate;":"value","quantity":"value","unitPrice":"value","description":"value"}'
POST/api/crm/opportunities/{id}/advance-stageAdvance stage

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

stage, lossReason*

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

Data model

Every field of a opportunities, 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
opp_notextread onlyOpp no
account_iduuidread, writeAccount id
nametextread, writeName
stagetextread onlyStage
amountnumericread, writeAmount
currencytextread onlyCurrency
probabilityintegerread onlyProbability
close_datedateread, writeClose date
owner_iduuidread onlyOwner id
loss_reasontextread onlyLoss reason
ar_invoice_iduuidread onlyAr invoice id
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
location_iduuidread onlyLocation id
warehouse_iduuidread onlyWarehouse 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
forecast_categorytextread onlyForecast category
forecast_override_reasontextread onlyForecast override reason
team_iduuidread, writeTeam id
territory_iduuidread, writeTerritory id
product_linetextread, writeProduct line
closed_attimestamp with time zoneread onlyClosed at
renewal_of_contract_iduuidread onlyRenewal of contract id

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