CAcausaprima

Generate a compliant e-invoice

Changed on

Anonymous endpoint. Rate-limited per source IP. Returns 201 with a download URL.

post/api/v1/invoices

Request

Headers

Idempotency-Keystring

Client-supplied key. Replaying the same key with identical inputs returns the cached invoice; replaying with different inputs returns 422 idempotency_key_mismatch.

X-Email-Verification-Tokenstring

Email-ownership token from POST /api/v1/scribo/email-verifications/{id}/redeem. Required for the first invoice per sender email — without it (or a scribo session cookie) an unverified sender receives 401 email_verification_required.

Request body

currencystring required
jurisdictionstring nullable
format_override'zugferd_comfort' | 'zugferd_basic' | 'xrechnung_cii' | 'xrechnung_ubl' | 'plain_pdf'
notesstring
invoice_numberstring nullable

Optional invoice number printed on the document (BT-1). Omit the field entirely to have the server assign one — do NOT send a placeholder like "auto", "TBD", or "N/A" (these are ignored and a real code is assigned). When present: 1-64 chars of letters, digits, space, or - / . # _.

issue_datestring

Optional ISO date (BT-2) — the invoice's issue date. Defaults to today when omitted.

due_datestring
payment_termsstring nullable
delivery_datestring

Response

Invoice generated and persisted

invoice_idstring uuid required
document_idstring uuid required
format'zugferd_comfort' | 'zugferd_basic' | 'xrechnung_cii' | 'xrechnung_ubl' | 'plain_pdf' required
download_urlstring uri required
download_url_expires_atstring date-time required
preview_urlstring uri
preview_url_expires_atstring date-time
magic_link_sentboolean required
recipient_email_sentboolean

Changes

  • 26d0ac79c526Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 094108698039Revision changes
    • warning

      added the new intercompany_business_partner enum value to the // response property for the response status