beel-es · Schema

IssuingReadinessResponse

InvoicingSpainFintechSoftware-as-a-Service

Properties

Name Type Description
success boolean
data object
meta object
View JSON Schema on GitHub

JSON Schema

beel-es-issuing-readiness-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/beel-es/json-schema/beel-es-issuing-readiness-response-schema.json",
  "title": "IssuingReadinessResponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/beel-es-company-api-openapi.yml#/components/schemas/IssuingReadinessResponse",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "$ref": "#/$defs/IssuingReadinessData"
    },
    "meta": {
      "$ref": "#/$defs/ResponseMeta"
    }
  },
  "$defs": {
    "IssuingReadinessData": {
      "type": "object",
      "description": "Issuing-readiness of a company: whether it can issue its STANDARD invoice\nright now, in this environment, and — if not — exactly what is missing. `ready`\nis true only when `blockers` is empty. Issuing any fiscal document requires the\ncompany to be activated in that environment (`COMPANY_NOT_ACTIVATED` otherwise),\nwhether or not it goes to VeriFactu. The VeriFactu capability chain (census,\nsignature) is only demanded on top of that when the company is under the VeriFactu\nregime in this environment — the same fact that decides, at issue time, whether its\ninvoices are registered. With VeriFactu off, a NIF, a default series and a live\nactivation are enough to be ready.\n",
      "properties": {
        "ready": {
          "type": "boolean",
          "description": "true if the company can issue invoices (no blockers)."
        },
        "blockers": {
          "type": "array",
          "description": "Reasons the company cannot issue yet (empty when ready). Each one names what is\nmissing and how to clear it:\n\n- `COMPANY_HAS_NO_NIF`: the company has no NIF. Set `nif` with\n  `PATCH /v1/companies/{company_id}`; once set it cannot be changed.\n- `SERIES_DEFAULT_NOT_FOUND`: there is no default `STANDARD` invoice series in this\n  environment. The `SIMPLIFIED` and `CORRECTIVE` ones are created on first use.\n  `PUT /v1/companies/{company_id}/series/defaults` creates the missing ones, or mark an\n  existing series with `PUT /v1/companies/{company_id}/series/{series_id}/default`.\n- `PROFILE_INCOMPLETE`: the fiscal identity is not complete enough to write an invoice\n  header: entity type, legal name or full fiscal address is missing. Complete\n  `entity_type`, `legal_name` and `address` with `PATCH /v1/companies/{company_id}`. A\n  missing NIF is reported as `COMPANY_HAS_NO_NIF` instead, never as both.\n- `COMPANY_NOT_ACTIVATED`: the company is not activated in the environment of the\n  request, and it is not under the VeriFactu regime. Activate it with\n  `POST /v1/companies/{company_id}/activations` for that environment.\n- `ENV_MISMATCH`: the same missing activation, for a company under the VeriFactu\n  regime. Activate it as above, or call with a credential of the environment where it\n  is already activated. The first stage of the VeriFactu chain.\n- `NIF_NOT_REGISTERED`: the NIF is not registered for VeriFactu submission in this\n  environment. Turning VeriFactu on\n  (`PUT /v1/companies/{company_id}/verifactu-configuration` with `enabled: true`)\n  registers it; in Live that call needs the signed representation first. Never reported\n  in Test, where the NIF is registered with its first submission.\n- `NIF_REPRESENTATION_REQUIRED`: the NIF is registered, but there is no signed AEAT\n  representation in force. Generate it with\n  `POST /v1/companies/{company_id}/representation`, sign it digitally and send it with\n  `POST /v1/companies/{company_id}/representation/submit`. Live only.\n",
          "items": {
            "type": "string",
            "enum": [
              "COMPANY_HAS_NO_NIF",
              "SERIES_DEFAULT_NOT_FOUND",
              "PROFILE_INCOMPLETE",
              "COMPANY_NOT_ACTIVATED",
              "ENV_MISMATCH",
              "NIF_NOT_REGISTERED",
              "NIF_REPRESENTATION_REQUIRED"
            ]
          }
        },
        "verifactu": {
          "type": "object",
          "description": "The compliance question, separate from the operational `ready` above: would\nthis NIF pass a VeriFactu emission right now? Relevant before putting the company\nunder the VeriFactu regime. For a company already under the regime,\n`verifactu.ready` coincides with `ready` (same evaluation).\n",
          "properties": {
            "ready": {
              "type": "boolean",
              "description": "true only when the company is operationally `ready` AND its VeriFactu\ncapability chain is clean. An operational blocker (missing NIF, default\nseries, or an incomplete fiscal identity) makes this false even if the\nchain itself is complete — and, since those are not chain stages, it does\nso with an EMPTY `blockers` list here. The reason is in the top-level\n`blockers`, which is where operational blockers are reported.\n"
            },
            "blockers": {
              "type": "array",
              "description": "ONLY the incremental VeriFactu capability stages, in order and mutually\nexclusive — one reason at a time, without repeating the operational\nblockers (NIF/series/fiscal identity) listed above. The stages, and how to\nclear each one, are the same as in the top-level `blockers`:\n\n- `ENV_MISMATCH`: the company is not activated in the environment of the request.\n- `NIF_NOT_REGISTERED`: the NIF is not registered for VeriFactu submission in\n  this environment; turning VeriFactu on registers it.\n- `NIF_REPRESENTATION_REQUIRED`: no signed AEAT representation in force. Only\n  appears where a signed representation is actually demanded (Live).\n",
              "items": {
                "type": "string",
                "enum": [
                  "ENV_MISMATCH",
                  "NIF_NOT_REGISTERED",
                  "NIF_REPRESENTATION_REQUIRED"
                ]
              }
            }
          }
        }
      }
    },
    "ResponseMeta": {
      "type": "object",
      "properties": {
        "timestamp": {
          "type": "string",
          "format": "date-time"
        },
        "request_id": {
          "type": "string"
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/beel-es-issuing-readiness-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.