Información general

Esta página te ayudará a comenzar con el API de Alegra

El API de Alegra es un servicio que te permite acceder a tu cuenta para mantener tu información actualizada, conectar aplicaciones externas y tener acceso instantáneo a tus datos.

Algunas aplicaciones que puedes construir con nuestra API son:

  • Sincronizar de manera automática tus contactos con Alegra y otra aplicación externa que utilices.
  • Crear automáticamente facturas en la aplicación a partir de pedidos de tu página web.
  • Sincronizar tus productos o servicios con Alegra.

Actualmente nuestra API puedes

Recurso

Endpoint

Descripción

Productos o servicios

/items

Consultar uno o todos los productos/servicios registrados en la aplicación. También puedes crear un producto nuevo.

Contactos

/contacts

Consultar uno o todos los contactos (clientes/proveedores) registrados. También puedes crear un contacto nuevo.

Facturas de venta

/invoices

Consultar una o todas las facturas de venta, crear una nueva o enviar una factura por correo.

Numeración de factura

/number-templates

Permite consultar las numeraciones para facturación que tiene configurada la empresa.

Impuestos

/taxes

Permite consultar los impuestos de la compañía.

Cuentas de banco

/bank-accounts

Permite consultar las cuentas de banco que tiene registrada la compañía en la aplicación.

Empresa

/company

Indica la información de la empresa como el nombre, dirección, régimen, entre otros.

Pagos

/payments

Permite consultar los pagos que se tienen registrados en la aplicación. También se puede realizar pagos a facturas de venta, facturas de compra o categorías

Categorías

/categories

Permite consultar las categorías configuradas en la aplicación.

Ajustes de categorías

/journals

Permite consultar uno o todos los ajustes de categorías registrados en la aplicación, crear uno nuevo, editarlos y eliminarlos.

Monedas

/currencies

Permite consultar una o todas las monedas asociadas a una cuenta.

Nuestra API está basada en principios REST que harán más fácil tu conexión y desarrollo; métodos HTTP (GET y POST) son utilizados para acceder a los recursos. El sistema procesa el request y retorna un código de respuesta en un formato de fácil compresión.

Ejemplos

{
                "id": 1,
                "name": "Billetera",
                "description": "Billetera de cuero negro",
                "reference": "REF-005",
                "inventory": {
                        "unit" : "piece",
                        "availableQuantity" : 150,
                        "unitCost" : 560,
                        "initialQuantity" : 320
                        },
                "tax" : [
                            {
                                "id" : 6,
                                "name" : "IVA",
                                "percentage" : 16,
                                "description" : "Impuesto de valor agregado"
                            }
                        ],
                "category" : {
                        "id": 54,
                        "name" : "Ventas"
                        },
                "price" : [
                            {
                             "idPriceList" : 1,
                            "name" : "General",
                            "price" : 1200
                            },
                            {
                                "idPriceList" : 2,
                                "name" : "Distribuidor",
                                "price" : 1050
                            }
                        ]
                
}
{
"code" : "901",
"message" : "Esta acción no está permitida para el usuario actual."
}

El formato de transferencia de datos soportado por la aplicación es JSON. Todas las respuestas se envían en formato JSON y así espera recibirlos.

🚧

Toda la comunicación con el API debe hacerse utilizando https://

Códigos de respuesta HTTP

El API puede retornar alguno de los siguientes códigos HTTP:

Código

Descripción

400

El request está mal formado. La información para crear el recurso no existe o es inválida.

401

Error en autenticación. La autenticación fallo o no se encontró la información para autenticar el request.

402

Pago requerido. La acción no se pudo realizar exitosamente ya que la cuenta se encuentra suspendida o el plan actual de la compañía no permite realizar la acción.

403

El usuario no tiene permisos para realizar la acción.

404

No se encontró en la aplicación el recurso que se está buscando. También se retorna cuando la cuenta se encuentra suspendida.

405

Operación no permitida. Ocurre cuando el método del request es inválido para el endpoint requerido.

201

El recurso se creó exitosamente.

200

Todo funcionó correctamente.

500

Ocurrió un error en la aplicación.

503

Servicio no disponible. Eje: Modo mantenimiento de la aplicación.

Pruebas en vivo

En nuestra documentación encontrarás un explorador de API que te permite realizar requests a tu cuenta y descubrir cómo funciona.

🚧

Debes tener en cuenta que los request que realices pueden modificar la información de tu cuenta.

Para utilizar el API explorer debes utilizar tu correo y token de acceso.

Lecturas recomendadas

Antes de comenzar te recomendamos los siguientes documentos que pueden ser de ayuda:

Autenticación
Limite request