Get VeriFactu configuration
Scopeconfiguration:readDeprecated. Use GET /v1/companies/{company_id}/verifactu-configuration, which
behaves identically.
Returns the VeriFactu configuration in force for the company (NIF) in focus.
- Writable state:
enabledsays whether VeriFactu is on,apply_by_defaultwhether it is applied by default to new invoices. - Resolved state:
status,signed,activatedandnif_statusare read-only and resolved server-side.
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/verifactu"{
"success": true,
"data": {
"enabled": false,
"apply_by_default": false,
"nif_status": "PENDING",
"nif_registered_at": "2019-08-24T14:15:22Z",
"status": "DISABLED",
"signed": true,
"activated": true,
"pdf_generated": true
},
"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"
}
}Update the VeriFactu configuration of a company PUT
Replaces the VeriFactu configuration of a company (NIF). - **Writable fields:** only `enabled` and `apply_by_default`, and both are required — this is a full replacement, not a partial merge. The rest of the returned configuration is resolved server-side. - **Coherence:** `apply_by_default` cannot be true while `enabled` is false, which answers `422 APPLY_BY_DEFAULT_REQUIRES_ENABLED`. ## Turning it off Setting `enabled` to false stops sending this company's invoices to AEAT and starts the deregistration of the NIF with the VeriFactu provider. It does not deactivate the company: the activation is a fact of its own for the (company, environment) pair, so the company keeps issuing in that environment and stays `ready`. Releasing the NIF — and in Live freeing it for another account — is always `DELETE /v1/companies/{company_id}/activations`.
Update VeriFactu configuration PUT
**Deprecated.** Use `PUT /v1/companies/{company_id}/verifactu-configuration`, which behaves identically. Updates the VeriFactu configuration of the company (NIF) in focus. - **Writable fields:** only `enabled` and `apply_by_default`. The rest of the returned configuration (`status`, `signed`, `activated`, `nif_status`) is resolved server-side. - **Full replacement:** both fields are required — this PUT replaces the whole state, it is not a partial merge, so omitting one is a client error and not a silent `false`. - **Coherence:** if `enabled` is false, `apply_by_default` must be false too. The other way round answers `422` `APPLY_BY_DEFAULT_REQUIRES_ENABLED`. ## Turning it off Setting `enabled` to false stops sending invoices to the AEAT and starts the deregistration of the NIF with the VeriFactu provider. It does **not** deactivate the NIF: the activation is a fact of its own for the (company, environment) pair, so issuing carries on and `issuing-readiness` stays `ready`. Releasing the NIF is always `DELETE /v1/companies/{company_id}/activations`, with its own guarantees.