Compañías

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.

Crear Compañía

El endpoint /companies/v1/ te permite crear una nueva compañía en nuestra base de datos.

Consideraciones generales

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:

  • ARG
  • BRA
  • CHL
  • COL
  • MEX
  • PER

Consideraciones sobre los documentos fiscales a utilizar

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

Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
x-idempotency-keystringrequired
ID único en cada request para utilizar nuestro esquema de idempotencia.
Ejemplo: fRwX12Dg3345AD
Body Parameters
legal_namestring
Pattern: ^[A-Za-z\u00C0-\u00ff0-9 -.,]+$
Ejemplo: Pomelo SAS
trade_namestring
Pattern: ^[A-Za-z\u00C0-\u00ff0-9 -.,]+$
Ejemplo: Pomelo
tax_identification_typestringrequired
Enum: CNPJCUIT
tax_identification_valuestringrequired
Pattern: ^[A-Za-zÀ-ÿ0-9 -/.,]+$
Ejemplo: 43.856.175/0001-08
emailstring
Pattern: [^@ \t\r\n][email protected][^@ \t\r\n]+\.[^@ \t\r\n]+
Ejemplo: [email protected]
phonestring
Pattern: ^[0-9]+$
Ejemplo: 1123456789
operation_countrystringrequired
ISO 3166 alpha-3
Pattern: ^[A-Za-zÀ-ÿ ]+$
Ejemplo: ARG
typestring
Enum: MEIMEIEISLUEIRELISSLTDASASSA;
legal_addressobject
tax_condition
Enum: VAT_REGISTEREDOTHERS
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

POST/companies/v1/
{
"legal_name":
"Pomelo SAS"
"trade_name":
"Pomelo"
"tax_identification_type":
"CNPJ"
"tax_identification_value":
"43.856.175/0001-08"
"email":
"phone":
"1123456789"
"operation_country":
"ARG"
"type":
"MEI"
"legal_address":{
"street_name":
"Av. Corrientes"
"street_number":
300
"floor":
1
"apartment":
"A"
"zip_code":
1414
"neighborhood":
"Villa Crespo"
"city":
"CABA"
"region":
"Buenos Aires"
"additional_info":
"Torre 2"
"country":
"ARG"
}
"tax_condition":
"VAT_REGISTERED"
}
Ejemplo de respuestas
{
"data":{
"id":
"cmp-2E5eUyw1ZolEj1Y3NHxnob7bFZe"
"legal_name":
"Pomelo SAS"
"trade_name":
"Pomelo"
"tax_identification_type":
"CNPJ"
"tax_identification_value":
"43.856.175/0001-08"
"email":
"phone":
"1123456789"
"operation_country":
"ARG"
"type":
"MEI"
"status":
"ACTIVE"
"legal_address":{
...
}
}
}

Buscar Compañías

El endpoint /companies/v1/ te permite buscar un grupo de compañías y recibir una lista ordenada en base a los parámetros especificados.

Consideraciones

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

Ordenamiento

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
Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Query Parameters
filter[tax_identification_type]string
Enum: CUILCPFRFCNITRUC
filter[tax_identification_value]string
filter[legal_name]string
Ejemplo: Pomelo SAS
filter[trade_name]string
Ejemplo: Pomelo
filter[email]string
Ejemplo: [email protected]
filter[status]string
Ejemplo: ACTIVE
filter[country_code]string
ISO 3166-1 alpha-3
Ejemplo: ARG
filter[type]string
Enum: MEI
page[size]number
Tamaño de página.
page[number]number
Número de página. El número de la primer página es 0.
sortstring
Ejemplo: id,-legal_name
Detalle de respuestas
dataarray
metaobject

¿Te resultó útil esta sección?

GET/companies/v1/
Ejemplo de respuestas
{
"data":[
0:{
...
}
]
"meta":{
"pagination":{
...
}
"filter":[
...
]
}
}

Obtener Compañía

El endpoint /companies/v1/{id} te permite consultar la información de una compañía a través de su id.

Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Path Parameters
idstringrequired
Id de la compañía
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

GET/companies/v1/{id}
Ejemplo de respuestas
{
"data":{
"id":
"cmp-2E5eUyw1ZolEj1Y3NHxnob7bFZe"
"legal_name":
"Pomelo SAS"
"trade_name":
"Pomelo"
"tax_identification_type":
"CNPJ"
"tax_identification_value":
"43.856.175/0001-08"
"email":
"phone":
"1123456789"
"operation_country":
"ARG"
"type":
"MEI"
"status":
"ACTIVE"
"legal_address":{
...
}
}
}

Modificar Compañía

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.

Consideraciones

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.

Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Body Parameters
emailstring
Pattern: [^@ \t\r\n][email protected][^@ \t\r\n]+\.[^@ \t\r\n]+
Ejemplo: [email protected]
phonestring
Pattern: ^[0-9]+$
Ejemplo: 1123456789
statusstring
Enum: ACTIVEBLOCKED
status_reasonstring
Enum: CLIENT_INTERNAL_REASON
Path Parameters
idstringrequired
Id de la compañía
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

PATCH/companies/v1/{id}
{
"email":
"phone":
"1123456789"
"status":
"ACTIVE"
"status_reason":
"CLIENT_INTERNAL_REASON"
}
Ejemplo de respuestas
{
"data":{
"id":
"cmp-2E5eUyw1ZolEj1Y3NHxnob7bFZe"
"legal_name":
"Pomelo SAS"
"trade_name":
"Pomelo"
"tax_identification_type":
"CNPJ"
"tax_identification_value":
"43.856.175/0001-08"
"email":
"phone":
"1123456789"
"operation_country":
"ARG"
"type":
"MEI"
"status":
"ACTIVE"
"legal_address":{
...
}
}
}