Factuarea API
Tipos impositivos

Calcular totales para un conjunto de líneas

Calcula la base imponible, el IVA, el recargo, la retención y el total general para un array de líneas con cantidad, precio, descuento y tipos impositivos. Devuelve los totales del documento más el desglose por línea.

POST
/taxes/calculate-totals

Authorization

AuthorizationBearer <token>

En: header

Cuerpo de la petición

application/json

Definiciones de TypeScript

Usa el tipo request body en TypeScript.

Cuerpo de la respuesta

application/json

application/json

application/json

application/json

application/json

application/json

{
  "data": {
    "subtotal": 250,
    "total_vat": 52.5,
    "total_surcharge": 0,
    "total_retention": 15,
    "total": 287.5,
    "lines": [
      {
        "subtotal": 100,
        "vat_amount": 21,
        "surcharge_amount": 0,
        "retention_amount": 0,
        "total": 121
      }
    ]
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "missing_api_key",
    "message": "No se ha proporcionado una API key válida en el header Authorization.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
    "request_id": "req_01HKQS5N8VR7QXJ9K3T6BWPMZA"
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "insufficient_scope",
    "message": "Esta API key no tiene el scope requerido para esta operación.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
    "request_id": "req_01HKQS5NBC3P8M1KX4V7SLNHQD"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_invalid",
    "message": "El campo `name` es obligatorio y no puede estar vacío.",
    "param": "name",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_invalid",
    "request_id": "req_01HKQS5NGS8Z3T6Q1D2E7FYVSI"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Has excedido el rate limit de 60 peticiones por minuto. Reintenta tras 30 segundos.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
    "request_id": "req_01HKQS5NKW1C6W9T4G5H0JBZVL"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "Ha ocurrido un error inesperado. Si persiste, contacta con soporte adjuntando el request_id.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
    "request_id": "req_01HKQS5NLX2D7X0U5H6J1KCAWM"
  }
}

Lista los impuestos filtrados por tipo

Devuelve los impuestos filtrados por categoría mediante el query param type (vat, retention, surcharge, other). Por defecto vat cuando se omite.

Calcular un impuesto sobre un importe base

Aplica el impuesto referenciado a un importe base y devuelve el desglose: base, tax_rate, tax_amount, total_amount y el objeto de impuesto completo.