invoicing

List Invoices

List caller-org invoices with optional filters + pagination.

get/api/v1/invoices

Request

  • Base URL: https://app.kaminari.ad
  • URL: https://app.kaminari.ad/api/v1/invoices
  • Auth: HTTP bearer

Query parameters

type'proforma' | 'final'

Kind of invoice. Drives numbering sequence prefix + workflow.

  • PROFORMA — the single document for every top-up (bank + crypto). Issued up front (status=ISSUED); on settlement it flips to PAID and the paid proforma IS the receipt. Carries no VAT line per the EU/Cyprus deposit-on-account rationale. Number prefix PF-.
  • FINAL — end-of-period statement. For PREPAID orgs it is informational (status=PAID on issue). For POSTPAID orgs it is the bill and remains ISSUED until payment confirmation. Number prefix IN-.
status'draft' | 'issued' | 'paid' | 'voided' | 'overdue'

Lifecycle states of an :class:Invoice.

Transitions:

  • DRAFT → ISSUED (on issuance; PDF render follows)
  • ISSUED → PAID (on admin payment confirmation or gateway webhook)
  • ISSUED → VOIDED (admin void with reason)
  • ISSUED → OVERDUE (scheduled: past due-date, still unpaid)
organization_idstring uuid nullable
pageinteger
limitinteger

Response

Successful Response

totalinteger required
pageinteger required
limitinteger required
pagesinteger required

Changes

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