List invoices for a month. (+Read access required)

Lists invoice summaries for a given month with pagination. Returns only the latest revision per invoice base. Pass invoiceBaseId to get all revisions for a specific invoice. (+PAY access required)

BETA: This invoice feature is in beta. Generated invoices should be reviewed manually or verified with a tax advisor before use. Use at your own risk.

get/invoice/monthly

Request

Base URL: ./../api/v1/ (relative, and the document was published on a file host, not at the API’s origin)
URL: ./../api/v1/invoice/monthly
Auth: API key in header token

Query parameters

monthstring required

Target month in format YYYY-MM (UTC calendar)

cursorIdstring

Cursor for pagination (InvoiceBase id)

limitnumber

Number of results to return

invoiceBaseIdstring

When provided, return all revisions for this specific invoice base (ignores pagination)

Response

List of invoice summaries

statusstring required

Example response

{
  "status": "Success",
  "data": {
    "Invoices": [
      {
        "id": "invoice_base_id",
        "invoiceId": "INV-0001",
        "createdAt": "2025-09-30T23:59:59.000Z",
        "revisionId": "revision_id",
        "revisionNumber": 0,
        "revisionCount": 1,
        "invoiceMonth": 9,
        "invoiceYear": 2025,
        "invoiceDate": "2025-09-30T00:00:00.000Z",
        "currencyShortId": "usd",
        "sellerName": "Alice",
        "sellerCompanyName": "Alice GmbH",
        "buyerName": "Bob",
        "buyerCompanyName": null,
        "isCancelled": false,
        "cancellationReason": null,
        "cancellationDate": null,
        "cancellationId": null,
        "itemCount": 3,
        "netTotal": "150.00",
        "vatTotal": "28.50",
        "grossTotal": "178.50",
        "CoveredPaymentRequestIds": [
          "payment_id_1",
          "payment_id_2"
        ],
        "buyerWalletVkey": "buyer_wallet_vkey",
        "invoicePdf": "BASE64_PDF_STRING",
        "cancellationInvoicePdf": null
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 50 revisions of this API.