Primeros pasos
- URL base de la API para el entorno de producción:
https://api.tukonta.com/v1 - URL de la aplicación web para el entorno de producción:
https://tu.tukonta.com - URL base de la API para el entorno de pruebas:
https://api-sandbox.tukonta.com/v1 - URL de la aplicación web para el entorno de pruebas:
https://sandbox.tukonta.com - Quién puede usarla: la API está incluida en todos los planes. Durante el periodo de prueba no está disponible: las claves responden
401con «La API está incluida en todos los planes, pero no durante el periodo de prueba.». - Autenticación: encabezado
X-API-KEYcon la clave de API (también se admiteAuthorization: Bearer <clave>). Cada clave pertenece a una empresa: todo lo que se consulta o se crea con ella es de esa empresa.
Formato de peticiones y respuestas
Sección titulada «Formato de peticiones y respuestas»- Las peticiones y las respuestas son JSON (
application/json). La excepción esPOST /expenses/:id/attachment, que recibe el archivo enmultipart/form-data. - Las fechas van en formato
yyyy-MM-dd. Por ejemplo:2026-11-11. - Los importes llevan como máximo 2 decimales.
- Los porcentajes (IVA, retención, recargo, afectación) se indican en tanto por uno. Por ejemplo: para 21 %, se indica
0.21. - Cada cliente, factura, ingreso, proveedor o gasto tiene un identificador,
id. En las rutas aparece como:id: por ejemplo,GET /customers/:idse pide comoGET /customers/674c98fda16dce6523336d88. - Las respuestas correctas tienen un código
2xx. Las de error, un código4xxo5xxy un cuerpo que explica qué ha pasado: consulta Errores.
Paginación y filtros de las listas
Sección titulada «Paginación y filtros de las listas»Las peticiones que devuelven una lista (GET /customers/, GET /invoices/, GET /incomes/, GET /providers/ y GET /expenses/) responden con la página de resultados en data y los datos de la paginación en pagination:
{ "data": [], "pagination": { "total": 25, "offset": 0, "limit": 10, "count": 10, "hasMore": true }}| Campo | Descripción |
|---|---|
total |
Número total de resultados. |
offset |
Posición del primer resultado de la página. |
limit |
Número máximo de resultados por página. |
count |
Número de resultados de esta página. |
hasMore |
true si hay más resultados después de esta página. |
Todas las listas admiten estos parámetros en la dirección (por ejemplo, GET /invoices/?offset=20&limit=20):
| Parámetro | Descripción |
|---|---|
offset |
Cuántos resultados saltar: 0 o más. Por defecto, 0. Para pedir la página siguiente, súmale limit. |
limit |
Cuántos resultados devolver: entre 1 y 100. Por defecto, 10. |
order |
desc (por defecto) o asc. En GET /expenses/ conviene indicarlo siempre: si no, el orden no está garantizado. |
Cada lista tiene además sus propios filtros, que se explican en su apartado.