CompanyInvoiceDelivery

Send several invoices in one email

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.
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

Headers

Idempotency-Keystring

Idempotency key to prevent duplicates in sensitive operations.

  • Any unique client-generated string (e.g. an order id). A UUID also works but is not required
  • Allowed characters: letters, digits, _ and - (max 255 chars)
  • Retrying with the same key replays the first response when it was a success (2xx) or a server error (5xx): same status and body, plus the header Idempotency-Replay: true. After a 5xx, check whether the operation took effect before retrying with a new key
  • A 4xx is not stored: the key is released, so the corrected request can reuse it
  • Stored responses expire 24 hours after processing

The key is scoped per user and environment, and bound to the request body, so retrying after a network timeout replays the stored response instead of repeating the operation.

StatusCodeWhen
400INVALID_IDEMPOTENCY_KEYThe key breaks the format rules above.
409IDEMPOTENCY_KEY_PROCESSINGThe first request is still in flight. Wait for the Retry-After seconds (2) and retry with the same key.
409IDEMPOTENCY_KEY_MISMATCHThe key was already used with a different body. Use a new key.

Request body

invoice_idsUUID[] required
recipientsEmail[] required

Email recipients. At least one is required: no address is inferred from any profile.

ccEmail[]

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.

subjectstring

Custom email subject. Defaults to the standard template.

messagestring

Custom message body. Defaults to the standard template.

language'es' | 'en' | 'ca'

Supported languages: es Spanish, en English, ca Catalan.

Example request

{
  "invoice_ids": [
    "550e8400-e29b-41d4-a716-446655440000"
  ],
  "recipients": [
    "user@example.com"
  ],
  "cc": [
    "user@example.com"
  ],
  "language": "es"
}

Response

Email sent successfully

successboolean required

Example response

{
  "success": true,
  "data": {
    "email_id": "550e8400-e29b-41d4-a716-446655440000",
    "sent_to": [
      "user@example.com"
    ],
    "failures": [
      {
        "invoice_id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ]
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.