CompanyBranding

Update the invoice customization of a company

Updates how the invoices of a company are rendered and delivered: PDF template, accent colour, invoice language and email language. Only the properties present in the request body are modified, and the logo is managed through the logo sub-resource.

The change applies to invoices rendered after it and does not alter already issued documents.

put/v1/companies/{company_id}/invoice-customization

Request

  • Base URL: https://app.beel.es/api
  • URL: https://app.beel.es/api/v1/companies/{company_id}/invoice-customization
  • 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_template_type'MODERN_TABLE' | 'PROFESSIONAL_SERVICE'

Invoice PDF template. MODERN_TABLE is a structured table layout for product/service lines; PROFESSIONAL_SERVICE is a text-based layout.

invoice_accent_colorstring

Accent colour applied to the invoice PDF, in #RRGGBB format.

invoice_language'es' | 'en' | 'ca' nullable

Language used to render the invoice PDF.

email_language'es' | 'en' | 'ca' nullable

Language used for the emails that deliver the invoice.

Example request

{
  "invoice_template_type": "MODERN_TABLE",
  "invoice_accent_color": "#fc481d",
  "invoice_language": "es",
  "email_language": "es"
}

Response

Invoice customization updated

successboolean required

Example response

{
  "success": true,
  "data": {
    "invoice_template_type": "MODERN_TABLE",
    "invoice_accent_color": "#fc481d",
    "invoice_language": "es",
    "email_language": "es"
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}

Changes

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