@beel_es/sdk 2.0.0 → 2.1.0

package/docs/reference/company-recurring-invoices.md

@@ -0,0 +1,136 @@
+<!-- Generated by `npm run docs:reference` from the SDK source and openapi/public-api.yaml. Do not edit. -->
+
+# `beel.company(companyId).recurringInvoices` — `CompanyRecurringInvoicesResource`
+
+[Reference index](README.md)
+
+Recurring invoice templates of one company. Reach it as
+`beel.company(companyId).recurringInvoices`.
+
+## Methods
+
+| Method | HTTP | Summary |
+|---|---|---|
+| [`beel.company(companyId).recurringInvoices.list(params?)`](#company-recurring-invoices-list) | `GET /v1/companies/{company_id}/recurring-invoices` | List the recurring invoices. |
+| [`beel.company(companyId).recurringInvoices.create(body)`](#company-recurring-invoices-create) | `POST /v1/companies/{company_id}/recurring-invoices` | Create a recurring invoice template. |
+| [`beel.company(companyId).recurringInvoices.get(recurringInvoiceId)`](#company-recurring-invoices-get) | `GET /v1/companies/{company_id}/recurring-invoices/{recurring_invoice_id}` | Get one recurring invoice. |
+| [`beel.company(companyId).recurringInvoices.update(recurringInvoiceId, body)`](#company-recurring-invoices-update) | `PATCH /v1/companies/{company_id}/recurring-invoices/{recurring_invoice_id}` | Update a recurring invoice. |
+| [`beel.company(companyId).recurringInvoices.delete(recurringInvoiceId)`](#company-recurring-invoices-delete) | `DELETE /v1/companies/{company_id}/recurring-invoices/{recurring_invoice_id}` | Delete a recurring invoice and cancel its pending generations. |
+| [`beel.company(companyId).recurringInvoices.setStatus(recurringInvoiceId, body)`](#company-recurring-invoices-set-status) | `PUT /v1/companies/{company_id}/recurring-invoices/{recurring_invoice_id}/status` | Pause, resume or end the template. |
+| [`beel.company(companyId).recurringInvoices.skip(recurringInvoiceId)`](#company-recurring-invoices-skip) | `POST /v1/companies/{company_id}/recurring-invoices/{recurring_invoice_id}/skip` | Skip the next scheduled occurrence. |
+| [`beel.company(companyId).recurringInvoices.generateNow(recurringInvoiceId)`](#company-recurring-invoices-generate-now) | `POST /v1/companies/{company_id}/recurring-invoices/{recurring_invoice_id}/generate` | Generate the next invoice now instead of waiting for the schedule. |
+| [`beel.company(companyId).recurringInvoices.nextOccurrence(recurringInvoiceId)`](#company-recurring-invoices-next-occurrence) | `GET /v1/companies/{company_id}/recurring-invoices/{recurring_invoice_id}/next-occurrence` | Preview the next invoice the template will generate. |
+| [`beel.company(companyId).recurringInvoices.history(recurringInvoiceId, params?)`](#company-recurring-invoices-history) | `GET /v1/companies/{company_id}/recurring-invoices/{recurring_invoice_id}/history` | The generation history of the template: generated, skipped and failed occurrences. |
+
+<a id="company-recurring-invoices-list"></a>
+### `list(params?)`
+
+List the recurring invoices.
+
+- **HTTP:** `GET /v1/companies/{company_id}/recurring-invoices` · operation `listCompanyRecurringInvoices` · scopes `invoices:read`
+- **Parameters:**
+  - `params?: operations['listCompanyRecurringInvoices']['parameters']['query']` — Filters and pagination.
+- **Returns:** The page of `recurring_invoices` and its `pagination`. Response `200` `data`: `{ recurring_invoices: RecurringInvoiceResponse[]; pagination?: Pagination }`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `422` `BeeLValidationError` · `429` `BeeLRateLimitError`
+
+<a id="company-recurring-invoices-create"></a>
+### `create(body)`
+
+Create a recurring invoice template.
+
+- **HTTP:** `POST /v1/companies/{company_id}/recurring-invoices` · operation `createCompanyRecurringInvoice` · scopes `invoices:write` · accepts `Idempotency-Key`
+- **Parameters:**
+  - `body: operations['createCompanyRecurringInvoice']['requestBody']['content']['application/json']` — Frequency, schedule, recipient and lines.
+- **Returns:** The recurring invoice. Response `201` `data`: `RecurringInvoiceResponse`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `404` `BeeLNotFoundError` · `422` `BeeLValidationError` · `429` `BeeLRateLimitError`
+
+<a id="company-recurring-invoices-get"></a>
+### `get(recurringInvoiceId)`
+
+Get one recurring invoice.
+
+- **HTTP:** `GET /v1/companies/{company_id}/recurring-invoices/{recurring_invoice_id}` · operation `getCompanyRecurringInvoice` · scopes `invoices:read`
+- **Parameters:**
+  - `recurringInvoiceId: string` — Recurring invoice UUID.
+- **Returns:** The recurring invoice. Response `200` `data`: `RecurringInvoiceResponse`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `404` `BeeLNotFoundError` · `429` `BeeLRateLimitError`
+
+<a id="company-recurring-invoices-update"></a>
+### `update(recurringInvoiceId, body)`
+
+Update a recurring invoice. Only the fields present in `body` change.
+
+- **HTTP:** `PATCH /v1/companies/{company_id}/recurring-invoices/{recurring_invoice_id}` · operation `patchCompanyRecurringInvoice` · scopes `invoices:write` · accepts `Idempotency-Key`
+- **Parameters:**
+  - `recurringInvoiceId: string` — Recurring invoice UUID.
+  - `body: operations['patchCompanyRecurringInvoice']['requestBody']['content']['application/json']` — Fields to change.
+- **Returns:** The updated recurring invoice. Response `200` `data`: `RecurringInvoiceResponse`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `404` `BeeLNotFoundError` · `409` `BeeLConflictError` · `422` `BeeLValidationError` · `429` `BeeLRateLimitError`
+
+<a id="company-recurring-invoices-delete"></a>
+### `delete(recurringInvoiceId)`
+
+Delete a recurring invoice and cancel its pending generations. Invoices it already
+generated are kept.
+
+- **HTTP:** `DELETE /v1/companies/{company_id}/recurring-invoices/{recurring_invoice_id}` · operation `deleteCompanyRecurringInvoice` · scopes `invoices:write`
+- **Parameters:**
+  - `recurringInvoiceId: string` — Recurring invoice UUID.
+- **Throws:** `401`/`403` `BeeLAuthError` · `404` `BeeLNotFoundError` · `429` `BeeLRateLimitError` · `500` `BeeLApiError`
+
+<a id="company-recurring-invoices-set-status"></a>
+### `setStatus(recurringInvoiceId, body)`
+
+Pause, resume or end the template.
+
+- **HTTP:** `PUT /v1/companies/{company_id}/recurring-invoices/{recurring_invoice_id}/status` · operation `setCompanyRecurringInvoiceStatus` · scopes `invoices:write` · accepts `Idempotency-Key`
+- **Parameters:**
+  - `recurringInvoiceId: string` — Recurring invoice UUID.
+  - `body: operations['setCompanyRecurringInvoiceStatus']['requestBody']['content']['application/json']` — Target `status` (e.g. `PAUSED`, `ACTIVE`).
+- **Returns:** The updated recurring invoice. Response `200` `data`: `RecurringInvoiceResponse`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `404` `BeeLNotFoundError` · `422` `BeeLValidationError` · `429` `BeeLRateLimitError`
+
+<a id="company-recurring-invoices-skip"></a>
+### `skip(recurringInvoiceId)`
+
+Skip the next scheduled occurrence.
+
+- **HTTP:** `POST /v1/companies/{company_id}/recurring-invoices/{recurring_invoice_id}/skip` · operation `skipCompanyRecurringInvoice` · scopes `invoices:write` · accepts `Idempotency-Key`
+- **Parameters:**
+  - `recurringInvoiceId: string` — Recurring invoice UUID.
+- **Returns:** The recurring invoice with its next date moved. Response `200` `data`: `RecurringInvoiceResponse`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `404` `BeeLNotFoundError` · `429` `BeeLRateLimitError`
+
+<a id="company-recurring-invoices-generate-now"></a>
+### `generateNow(recurringInvoiceId)`
+
+Generate the next invoice now instead of waiting for the schedule.
+
+- **HTTP:** `POST /v1/companies/{company_id}/recurring-invoices/{recurring_invoice_id}/generate` · operation `generateCompanyRecurringInvoiceNow` · scopes `invoices:write` · accepts `Idempotency-Key`
+- **Parameters:**
+  - `recurringInvoiceId: string` — Recurring invoice UUID.
+- **Returns:** The generated `invoice_id` and the `next_generation` date. Response `201` `data`: `{ invoice_id?: string; next_generation?: string | null }`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `404` `BeeLNotFoundError` · `409` `BeeLConflictError` · `422` `BeeLValidationError` · `429` `BeeLRateLimitError`
+
+<a id="company-recurring-invoices-next-occurrence"></a>
+### `nextOccurrence(recurringInvoiceId)`
+
+Preview the next invoice the template will generate.
+
+- **HTTP:** `GET /v1/companies/{company_id}/recurring-invoices/{recurring_invoice_id}/next-occurrence` · operation `getCompanyRecurringInvoiceNextOccurrence` · scopes `invoices:read`
+- **Parameters:**
+  - `recurringInvoiceId: string` — Recurring invoice UUID.
+- **Returns:** The invoice as it would be generated. Response `200` `data`: `NextOccurrence`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `404` `BeeLNotFoundError` · `409` `BeeLConflictError` · `422` `BeeLValidationError` · `429` `BeeLRateLimitError`
+
+<a id="company-recurring-invoices-history"></a>
+### `history(recurringInvoiceId, params?)`
+
+The generation history of the template: generated, skipped and failed occurrences.
+
+- **HTTP:** `GET /v1/companies/{company_id}/recurring-invoices/{recurring_invoice_id}/history` · operation `getCompanyRecurringInvoiceHistory` · scopes `invoices:read`
+- **Parameters:**
+  - `recurringInvoiceId: string` — Recurring invoice UUID.
+  - `params?: operations['getCompanyRecurringInvoiceHistory']['parameters']['query']` — Pagination.
+- **Returns:** The `history` entries. Response `200` `data`: `{ history: GenerationHistoryResponse[]; pagination: Pagination }`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `404` `BeeLNotFoundError` · `422` `BeeLValidationError` · `429` `BeeLRateLimitError`

package/docs/reference/company-series.md

@@ -0,0 +1,94 @@
+<!-- Generated by `npm run docs:reference` from the SDK source and openapi/public-api.yaml. Do not edit. -->
+
+# `beel.company(companyId).series` — `CompanySeriesResource`
+
+[Reference index](README.md)
+
+Invoice series (numbering) of one company. Each series numbers one `document_type`.
+Reach it as `beel.company(companyId).series`.
+
+## Methods
+
+| Method | HTTP | Summary |
+|---|---|---|
+| [`beel.company(companyId).series.list(params?)`](#company-series-list) | `GET /v1/companies/{company_id}/series` | List the company's series. |
+| [`beel.company(companyId).series.create(body)`](#company-series-create) | `POST /v1/companies/{company_id}/series` | Create a series. |
+| [`beel.company(companyId).series.update(seriesId, body)`](#company-series-update) | `PATCH /v1/companies/{company_id}/series/{series_id}` | Update a series. |
+| [`beel.company(companyId).series.delete(seriesId)`](#company-series-delete) | `DELETE /v1/companies/{company_id}/series/{series_id}` | Delete (soft-delete) a series. |
+| [`beel.company(companyId).series.getDefaults()`](#company-series-get-defaults) | `GET /v1/companies/{company_id}/series/defaults` | The current default series per document type. |
+| [`beel.company(companyId).series.ensureDefaults()`](#company-series-ensure-defaults) | `PUT /v1/companies/{company_id}/series/defaults` | Ensure a default series exists per document type, creating the missing ones. |
+| [`beel.company(companyId).series.setDefault(seriesId)`](#company-series-set-default) | `PUT /v1/companies/{company_id}/series/{series_id}/default` | Mark a series as the default for its document type. |
+
+<a id="company-series-list"></a>
+### `list(params?)`
+
+List the company's series.
+
+- **HTTP:** `GET /v1/companies/{company_id}/series` · operation `listCompanySeries` · scopes `series:read`
+- **Parameters:**
+  - `params?: operations['listCompanySeries']['parameters']['query']` — Filters; `page`/`limit` to paginate.
+- **Returns:** The `series`, and `pagination` when you paginated. Response `200` `data`: `{ series: InvoiceSeries[]; pagination?: Pagination }`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `422` `BeeLValidationError` · `429` `BeeLRateLimitError`
+
+<a id="company-series-create"></a>
+### `create(body)`
+
+Create a series.
+
+- **HTTP:** `POST /v1/companies/{company_id}/series` · operation `createCompanySeries` · scopes `series:write` · accepts `Idempotency-Key`
+- **Parameters:**
+  - `body: operations['createCompanySeries']['requestBody']['content']['application/json']` — Code, name, format and the `document_type` it numbers.
+- **Returns:** The created series. Response `201` `data`: `InvoiceSeries`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `409` `BeeLConflictError` · `422` `BeeLValidationError` · `429` `BeeLRateLimitError`
+
+<a id="company-series-update"></a>
+### `update(seriesId, body)`
+
+Update a series. Only the fields present in `body` change.
+
+- **HTTP:** `PATCH /v1/companies/{company_id}/series/{series_id}` · operation `patchCompanySeries` · scopes `series:write`
+- **Parameters:**
+  - `seriesId: string` — Series UUID.
+  - `body: operations['patchCompanySeries']['requestBody']['content']['application/json']` — Fields to change.
+- **Returns:** The updated series. Response `200` `data`: `InvoiceSeries`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `404` `BeeLNotFoundError` · `409` `BeeLConflictError` · `422` `BeeLValidationError` · `429` `BeeLRateLimitError`
+
+<a id="company-series-delete"></a>
+### `delete(seriesId)`
+
+Delete (soft-delete) a series. Its code stays taken, since issued invoices carry it.
+
+- **HTTP:** `DELETE /v1/companies/{company_id}/series/{series_id}` · operation `deleteCompanySeries` · scopes `series:write`
+- **Parameters:**
+  - `seriesId: string` — Series UUID.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `404` `BeeLNotFoundError` · `429` `BeeLRateLimitError`
+
+<a id="company-series-get-defaults"></a>
+### `getDefaults()`
+
+The current default series per document type.
+
+- **HTTP:** `GET /v1/companies/{company_id}/series/defaults` · operation `getCompanyDefaultSeries` · scopes `series:read`
+- **Returns:** One entry per document type, saying whether a default exists. Response `200` `data`: `{ defaults: DocumentTypeDefaultStatus[] }`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `429` `BeeLRateLimitError`
+
+<a id="company-series-ensure-defaults"></a>
+### `ensureDefaults()`
+
+Ensure a default series exists per document type, creating the missing ones.
+Idempotent.
+
+- **HTTP:** `PUT /v1/companies/{company_id}/series/defaults` · operation `ensureCompanyDefaultSeries` · scopes `series:write` · accepts `Idempotency-Key`
+- **Returns:** The default series. Response `200` `data`: `{ series: InvoiceSeries[] }`.
+- **Throws:** `401`/`403` `BeeLAuthError` · `429` `BeeLRateLimitError` · `500` `BeeLApiError`
+
+<a id="company-series-set-default"></a>
+### `setDefault(seriesId)`
+
+Mark a series as the default for its document type.
+
+- **HTTP:** `PUT /v1/companies/{company_id}/series/{series_id}/default` · operation `setCompanyDefaultSeries` · scopes `series:write` · accepts `Idempotency-Key`
+- **Parameters:**
+  - `seriesId: string` — Series UUID.
+- **Returns:** The series. Response `200` `data`: `InvoiceSeries`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `404` `BeeLNotFoundError` · `409` `BeeLConflictError` · `429` `BeeLRateLimitError`

package/docs/reference/company-tax-configuration.md

@@ -0,0 +1,36 @@
+<!-- Generated by `npm run docs:reference` from the SDK source and openapi/public-api.yaml. Do not edit. -->
+
+# `beel.company(companyId).taxConfiguration` — `CompanyTaxConfigurationResource`
+
+[Reference index](README.md)
+
+Tax defaults of one company (main tax, IRPF, equivalence surcharge). The canonical
+replacement for the account-wide `beel.configuration.getTaxConfig()`, whose flat route is
+deprecated. Reach it as `beel.company(companyId).taxConfiguration`.
+
+## Methods
+
+| Method | HTTP | Summary |
+|---|---|---|
+| [`beel.company(companyId).taxConfiguration.get()`](#company-tax-configuration-get) | `GET /v1/companies/{company_id}/tax-configuration` | Get the tax configuration. |
+| [`beel.company(companyId).taxConfiguration.update(body)`](#company-tax-configuration-update) | `PUT /v1/companies/{company_id}/tax-configuration` | Replace the tax configuration — this is a `PUT`, not a merge: send the whole state. |
+
+<a id="company-tax-configuration-get"></a>
+### `get()`
+
+Get the tax configuration.
+
+- **HTTP:** `GET /v1/companies/{company_id}/tax-configuration` · operation `getCompanyTaxConfiguration` · scopes `configuration:read`
+- **Returns:** The company's tax defaults. Response `200` `data`: `TaxConfiguration`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `429` `BeeLRateLimitError`
+
+<a id="company-tax-configuration-update"></a>
+### `update(body)`
+
+Replace the tax configuration — this is a `PUT`, not a merge: send the whole state.
+
+- **HTTP:** `PUT /v1/companies/{company_id}/tax-configuration` · operation `updateCompanyTaxConfiguration` · scopes `configuration:write`
+- **Parameters:**
+  - `body: components['schemas']['UpdateTaxConfigurationRequest']` — The complete tax configuration.
+- **Returns:** The stored configuration. Response `200` `data`: `TaxConfiguration`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `422` `BeeLValidationError` · `429` `BeeLRateLimitError`

package/docs/reference/company-verifactu-configuration.md

@@ -0,0 +1,41 @@
+<!-- Generated by `npm run docs:reference` from the SDK source and openapi/public-api.yaml. Do not edit. -->
+
+# `beel.company(companyId).verifactuConfiguration` — `CompanyVeriFactuConfigurationResource`
+
+[Reference index](README.md)
+
+VeriFactu configuration of one company. The canonical replacement for
+`beel.configuration.getVerifactu()`, whose flat route is deprecated. Reach it as
+`beel.company(companyId).verifactuConfiguration`.
+
+Whether an invoice reaches AEAT is a fact of this NIF resolved at issue time, not a
+per-invoice choice: `enabled` is the only writable field. Everything else — `status`,
+`nif_status`, `signed`, `activated`, `pdf_generated` — is resolved server-side. The
+outcome of each invoice is on the invoice itself: `invoice.verifactu.submission_status`.
+
+## Methods
+
+| Method | HTTP | Summary |
+|---|---|---|
+| [`beel.company(companyId).verifactuConfiguration.get()`](#company-verifactu-configuration-get) | `GET /v1/companies/{company_id}/verifactu-configuration` | Get the VeriFactu configuration of this NIF. |
+| [`beel.company(companyId).verifactuConfiguration.update(body)`](#company-verifactu-configuration-update) | `PUT /v1/companies/{company_id}/verifactu-configuration` | Turn VeriFactu on or off for this NIF. |
+
+<a id="company-verifactu-configuration-get"></a>
+### `get()`
+
+Get the VeriFactu configuration of this NIF.
+
+- **HTTP:** `GET /v1/companies/{company_id}/verifactu-configuration` · operation `getCompanyVeriFactuConfiguration` · scopes `configuration:read`
+- **Returns:** `enabled` and the server-resolved state of the NIF. Response `200` `data`: `VeriFactuConfiguration`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `429` `BeeLRateLimitError`
+
+<a id="company-verifactu-configuration-update"></a>
+### `update(body)`
+
+Turn VeriFactu on or off for this NIF. `enabled` is the only field you can write.
+
+- **HTTP:** `PUT /v1/companies/{company_id}/verifactu-configuration` · operation `updateCompanyVeriFactuConfiguration` · scopes `configuration:write`
+- **Parameters:**
+  - `body: components['schemas']['UpdateVeriFactuConfigurationRequest']` — `{ enabled }`.
+- **Returns:** The updated configuration. Response `200` `data`: `VeriFactuConfiguration`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `422` `BeeLValidationError` · `429` `BeeLRateLimitError`

package/docs/reference/company.md

@@ -0,0 +1,94 @@
+<!-- Generated by `npm run docs:reference` from the SDK source and openapi/public-api.yaml. Do not edit. -->
+
+# `beel.company(companyId)` — `CompanyScope`
+
+[Reference index](README.md)
+
+Operations scoped to a single company (NIF). This is the explicit multi-NIF surface:
+the company is addressed in the path, so no session focus or `BeeL-Active-Company`
+header is needed. Get one with `beel.company(companyId)`; list the ids with
+`beel.account(accountId).companies.list()`.
+
+Every method rejects with a `BeeLApiError` subclass when the API answers non-2xx.
+
+**Example**
+
+```typescript
+const company = beel.company('company-uuid');
+const invoice = await company.invoices.create({ ... });
+await company.invoices.issue(invoice.id);
+```
+
+## Properties
+
+| Property | Type | Description |
+|---|---|---|
+| `invoices` | [`CompanyInvoicesResource`](company-invoices.md) | Invoices of this company: create, issue, void, correct, list, PDF, email. |
+| `customers` | [`CompanyCustomersResource`](company-customers.md) | Customers of this company. |
+| `products` | [`CompanyProductsResource`](company-products.md) | Products and services of this company. |
+| `series` | [`CompanySeriesResource`](company-series.md) | Invoice series (numbering) of this company. |
+| `recurringInvoices` | [`CompanyRecurringInvoicesResource`](company-recurring-invoices.md) | Recurring invoice templates of this company. |
+| `paymentConnections` | [`CompanyPaymentConnectionsResource`](company-payment-connections.md) | Payment provider connections (Stripe) that auto-generate invoices under this NIF. |
+| `taxConfiguration` | [`CompanyTaxConfigurationResource`](company-tax-configuration.md) | Default taxes of this company. |
+| `verifactuConfiguration` | [`CompanyVeriFactuConfigurationResource`](company-verifactu-configuration.md) | Whether this NIF submits its invoices to AEAT under VeriFactu. |
+
+## Methods
+
+| Method | HTTP | Summary |
+|---|---|---|
+| [`beel.company(companyId).get(params?)`](#company-get) | `GET /v1/companies/{company_id}` | Get the company: its fiscal identity, address and settings. |
+| [`beel.company(companyId).update(body)`](#company-update) | `PATCH /v1/companies/{company_id}` | Update the company's data. |
+| [`beel.company(companyId).delete()`](#company-delete) | `DELETE /v1/companies/{company_id}` | Remove the company from its account. |
+| [`beel.company(companyId).fiscalSummary(params?)`](#company-fiscal-summary) | `GET /v1/companies/{company_id}/fiscal-summary` | Fiscal summary of the company for a period: taxable base, VAT and IRPF aggregates. |
+| [`beel.company(companyId).issuingReadiness()`](#company-issuing-readiness) | `GET /v1/companies/{company_id}/issuing-readiness` | Whether the company can issue invoices now, and what blocks it if not. |
+
+<a id="company-get"></a>
+### `get(params?)`
+
+Get the company: its fiscal identity, address and settings.
+
+- **HTTP:** `GET /v1/companies/{company_id}` · operation `getCompanyById` · scopes `companies:read`
+- **Parameters:**
+  - `params?: operations['getCompanyById']['parameters']['query']` — Optional query of `getCompanyById` (e.g. `include`).
+- **Returns:** The company. Response `200` `data`: `CompanyData`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `429` `BeeLRateLimitError`
+
+<a id="company-update"></a>
+### `update(body)`
+
+Update the company's data. Only the fields present in `body` change.
+
+- **HTTP:** `PATCH /v1/companies/{company_id}` · operation `patchCompanyById` · scopes `companies:write`
+- **Parameters:**
+  - `body: components['schemas']['UpdateCompanyRequest']` — Fields to change.
+- **Returns:** The updated company. Response `200` `data`: `CompanyData`.
+- **Throws:** `401`/`403` `BeeLAuthError` · `422` `BeeLValidationError` · `429` `BeeLRateLimitError` · `500` `BeeLApiError`
+
+<a id="company-delete"></a>
+### `delete()`
+
+Remove the company from its account. Blocked for the primary NIF, a NIF active in Live,
+or one holding Live invoices.
+
+- **HTTP:** `DELETE /v1/companies/{company_id}` · operation `deleteCompanyById` · scopes `companies:write`
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `409` `BeeLConflictError` · `429` `BeeLRateLimitError`
+
+<a id="company-fiscal-summary"></a>
+### `fiscalSummary(params?)`
+
+Fiscal summary of the company for a period: taxable base, VAT and IRPF aggregates.
+
+- **HTTP:** `GET /v1/companies/{company_id}/fiscal-summary` · operation `getCompanyFiscalSummary` · scopes `invoices:read`
+- **Parameters:**
+  - `params?: operations['getCompanyFiscalSummary']['parameters']['query']` — `start_date` and `end_date` (both or neither; default: the current month).
+- **Returns:** The aggregates of the period. Response `200` `data`: `FiscalSummaryResponse`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `429` `BeeLRateLimitError`
+
+<a id="company-issuing-readiness"></a>
+### `issuingReadiness()`
+
+Whether the company can issue invoices now, and what blocks it if not.
+
+- **HTTP:** `GET /v1/companies/{company_id}/issuing-readiness` · operation `getCompanyIssuingReadiness` · scopes `companies:read`
+- **Returns:** `ready` plus the list of `blockers`. Response `200` `data`: `IssuingReadinessData`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `429` `BeeLRateLimitError`

package/docs/reference/configuration.md

@@ -0,0 +1,90 @@
+<!-- Generated by `npm run docs:reference` from the SDK source and openapi/public-api.yaml. Do not edit. -->
+
+# `beel.configuration` — `ConfigurationResource`
+
+[Reference index](README.md)
+
+> **Deprecated.** The contract deprecates these routes. Use `beel.company(companyId).taxConfiguration`, `beel.company(companyId).verifactuConfiguration` and `CatalogsResource` (`beel.catalogs`) instead.
+
+Account-wide configuration on the flat `/v1/configuration/*` routes.
+
+## Methods
+
+| Method | HTTP | Summary |
+|---|---|---|
+| [`beel.configuration.getTaxConfig()`](#configuration-get-tax-config) | `GET /v1/configuration/taxes` | Get the tax configuration (default VAT, IRPF…) of the focused company. |
+| [`beel.configuration.updateTaxConfig(body)`](#configuration-update-tax-config) | `PUT /v1/configuration/taxes` | Replace the tax configuration of the focused company. |
+| [`beel.configuration.getTaxTypes()`](#configuration-get-tax-types) | `GET /v1/configuration/tax-types` | Tax types the API accepts (IVA/IGIC rates, IRPF types, equivalence surcharges). |
+| [`beel.configuration.getInvoiceCustomizationOptions()`](#configuration-get-invoice-customization-options) | `GET /v1/configuration/invoice-customization-options` | Invoice customization options (templates, colors…). |
+| [`beel.configuration.updateLanguage(language)`](#configuration-update-language) | `PUT /v1/configuration/language` | Update the preferred language of the signed-in person. |
+| [`beel.configuration.getVerifactu()`](#configuration-get-verifactu) | `GET /v1/configuration/verifactu` | Get the VeriFactu configuration of the focused company. |
+| [`beel.configuration.updateVerifactu(body)`](#configuration-update-verifactu) | `PUT /v1/configuration/verifactu` | Update the VeriFactu configuration of the focused company. |
+
+<a id="configuration-get-tax-config"></a>
+### `getTaxConfig()`
+
+Get the tax configuration (default VAT, IRPF…) of the focused company.
+
+- **HTTP:** `GET /v1/configuration/taxes` · operation `getTaxConfiguration` · scopes `configuration:read` · **deprecated in the contract**
+- **Returns:** The tax configuration. Response `200` `data`: `TaxConfiguration`.
+- **Throws:** `401`/`403` `BeeLAuthError` · `500` `BeeLApiError`
+
+<a id="configuration-update-tax-config"></a>
+### `updateTaxConfig(body)`
+
+Replace the tax configuration of the focused company.
+
+- **HTTP:** `PUT /v1/configuration/taxes` · operation `updateTaxConfiguration` · scopes `configuration:write` · **deprecated in the contract**
+- **Parameters:**
+  - `body: any` — The complete tax configuration.
+- **Returns:** The stored configuration. Response `200` `data`: `TaxConfiguration`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `422` `BeeLValidationError`
+
+<a id="configuration-get-tax-types"></a>
+### `getTaxTypes()`
+
+Tax types the API accepts (IVA/IGIC rates, IRPF types, equivalence surcharges).
+
+- **HTTP:** `GET /v1/configuration/tax-types` · operation `getTaxTypes` · scopes `configuration:read` · **deprecated in the contract**
+- **Returns:** The tax types catalog. Response `200` `data`: `TaxTypesCatalog`.
+- **Throws:** `401`/`403` `BeeLAuthError` · `500` `BeeLApiError`
+
+<a id="configuration-get-invoice-customization-options"></a>
+### `getInvoiceCustomizationOptions()`
+
+Invoice customization options (templates, colors…).
+
+- **HTTP:** `GET /v1/configuration/invoice-customization-options` · operation `getInvoiceCustomizationOptions` · scopes `configuration:read` · **deprecated in the contract**
+- **Returns:** The customization options. Response `200` `data`: `InvoiceCustomizationOptionsResponse`.
+- **Throws:** `401`/`403` `BeeLAuthError` · `500` `BeeLApiError`
+
+<a id="configuration-update-language"></a>
+### `updateLanguage(language)`
+
+Update the preferred language of the signed-in person.
+
+- **HTTP:** `PUT /v1/configuration/language` · operation `updateLanguage` · scopes `configuration:write` · **deprecated in the contract**
+- **Parameters:**
+  - `language: string` — `es`, `en` or `ca`.
+- **Returns:** The updated preferences. Response `200` `data`: `{ language?: Language }`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `422` `BeeLValidationError`
+
+<a id="configuration-get-verifactu"></a>
+### `getVerifactu()`
+
+Get the VeriFactu configuration of the focused company.
+
+- **HTTP:** `GET /v1/configuration/verifactu` · operation `getVeriFactuConfiguration` · scopes `configuration:read` · **deprecated in the contract**
+- **Returns:** The VeriFactu configuration. Response `200` `data`: `VeriFactuConfiguration`.
+- **Throws:** `401`/`403` `BeeLAuthError` · `500` `BeeLApiError`
+
+<a id="configuration-update-verifactu"></a>
+### `updateVerifactu(body)`
+
+Update the VeriFactu configuration of the focused company.
+
+- **HTTP:** `PUT /v1/configuration/verifactu` · operation `updateVeriFactuConfiguration` · scopes `configuration:write` · **deprecated in the contract**
+- **Parameters:**
+  - `body: any` — `{ enabled }`.
+- **Returns:** The updated configuration. Response `200` `data`: `VeriFactuConfiguration`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `422` `BeeLValidationError`

package/docs/reference/customer-builder.md

@@ -0,0 +1,107 @@
+<!-- Generated by `npm run docs:reference` from the SDK source and openapi/public-api.yaml. Do not edit. -->
+
+# `CustomerBuilder`
+
+[Reference index](README.md)
+
+Fluent builder for the body of `customers.create`. It builds the request object only;
+send it with `beel.company(companyId).customers.create(builder.build())`.
+
+**Example**
+
+```typescript
+const customer = CustomerBuilder.create()
+  .name('Acme Corporation SL')
+  .nif('B12345678')
+  .email('contact@acme.com')
+  .address('Calle Mayor', '1', '28001', 'Madrid', 'Madrid', 'Spain')
+  .build();
+```
+
+## Methods
+
+| Method | HTTP | Summary |
+|---|---|---|
+| [`CustomerBuilder.create()`](#customer-builder-create) | — | Start a new builder. |
+| [`CustomerBuilder.name(name)`](#customer-builder-name) | — | Legal name of the customer. |
+| [`CustomerBuilder.nif(nif)`](#customer-builder-nif) | — | NIF/CIF of the customer. |
+| [`CustomerBuilder.email(email)`](#customer-builder-email) | — | Contact email. |
+| [`CustomerBuilder.phone(phone)`](#customer-builder-phone) | — | Contact phone: 9 to 20 characters of digits, spaces, dashes, parentheses and a leading `+`. |
+| [`CustomerBuilder.address(street, number, postalCode, city, province, country, countryCode?)`](#customer-builder-address) | — | Fiscal address. |
+| [`CustomerBuilder.notes(notes)`](#customer-builder-notes) | — | Internal notes about the customer. |
+| [`CustomerBuilder.build()`](#customer-builder-build) | — | Build the request body. |
+
+<a id="customer-builder-create"></a>
+### `create()`
+
+Start a new builder.
+
+- **Returns:** An empty customer builder.
+
+<a id="customer-builder-name"></a>
+### `name(name)`
+
+Legal name of the customer. Required.
+
+- **Parameters:**
+  - `name: string` — Legal name.
+- **Returns:** This builder.
+
+<a id="customer-builder-nif"></a>
+### `nif(nif)`
+
+NIF/CIF of the customer. Required.
+
+- **Parameters:**
+  - `nif: string` — Spanish tax id.
+- **Returns:** This builder.
+
+<a id="customer-builder-email"></a>
+### `email(email)`
+
+Contact email.
+
+- **Parameters:**
+  - `email: string` — Email address.
+- **Returns:** This builder.
+
+<a id="customer-builder-phone"></a>
+### `phone(phone)`
+
+Contact phone: 9 to 20 characters of digits, spaces, dashes, parentheses and a leading `+`.
+
+- **Parameters:**
+  - `phone: string` — Phone number.
+- **Returns:** This builder.
+
+<a id="customer-builder-address"></a>
+### `address(street, number, postalCode, city, province, country, countryCode?)`
+
+Fiscal address. Required.
+
+- **Parameters:**
+  - `street: string` — Street name.
+  - `number: string` — Street number.
+  - `postalCode: string` — Postal code.
+  - `city: string` — City.
+  - `province: string` — Province.
+  - `country: string` — Country name.
+  - `countryCode?: string` — ISO 3166-1 alpha-2 code. Default: `ES`. Default: `'ES'`.
+- **Returns:** This builder.
+
+<a id="customer-builder-notes"></a>
+### `notes(notes)`
+
+Internal notes about the customer.
+
+- **Parameters:**
+  - `notes: string` — Free text.
+- **Returns:** This builder.
+
+<a id="customer-builder-build"></a>
+### `build()`
+
+Build the request body.
+
+- **Returns:** The `CreateCustomerRequest`.
+- **Throws:** `Error` When the name, NIF or address is missing.