GetEntity

Returns one entity, such as a customer, shipper, carrier or transporter, with its details and its entity data fields. Use it to copy an entity into your own system, for example each entity that GetEntitiesUpdated lists as changed.

How to sign in and read the response: Authentication, Responses.

GET /api/v1/GetEntity?ID=48211
Token: your-token

Or, by code:

GET /api/v1/GetEntity?Code=EXSHIP
Token: your-token

Parameter	Required	Meaning
`ID`	One of the two	The entity’s ID, a whole number.
`Code`	One of the two	The entity’s code (Entity Code), for example `EXSHIP`. Capitals do not matter.

If you send both, TrakIT uses ID.

Rules

Rule	`Info` when it fails
The `Token` header holds a valid token.	`Token missing in header`, `Token invalid or expired`, or another answer listed in Login token
The user is a system administrator with API access.	`API User must be SysAdmin with API Access`
`ID`, if given, is a number.	`ID must be numeric`
An entity has that ID or code.	`No such entity`

Response

On success, RetInfo is the entity and RowsAffected is 1. Times are in UTC, without a time zone (see Dates and times).

{
  "Code": 1,
  "Info": "",
  "RetInfo": {
    "EntID": 48211,
    "EntType": 1,
    "TypeList": null,
    "GroupID": null,
    "Notify": true,
    "Account": "EXSHIP-01",
    "CurrCode": "USD",
    "Active": true,
    "CreatedBy": "JSMITH",
    "RespOffice": 3,
    "LocalName": null,
    "MultiTypes": "8,9",
    "RespUser": "JSMITH",
    "RespUserName": "John Smith",
    "PCID": 12,
    "EntCode": "EXSHIP",
    "EntName": "Example Shipping Co",
    "GroupName": null,
    "Email": "ops@example.com",
    "FinEmail": "accounts@example.com",
    "MgmtEmail": "",
    "Contact": "John Smith",
    "Remarks": "",
    "Address": "1 Example Road, Example City",
    "CountryCode": "KE",
    "Phone": "+1 555 0100",
    "Changed": "2026-10-20T14:30:05.437",
    "ChangedBy": "JSMITH",
    "LastEmail": "2026-10-21T06:00:12.250",
    "CountryName": "Kenya",
    "HasLogo": false,
    "OfficeName": "Example Logistics Ltd",
    "PCName": "Freight",
    "TrackLink": false,
    "EnableAPI": false,
    "TIN": "P000000000X",
    "RegN": null,
    "SCAC": null,
    "IsCarrier": false,
    "CreatedOn": "2026-10-02T09:15:44.903",
    "WANum": "",
    "ApprovedOn": "2026-10-02T10:01:30.117",
    "ApprovedBy": "JSMITH",
    "InvRemFreq": 7,
    "LastInvRem": "2026-10-26T05:05:02.680",
    "Data": [
      {
        "FieldName": "Credit Days",
        "Value": "30",
        "Remarks": "",
        "Updated": "2026-10-15T08:00:21.330",
        "UpdatedBy": "JSMITH"
      }
    ]
  },
  "RowsAffected": 1,
  "Scalar": null,
  "Identity": 0
}

The labels in bold are those of the entity’s fields.

Field	Meaning
`EntID`	The entity’s ID.
`EntCode`, `EntName`	Entity Code and Entity Name.
`EntType`	The entity’s main type, as a number: `0` carrier, `1` customer, `2` transporter, `3` bond agent, `4` clearing agent, `5` bank, `6` authority, `7` other, `8` shipper, `9` receiver. TrakIT Support names the types for your installation, so the names may differ: see Entity types.
`MultiTypes`	The entity’s other types, as numbers separated by commas, or `null`.
`TypeList`	Not used: always `null`.
`IsCarrier`	`true` when the entity is a carrier, as its main type or another type.
`Active`	`false` when the entity is disabled (Disable).
`LocalName`	Local Name, or `null`.
`CountryCode`, `CountryName`	Country: its 2-letter ISO code and its name.
`Address`	Postal Address.
`Contact`	Contact Person(s).
`Phone`	Phone Numbers.
`WANum`	WhatsApp Numbers.
`Email`, `FinEmail`, `MgmtEmail`	General Emails, Finance Emails and Management Emails. Empty when none are entered.
`Remarks`	Remarks.
`TIN`, `RegN`	TIN and Registration, or `null`.
`SCAC`	Shipping Line (SCAC), for carriers, or `null`.
`Account`	Default Account, or `null`.
`CurrCode`	Base Currency, or `null`.
`RespOffice`, `OfficeName`	Responsible Company: its ID and name.
`PCID`, `PCName`	Default Profit Center: its ID and name, or `null`.
`RespUser`, `RespUserName`	Responsible: the user ID and the user’s name, or `null`.
`GroupID`, `GroupName`	Customer Group, for customers: its ID and name, or `null`.
`Notify`	`true` when Status Updates is on.
`TrackLink`	`true` when Send Link is on.
`EnableAPI`	`true` when Enable API Access is on: the entity has an entity API key.
`HasLogo`	`true` when the entity has a logo.
`CreatedBy`, `CreatedOn`	The user ID of the user who created the entity, and when.
`Changed`, `ChangedBy`	When the entity’s details were last saved, and the user ID of the user who saved them.
`ApprovedOn`, `ApprovedBy`	When the entity was approved, and the user ID of the user who approved it, or `null`.
`LastEmail`	When TrakIT last sent the customer a status update email, or `null`.
`InvRemFreq`	How often payment reminders are sent, in days: `1`, `2`, `3`, `7`, `15` or `30`, or `0` for none.
`LastInvRem`	When the last payment reminder was sent, or `null`.
`Data`	The entity’s data fields that have been saved, in the order of the fields. An empty list if none.

Each entry of Data:

Field	Meaning
`FieldName`	The data field’s name.
`Value`	The value, as text.
`Remarks`	The remarks, or an empty string.
`Updated`	When the value was last saved.
`UpdatedBy`	The user ID of the user who saved it, or `null` for a computed field.