@beel_es/sdk 2.0.0 → 2.2.0

package/docs/reference/account.md

@@ -0,0 +1,94 @@
+<!-- Generated by `npm run docs:reference` from the SDK source and openapi/public-api.yaml. Do not edit. -->
+
+# `beel.account(accountId)` — `AccountScope`
+
+[Reference index](README.md)
+
+Operations scoped to one account: its companies (NIFs), members, invitations, webhooks
+and usage. Reach it as `beel.account(accountId)`.
+
+**Example**
+
+```typescript
+const { companies } = await beel.account('account-uuid').companies.list();
+const company = beel.company(companies[0].id!);
+```
+
+## Properties
+
+| Property | Type | Description |
+|---|---|---|
+| `members` | [`AccountMembersResource`](account-members.md) | Members of the account and their per-company grants. |
+| `invitations` | [`AccountInvitationsResource`](account-invitations.md) | Invitations to join the account. |
+| `webhooks` | [`AccountWebhooksResource`](account-webhooks.md) | Webhook subscriptions of the account. |
+| `companies` | [`AccountCompaniesResource`](account-companies.md) | Companies (NIFs) of the account — where company ids come from. |
+
+## Methods
+
+| Method | HTTP | Summary |
+|---|---|---|
+| [`beel.account(accountId).get()`](#account-get) | `GET /v1/accounts/{account_id}` | Get the account summary. |
+| [`beel.account(accountId).usage()`](#account-usage) | `GET /v1/accounts/{account_id}/usage` | Provisioning usage counters for billing: provisioned accounts and NIFs. |
+| [`beel.account(accountId).changeAccessLevel(body)`](#account-change-access-level) | `PATCH /v1/accounts/{account_id}/access-level` | Change the access level you keep over this account. |
+| [`beel.account(accountId).endManagement()`](#account-end-management) | `DELETE /v1/accounts/{account_id}/management` | End your management of this account: you lose access, and the holder keeps the account, its NIFs and its invoices. |
+| [`beel.account(accountId).createClaimToken(body?)`](#account-create-claim-token) | `POST /v1/accounts/{account_id}/claim-tokens` | Issue a single-use claim token so the account's holder can take ownership. |
+| [`beel.account(accountId).setOwner(body)`](#account-set-owner) | `PUT /v1/accounts/{account_id}/owner` | Make an existing member the account's owner. |
+
+<a id="account-get"></a>
+### `get()`
+
+Get the account summary.
+
+- **HTTP:** `GET /v1/accounts/{account_id}` · operation `getAccount` · scopes `accounts:read`
+- **Returns:** The account summary. Response `200` `data`: `ManagedAccountSummary`.
+- **Throws:** `401`/`403` `BeeLAuthError` · `429` `BeeLRateLimitError` · `500` `BeeLApiError`
+
+<a id="account-usage"></a>
+### `usage()`
+
+Provisioning usage counters for billing: provisioned accounts and NIFs.
+
+- **HTTP:** `GET /v1/accounts/{account_id}/usage` · operation `getAccountUsage` · scopes `accounts:read`
+- **Returns:** `provisioned_accounts` and `nifs`. Response `200` `data`: `ProvisioningUsage`.
+- **Throws:** `401`/`403` `BeeLAuthError` · `404` `BeeLNotFoundError` · `429` `BeeLRateLimitError` · `500` `BeeLApiError`
+
+<a id="account-change-access-level"></a>
+### `changeAccessLevel(body)`
+
+Change the access level you keep over this account. Raising it is only possible while
+the account is unclaimed.
+
+- **HTTP:** `PATCH /v1/accounts/{account_id}/access-level` · operation `changeManagedAccountAccessLevel` · scopes `accounts:write`
+- **Parameters:**
+  - `body: NonNullable<operations['changeManagedAccountAccessLevel']['requestBody']>['content']['application/json']` — The new `access_level`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `429` `BeeLRateLimitError`
+
+<a id="account-end-management"></a>
+### `endManagement()`
+
+End your management of this account: you lose access, and the holder keeps the
+account, its NIFs and its invoices.
+
+- **HTTP:** `DELETE /v1/accounts/{account_id}/management` · operation `endAccountManagement` · scopes `accounts:write`
+- **Throws:** `401`/`403` `BeeLAuthError` · `429` `BeeLRateLimitError` · `500` `BeeLApiError`
+
+<a id="account-create-claim-token"></a>
+### `createClaimToken(body?)`
+
+Issue a single-use claim token so the account's holder can take ownership.
+
+- **HTTP:** `POST /v1/accounts/{account_id}/claim-tokens` · operation `createAccountClaimToken` · scopes `accounts:write` · accepts `Idempotency-Key`
+- **Parameters:**
+  - `body?: NonNullable<operations['createAccountClaimToken']['requestBody']>['content']['application/json']` — `email` when the account has no holder yet; omit to re-issue.
+- **Returns:** `claim_token`, `claim_url` and `expires_at`. Response `201` `data`: `ClaimTokenResult`.
+- **Throws:** `401`/`403` `BeeLAuthError` · `404` `BeeLNotFoundError` · `409` `BeeLConflictError` · `422` `BeeLValidationError` · `429` `BeeLRateLimitError` · `500` `BeeLApiError`
+
+<a id="account-set-owner"></a>
+### `setOwner(body)`
+
+Make an existing member the account's owner. Repeatable: it states the desired owner.
+
+- **HTTP:** `PUT /v1/accounts/{account_id}/owner` · operation `putAccountOwner` · accepts `Idempotency-Key`
+- **Parameters:**
+  - `body: operations['putAccountOwner']['requestBody']['content']['application/json']` — The member that becomes owner.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `404` `BeeLNotFoundError` · `429` `BeeLRateLimitError`

package/docs/reference/accounts.md

@@ -0,0 +1,72 @@
+<!-- Generated by `npm run docs:reference` from the SDK source and openapi/public-api.yaml. Do not edit. -->
+
+# `beel.accounts` — `AccountsResource`
+
+[Reference index](README.md)
+
+Accounts you provisioned and manage (multi-account provisioning for platforms and
+advisory firms). Reach it as `beel.accounts`; scope one with `beel.account(accountId)`.
+
+Every method rejects with a `BeeLApiError` subclass when the API answers non-2xx.
+
+**Example**
+
+```typescript
+const { accounts } = await beel.accounts.list();
+const account = beel.accounts.scope(accounts[0].account_id);
+const members = await account.members.list();
+```
+
+## Methods
+
+| Method | HTTP | Summary |
+|---|---|---|
+| [`beel.accounts.list(params?)`](#accounts-list) | `GET /v1/accounts` | List the accounts you provisioned, newest first. |
+| [`beel.accounts.provision(body)`](#accounts-provision) | `POST /v1/accounts` | Provision a new managed account. |
+| [`beel.accounts.get(accountId)`](#accounts-get) | `GET /v1/accounts/{account_id}` | Get a managed account. |
+| [`beel.accounts.scope(accountId)`](#accounts-scope) | — | Alias of `beel.account(accountId)`: the operations scoped to one account. |
+
+<a id="accounts-list"></a>
+### `list(params?)`
+
+List the accounts you provisioned, newest first. Cursor-paginated: pass the
+`next_cursor` of one page as `cursor` of the next until it is `null`.
+
+- **HTTP:** `GET /v1/accounts` · operation `listAccounts` · scopes `accounts:read`
+- **Parameters:**
+  - `params?: operations['listAccounts']['parameters']['query']` — `status`, `external_ref` (exact), `limit`, `cursor`.
+- **Returns:** The `accounts` of the page and `next_cursor`. Response `200` `data`: `{ accounts: ManagedAccountSummary[]; next_cursor?: string | null }`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `422` `BeeLValidationError` · `429` `BeeLRateLimitError`
+
+<a id="accounts-provision"></a>
+### `provision(body)`
+
+Provision a new managed account. Idempotent by `external_ref`: sending the same one
+again returns the same account. Answers with the provisioning result — the account id,
+its status and, when one is issued, the claim link — not with the account summary.
+
+- **HTTP:** `POST /v1/accounts` · operation `provisionAccount` · scopes `accounts:write` · accepts `Idempotency-Key`
+- **Parameters:**
+  - `body: operations['provisionAccount']['requestBody']['content']['application/json']` — `external_ref` and the holder's details.
+- **Returns:** `account_id`, `status` and the claim link state. Response `201` `data`: `ProvisionAccountResult`.
+- **Throws:** `400`/`500`/`502` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `409` `BeeLConflictError` · `422` `BeeLValidationError` · `429` `BeeLRateLimitError`
+
+<a id="accounts-get"></a>
+### `get(accountId)`
+
+Get a managed account.
+
+- **HTTP:** `GET /v1/accounts/{account_id}` · operation `getAccount` · scopes `accounts:read`
+- **Parameters:**
+  - `accountId: string` — Account UUID.
+- **Returns:** The account summary. Response `200` `data`: `ManagedAccountSummary`.
+- **Throws:** `401`/`403` `BeeLAuthError` · `429` `BeeLRateLimitError` · `500` `BeeLApiError`
+
+<a id="accounts-scope"></a>
+### `scope(accountId)`
+
+Alias of `beel.account(accountId)`: the operations scoped to one account.
+
+- **Parameters:**
+  - `accountId: string` — Account UUID.
+- **Returns:** The account scope. No request is made.

package/docs/reference/catalogs.md

@@ -0,0 +1,68 @@
+<!-- Generated by `npm run docs:reference` from the SDK source and openapi/public-api.yaml. Do not edit. -->
+
+# `beel.catalogs` — `CatalogsResource`
+
+[Reference index](README.md)
+
+Account-wide catalogs, the credential's identity and personal preferences, on their
+canonical paths. Reach it as `beel.catalogs`.
+
+These replace the `/v1/configuration/*` reads on `ConfigurationResource`,
+whose flat routes are deprecated.
+
+## Methods
+
+| Method | HTTP | Summary |
+|---|---|---|
+| [`beel.catalogs.identity()`](#catalogs-identity) | `GET /v1/me/identity` | Who the API key belongs to: its `account_id` — the starting point to list the account's companies — plus the person's email, name and language, and the credential. |
+| [`beel.catalogs.taxTypes()`](#catalogs-tax-types) | `GET /v1/tax-types` | Tax types the API accepts. |
+| [`beel.catalogs.invoiceCustomizationOptions()`](#catalogs-invoice-customization-options) | `GET /v1/invoice-customization-options` | Invoice PDF templates and customization options. |
+| [`beel.catalogs.updateMe(body)`](#catalogs-update-me) | `PATCH /v1/me` | Update the signed-in person's preferences. |
+
+<a id="catalogs-identity"></a>
+### `identity()`
+
+Who the API key belongs to: its `account_id` — the starting point to list the
+account's companies — plus the person's email, name and language, and the credential.
+Needs no scope, so it also confirms that a key works.
+
+- **HTTP:** `GET /v1/me/identity` · operation `getMyIdentity`
+- **Returns:** The identity of the credential. Response `200` `data`: `MyIdentity`.
+- **Throws:** `401`/`403` `BeeLAuthError` · `429` `BeeLRateLimitError` · `500` `BeeLApiError`
+
+**Example**
+
+```typescript
+const { account_id } = await beel.catalogs.identity();
+const { companies } = await beel.account(account_id).companies.list();
+```
+
+<a id="catalogs-tax-types"></a>
+### `taxTypes()`
+
+Tax types the API accepts. Canonical form of `configuration/tax-types`.
+
+- **HTTP:** `GET /v1/tax-types` · operation `listTaxTypes` · scopes `configuration:read`
+- **Returns:** The tax types catalog. Response `200` `data`: `TaxTypesCatalog`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `429` `BeeLRateLimitError`
+
+<a id="catalogs-invoice-customization-options"></a>
+### `invoiceCustomizationOptions()`
+
+Invoice PDF templates and customization options. Canonical form of the `configuration` read.
+
+- **HTTP:** `GET /v1/invoice-customization-options` · operation `listInvoiceCustomizationOptions` · scopes `configuration:read`
+- **Returns:** The customization options. Response `200` `data`: `InvoiceCustomizationOptionsResponse`.
+- **Throws:** `401`/`403` `BeeLAuthError` · `429` `BeeLRateLimitError` · `500` `BeeLApiError`
+
+<a id="catalogs-update-me"></a>
+### `updateMe(body)`
+
+Update the signed-in person's preferences. Canonical form of
+`PUT /v1/configuration/language`: the language belongs to the person, not to a company.
+
+- **HTTP:** `PATCH /v1/me` · operation `updateMe` · scopes `configuration:write`
+- **Parameters:**
+  - `body: components['schemas']['UpdateMeRequest']` — Preferences to change, e.g. `{ language: 'es' }`.
+- **Returns:** The updated preferences. Response `200` `data`: `MyPreferences`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `422` `BeeLValidationError` · `429` `BeeLRateLimitError`

package/docs/reference/client.md

@@ -0,0 +1,113 @@
+<!-- Generated by `npm run docs:reference` from the SDK source and openapi/public-api.yaml. Do not edit. -->
+
+# `beel` — `BeeL`
+
+[Reference index](README.md)
+
+The BeeL API client. Create one per API key and reuse it; it holds no global state.
+Address a company with `company` and an account with `account`.
+
+Requests are retried automatically when it is safe — see `BeeLConfig` — and every `POST`
+carries an `Idempotency-Key` that those retries reuse.
+
+**Example**
+
+```typescript
+import { BeeL } from '@beel_es/sdk';
+
+const beel = new BeeL({ apiKey: process.env.BEEL_API_KEY! });
+
+const invoice = await beel.company('company-uuid').invoices.create({
+  type: 'STANDARD',
+  recipient: { customer_id: 'customer-uuid' },
+  lines: [{
+    description: 'Service', quantity: 1, unit_price: 100,
+    main_tax: { type: 'IVA', percentage: 21, regime_key: '01' },
+  }],
+});
+```
+
+## Constructor
+
+```typescript
+new BeeL(config: BeeLConfig)
+```
+
+`config` is a [`BeeLConfig`](types.md#beelconfig).
+
+## Properties
+
+| Property | Type | Description |
+|---|---|---|
+| `invoices` | [`InvoicesResource`](invoices.md) | **Deprecated.** Session-focus endpoints are deprecated in the API contract. |
+| `customers` | [`CustomersResource`](customers.md) | **Deprecated.** Session-focus endpoints are deprecated in the API contract. |
+| `products` | [`ProductsResource`](products.md) | **Deprecated.** Session-focus endpoints are deprecated in the API contract. |
+| `configuration` | [`ConfigurationResource`](configuration.md) | **Deprecated.** Session-focus configuration endpoints are deprecated in the API contract. |
+| `series` | [`SeriesResource`](series.md) | **Deprecated.** Session-focus endpoints are deprecated in the API contract. |
+| `catalogs` | [`CatalogsResource`](catalogs.md) | Account-wide catalogs, the credential's identity and personal preferences. |
+| `nif` | [`NifResource`](nif.md) | NIF validation against the AEAT register. |
+| `accounts` | [`AccountsResource`](accounts.md) | Accounts you manage (multi-account provisioning: members, invitations, webhooks, companies). |
+| `raw` | `ReturnType<typeof createBeeLClient>` | The typed client underneath, for any endpoint this SDK does not wrap yet. |
+
+## Methods
+
+| Method | HTTP | Summary |
+|---|---|---|
+| [`beel.company(companyId)`](#client-company) | — | Returns a facade scoped to one company (NIF) — the explicit multi-NIF surface. |
+| [`beel.account(accountId)`](#client-account) | — | Returns a facade scoped to one account — companies, members, invitations, account webhooks, usage. |
+| [`beel.downloadPdf(invoiceId)`](#client-download-pdf) | — | **Deprecated.** Download an invoice PDF as a Buffer. |
+
+<a id="client-company"></a>
+### `company(companyId)`
+
+Returns a facade scoped to one company (NIF) — the explicit multi-NIF surface.
+All operations address the company in the path, no session focus needed. No request
+is made; get the ids from `beel.account(accountId).companies.list()`.
+
+- **Parameters:**
+  - `companyId: string` — Company UUID (not its NIF).
+- **Returns:** The company scope.
+
+**Example**
+
+```typescript
+const company = beel.company('company-uuid');
+const { invoices } = await company.invoices.list({ status: 'ISSUED' });
+```
+
+<a id="client-account"></a>
+### `account(accountId)`
+
+Returns a facade scoped to one account — companies, members, invitations, account
+webhooks, usage. Symmetric with `company`. No request is made; your own account
+id is `(await beel.catalogs.identity()).account_id`.
+
+- **Parameters:**
+  - `accountId: string` — Account UUID.
+- **Returns:** The account scope.
+
+**Example**
+
+```typescript
+const account = beel.account('account-uuid');
+const members = await account.members.list();
+```
+
+<a id="client-download-pdf"></a>
+### `downloadPdf(invoiceId)`
+
+> **Deprecated.** Relies on the deprecated session-focus PDF endpoint. Use `beel.company(companyId).invoices.getPdf(invoiceId)` and fetch `download_url` instead.
+
+Download an invoice PDF as a Buffer.
+
+- **Parameters:**
+  - `invoiceId: string` — Invoice UUID.
+- **Returns:** The PDF bytes and its file name.
+- **Throws:** `Error` When downloading the file fails.
+
+**Example**
+
+```typescript
+const { buffer, fileName } = await beel.downloadPdf('invoice-uuid');
+fs.writeFileSync(fileName, buffer);
+```

package/docs/reference/company-customers.md

@@ -0,0 +1,85 @@
+<!-- Generated by `npm run docs:reference` from the SDK source and openapi/public-api.yaml. Do not edit. -->
+
+# `beel.company(companyId).customers` — `CompanyCustomersResource`
+
+[Reference index](README.md)
+
+Customers of one company. Reach it as `beel.company(companyId).customers`.
+
+## Methods
+
+| Method | HTTP | Summary |
+|---|---|---|
+| [`beel.company(companyId).customers.list(params?)`](#company-customers-list) | `GET /v1/companies/{company_id}/customers` | List the company's customers, paginated and searchable. |
+| [`beel.company(companyId).customers.create(body)`](#company-customers-create) | `POST /v1/companies/{company_id}/customers` | Create a customer. |
+| [`beel.company(companyId).customers.createBulk(body)`](#company-customers-create-bulk) | `POST /v1/companies/{company_id}/customers/bulk` | Create several customers in one call. |
+| [`beel.company(companyId).customers.get(customerId)`](#company-customers-get) | `GET /v1/companies/{company_id}/customers/{customer_id}` | Get one customer. |
+| [`beel.company(companyId).customers.update(customerId, body)`](#company-customers-update) | `PATCH /v1/companies/{company_id}/customers/{customer_id}` | Update a customer. |
+| [`beel.company(companyId).customers.delete(customerId)`](#company-customers-delete) | `DELETE /v1/companies/{company_id}/customers/{customer_id}` | Delete a customer that has no invoices. |
+
+<a id="company-customers-list"></a>
+### `list(params?)`
+
+List the company's customers, paginated and searchable.
+
+- **HTTP:** `GET /v1/companies/{company_id}/customers` · operation `listCompanyCustomers` · scopes `customers:read`
+- **Parameters:**
+  - `params?: operations['listCompanyCustomers']['parameters']['query']` — Filters and pagination.
+- **Returns:** The page of `customers` and its `pagination`. Response `200` `data`: `{ customers: Customer[]; pagination: Pagination }`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `422` `BeeLValidationError` · `429` `BeeLRateLimitError`
+
+<a id="company-customers-create"></a>
+### `create(body)`
+
+Create a customer.
+
+- **HTTP:** `POST /v1/companies/{company_id}/customers` · operation `createCompanyCustomer` · scopes `customers:write` · accepts `Idempotency-Key`
+- **Parameters:**
+  - `body: components['schemas']['CreateCustomerRequest']` — Legal name, NIF (or alternative id) and address.
+- **Returns:** The created customer. Response `201` `data`: `Customer`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `409` `BeeLConflictError` · `422` `BeeLValidationError` · `429` `BeeLRateLimitError`
+
+<a id="company-customers-create-bulk"></a>
+### `createBulk(body)`
+
+Create several customers in one call.
+
+- **HTTP:** `POST /v1/companies/{company_id}/customers/bulk` · operation `createCompanyCustomersBulk` · scopes `customers:write` · accepts `Idempotency-Key`
+- **Parameters:**
+  - `body: operations['createCompanyCustomersBulk']['requestBody']['content']['application/json']` — The customers, and whether it is a dry run.
+- **Returns:** Per-customer results and totals. Response `200` `data`: `CustomerValidationUnifiedResult`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `409` `BeeLConflictError` · `422` `BeeLValidationError` · `429` `BeeLRateLimitError`
+
+<a id="company-customers-get"></a>
+### `get(customerId)`
+
+Get one customer.
+
+- **HTTP:** `GET /v1/companies/{company_id}/customers/{customer_id}` · operation `getCompanyCustomer` · scopes `customers:read`
+- **Parameters:**
+  - `customerId: string` — Customer UUID.
+- **Returns:** The customer. Response `200` `data`: `Customer`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `404` `BeeLNotFoundError` · `429` `BeeLRateLimitError`
+
+<a id="company-customers-update"></a>
+### `update(customerId, body)`
+
+Update a customer. Only the fields present in `body` change.
+
+- **HTTP:** `PATCH /v1/companies/{company_id}/customers/{customer_id}` · operation `patchCompanyCustomer` · scopes `customers:write`
+- **Parameters:**
+  - `customerId: string` — Customer UUID.
+  - `body: operations['patchCompanyCustomer']['requestBody']['content']['application/json']` — Fields to change.
+- **Returns:** The updated customer. Response `200` `data`: `Customer`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `404` `BeeLNotFoundError` · `409` `BeeLConflictError` · `422` `BeeLValidationError` · `429` `BeeLRateLimitError`
+
+<a id="company-customers-delete"></a>
+### `delete(customerId)`
+
+Delete a customer that has no invoices. Its NIF (or alternative id) is released for a
+new customer.
+
+- **HTTP:** `DELETE /v1/companies/{company_id}/customers/{customer_id}` · operation `deleteCompanyCustomer` · scopes `customers:write`
+- **Parameters:**
+  - `customerId: string` — Customer UUID.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `404` `BeeLNotFoundError` · `409` `BeeLConflictError` · `429` `BeeLRateLimitError`

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

@@ -0,0 +1,52 @@
+<!-- Generated by `npm run docs:reference` from the SDK source and openapi/public-api.yaml. Do not edit. -->
+
+# `beel.company(companyId).invoices.schedule` — `CompanyInvoiceScheduleResource`
+
+[Reference index](README.md)
+
+Scheduled issuing of one invoice: read it, set it, clear it. Reach it as
+`beel.company(companyId).invoices.schedule`.
+
+## Methods
+
+| Method | HTTP | Summary |
+|---|---|---|
+| [`beel.company(companyId).invoices.schedule.get(invoiceId)`](#company-invoices-schedule-get) | `GET /v1/companies/{company_id}/invoices/{invoice_id}/schedule` | Get the schedule of an invoice. |
+| [`beel.company(companyId).invoices.schedule.set(invoiceId, body)`](#company-invoices-schedule-set) | `PUT /v1/companies/{company_id}/invoices/{invoice_id}/schedule` | Set or move the schedule. |
+| [`beel.company(companyId).invoices.schedule.clear(invoiceId)`](#company-invoices-schedule-clear) | `DELETE /v1/companies/{company_id}/invoices/{invoice_id}/schedule` | Clear the schedule, returning the invoice to a plain draft — the canonical form of `unschedule`. |
+
+<a id="company-invoices-schedule-get"></a>
+### `get(invoiceId)`
+
+Get the schedule of an invoice.
+
+- **HTTP:** `GET /v1/companies/{company_id}/invoices/{invoice_id}/schedule` · operation `getCompanyInvoiceSchedule` · scopes `invoices:read`
+- **Parameters:**
+  - `invoiceId: string` — Invoice UUID.
+- **Returns:** `scheduled_for` and `generation_mode`. Response `200` `data`: `InvoiceSchedule`.
+- **Throws:** `401`/`403` `BeeLAuthError` · `404` `BeeLNotFoundError` · `429` `BeeLRateLimitError` · `500` `BeeLApiError`
+
+<a id="company-invoices-schedule-set"></a>
+### `set(invoiceId, body)`
+
+Set or move the schedule. One `PUT` replaces the three legacy calls
+(`schedule`, `reschedule`, `unschedule`): setting it again moves it.
+
+- **HTTP:** `PUT /v1/companies/{company_id}/invoices/{invoice_id}/schedule` · operation `setCompanyInvoiceSchedule` · scopes `invoices:write` · accepts `Idempotency-Key`
+- **Parameters:**
+  - `invoiceId: string` — UUID of a draft invoice.
+  - `body: components['schemas']['SetInvoiceScheduleRequest']` — `scheduled_for` date and what to do then.
+- **Returns:** The scheduled invoice. Response `200` `data`: `Invoice`.
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `404` `BeeLNotFoundError` · `409` `BeeLConflictError` · `422` `BeeLValidationError` · `429` `BeeLRateLimitError`
+
+<a id="company-invoices-schedule-clear"></a>
+### `clear(invoiceId)`
+
+Clear the schedule, returning the invoice to a plain draft — the canonical form of
+`unschedule`. Idempotent.
+
+- **HTTP:** `DELETE /v1/companies/{company_id}/invoices/{invoice_id}/schedule` · operation `deleteCompanyInvoiceSchedule` · scopes `invoices:write` · accepts `Idempotency-Key`
+- **Parameters:**
+  - `invoiceId: string` — Invoice UUID.
+- **Returns:** `Promise<void>`
+- **Throws:** `400`/`500` `BeeLApiError` · `401`/`403` `BeeLAuthError` · `404` `BeeLNotFoundError` · `429` `BeeLRateLimitError`