---
title: "Get the fiscal representation"
method: GET
path: "/v1/companies/{company_id}/representation"
tags: ["CompanyRepresentation"]
---

# Get the fiscal representation

`GET /v1/companies/{company_id}/representation`

## Request

- Base URL: `https://app.beel.es/api`
- URL: `https://app.beel.es/api/v1/companies/{company_id}/representation`
- Auth: HTTP bearer

Returns the state of the AEAT fiscal representation of a company: whether the
document has been generated, signed and submitted, and whether AEAT accepted it or it was
cancelled.

- **`status`:** `NOT_STARTED`, `PDF_GENERATED`, `SUBMITTED`, `ACTIVE`, `ERROR` or
  `CANCELLED`.
- **Never started:** not an error. The endpoint answers `200` with `NOT_STARTED`, so
  polling it is always safe.

## Response `200`

Representation state

- RepresentationStatusResponse
  - `success` boolean
  - `data` object
    - `status` 'NOT_STARTED' | 'PDF_GENERATED' | 'SUBMITTED' | 'ACTIVE' | 'ERROR' | 'CANCELLED': Stage of the AEAT representation of the company. - `NOT_STARTED`: no representation document has been generated yet. - `PDF_GENERATED`: the document is generated and waits for a digital signature. - `SUBMITTED`: returned only by the submit operation, as its acknowledgement; this read never returns it. - `ACTIVE`: the signed document was accepted and the representation is in force, so invoices of this NIF can be submitted to the AEAT in Live. - `ERROR`: reserved; not currently returned. - `CANCELLED`: the representation was cancelled. Invoices of this NIF are not submitted to the AEAT in Live until a new signed document is accepted.
    - `message` string
    - `updated_at` string, date-time
  - `meta` ResponseMeta
    - `timestamp` string, date-time
    - `request_id` string

## Other responses

- `401`: Missing or invalid authentication. Like every other error, `message`/`detail` is localized according to `Accept-Language` (`es`, `en`, `ca`); defaults to English when the header is missing or asks for none of those.
- `403`: Your account does not own or manage this company. That case answers `error.code` `ACTIVE_COMPANY_NOT_ACCESSIBLE`.
- `429`: Rate limit exceeded. `RATE_LIMIT_EXCEEDED` when the request rate of your credential is over its limit; `TOO_MANY_REQUESTS` when an email the operation sends is held back because too many went out to that recipient in a short time. Either way, retry after the `Retry-After` seconds. `QUOTA_EXCEEDED` is the other `429`: the operation would go over a quota of your plan for the current period (issued invoices, for instance). Retrying does not help until the quota resets or the plan changes. `error.details` carries `feature_code`, `current_usage`, `quota_limit` and `reset_date`, and `RateLimit-Reset` the seconds until the reset when it is known.
- `500`: Internal server error
- `default`: Any status code the operation does not list above. Every operation declares it, so a generated client always has a branch to fall into and never loses the cause of a failure it did not anticipate. This is where the transport-level answers land — `405`, `406`, `415` and `429` — together with any status a future version of the API starts returning. All of them carry the same error envelope as the codes listed explicitly, so `error.code` is what tells them apart: switching on the status code alone is not enough. See «Transport-level errors» in the API description for when each one is produced. A `402` carrying `SUBSCRIPTION_REQUIRED` lands here when the account has no active subscription. `error.details` says why and what to do: `current_status` (absent if it never had one), `required_permission` and `action`. A `503` carrying `SERVICE_UNAVAILABLE` lands here too, with a `Retry-After` header: a dependency of BeeL itself (the database, the email provider) was momentarily unavailable and nothing was done. Retry after those seconds. A `502` carrying `EXTERNAL_SERVICE_ERROR` also lands here: an outbound integration the operation depends on failed or did not answer in time. It is a transient condition — retry with the same `Idempotency-Key` where the operation accepts one. One exception to the envelope: a failure of the network edge that never reaches the application (`502`, `503`, `504`, `524`) is generated by Cloudflare and its body is not BeeL's — it may not even be JSON. Treat those as "no answer", and retry.

---

[API](https://skmtc.dev/beel/apis/beel-public-api.md) · [All operations](https://skmtc.dev/beel/apis/beel-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/beel/apis/beel-public-api/revisions/ffbc0ae31f79?raw)
