TRANXACT.AI Help

Master data · Records

Addresses

Read and maintain addresses records (mdm.addresses).

Type REST5 operationsBase path /api/mdm/addressesPublished as /api/v1/addresses

Download specification (OpenAPI 3.1)

Overview

PackageMaster data
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 Master data › Addresses 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.
Tablemdm.addresses · 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

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

GET/api/mdm/addressesList addresses

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",
      "address_line1": "text",
      "address_line2": "text",
      "address_line3": "text",
      "city": "text",
      "region": "text",
      "postal_code": "POS-000001",
      "country": "US",
      "local_script": "text",
      "latitude": "1250.00",
      "longitude": "1250.00",
      "timezone": "text",
      "validation_status": "draft",
      "validated_at": "2026-10-30T09:00:00Z"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "address_line1": "text",
  "address_line2": "text",
  "address_line3": "text",
  "city": "text",
  "region": "text",
  "postal_code": "POS-000001",
  "country": "US",
  "local_script": "text",
  "latitude": "1250.00",
  "longitude": "1250.00",
  "timezone": "text",
  "validation_status": "draft",
  "validated_at": "2026-10-30T09:00:00Z"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
address_line1textYesAddress line1
address_line2textNoAddress line2
address_line3textNoAddress line3
citytextNoCity
regiontextNoRegion
postal_codetextNoPostal code
countrytextNoCountry
local_scripttextNoLocal script
latitudenumericNoLatitude
longitudenumericNoLongitude
timezonetextNoTimezone
validation_statustextNoValidation status
building_notextNoBuilding no
districttextNoDistrict
additional_notextNoAdditional no

Sample body

{
  "address_line1": "text",
  "address_line2": "text",
  "address_line3": "text",
  "city": "text",
  "region": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "address_line1": "text",
  "address_line2": "text",
  "address_line3": "text",
  "city": "text",
  "region": "text",
  "postal_code": "POS-000001",
  "country": "US",
  "local_script": "text",
  "latitude": "1250.00",
  "longitude": "1250.00",
  "timezone": "text",
  "validation_status": "draft",
  "validated_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/mdm/addresses" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"address_line1":"text","address_line2":"text","address_line3":"text","city":"text","region":"text"}'
PUT/api/mdm/addresses/{id}Change a addresses

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
address_line1textYesAddress line1
address_line2textNoAddress line2
address_line3textNoAddress line3
citytextNoCity
regiontextNoRegion
postal_codetextNoPostal code
countrytextNoCountry
local_scripttextNoLocal script
latitudenumericNoLatitude
longitudenumericNoLongitude
timezonetextNoTimezone
validation_statustextNoValidation status
building_notextNoBuilding no
districttextNoDistrict
additional_notextNoAdditional no

Sample body

{
  "address_line1": "text",
  "address_line2": "text"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "address_line1": "text",
  "address_line2": "text",
  "address_line3": "text",
  "city": "text",
  "region": "text",
  "postal_code": "POS-000001",
  "country": "US",
  "local_script": "text",
  "latitude": "1250.00",
  "longitude": "1250.00",
  "timezone": "text",
  "validation_status": "draft",
  "validated_at": "2026-10-30T09:00:00Z"
}

Sample request

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

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

Data model

Every field of a addresses, 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
address_line1textread, writeAddress line1
address_line2textread, writeAddress line2
address_line3textread, writeAddress line3
citytextread, writeCity
regiontextread, writeRegion
postal_codetextread, writePostal code
countrytextread, writeCountry
local_scripttextread, writeLocal script
latitudenumericread, writeLatitude
longitudenumericread, writeLongitude
timezonetextread, writeTimezone
validation_statustextread, writeValidation status
validated_attimestamp with time zoneread onlyValidated at
validation_sourcetextread onlyValidation source
created_attimestamp with time zoneread onlyCreated at
updated_attimestamp with time zoneread onlyUpdated at
created_byuuidread onlyCreated by
updated_byuuidread onlyUpdated by
building_notextread, writeBuilding no
districttextread, writeDistrict
additional_notextread, writeAdditional no
countytextread onlyCounty
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

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 Master data › Addresses 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.