Skip to content

Conceptos

Esta página resume conceptos que aplican en toda la API: ámbito por compañía, tipos de documento y el flujo típico de un documento (borrador → confirmar → cancelar).

Ámbito por compañía

Toda la API opera en el contexto de una compañía. Los datos (documentos, productos, socios, inventario, etc.) pertenecen a una compañía concreta.

  • Con sesión web: la compañía se determina por la sesión del usuario (y, si la app lo permite, por el selector de compañía).
  • Con API key: la compañía queda fijada por la llave: todas las peticiones con esa llave se asocian a la empresa para la que se creó. No es necesario ni permitido indicar en el cuerpo ni en la URL el contexto de otra compañía.

Así se evita acceder por error a datos de otra compañía cuando se usan llaves.

Tipos de documento

Los documentos (facturas, cotizaciones, notas de crédito, etc.) tienen un código de tipo (type). Algunos ejemplos típicos:

CódigoUso habitual
01Factura (consumidor o contribuyente)
03Nota de crédito
04Nota de débito
CotizaciónSegún configuración (a veces sin código numérico)

Los valores exactos pueden variar según el país y la configuración de tu compañía. En listados y filtros se usa el campo type para filtrar por tipo de documento. Consulta la respuesta de la API o la referencia de documentos para los códigos disponibles en tu caso.

Flujo de un documento

El ciclo de vida típico de un documento es:

  1. Borrador (draft): se crea con POST /documents (o se actualiza con PUT /documents/:id). El documento puede editarse y aún no tiene validez tributaria ni número final en muchos casos.
  2. Confirmar: cuando el documento está listo, se envía POST /documents/:id/confirm. A partir de aquí suele asignarse número definitivo y considerarse emitido; según la normativa puede no ser editable.
  3. Cancelar (si aplica): para anular un documento confirmado se usa POST /documents/:id/cancel. No todos los tipos permiten cancelación; depende de la configuración y la normativa.

En resumen: crear/editar en borrador → confirmar → opcionalmente cancelar. Para detalles de rutas y parámetros, ver Documentos.

Volver a la guía · Referencia de API

Documentación API abaco · Changelog