TRANXACT.AI Help

Accounting · Settlement & Allocation

Allocation Segments

Who sends, who receives, and what splits between them. Anything less than a 100% sender share leaves a residue on the sender, which is sometimes right and usually a mistake.

Type REST10 operationsBase path /api/accounting/allocation-segmentsPublished as /api/v1/allocation-segments

Download specification (OpenAPI 3.1) Screen: Allocation Segments

Overview

PackageAccounting
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 Accounting › Allocation Segments 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.
Tableacct.allocation_segments
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

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

GET/api/accounting/allocation-segmentsList allocation segments

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",
      "cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "segment_no": 10,
      "name": "Example",
      "sender_type": "cost_center",
      "sender_pattern": "text",
      "sender_group": "text",
      "cost_element_pattern": "text",
      "sender_pct": "1250.00",
      "sender_rule": "posted_amount",
      "fixed_amount": "1250.00",
      "receiver_type": "cost_center",
      "receiver_pattern": "text",
      "receiver_group": "text"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "segment_no": 10,
  "name": "Example",
  "sender_type": "cost_center",
  "sender_pattern": "text",
  "sender_group": "text",
  "cost_element_pattern": "text",
  "sender_pct": "1250.00",
  "sender_rule": "posted_amount",
  "fixed_amount": "1250.00",
  "receiver_type": "cost_center",
  "receiver_pattern": "text",
  "receiver_group": "text"
}

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

Sample request

curl "https://demo.tranxact.ai/api/accounting/allocation-segments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/allocation-segmentsCreate a allocation segment

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
cycle_iduuidYesCycle
segment_nointegerYesSegment
nametextYesName
sender_typetextNoSender type
Allowed: cost_center profit_center order project activity
sender_patterntextNoSender pattern — 'ADM%' for every administration cost center.
sender_grouptextNoSender group
cost_element_patterntextNoCost element pattern
sender_pctnumericNoSender sends %
sender_ruletextNoSender rule
Allowed: posted_amount fixed_amount fixed_rate fixed_price
fixed_amountnumericNoFixed amount
receiver_typetextNoReceiver type
Allowed: cost_center profit_center order project wbs_element profitability_segment item customer
receiver_patterntextNoReceiver pattern
receiver_grouptextNoReceiver group
driver_iduuidNoDriver
basistextNoBasis
Allowed: driver fixed_percentage fixed_portion posted_amount equal
assessment_element_iduuidNoAssessment element — Required for an assessment; must be blank for a distribution.
is_activebooleanNoActive
notestextNoNotes

Sample body

{
  "cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "segment_no": 10,
  "name": "Example",
  "sender_type": "cost_center",
  "sender_pattern": "text",
  "sender_group": "text",
  "cost_element_pattern": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "segment_no": 10,
  "name": "Example",
  "sender_type": "cost_center",
  "sender_pattern": "text",
  "sender_group": "text",
  "cost_element_pattern": "text",
  "sender_pct": "1250.00",
  "sender_rule": "posted_amount",
  "fixed_amount": "1250.00",
  "receiver_type": "cost_center",
  "receiver_pattern": "text",
  "receiver_group": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/allocation-segments" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"cycle_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","segment_no":10,"name":"Example","sender_type":"cost_center","sender_pattern":"text","sender_group":"text","cost_element_pattern":"text"}'
PUT/api/accounting/allocation-segments/{id}Change a allocation segment

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
cycle_iduuidYesCycle
segment_nointegerYesSegment
nametextYesName
sender_typetextNoSender type
Allowed: cost_center profit_center order project activity
sender_patterntextNoSender pattern — 'ADM%' for every administration cost center.
sender_grouptextNoSender group
cost_element_patterntextNoCost element pattern
sender_pctnumericNoSender sends %
sender_ruletextNoSender rule
Allowed: posted_amount fixed_amount fixed_rate fixed_price
fixed_amountnumericNoFixed amount
receiver_typetextNoReceiver type
Allowed: cost_center profit_center order project wbs_element profitability_segment item customer
receiver_patterntextNoReceiver pattern
receiver_grouptextNoReceiver group
driver_iduuidNoDriver
basistextNoBasis
Allowed: driver fixed_percentage fixed_portion posted_amount equal
assessment_element_iduuidNoAssessment element — Required for an assessment; must be blank for a distribution.
is_activebooleanNoActive
notestextNoNotes

Sample body

{
  "cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "segment_no": 10
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "segment_no": 10,
  "name": "Example",
  "sender_type": "cost_center",
  "sender_pattern": "text",
  "sender_group": "text",
  "cost_element_pattern": "text",
  "sender_pct": "1250.00",
  "sender_rule": "posted_amount",
  "fixed_amount": "1250.00",
  "receiver_type": "cost_center",
  "receiver_pattern": "text",
  "receiver_group": "text"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/allocation-segments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"cycle_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","segment_no":10}'
DELETE/api/accounting/allocation-segments/{id}Delete a allocation segment

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

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/accounting/allocation-segments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/receivers" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/allocation-segments/{parentId}/receiversReceivers

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/accounting/allocation-segments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/receivers" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/accounting/allocation-segments/{parentId}/receivers/{lineId}Receivers

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/accounting/allocation-segments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/receivers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/accounting/allocation-segments/{parentId}/receivers/{lineId}Receivers

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/accounting/allocation-segments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/receivers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a allocation segment, 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
cycle_iduuidread, writeCycle
segment_nointegerread, writeSegment
nametextread, writeName
sender_typetextread, writeSender type
Allowed: cost_center profit_center order project activity
sender_patterntextread, writeSender pattern — 'ADM%' for every administration cost center.
sender_grouptextread, writeSender group
cost_element_patterntextread, writeCost element pattern
sender_pctnumericread, writeSender sends %
sender_ruletextread, writeSender rule
Allowed: posted_amount fixed_amount fixed_rate fixed_price
fixed_amountnumericread, writeFixed amount
receiver_typetextread, writeReceiver type
Allowed: cost_center profit_center order project wbs_element profitability_segment item customer
receiver_patterntextread, writeReceiver pattern
receiver_grouptextread, writeReceiver group
driver_iduuidread, writeDriver
basistextread, writeBasis
Allowed: driver fixed_percentage fixed_portion posted_amount equal
assessment_element_iduuidread, writeAssessment element — Required for an assessment; must be blank for a distribution.
is_activebooleanread, writeActive
notestextread, writeNotes
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_attimestamp with time zoneread onlyCreated at
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 Accounting › Allocation Segments 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.