Sign in
invoice

Generate a monthly invoice PDF without signature verification. (+PAY access required)

Generates an invoice PDF aggregating all payment requests for a buyer wallet within a month, without requiring buyer wallet signature verification. (+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 discretion.

post/invoice/monthly/internal

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/internal
  • Auth: API key in header token

Request body

buyerWalletVkeystring required

The buyer wallet vkey to aggregate the month for

sellerWalletVkeystring

Optional seller wallet vkey to scope the invoice to a specific seller

monthstring required

Target month in format YYYY-MM (UTC calendar)

invoiceCurrency'usd' | 'eur' | 'gbp' | 'jpy' | 'chf' | 'aed' required

The currency of the invoice

CurrencyConversionobject

Currency conversion settings by unit for this invoice

vatRatenumber

The VAT rate as decimal (e.g., 0.19 for 19%)

reverseChargeboolean

Enable reverse charge (VAT = 0, notice on invoice)

forceRegenerateboolean

Force cancel existing invoice and generate a new revision, even if no data changes detected

Example request

{
  "buyerWalletVkey": "buyer_wallet_vkey",
  "month": "2025-09",
  "invoiceCurrency": "usd",
  "CurrencyConversion": {
    "": 0.45,
    "policyIdAssetHex": 1.23
  },
  "Invoice": {
    "itemNamePrefix": "Agent: ",
    "title": "Monthly Invoice",
    "language": "en-us",
    "localizationFormat": "en-us"
  },
  "vatRate": 0.19,
  "reverseCharge": false,
  "forceRegenerate": false,
  "Seller": {
    "country": "DE",
    "city": "Berlin",
    "zipCode": "10115",
    "street": "Example Str.",
    "streetNumber": "1",
    "email": "seller@example.com",
    "phone": "+49 30 123456",
    "name": "Alice",
    "companyName": "Alice GmbH",
    "vatNumber": "DE123456789"
  },
  "Buyer": {
    "country": "DE",
    "city": "Berlin",
    "zipCode": "10115",
    "street": "Buyer Str.",
    "streetNumber": "2",
    "email": "buyer@example.com",
    "phone": "+49 30 987654",
    "name": "Bob",
    "companyName": null,
    "vatNumber": null
  }
}

Response

Monthly invoice generated

statusstring required

Example response

{
  "status": "Success",
  "data": {
    "invoice": "BASE64_PDF_STRING",
    "cancellationInvoice": "BASE64_CANCELLATION_PDF_STRING_OR_UNDEFINED"
  }
}

Changes

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