Get user tax configuration
Scopeconfiguration:readDeprecated. Use GET /v1/companies/{company_id}/tax-configuration, which behaves
identically.
Retrieves the tax configuration of the company (NIF) in focus: the default main tax
(IVA, IGIC, IPSI or OTHER) with its percentage and regime key, the default
exemption reason, the IRPF and equivalence surcharge settings, and the default payment
method and payment term.
Keys are prefixed beel_sk_, and each one carries the scopes it was created with: a key
short of the scope an operation needs is answered 403. The scope an operation requires
is shown next to its title, and the full catalogue lives in the Scopes reference.
Keys are created from the BeeL dashboard. They are secret credentials: do not share them or commit them to source control.
In: header
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://app.beel.es/api/v1/configuration/taxes"{
"success": true,
"data": {
"default_main_tax": {
"type": "IVA",
"percentage": 21,
"regime_key": "01"
},
"default_exemption_reason": "EXENTA_ART_20",
"default_exemption_reason_text": "string",
"apply_equivalence_surcharge": false,
"default_equivalence_surcharge": 5.2,
"apply_irpf": false,
"default_irpf_rate": 15,
"irpf_exempt": false,
"default_payment_method": "BANK_TRANSFER",
"payment_term_days": 365,
"proforma_validity_days": 365
},
"meta": {
"timestamp": "2025-01-15T10:30:00Z",
"request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication is required to access this resource"
},
"meta": {
"timestamp": "2025-01-15T10:30:00Z",
"request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
}
}{
"success": false,
"error": {
"code": "FORBIDDEN",
"message": "You do not have permission to access this resource"
},
"meta": {
"timestamp": "2025-01-15T10:30:00Z",
"request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
}
}{
"success": false,
"error": {
"code": "INTERNAL_ERROR",
"message": "Internal server error"
},
"meta": {
"timestamp": "2025-01-15T10:30:00Z",
"request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
}
}{
"success": false,
"error": {
"code": "UNSUPPORTED_MEDIA_TYPE",
"message": "Unsupported media type: text/plain. Supported: application/json"
},
"meta": {
"timestamp": "2025-01-15T10:30:00Z",
"request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
}
}Get complete tax types catalog GET
**Deprecated.** Use `GET /v1/tax-types`, which returns exactly the same catalog. It is reference data shared by every account, not the settings of a NIF, so it does not belong under `/v1/configuration`. Returns the catalog of Spanish tax regimes with their valid percentages and VeriFactu regime codes. - **`tax_regimes`:** the tax types and the percentages and regime keys each one admits. - **`irpf_types`:** the available IRPF withholding rates. - **`equivalence_surcharges`:** the surcharge that corresponds to each VAT percentage. - **`exemption_reasons`:** the accepted exemption reasons.
Update tax configuration PUT
**Deprecated.** Use `PUT /v1/companies/{company_id}/tax-configuration`, which behaves identically. Updates the tax configuration of the company (NIF) in focus. Fields you omit keep their current value. - **Regime coherence:** the main tax and its VeriFactu regime key must match. Regime key `18` (equivalence surcharge) only exists for `IVA`, so pairing it with `IGIC`, `IPSI` or `OTHER` answers `422` `INVALID_REGIME_KEY_FOR_TAX_TYPE`, with `details` naming the rejected key, the tax type and the keys that type admits. - **Surcharge:** applying the surcharge without regime key `18` answers `422` `RECARGO_REQUIRES_REGIME_RE`. - **Exemption reason:** `default_exemption_reason` travels with `default_main_tax` — sending the tax without a reason clears the stored one, and sending only the reason applies it to the tax already stored.