Invoices
High-level description
Section titled “High-level description”Invoice content combines a document with payment metadata. Use the common payload below for every invoice, then choose the subtype that matches the reason for payment.
Sub-types
Section titled “Sub-types”| Type | Description | Retained delivery |
|---|---|---|
invoice |
Standard invoice for goods or services. | Not supported |
invoice.reminder |
Reminder for an invoice that has not been paid. | Not supported |
invoice.debtcampaign |
Invoice or payment plan from a debt collection company. | Not supported |
invoice.renewal |
Offer to renew a subscription, insurance policy, or similar service. | Not supported |
invoice.debtcollection |
Debt collection claim (inkassokrav). | Not supported |
invoice.donation |
Optional donation request. | Not supported |
invoice.paymentnotice |
Payment notice for a membership organisation. | Not supported |
Common payload
Section titled “Common payload”Every invoice request needs a recipient identifier, subject, type, and
usually one or more PDF parts. Invoice requests also must have a valid
payment_multiple_options object.
| Field | Purpose |
|---|---|
ssn, email, or vat_number |
Identifies the person or company recipient |
subject |
Short inbox title; never include personal or sensitive information |
type |
Selects the invoice subtype |
parts |
Contains the complete invoice as a PDF |
generated_at |
Optional timestamp used for inbox sorting |
payment_multiple_options |
Defines the amount, account, due date, currency, and payment reference |
retain and retention_time |
Not supported for invoice content |
Payment payload
Section titled “Payment payload”Set payment_multiple_options.payable to true if the invoice should be
payable through Kivra, and provide at least one payment option. The payment
account, currency, due date, and reference are shown in Kivra so the recipient
can pay without re-entering the details. Each fixed option includes a due date,
amount, reference type, and reference value. You can add a flexible option when
the recipient may choose the amount.
{ "ssn": "YYYYMMDDNNNN", "subject": "Invoice for March", "type": "invoice", "parts": [ { "name": "invoice.pdf", "content_type": "application/pdf", "data": "BASE64_ENCODED_PDF" } ], "payment_multiple_options": { "payable": true, "account": "1234-5678", "method": "1", "currency": "SEK", "options": [ { "due_date": "2026-11-30", "amount": "1250.00", "type": "SE_OCR", "reference": "426523791" } ] }}Other information
Section titled “Other information”Invoice notifications use the due date in the first payment option. Clients without support for multiple options display only that first option.
See Payment options for payment options and limits, and Payment webhooks for payment events.