TRANXACT.AI Help

Accounting · Assets

Custody Trail

Every hand-over, return and verification, in order, for every asset. Append-only: the way to correct it is to record the next movement.

Type REST6 operationsBase path /api/accounting/asset-custodyPublished as /api/v1/asset-custody

Download specification (OpenAPI 3.1) Screen: Custody Trail

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 › Custody Trail 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.asset_custody_trail · kept per company (and organisational unit where it has one)
RecordRead only; 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/accounting/asset-custodyList custody trail

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",
      "asset_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "seq_no": 10,
      "event_type": "text",
      "occurred_on": "2026-10-30",
      "reference_no": "REF-000001",
      "condition": "text",
      "acknowledged": true,
      "notes": "text",
      "created_at": "2026-10-30T09:00:00Z",
      "asset_no": "ASS-000001",
      "asset_name": "Example",
      "asset_class": "text",
      "asset_status": "draft"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "asset_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "seq_no": 10,
  "event_type": "text",
  "occurred_on": "2026-10-30",
  "reference_no": "REF-000001",
  "condition": "text",
  "acknowledged": true,
  "notes": "text",
  "created_at": "2026-10-30T09:00:00Z",
  "asset_no": "ASS-000001",
  "asset_name": "Example",
  "asset_class": "text",
  "asset_status": "draft"
}

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

Sample request

curl "https://demo.tranxact.ai/api/accounting/asset-custody/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/asset-custodyPost custody trail

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

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 PUT "https://demo.tranxact.ai/api/accounting/asset-custody/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/accounting/asset-custody/{id}Delete custody trail

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

Data model

Every field of a asset custody, 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
asset_iduuidread onlyAsset id
seq_nointegerread onlySeq no
event_typetextread onlyEvent type
occurred_ondateread onlyOccurred on
reference_notextread onlyReference no
conditiontextread onlyCondition
acknowledgedbooleanread onlyAcknowledged
notestextread onlyNotes
created_attimestamp with time zoneread onlyCreated at
asset_notextread onlyAsset no
asset_nametextread onlyAsset name
asset_classtextread onlyAsset class
asset_statustextread onlyAsset status
holder_nametextread onlyHolder name
holder_notextread onlyHolder no
holder_statustextread onlyHolder status
from_nametextread onlyFrom name
held_by_unittextread onlyHeld by unit
held_attextread onlyHeld at
performed_by_nametextread onlyPerformed by name

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 › Custody Trail 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.