--- title: "Send several invoices in one email" method: POST path: "/v1/companies/{company_id}/invoices/deliveries" tags: ["CompanyInvoiceDelivery"] --- # Send several invoices in one email `POST /v1/companies/{company_id}/invoices/deliveries` ## Request - Base URL: `https://app.beel.es/api` - URL: `https://app.beel.es/api/v1/companies/{company_id}/invoices/deliveries` - Auth: HTTP bearer Sends one email carrying the PDFs of several invoices of this company as attachments. - **`recipients`:** required, and must carry at least one address; no address is inferred from any profile. - **Limit:** up to 200 invoices per message (`invoice_ids`). - **Failures:** invoices whose PDF cannot be attached are reported in `failures`, and the message is still sent with the rest. ## Headers - `Idempotency-Key` string ## Request body - CreateInvoiceDeliveryRequest: One email delivery carrying several invoices of this company as attachments. - `invoice_ids` UUID[], required - `recipients` Email[], required: Email recipients. At least one is required: no address is inferred from any profile. - `cc` Email[]: CC recipients. Copied addresses count as recipients of the message: they are subject to the same sending restrictions and to the same quota as the addresses in `recipients`. When omitted, the CC addresses configured in the sender's email defaults apply; send an empty array to deliver the message without any copy. - `subject` string: Custom email subject. Defaults to the standard template. - `message` string: Custom message body. Defaults to the standard template. - `language` 'es' | 'en' | 'ca': Supported languages: `es` Spanish, `en` English, `ca` Catalan. ## Response `200` Email sent successfully - object: The envelope every successful JSON response of the BeeL. API is wrapped in. There are no bare resources in v1 and none are planned: the payload always hangs off `data`. - A **single resource** is an object in `data`. - A **collection** hangs off a named key inside `data`, together with its `pagination`, also inside `data` — `data: {invoices: [...], pagination: {...}}`. - A collection carries `pagination` unless its operation declares itself a **closed catalogue**: a fixed, bounded list with nothing to page through. The declaration is explicit in the operation; a missing `pagination` is never something to infer. - `GET /v1/accounts` pages by cursor (`data: {accounts: [...], next_cursor}`). It is a documented variant of pagination, not another envelope. Putting the array straight into `data` with `pagination` as its sibling is the shape a v2 would adopt; v1 is not being flipped to it. - `success` boolean, required - `data` object, required: The payload. An object for a single resource; an object holding the named collection (and its `pagination`) for a listing. Never a bare array at this level in v1. - `email_id` string, uuid, required: Universally Unique Identifier (UUID v4) - `sent_to` Email[], required - `sent_at` string, date-time, required - `total_invoices` integer, required: Total number of requested invoices - `invoices_attached` integer, required: Number of PDFs successfully attached - `failures` object[]: List of invoices that could not be attached - `invoice_id` string, uuid: Universally Unique Identifier (UUID v4) - `error_code` 'NOT_FOUND' | 'PDF_NOT_GENERATED' | 'INVALID_STATE' | 'INTERNAL_ERROR' - `error_message` string - `meta` ResponseMeta - `timestamp` string, date-time - `request_id` string ## Other responses - `400`: No valid invoices to send or no recipients specified Other `error.code` values with this status: - `BULK_EMAIL_NO_VALID_INVOICES` — none of the requested invoices could be attached (not found, draft or scheduled, or PDF not generated yet); nothing was sent. Fix them and retry. - `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, or does not hold the required access over it. A NIF that does not exist answers the same way. That case answers `error.code` `ACTIVE_COMPANY_NOT_ACCESSIBLE`. - `422`: `VALIDATION_ERROR` — the body parses but a value is not acceptable. `details` is a flat map from the offending property's name (in the contract's `snake_case`, nested paths joined with a dot, e.g. `recipient.address.postal_code`) to a message describing what is wrong with it, one entry per property. When the rejected value is one outside an enum's vocabulary, `details` instead follows `FieldDeserializationError` (`field`, `invalid_value`, `allowed_values`). Two more codes share this status for a value that passes the contract but does not fit where it is stored: `VALUE_TOO_LONG` (a text longer than its column holds) and `VALUE_OUT_OF_RANGE` (a number outside what its column holds). Nothing was written. - `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)