TRANXACT.AI Help

CRM · Reachable by link

Customer · Relationships

Who acts for whom. A parent that pays a subsidiary, a buying group, a guarantor — and whether the exposure rolls up.

Type REST6 operationsBase path /api/crm/customer-relationshipsPublished as /api/v1/customer-relationships

Download specification (OpenAPI 3.1) Screen: Customer · Relationships

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 › Customer · Relationships 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.customer_relationships · 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/customer-relationshipsList customer · relationships

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",
      "from_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "to_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "from_site_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "to_site_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "relationship": "pays_for",
      "rolls_up_credit": true,
      "share_pct": "1250.00",
      "notes": "text",
      "created_at": "2026-10-30T09:00:00Z",
      "effective_from": "2026-10-30",
      "effective_to": "2026-10-30",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "xf_text_1": "text"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "from_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "to_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "from_site_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "to_site_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "relationship": "pays_for",
  "rolls_up_credit": true,
  "share_pct": "1250.00",
  "notes": "text",
  "created_at": "2026-10-30T09:00:00Z",
  "effective_from": "2026-10-30",
  "effective_to": "2026-10-30",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "xf_text_1": "text"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
from_account_iduuidYesFrom account
to_account_iduuidYesTo account
from_site_iduuidNoFrom site id
to_site_iduuidNoTo site id
relationshiptextYesRelationship — A parent company is kept on the Party tab (Is a subsidiary of); the parent_of rows here follow it.
Allowed: pays_for bills_to ships_to guarantees buying_group_for agent_for franchisor_of shares_credit_with
rolls_up_creditbooleanNoExposure rolls up — A guarantor carries the guaranteed balance against its own limit. A credit check that does not know this does nothing.
share_pctnumericNoShare %
notestextNoNotes
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.

Sample body

{
  "from_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "to_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "relationship": "pays_for",
  "from_site_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "to_site_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "rolls_up_credit": true,
  "share_pct": "1250.00"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "from_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "to_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "from_site_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "to_site_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "relationship": "pays_for",
  "rolls_up_credit": true,
  "share_pct": "1250.00",
  "notes": "text",
  "created_at": "2026-10-30T09:00:00Z",
  "effective_from": "2026-10-30",
  "effective_to": "2026-10-30",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "xf_text_1": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/customer-relationships" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"from_account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","to_account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","relationship":"pays_for","from_site_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","to_site_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","rolls_up_credit":true,"share_pct":"1250.00"}'
PUT/api/crm/customer-relationships/{id}Change a customer relationships

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
from_account_iduuidYesFrom account
to_account_iduuidYesTo account
from_site_iduuidNoFrom site id
to_site_iduuidNoTo site id
relationshiptextYesRelationship — A parent company is kept on the Party tab (Is a subsidiary of); the parent_of rows here follow it.
Allowed: pays_for bills_to ships_to guarantees buying_group_for agent_for franchisor_of shares_credit_with
rolls_up_creditbooleanNoExposure rolls up — A guarantor carries the guaranteed balance against its own limit. A credit check that does not know this does nothing.
share_pctnumericNoShare %
notestextNoNotes
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.

Sample body

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "from_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "to_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "from_site_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "to_site_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "relationship": "pays_for",
  "rolls_up_credit": true,
  "share_pct": "1250.00",
  "notes": "text",
  "created_at": "2026-10-30T09:00:00Z",
  "effective_from": "2026-10-30",
  "effective_to": "2026-10-30",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "xf_text_1": "text"
}

Sample request

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

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/customer-relationships/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/customer-relationships/{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/customer-relationships/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 customer relationships, 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
from_account_iduuidread, writeFrom account
to_account_iduuidread, writeTo account
from_site_iduuidread, writeFrom site id
to_site_iduuidread, writeTo site id
relationshiptextread, writeRelationship — A parent company is kept on the Party tab (Is a subsidiary of); the parent_of rows here follow it.
Allowed: pays_for bills_to ships_to guarantees buying_group_for agent_for franchisor_of shares_credit_with
rolls_up_creditbooleanread, writeExposure rolls up — A guarantor carries the guaranteed balance against its own limit. A credit check that does not know this does nothing.
share_pctnumericread, writeShare %
notestextread, writeNotes
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

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 › Customer · Relationships 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.