Empresas

Listar Empresas

GET /v2/enterprises/

Parámetro	Descripción
attributes	Especifica qué atributos buscar. Puede incluir valores como 'serial', 'number', 'carrier', 'service_provider' y 'batch'. Si es nulo, busca toda la información.
includes	Especifica entidades relacionadas a incluir en la consulta. Contiene arrays para 'dispositivo' y 'empresa' con valores como 'name', 'imei', 'code', 'cnpj'.
filters	Especifica filtros para varios campos como 'chips.serial', 'chips.number', 'chips.carrier', 'chips.service_provider', 'chips.batch', 'device.name', 'device.imei', 'device.code', 'enterprise.name', 'enterprise.cnpj'. Cada campo de filtro admite condiciones como 'eq', 'neq', 'ilk', 'ew', 'sw'.
search	Especifica la consulta de búsqueda como mucho 100 caracteres.
limit	Especifica el número máximo de resultados a retornar. Debe ser un número entre 1 y 100.
page	Especifica el número de página para resultados paginados. Debe ser un número mayor o igual a 0.
count	Indica si incluir el total de resultados en la respuesta.
sort	Especifica criterios de clasificación para los campos 'number' y 'serial'. Los valores pueden ser -1 (orden descendente) o 1 (orden ascendente).

Respostas

Status	Significado	Descrição
200	OK	Respuesta estándar
400	Bad Request	Solicitud Inválida

Esta operación no requiere autenticación

Crear Empresas

POST /v2/enterprises/

Datos de Envío

{
  "body": {
    "data": {
      "attributes": {
        "name": "Empresa de Ejemplo",
        "cnpj": "12345678901234",
        "timezone": "America/New_York",
        "phone1": "(123) 456-7890",
        "phone2":"(123) 123-4567",
        "email": "info@empresa.com",
        "contact_name": "Juan Pérez",
        "webpage": "http://empresa.com",
        "assistance_emergency_tel": "911",
        "theft_emergency_tel": "911",
        "fantasy_name": "Ejemplo"
      },
      "relationships": {
        "country": {
          "type": "país",
          "id": "abc1234567890def"
        }
      }
    }
  }
}

Campo	Descripción	Obrigatório
data	Objeto que contiene atributos y relaciones de datos.	sí
attributes	Objeto que contiene atributos de la empresa.	sí
- name	String con el nombre de la empresa, longitud máxima de 250 caracteres.	sí
- cnpj	String con el CNPJ de la empresa, longitud máxima de 25 caracteres.	sí
- timezone	String con la zona horaria de la empresa, debe ser una String de zona horaria válida de la lista de zonas horarias conocidas, o nula.	sí
- phone1	String con el número de teléfono principal de la empresa, longitud máxima de 100 caracteres, o nula.	no
- phone2	String con el número de teléfono secundario de la empresa, longitud máxima de 100 caracteres, o nula.	no
- email	String con la dirección de correo electrónico de la empresa, longitud máxima de 100 caracteres, o nula.	no
- contact_name	String con el nombre de contacto de la empresa, longitud máxima de 100 caracteres, o nula.	no
- webpage	String con la URL de la página web de la empresa, longitud máxima de 255 caracteres, o nula.	no
- assistance_emergency_tel	String con el número de teléfono de emergencia para asistencia de la empresa, longitud máxima de 100 caracteres, o nula.	no
- theft_emergency_tel	String con el número de teléfono de emergencia para robo de la empresa, longitud máxima de 100 caracteres, o nula.	no
- fantasy_name	String con el nombre fantasia de la empresa, longitud máxima de 100 caracteres, o nula.	no
relationships	Objeto que contiene información de relación.	sí
- country	Objeto que representa la relación con un país.	no
-- type	String con el tipo de relación, debe ser 'country'.	sí
-- id	String con el ID del país, debe consistir en 15 caracteres alfanuméricos.	sí

Nombre	In	Tipo	Requerido	Descripción
id	path	string	sí	ninguna

Respuestas

Status	Significado	Descripción
200	OK	Respuesta estándar
400	Bad Request	Una de 'Bad Request' o 'Failed to Create Enterprise'

Esta operación no requiere autenticación

Mostrar Empresas

GET /v2/enterprises/{id}

Parámetro	Descripción	Obrigatório
attributes	Un array opcional de Strings que especifica los atributos a recuperar. Los atributos válidos incluyen 'name', 'phone1', 'phone2', 'email', 'contact_name', 'created_at', 'updated_at', 'deactivated_at', 'cnpj', 'webpage', 'timezone', 'assistance_emergency_tel', 'theft_emergency_tel', 'fantasy_name'. Si es nulo, se recuperan todas las información.	No
includes	Un objeto opcional que especifica las entidades relacionadas a incluir en la consulta. Contiene arrays para 'addresses' y 'document'. Cada array puede incluir valores como 'formatted_address', 'city', 'region', 'zip_code', 'file_size', 'created_at', 'folder', 'key_name', 'mime', 'name'.	No
- addresses	Un array de atributos de dirección para incluir en la respuesta. Los atributos válidos incluyen 'formatted_address', 'city', 'region', 'zip_code'.	No
- document	Un array de atributos de documento para incluir en la respuesta. Los atributos válidos incluyen 'file_size', 'created_at', 'folder', 'key_name', 'mime', 'name'.	No

Respuestas

Status	Significado	Descripción
200	OK	Respuesta estándar
400	Bad Request	Solicitud inválida
401	Unauthorized	No autorizado
404	Not Found	No encontrado

Esta operación no requiere autenticación

Actualizar Empresas

PATCH /v2/enterprises/{id}

Carga útil

{
  "body": {
    "data": {
      "attributes": {
        "name": "Example Company",
        "cnpj": "12345678901234",
        "timezone": "America/New_York",
        "phone1": "(123) 456-7890",
        "phone2":"(123) 123-4567",
        "email": "info@example.com",
        "contact_name": "John Doe",
        "webpage": "http://example.com",
        "assistance_emergency_tel": "911",
        "theft_emergency_tel": "911",
        "fantasy_name": "Example"
      },
      "relationships": {
        "country": {
          "type": "country",
          "id": "abc1234567890def"
        }
      }
    }
  }
}

Campo	Descripción	Obligatorio
data	Objeto que contiene atributos y relaciones de datos.	sí
attributes	Objeto que contiene atributos de la empresa.	sí
- name	String con el nombre de la empresa, longitud máxima de 250 caracteres.	sí
- cnpj	String con el CNPJ de la empresa, longitud máxima de 25 caracteres.	sí
- timezone	String con la zona horaria de la empresa, debe ser una String de zona horaria válida de la lista de zonas horarias conocidas, o nula.	sí
- phone1	String con el número de teléfono principal de la empresa, longitud máxima de 100 caracteres, o nula.	no
- phone2	String con el número de teléfono secundario de la empresa, longitud máxima de 100 caracteres, o nula.	no
- email	String con la dirección de correo electrónico de la empresa, longitud máxima de 100 caracteres, o nula.	no
- contact_name	String con el nombre de contacto de la empresa, longitud máxima de 100 caracteres, o nula.	no
- webpage	String con la URL de la página de la empresa, longitud máxima de 255 caracteres, o nula.	no
- assistance_emergency_tel	String con el número de teléfono de emergencia para asistencia de la empresa, longitud máxima de 100 caracteres, o nula.	no
- theft_emergency_tel	String con el número de teléfono de emergencia para robo de la empresa, longitud máxima de 100 caracteres, o nula.	no
- fantasy_name	String con el nombre fantasia de la empresa, longitud máxima de 100 caracteres, o nula.	no
relationships	Objeto que contiene información de relación.	sí
- country	Objeto que representa la relación con un país.	no
-- type	String con el tipo de relación, debe ser 'country'.	sí
-- id	String con el ID del país, debe consistir en 15 caracteres alfanuméricos.	sí

Respuestas

Estado	Significado	Descripción
200	OK	Respuesta estándar
400	Solicitud Incorrecta	Solicitud Incorrecta
401	unauthorized	No Autorizado
404	No Encontrado	No Encontrado

Esta operación no requiere autenticación

Eliminar Empresas

DELETE /v2/enterprises/{id}

Parámetros

{
  "params": {
    "id": "ABC1234567890DEF"
  }
}

Campo	Descripción	Obligatorio
id	String que especifica el ID. Debe ser alfanumérico y exactamente 15 caracteres de longitud.	sí

Respuestas

Estado	Significado	Descripción
200	OK	Respuesta estándar
400	Solicitud Incorrecta	Uno de 'Bad Request', 'Cannot Delete Self Enterprise', 'Cannot Delete a Main Client Enterprise', 'Cannot Delete Enterprise With Other Affiliations', 'Invalid Affiliation', 'Enterprise Not Affiliated' o 'Cannot Delete Enterprise With Devices, Chips, Vehicles or Users'
401	unauthorized	No Autorizado
404	No Encontrado	No Encontrado

Esta operación no requiere autenticación

Actualizar {situation} Empresas

PATCH /v2/enterprises/{id}/status/{situation}

Parámetros

{
  "params": {
    "id": "ABC1234567890DEF",
    "situation": "activación"
  }
}

Campo	Descripción	Obligatorio
id	String que contiene el ID, debe seguir el patrón alfanumérico y tener una longitud de 15 caracteres.	sí
situation	String que indica la situación, debe ser 'activación' o 'deactivación'.	sí

Respuestas

Estado	Significado	Descripción
200	OK	Respuesta estándar

Esta operación no requiere autenticación

Usuarios Associations Devices