GetEntity

Renvoie une entité, comme un client, un chargeur, un transporteur ou un transporteur routier, avec ses détails et ses champs de données d’entité. Utilisez-le pour copier une entité dans votre propre système, par exemple chaque entité que GetEntitiesUpdated liste comme modifiée.

Comment se connecter et lire la réponse : Authentification, Réponses.

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

Ou, par code :

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

Paramètre	Obligatoire	Signification
`ID`	L’un des deux	L’identifiant de l’entité, un nombre entier.
`Code`	L’un des deux	Le code de l’entité (Entity Code), par exemple `EXSHIP`. Les majuscules n’ont pas d’importance.

Si vous envoyez les deux, TrakIT utilise ID.

Règles

Règle	`Info` en cas d’échec
L’en-tête `Token` contient un jeton valide.	`Token missing in header`, `Token invalid or expired`, ou une autre réponse listée dans Jeton de connexion
L’utilisateur est un administrateur système disposant de l’accès à l’API.	`API User must be SysAdmin with API Access`
`ID`, s’il est indiqué, est un nombre.	`ID must be numeric`
Une entité a cet identifiant ou ce code.	`No such entity`

Réponse

En cas de succès, RetInfo est l’entité et RowsAffected vaut 1. Les heures sont en UTC, sans fuseau horaire (voir Dates et heures).

{
  "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
}

Les libellés en gras sont ceux des champs de l’entité.

Champ	Signification
`EntID`	L’identifiant de l’entité.
`EntCode`, `EntName`	Entity Code et Entity Name.
`EntType`	Le type principal de l’entité, sous forme de nombre : `0` transporteur, `1` client, `2` transporteur routier, `3` agent de caution, `4` commissionnaire en douane, `5` banque, `6` autorité, `7` autre, `8` chargeur, `9` réceptionnaire. Le support TrakIT nomme les types pour votre installation : les noms peuvent donc être différents. Voir Types d’entités.
`MultiTypes`	Les autres types de l’entité, sous forme de nombres séparés par des virgules, ou `null`.
`TypeList`	Non utilisé : toujours `null`.
`IsCarrier`	`true` quand l’entité est un transporteur, comme type principal ou comme autre type.
`Active`	`false` quand l’entité est désactivée (Disable).
`LocalName`	Local Name, ou `null`.
`CountryCode`, `CountryName`	Country : son code ISO à 2 lettres et son nom.
`Address`	Postal Address.
`Contact`	Contact Person(s).
`Phone`	Phone Numbers.
`WANum`	WhatsApp Numbers.
`Email`, `FinEmail`, `MgmtEmail`	General Emails, Finance Emails et Management Emails. Vides quand aucune adresse n’est saisie.
`Remarks`	Remarks.
`TIN`, `RegN`	TIN et Registration, ou `null`.
`SCAC`	Shipping Line (SCAC), pour les transporteurs, ou `null`.
`Account`	Default Account, ou `null`.
`CurrCode`	Base Currency, ou `null`.
`RespOffice`, `OfficeName`	Responsible Company : son identifiant et son nom.
`PCID`, `PCName`	Default Profit Center : son identifiant et son nom, ou `null`.
`RespUser`, `RespUserName`	Responsible : l’identifiant utilisateur et le nom de l’utilisateur, ou `null`.
`GroupID`, `GroupName`	Customer Group, pour les clients : son identifiant et son nom, ou `null`.
`Notify`	`true` quand Status Updates est activé.
`TrackLink`	`true` quand Send Link est activé.
`EnableAPI`	`true` quand Enable API Access est activé : l’entité a une clé d’API de l’entité.
`HasLogo`	`true` quand l’entité a un logo.
`CreatedBy`, `CreatedOn`	L’identifiant utilisateur de l’utilisateur qui a créé l’entité, et quand.
`Changed`, `ChangedBy`	Quand les détails de l’entité ont été enregistrés pour la dernière fois, et l’identifiant utilisateur de l’utilisateur qui les a enregistrés.
`ApprovedOn`, `ApprovedBy`	Quand l’entité a été approuvée, et l’identifiant utilisateur de l’utilisateur qui l’a approuvée, ou `null`.
`LastEmail`	Quand TrakIT a envoyé pour la dernière fois au client un e-mail de mise à jour de statut, ou `null`.
`InvRemFreq`	La fréquence d’envoi des rappels de paiement, en jours : `1`, `2`, `3`, `7`, `15` ou `30`, ou `0` pour aucun.
`LastInvRem`	Quand le dernier rappel de paiement a été envoyé, ou `null`.
`Data`	Les champs de données de l’entité qui ont été enregistrés, dans l’ordre des champs. Une liste vide s’il n’y en a aucun.

Chaque élément de Data :

Champ	Signification
`FieldName`	Le nom du champ de données.
`Value`	La valeur, sous forme de texte.
`Remarks`	Les remarques, ou une chaîne vide.
`Updated`	Quand la valeur a été enregistrée pour la dernière fois.
`UpdatedBy`	L’identifiant utilisateur de l’utilisateur qui l’a enregistrée, ou `null` pour un champ calculé.