BillMore API (1.0.0)

Returns the API health status. Requires a valid API key.

Returns the document usage and quota for the authenticated company's current billing period. When the plan has unlimited documents, maxDocuments and remainingDocuments are null and unlimitedDocuments is true.

Returns the company details and settings for the authenticated company. Includes identity, address, legal, payment, and tax configuration.

Returns a paginated list of documents for the authenticated company. Supports filtering by document type, date range, status flags, and client, plus configurable sorting.

Date-range filters operate on the document date field and are interpreted in the company's local timezone.

Creates a new document with automatic PDF generation. The document number can be provided or auto-generated based on company settings. A PDF is generated using the company's default layout and uploaded to storage.

For exportType: factur-x and exportType: xrechnung, the e-invoicing artifact is generated on every save, regardless of the finalized flag, and validated. The request fails with 422 if validation fails. To save a draft without e-invoice validation, use exportType: pdf and switch to factur-x / xrechnung later.

Prerequisites for exportType: factur-x:

• Your company profile must have a countryCode.
• The client must have name and countryCode.

Prerequisites for exportType: xrechnung:

• Your company profile must have a countryCode.
• The client must have name, countryCode, email, and clientNumber.
• priceLayout: gross is not supported.

Returns a single document with all fields and computed totals.

Partially updates a document. All fields are optional. Three permission tiers apply based on the document state:

Not finalized — all content and status fields can be updated. The document can also be finalized by passing finalized: true.

Finalized (not cancelled) — only status fields: paid, paidDate, paidNotes, sent, sentDate, sentNotes, customStatus, customStatusDate, customStatusName, customStatusNotes.

Finalized and cancelled — only customStatus, customStatusDate, customStatusName, customStatusNotes.

Immutable fields (type, number, currency) cannot be changed. Cancellation uses a dedicated future endpoint.

When content fields change, the PDF is automatically regenerated. When a status boolean (paid/sent/customStatus) is set to true without a corresponding date, today's date is used. Setting it to false unsets the date and notes.

Deletes a document. Finalized documents cannot be deleted. An audit log entry is created with a snapshot of the deleted document.

Sends a document by email to the given recipient with the document's PDF attached. Documents can be sent in any state (drafts and finalized).

On success, the document is automatically marked as sent unless it was already sent or is cancelled.

Each company has a daily email quota.

Requires the API key to carry the email:send permission.

Cancels a finalized invoice (Stornorechnung). The original document is updated in place — cancelled becomes true, cancelledDate is server-set to the current timestamp, and the optional cancellationReason is stored.

A separate cancellation artifact (PDF, Factur-X PDF/A-3, or XRechnung XML — driven by the original document's exportType) is generated. Validation rules:

• Only invoices (type: invoice) can be cancelled.
• The invoice must be finalized: true.
• The invoice must not already be cancelled.

For factur-x and xrechnung documents the same e-invoice validation that applies to document creation runs against the cancellation artifact. Validation failures return 422.

Download the generated cancellation artifact via GET /documents/{id}/cancellation/pdf (PDF / Factur-X) or GET /documents/{id}/cancellation/xml (XRechnung).

Returns the PDF for a document as a binary response.

Use ?disposition=inline to render the PDF inline in a browser (default is attachment which forces a download).

For cancelled invoices, the cancellation PDF lives at GET /documents/{id}/cancellation/pdf.

Returns the standalone XRechnung (UBL Invoice) XML for a document as a text response.

Only available for documents created with exportType: 'xrechnung'. For Factur-X documents the XML is embedded in the PDF — use GET /documents/{id}/pdf instead.

For cancelled invoices, the cancellation XRechnung XML lives at GET /documents/{id}/cancellation/xml.

Returns the cancellation-invoice PDF (Stornorechnung) for a cancelled invoice as a binary response.

The cancellation PDF is a separate artifact, generated by POST /documents/{id}/cancel. Only available for invoices that have already been cancelled (cancelled: true).

Use ?disposition=inline to render the PDF inline in a browser (default is attachment which forces a download).

Returns the standalone XRechnung (UBL Invoice) XML for a cancelled invoice as a text response.

The cancellation XML is a separate artifact, generated by POST /documents/{id}/cancel. Only available for cancelled invoices that were created with exportType: 'xrechnung'.

Use ?disposition=inline to render the XML inline in a browser.

Returns a paginated list of contacts (clients) for the authenticated company. Results are sorted by createdAt descending and include a lightweight subset of fields.

Creates a new contact (client) for the authenticated company. The name field is required. All other fields are optional.

If clientNumber is provided, it must be unique across the company's contacts. The API does not auto-generate a clientNumber.

Returns a single contact with all fields.

Partially updates a contact. All fields are optional. If clientNumber is changed, it must remain unique across the company's contacts.

Immutable fields (id, type, createdAt, updatedAt) cannot be changed.

Permanently deletes a contact. An audit log entry is recorded. Existing documents that reference the contact retain their embedded client snapshot and are not affected.

Returns a paginated list of products for the authenticated company. Results are sorted by createdAt descending and include a lightweight subset of fields.

Creates a new product for the authenticated company. The title field is required. All other fields are optional.

Either netPrice or grossPrice may be provided (not both). If grossPrice is provided, vatRate is required and the API will compute and store the netPrice. grossPrice is never stored or returned.

Returns a single product with all fields.

Partially updates a product. All fields are optional.

Either netPrice or grossPrice may be provided (not both). If grossPrice is provided without vatRate in the same body, the product's currently stored vatRate will be used for the net-price conversion.

Immutable fields (id, createdAt, updatedAt) cannot be changed.

Permanently deletes a product. An audit log entry is recorded. Existing documents that reference the product retain their line snapshots and are not affected.