Factuarea API
Tipus impositius

Calcular totals per a un conjunt de línies

Calcula la base imposable, l'IVA, el recàrrec, la retenció i el total general per a un array de línies amb quantitat, preu, descompte i tipus impositius. Retorna els totals del document més el desglossament per línia.

POST
/taxes/calculate-totals

Authorization

AuthorizationBearer <token>

A: header

Cos de la petició

application/json

Definicions de TypeScript

Usa el tipus request body a TypeScript.

Cos de la resposta

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"
  }
}

Llista els impostos filtrats per tipus

Retorna els impostos filtrats per categoria mitjançant el query param type (vat, retention, surcharge, other). Per defecte vat quan s'omet.

Calcular un impost sobre un import base

Aplica l'impost referenciat a un import base i retorna el desglossament: base, tax_rate, tax_amount, total_amount i l'objecte d'impost complet.