API Reference

Casos de Uso

Esta es la sección de documentación dedicada a aclarar los casos de uso relacionados con la API de Establecimientos. Aquí encontrarás ejemplos de uso y notas sobre el uso de la API.

Creación de Establecimiento

La creación de establecimiento solo puede ser utilizada por establecimientos creados como whitelabel en nuestra plataforma. Por lo tanto, los establecimientos creados como tienda no pueden disfrutar de esta funcionalidad, ya que la idea de este punto final es permitir la creación de tiendas para empresas que tienen otras debajo de ellas, como franquicias, matrices y otras.

Además, considera establecimientos como cualquier compañía/empresa/persona usuaria de la plataforma, ya sea persona física o persona jurídica. De esta manera, en el punto final de creación de establecimiento es posible crear tanto establecimientos en nombre de personas físicas como jurídicas.

Creación de Establecimiento - Persona Física

Para la creación de establecimientos a nombre de una persona física, es necesario hacer algunas consideraciones y ajustes en el envío de la solicitud a la API:

  • Considere que el parámetro commercialName sea el nombre de marca de la persona física;
  • Considere que el parámetro socialReason sea el nombre completo de la persona física;
  • Considere que el parámetro documentNumber sea el número del Registro de Identificación Fiscal (CPF) de la persona física;
  • Considere que el parámetro cnaeId sea el ID identificador del CNAE 7490-1/99, reservado para personas físicas en nuestra plataforma. Puedes obtener más información sobre el endpoint de listado de CNAE haciendo clic aquí.
  • Considere que el parámetro foundationDate sea la fecha de nacimiento de la persona física.
  • Considere que el parámetro companyFormationCode sea igual a 06 - Empresa Individual de Responsabilidad Limitada para personas físicas.
  • Considere que el parámetro representative contenga los datos de la propia persona física.
  • Considera que el parámetro address sea la dirección de la persona física.

Además, la cuenta bancaria debe estar vinculada al número de documento de la persona física y a los datos de registro, y es donde se realizarán las liquidaciones de pago creadas en la plataforma.

Creación de Establecimiento - Persona Jurídica

La creación de un establecimiento a nombre de una persona jurídica es intuitiva y se realiza conforme a los parámetros necesarios en el punto final de creación de establecimiento. Sin embargo, es necesario que los datos enviados estén en concordancia con el registro CNPJ de la empresa, ya que los registros de establecimientos con información inconsistente, como el tipo de composición de la empresa, las direcciones registradas, los representantes, entre otros, pueden ser rechazados.

Por otro lado, al igual que en el caso de una persona física, la cuenta bancaria debe estar vinculada al CNPJ del establecimiento, ya que los pagos no se realizarán en cuentas bancarias que no estén vinculadas al CNPJ.