NewThe SII in Live, under contract
BeeL
Get startedMulti-NIFVeriFactuSIIRulesStripeAPI referenceChangelog
Compliance

Get the compliance systems of a company

Scopeconfiguration:read

Returns the tax systems this company reports its invoices through, in the environment of the request: the ones that apply today (ACTIVE) and the ones set to start on a later date (SCHEDULED), each with its period and its settings. Periods that have ended are not listed. Today is the date in Spain.

The systems use the same names as the compliance array of an invoice, which records the ones that applied to that invoice when it was issued.


GET
/v1/companies/{company_id}/compliance
AuthorizationBearer <token>

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

Path Parameters

company_idstring

Unique identifier (UUID) of the company the operation acts on — its identifier, not its NIF. It is the only source of context: the account that owns it is derived from it, and the BeeL-Active-Company header plays no part. A company you do not reach answers 403, and so does a company that does not exist, so the existence of a company in another account is never disclosed.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://app.beel.es/api/v1/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08/compliance"
{
  "success": true,
  "data": {
    "systems": [
      {
        "system": "VERIFACTU",
        "status": "ACTIVE",
        "effective_from": "2026-03-02",
        "effective_to": "2027-01-01",
        "settings": {},
        "created_at": "2026-03-02T09:30:00Z",
        "created_by": "6f1e2d3c-4b5a-4c7d-8e9f-0a1b2c3d4e5f"
      },
      {
        "system": "SII",
        "status": "SCHEDULED",
        "effective_from": "2027-01-01",
        "effective_to": null,
        "settings": {
          "periodicity": "MONTHLY",
          "reason": "MANDATORY_LARGE_COMPANY",
          "already_in_sii": false
        },
        "created_at": "2026-11-12T10:15:00Z",
        "created_by": "6f1e2d3c-4b5a-4c7d-8e9f-0a1b2c3d4e5f"
      }
    ]
  },
  "meta": {
    "timestamp": "2026-11-12T10:15:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}
{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The parameter 'invoice_id' has an invalid type. Expected: UUID.",
    "details": {
      "field": "invoice_id",
      "invalid_value": "deliveries",
      "expected_format": "UUID"
    }
  },
  "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": "VALIDATION_ERROR",
    "message": "The provided data is not valid",
    "details": {
      "field": "specific error message"
    }
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  },
  "type": "https://docs.beel.es/errors/INVOICE_NO_LINES",
  "title": "INVOICE_NO_LINES",
  "detail": "The invoice must have at least one line",
  "instance": "/v1/invoices/abc-123"
}
{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Too many requests. Please try again in 60 seconds."
  },
  "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"
  }
}

Deactivate a compliance system of a company POST

Stops `system` from applying to this company from `effective_to` on, in the environment of the request, without activating another one in its place. Invoices issued on or after that date are not reported through it. To move to a system that excludes this one, activate that one instead: the switch happens in a single call. - **Today or later:** without `effective_to` (send `{}`), the system stops applying today. A date in the past answers `422 COMPLIANCE_EFFECTIVE_DATE_IN_PAST`. - **Scheduled activations:** one that would start on or after `effective_to` is cancelled, which is always accepted; one that is in force, or starts before, ends on `effective_to`, and for the SII that is leaving it. - **Nothing to deactivate:** when the system does not apply on or after `effective_to`, the request answers `200` and changes nothing. - **Sandbox:** a company in Sandbox always reports through VeriFactu or the SII, so deactivating the one that applies, without activating the other, answers `422 COMPLIANCE_REQUIRED_IN_SANDBOX`. - **VeriFactu:** deactivating `VERIFACTU` behaves like turning VeriFactu off with `PUT /v1/companies/{company_id}/verifactu-configuration`, with the same effects. - **SII in Live:** leaving it takes effect tomorrow at the earliest, never on a past date. It can only be left from 1 January when `settings.reason` is `VOLUNTARY` or `MANDATORY_LARGE_COMPANY`, from the first day of a month when it is `REDEME`, and on any date when it is `VAT_GROUP`, judged by the `reason` of the period in force. This also applies to an SII activation that is scheduled and would end after it starts. - **SII in Sandbox:** it can be left on any date from today. - **Cancelling a scheduled SII:** the VeriFactu period that ended on its `effective_from` is left without an end date. The response carries the same body as `GET /v1/companies/{company_id}/compliance`.

Update user preferred language (deprecated) PUT

**Deprecated — use `PATCH /v1/me` instead.** The preferred language belongs to the person, not to a company's configuration. Updates the authenticated user's preferred language. - **What it affects:** the language of the emails BeeL sends to the user and of the translated labels the API returns, such as the invoice template names in `GET /v1/invoice-customization-options`. - **Supported languages:** `es` (Spanish), `en` (English) and `ca` (Catalan). **Retires on 9 December 2026.** See the [migration guide](https://docs.beel.es/changelog/resources-under-the-nif) for what moved where and what changes when you switch.