Skip to content

Tipos de documento, series y correlativos ​

Configuración de tipos de documento comerciales por empresa: factura, nota de crédito, proforma, presupuesto u otros personalizados, cada uno con al menos una serie y un correlativo entero monótono.

Conceptos clave ​

  • Semillas: al crear una empresa o al listar tipos por primera vez se insertan de forma idempotente: factura, nota_credito, proforma, presupuesto, cada uno con una serie por defecto (F, NC, PR, PRE) y nextNumber = 1.
  • Fiscal vs no fiscal: isFiscal marca si el tipo consume reglas Verifactu/Facturae en emisión (módulo de documentos posterior). Proforma/presupuesto nacen no fiscales.
  • Nota de crédito: requiresOriginDocument = true en nota_credito (y tipos de rectificación equivalentes). La emisión exigirá el id de la factura origen (assertOriginLinkRequired en el servicio).
  • Correlativo: el número se asigna solo al emitir un documento, dentro de la misma transacción; una emisión fallida no consume correlativo.
  • Emitidos: si hay documentos issued ligados a un tipo o serie, DELETE de ese tipo/serie responde 409 (no se puede borrar ni reiniciar el correlativo recreando la serie). Tampoco se puede cambiar isFiscal mientras existan emitidos; la regla incluye las semillas. Un valor sin cambios y las ediciones de nombre siguen permitidos. Defensa adicional: índice único parcial (company_id, series_code, number) en commercial_documents.
  • RBAC: MEMBER/VIEWER solo leen; OWNER/ADMIN (y super admin de plataforma) configuran.
  • Aislamiento: tipos y series son por companyId; acceso cruzado → 404.

Endpoints ​

Todos requieren Authorization: Bearer <token> y contexto de empresa (X-Company-Id o JWT).

MétodoRutaRolesNotas
GET/document-typesCualquier rol del tenantSemillas si faltan
POST/document-typesOWNER, ADMINCrea tipo + serie inicial
GET/document-types/:idCualquier rolIncluye series[]
PATCH/document-types/:idOWNER, ADMINNombre / flags; 409 al cambiar isFiscal si hay emitidos
DELETE/document-types/:idOWNER, ADMIN204; cascade series; 409 si hay emitidos
POST/document-types/:id/seriesOWNER, ADMINNueva serie
PATCH/document-types/:id/series/:seriesIdOWNER, ADMINCódigo/nombre (no correlativo)
DELETE/document-types/:id/series/:seriesIdOWNER, ADMIN400 si es la última; 409 si hay emitidos

Ejemplo — crear tipo ​

http
POST /document-types
Content-Type: application/json

{
  "code": "albaran_fiscal",
  "name": "Albarán fiscal",
  "isFiscal": true,
  "requiresOriginDocument": false,
  "seriesCode": "ALB",
  "seriesName": "Serie ALB"
}

Relacionado ​