beel_get_setup_status
Read setup status for BeeL invoicing: get company IDs, NIFs, Live readiness blockers, default series, VeriFactu and tax defaults, and the recommended next action to resolve missing setup.
Instructions
Read-only setup status across your account, with the ids an integration needs: for each company its company_id and NIF, whether it can issue Live and exactly what is missing (issuing-readiness blockers, default series, VeriFactu, payment connection), its default series per document type (id and code), its VeriFactu status and its tax defaults, and the single recommended next action. A section that could not be read carries an error and never a default, so an unknown is never reported as ready.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| company_id | No | Optional: restrict the report to a single company, by its company id (a UUID). This is not the NIF; the NIF is reported as a field of each company. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | Why the report is incomplete: the company listing failed, a filter matched nothing, or entries were unusable. Present only when something went wrong. | |
| account | Yes | The authenticated account, or an error note if identity could not be read. | |
| companies | Yes | ||
| environment | Yes | Which BeeL environment this session operates on. `live` means every invoice issued is a real fiscal document. | |
| next_action | Yes | Single recommended next action across the whole account. |