API Endpoints

Endpoint para dar de alta a una empresa

post
https://sandbox-api.alanube.co/cri/v1/companies

Endpoint que permite dar de alta a empresas en la API con las configuraciones necesarias para enviar documentos a Hacienda

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Objeto JSON con la información de la empresa

string
required
length between 1 and 100

Nombre de la empresa o Razón social

string
enum
required

Tipo de identificación de la empresa. Corresponde al tipo de cédula emitida por Hacienda. Codificación:

  • 01 - Cédula física
  • 02 - Cédula jurídica
  • 03 - DIMEX
  • 04 - NITE
Allowed:
string
required
length between 9 and 12
^[A-Za-z0-9]+$

Número de identificación emitido por Hacienda. Para los tipos 01-04 acepta letras y números, mantiene la longitud por tipo y no permite ceros a la izquierda.

string
length between 1 and 80

Nombre comercial, en el caso que se cuente con nombre comercial debe indicarse

phone
object

Objeto que contiene información sobre número de fax que se desee suministrar a Hacienda.
Nota: En documentos versión 4.3, este campo será validado e incluido en el XML; en la versión 4.4, la API lo recibirá pero no aplicará validaciones ni incluirá el dato en el XML de los comprobantes

fax
object

Objeto que contiene información sobre número de fax que se desee suministrar a Hacienda.
Nota: En documentos versión 4.3, este campo será validado e incluido en el XML; en la versión 4.4, la API lo recibirá pero no aplicará validaciones ni incluirá el dato en el XML de los comprobantes

address
object
required

Objeto que contiene información sobre la ubicación de una empresa/receptor. La codificación a utilizar para cada uno de los atributos corresponde a la tabla suministrada por Hacienda, la cual se puede consultar en su correspondiente endpoint.

economicActivities
array of strings
length ≥ 1

Este array contiene las actividades económicas que la empresa tiene asociadas en Hacienda

economicActivities
string
length between 1 and 12
^[a-zA-Z0-9]{0,12}$

Número de Registro Fiscal de bebidas alcohólicas Ley 8707. Se convierte en carácter obligatorio cuando se estén facturando códigos CAByS de bebidas alcohólicas según la Ley 8707. Contiene los datos del número de registro de bebidas alcohólicas, suministrado por la Dirección General de Aduanas.

string
enum
required

Tipo de empresa. Solo se permiten dos valores posibles. Un usuario solo puede tener una empresa de tipo main, pero varias de tipo associated

Allowed:
emails
array of strings
length between 1 and 4

Elemento que contiene la dirección de correo electrónico del emisor. Se permite incluir hasta un máximo de 4 direcciones.

emails
certificate
object
required

Objeto que contiene información sobre el certificado a ser usado para la firma de documentos electrónicos emitidos

notificationByEmail
object
token
object
required

Objeto que contiene las credenciales que se generan desde el sistema ATV del Ministerio de Hacienda

webhooks
object

Objeto que contiene la información de los webhooks configurados para la empresa

string
length between 1 and 204800
^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

Logo de la empresa para usar en PDFs. Debe enviarse como base64 puro (sin prefijo data:). El tamaño máximo es 150 KB y los formatos permitidos son JPEG, PNG y WebP.

pdfConfig
object
deprecated

DEPRECATED: Este objeto se mantiene solo para retrocompatibilidad. Use la propiedad 'logo' al nivel raíz de company. Las demás propiedades de pdfConfig ya no se utilizan.

Responses

Updated about 2 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago