Creación de una compañía
En esta sección se detallan pasos y conceptos a tener en cuenta al momento de crear una compañía en la API de Alanube.
Tipos de compañías
Antes de iniciar, es importante tener en cuenta que existen dos tipos de compañías en la API:
- Principal (main)
- Asociada (associated)
Cuando se genera un usuario en la API, y junto a este su correspondiente token de acceso, dicho usuario puede crear cualquiera de estos dos tipos de compañías.
Por un lado, podemos crear la compañía de tipo principal, que puede ser o no emisora electrónica en la API. La única restricción existente es que un usuario no puede tener más de una compañía principal.
Por el otro, podemos crear compañías asociadas (el término viene de que podemos verlas como compañías asociadas a la principal) y para este caso no hay límite de creación, es decir, un usuario puede tener muchas compañías de tipo asociada.
Esto es útil cuando por un lado, como compañía principal somos consumidores de la API, es decir, emitimos a través de Alanube, pero a su vez, somos revendedores del servicio y queremos emitir a nombre de las distintas compañías de nuestros clientes.
¿Cómo le indico a la API con qué compañía quiero emitir o hacer consultas?
Para esto los distintos endpoints aceptan un parámetro opcional que es el idCompany.
Cuando el parámetro idCompany no está presente, la API interpreta que se tiene la intención de emitir a nombre de la compañía principal, la cual al ser una sola por usuario, podemos identificarla por el token del mismo, de ahí a que se dice que este tipo de compañía es la asociada al token.
Cuando el parámetro idCompany está presente, la API interpreta que se tiene la intención de emitir a nombre de una de las tantas compañías asociadas, identificada precisamente con el parámetro idCompany.
¿Cómo obtengo el parámetro idCompany?
El parámetro idCompany es retornado por la API al momento de que un usuario crea una nueva compañía mediante el endpoint correspondiente. Es importante almacenar este id de compañía ya que es lo que identifica dicha compañía recién creada en la API.
Cuando generamos el token, se asocia a éste la compañía "Principal" que puede ser o no una de las empresas emisoras de documentos. Es por esto, que tenemos disponibles una serie de servicios, donde podrá gestionar aquellas compañías de tipo "Asociada", las cuales serán aquellas empresas emisoras de documentos electrónicos asociadas a su token.
Pasos para la creación de una compañía
Habiendo explicado esta diferencia entre compañías, se procederá a explicar cómo crear una compañía de tipo principal.
Aclaración
El proceso para crear compañías de tipo asociada, es idéntico al explicado a continuación, con la salvedad de que la propiedad
type
tendrá el valorassociated
.No es necesario crear una compañía de tipo principal para crear compañías asociadas.
1. Crear la compañía
Como requisito para este paso, debemos contar con un token de autenticación. Si todavía no tienes uno, puedes averiguar acá cómo pedir uno para nuestro ambiente de pruebas.
Se deben indicar los datos de una compañía previamente registrada en la entidad fiscal (p.e. DGII), si por el momento no tiene estos datos puede hacer uso de los datos que componen los ejemplos.
La creación de la compañía se realiza por medio del servicio de creación de compañía.
A continuación, se muestra a modo de ejemplo como quedaría un request para el uso del servicio:
{
"name": "Mi compañía S.A.S.",
"tradeName": "Mi compañía S.A.S.",
"identification": "123456789",
"address": "Calle 123",
"province": "Mi provincia",
"municipality": "Mi municipio",
"type": "main",
"email": "[email protected]",
"certificate": {
"name": "some_certificate",
"extension": "p12",
"content": "«contenido del certificado codificado en base64»",
"password": "some_password_1234"
},
"webhooks": {
// ...configuración de/los webhook/s
},
// ...resto de propiedades que pudieran haber
}
2. Habilitar la compañía en la DGII y en la API
Consiste, entre otros pasos, en enviar un conjunto de documentos de prueba (set de pruebas) requeridos por la entidad por medio del servicio de generación de set de pruebas.
Es importante, a la hora de crear el set de pruebas, indicar:
- El parámetro idCompany, si es que queremos certificar una compañía distinta a la principal.
- El parámetro retryNumber, con el cual generamos de manera sencilla los números de secuencia de los comprobantes que conforman el set de pruebas. Por ejemplo, para
"retryNumber": 1
, el número de secuencia será E310000000001. - Datos correspondientes a un ítem de ejemplo que sea representativo del negocio.
A continuación, se muestra a modo de ejemplo como quedaría un request para el uso del servicio:
{
"idCompany": "01FVD6QRP3HB40GZVW5SQGV29V",
"retryNumber": 1,
"itemExample": {
"billingIndicator": 1,
"itemName": "Caja de madera",
"goodServiceIndicator": 1,
"itemDescription": "Una simple cada de madera. Esta descripción es opcional.",
"unitPriceItem": 2500
}
}
Sobre el proceso de certificación
Para conocer más acerca del proceso de certificación, te invitamos a leer el artículo principal sobre el mismo.
Updated almost 2 years ago