API Reference 2.0
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
Dejamos una lista de ejemplos:
- ARG
- BRA
- CHL
- COL
- MEX
- PER
| Tipo de Empresa | Descripción | País |
|---|---|---|
| COOP | Sociedad Cooperativa. | Brasil |
| ME | Microempresa. | Brasil |
| MEI | Microempreendedor Individual. | Brasil |
| EI | Empresario Individual. | Brasil |
| SCP | Sociedad en cuenta de Participación. | Brasil |
| SLU | Sociedad Limitada Unipersonal. | Brasil |
| EIRELI | Empresa Individual de Responsabilidad Limitada. | Brasil |
| SS | Sociedad Simplificada. | Brasil |
| LTDA | Sociedad de Responsabilidad Limitada. | Brasil |
| SA | Sociedad Anónima. | Argentina |
| SRL | Empresa con responsabilidad limitada. | Argentina |
| SAS | Sociedad por Acciones Simplificada. | Argentina |
| SELF_COMPANY | Empresa unipersonal. | Argentina |
| RI | Responsable Inscripto. | Argentina |
| SELF_EMPLOYED | Monotribustista. | Argentina |
| SH | Sociedad en Comandita Simple. | Argentina |
| CAP_I_SECC_IV | Sociedad de Capital e Industria Sección IV. | Argentina |
| SIMPLE_SOC | Sociedad Simple. | Argentina |
| SAU | Sociedad Anónima Unipersonal. | Argentina |
| SGR | Sociedad de Garantía Recíproca. | Argentina |
| ESCROW | Fideicomiso. | Argentina |
| CONSORTIUM | Consorcio. | Argentina |
| COOPERATIVE | Cooperativa. | Argentina |
| CIVIL_SOCIETY | Sociedad Civil. | Argentina |
| CIVIL_ASSOCIATION | Asociación Civil. | Argentina |
| SACIFIA | Sociedad Anónima con Participación Estatal Mayoritaria. | Argentina |
Consideraciones sobre los documentos fiscales a utilizar
Brasil: El tipo de documento fiscal aceptado es el CNPJ.
Argentina: El tipo de documento fiscal aceptado es el CUIT. Campos requeridos: legal_address, email, tradeName, legalName, phone, type, tax_condition
¿Te resultó útil esta sección?
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:
idlegal_nametrade_nametax_identification_typetax_identification_valuestatus
¿Te resultó útil esta sección?
Obtener Compañía
El endpoint /companies/v1/{id} te permite consultar la información de una compañía a través de su id.
¿Te resultó útil esta sección?
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.