Factuarea API
Tipus impositius

Alternar l'estat actiu de l'impost

Canvia un impost entre actiu i inactiu. Els impostos inactius s'amaguen dels selectors però segueixen disponibles per a documents ja emesos.

POST
/taxes/{tax}/toggle

Authorization

AuthorizationBearer <token>

A: header

Paràmetres de ruta

tax*string

Paràmetres de capçalera

Idempotency-Key?string

Clau única generada pel client per garantir la idempotència en els reintents. Et permet reenviar de manera segura la mateixa petició: la primera resposta es cacheja i es retorna sense tornar a executar la mutació. És una cadena opaca per al servidor; qualsevol valor únic de fins a 64 caràcters és vàlid (UUID v7, UUID v4, ULID, nanoid, etc.). Es recomana UUID v7 per coherència amb els identificadors de l'API. La mateixa clau reutilitzada amb un body diferent retorna 409 idempotency_key_reused.

Longitud1 <= length <= 64

Cos de la resposta

application/json

application/json

application/json

application/json

application/json

application/json

{
  "data": {
    "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a0f",
    "object": "tax",
    "name": "IVA general 21%",
    "code": "IVA21",
    "rate": 21,
    "type": "vat",
    "applies_to": "both",
    "country": "ES",
    "is_default": true,
    "is_active": true,
    "is_system": true,
    "description": "IVA general aplicable en territorio peninsular y Baleares.",
    "default_for_documents": {
      "invoice": true,
      "quote": true,
      "delivery_note": true,
      "proforma": true,
      "purchase_invoice": true,
      "recurring_invoice": true
    },
    "customer_visible_label": "IVA 21%",
    "external_reference": "S1",
    "valid_from": "2012-09-01",
    "valid_until": null,
    "reverse_charge": false,
    "country_aeat_zone": "peninsula",
    "metadata": {
      "erp_code": "IVA-GEN",
      "ledger_account": "477000"
    },
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z"
  }
}

{
  "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": "idempotency_error",
    "code": "idempotency_key_reused",
    "message": "La cabecera `Idempotency-Key` ya se usó con un body distinto. Usa una clave nueva o reenvía exactamente el mismo body.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#idempotency_key_reused",
    "request_id": "req_01HKQS5NHT9A4U7R2E3F8GZWTJ"
  }
}

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

Obtenir estadístiques d'impostos

KPIs agregats dels tipus impositius disponibles per a la teva empresa: nombre total d'impostos, nombre d'actius i desglossament per tipus (vat, retention, surcharge, other). Retornat com a `{ "data": TaxStats }`.

Actualitzar un impost

Actualització parcial d'un impost: name, code, rate, applies_to, country i description. Els impostos del sistema (is_system=true) no són editables.