La API de Compañías contiene todos los endpoints necesarios para administrar las bases de compañías. Podrás usarla para crear, actualizar o incluso buscar compañías bajo determinados parámetros.
El endpoint /companies/v1/
te permite crear una nueva compañía en nuestra base de datos.
Para el campo operation_country
esperamos un código de 3 caracteres respetando el estándar ISO 3166 alpha-3.
Dejamos una lista de ejemplos:
Brasil: El tipo de documento fiscal aceptado es el CNPJ. El tipo de empresa aceptada es MEI, EI, SLU, EIRELI, SS, LTDA y SA.
Argentina:
El tipo de documento fiscal aceptado es el CUIT.
Campos requeridos: legal_address
, email
, tradeName
, legalName
, phone
, type
, tax_condition
El endpoint /companies/v1/
te permite buscar un grupo de compañías y recibir una lista ordenada en base a los parámetros especificados.
Podrás especificar tus filtros como parámetros siguiendo este patrón: filter[campo]=valor
. Por ejemplo: /companies/v1/?filter[status]=ACTIVE
Para filtrar un atributo con varios valores posibles, deberás separar los valores con comas.
Por ejemplo: filter[status]=ACTIVE,BLOCKED
Los resultados serán paginados y podrás especificar la cantidad de datos por página y también qué página ver utilizando: page[number]=valor
y page[size]=valor
Podrás especificar el orden de los resultados con determinados parámetros que deberás enviar como una lista de strings en el filtro de tipo sort. Por ejemplo: ?filter[status]=ACTIVE&sort=status
El ordenamiento por defecto será ascendente. Para especificar un orden descendente, deberás enviar el carácter '-' como prefijo del atributo. Por ejemplo: /companies/v1/?filter[status]=ACTIVE&sort=status,-tax_identification_type
Los posibles atributos para ordenar son:
id
legal_name
trade_name
tax_identification_type
tax_identification_value
status
El endpoint /companies/v1/{id}
te permite consultar la información de una compañía a través de su id.
El endpoint /companies/v1/{id}
permite actualizar la información de una compañía a través de su id.
Sólo es posible actualizar una compañía si esta no fue validada.
Para bloquear una compañía deberás enviar el status
con el valor BLOCKED
y el valor CLIENT_INTERNAL_REASON
en el campo status_reason
.
Para reactivar una compañía que bloqueaste, deberás enviar status
con valor ACTIVE
.