Ir al contenido

GetEntity

Devuelve una entidad, como un cliente, un cargador, un transportista o un transportista por carretera, con sus detalles y sus campos de datos de entidad. Utilícelo para copiar una entidad en su propio sistema, por ejemplo cada entidad que GetEntitiesUpdated lista como modificada.

Cómo iniciar sesión y leer la respuesta: Autenticación, Respuestas.

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

O, por código:

GET /api/v1/GetEntity?Code=EXSHIP
Token: your-token
Parámetro Obligatorio Significado
ID Uno de los dos El identificador de la entidad, un número entero.
Code Uno de los dos El código de la entidad (Entity Code), por ejemplo EXSHIP. Las mayúsculas no importan.

Si envía los dos, TrakIT usa ID.

Regla Info si no se cumple
El encabezado Token contiene un token válido. Token missing in header, Token invalid or expired, u otra respuesta indicada en Token de inicio de sesión
El usuario es un administrador del sistema con acceso a la API. API User must be SysAdmin with API Access
ID, si se indica, es un número. ID must be numeric
Existe una entidad con ese identificador o ese código. No such entity

Si tiene éxito, RetInfo es la entidad y RowsAffected es 1. Las horas están en UTC, sin zona horaria (consulte Fechas y horas).

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

Las etiquetas en negrita son las de los campos de la entidad.

Campo Significado
EntID El identificador de la entidad.
EntCode, EntName Entity Code y Entity Name.
EntType El tipo principal de la entidad, como número: 0 transportista, 1 cliente, 2 transportista por carretera, 3 agente de fianzas, 4 agente de aduanas, 5 banco, 6 autoridad, 7 otro, 8 cargador, 9 receptor. El soporte de TrakIT da nombre a los tipos de su instalación, por lo que los nombres pueden ser distintos: consulte Tipos de entidad.
MultiTypes Los otros tipos de la entidad, como números separados por comas, o null.
TypeList No se usa: siempre null.
IsCarrier true cuando la entidad es un transportista, como tipo principal o como otro tipo.
Active false cuando la entidad está desactivada (Disable).
LocalName Local Name, o null.
CountryCode, CountryName Country: su código ISO de 2 letras y su nombre.
Address Postal Address.
Contact Contact Person(s).
Phone Phone Numbers.
WANum WhatsApp Numbers.
Email, FinEmail, MgmtEmail General Emails, Finance Emails y Management Emails. Vacíos cuando no se ha introducido ninguno.
Remarks Remarks.
TIN, RegN TIN y Registration, o null.
SCAC Shipping Line (SCAC), para los transportistas, o null.
Account Default Account, o null.
CurrCode Base Currency, o null.
RespOffice, OfficeName Responsible Company: su identificador y su nombre.
PCID, PCName Default Profit Center: su identificador y su nombre, o null.
RespUser, RespUserName Responsible: el identificador de usuario y el nombre del usuario, o null.
GroupID, GroupName Customer Group, para los clientes: su identificador y su nombre, o null.
Notify true cuando Status Updates está activado.
TrackLink true cuando Send Link está activado.
EnableAPI true cuando Enable API Access está activado: la entidad tiene una clave de API de la entidad.
HasLogo true cuando la entidad tiene un logotipo.
CreatedBy, CreatedOn El identificador de usuario de quien creó la entidad, y cuándo.
Changed, ChangedBy Cuándo se guardaron por última vez los detalles de la entidad, y el identificador de usuario de quien los guardó.
ApprovedOn, ApprovedBy Cuándo se aprobó la entidad, y el identificador de usuario de quien la aprobó, o null.
LastEmail Cuándo envió TrakIT por última vez al cliente un correo electrónico de actualización de estado, o null.
InvRemFreq Con qué frecuencia se envían los recordatorios de pago, en días: 1, 2, 3, 7, 15 o 30, o 0 si no se envían.
LastInvRem Cuándo se envió el último recordatorio de pago, o null.
Data Los campos de datos de la entidad que se han guardado, en el orden de los campos. Una lista vacía si no hay ninguno.

Cada elemento de Data:

Campo Significado
FieldName El nombre del campo de datos.
Value El valor, como texto.
Remarks Las observaciones, o una cadena vacía.
Updated Cuándo se guardó el valor por última vez.
UpdatedBy El identificador de usuario de quien lo guardó, o null para un campo calculado.