Calculate totals for a set of lines

Compute subtotal, VAT, surcharge, retention and grand total for an array of line items with quantity, price, discount and tax rates.

Returns the document totals plus the per-line breakdown.

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Formatdate

X-Active-Profile?string

Operate on behalf of a child company (gestoría master key): pass its public id (UUID v7) and the request runs against that child's data without changing the key's scope, tier or environment (omit to use the key's own company). Invalid UUID → 400 parameter_invalid_uuid; unknown or non-owned id → 404 profile_not_found. See the Acting on behalf guide.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

lines*array<>

Items1 <= items <= 500

Response Body

`application/json`

Request example

const apiKey = process.env.FACTUAREA_API_KEY;if (!apiKey) throw new Error("Set FACTUAREA_API_KEY");const response = await fetch("https://api.factuarea.com/v1/taxes/calculate-totals", {  method: "POST",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/json","Content-Type":"application/json"} },  body: JSON.stringify({  "lines": [    {      "quantity": 2,      "unit_price": 100,      "discount": 10,      "vat_rate": 21,      "retention_rate": 15,      "surcharge_rate": 5.2    }  ]}),});if (!response.ok) throw new Error(await response.text());if (response.status !== 204) console.log(await response.json());

Response example

{
  "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
      },
      {
        "subtotal": 150,
        "vat_amount": 31.5,
        "surcharge_amount": 0,
        "retention_amount": 15,
        "total": 166.5
      }
    ]
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "missing_api_key",
    "message": "Falta header Authorization o X-API-Key.",
    "doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
    "request_id": "req_a03341bf542993fe3d07de0847"
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "insufficient_scope",
    "message": "Esta operación requiere el scope 'taxes:read'. Tu API key solo tiene los scopes: ninguno.",
    "doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
    "request_id": "req_3ba744cc811b9277a279709798"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_param_value",
    "message": "El campo lines es obligatorio.",
    "param": "lines",
    "errors": [
      {
        "param": "lines",
        "code": "parameter_missing",
        "message": "El campo lines es obligatorio."
      }
    ],
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_param_value",
    "request_id": "req_a7165f94b14453f125f5366dcc"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Has excedido el límite de requests permitido. Reintenta más tarde.",
    "doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
    "request_id": "req_6ce7c3ab8abb42f7863ac0c444"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "Algo se rompió en nuestro lado al procesar la petición. La condición no la provoca tu payload.",
    "doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
    "request_id": "req_ad413687c83d2919ef02338d7e"
  }
}

Calculate totals for a set of lines

Authorization

Headers

Request Body

Response Body

200application/json

401application/json

403application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`