List uninvoiced payments for a month. (+Read access required)

Finds billable payment requests that do not yet have an invoice for a given month. Only finalized payments are included: Withdrawn (seller completed work), ResultSubmitted past unlock time, or DisputedWithdrawn with seller funds. Payments still locked, pending refund, or in dispute are excluded. (+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.

get/invoice/monthly/missing

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

Query parameters

monthstring required

Target month in format YYYY-MM (UTC calendar)

buyerWalletVkeystring

Optional buyer wallet vkey filter

cursorIdstring

Cursor for pagination (PaymentRequest id)

limitnumber

Number of results to return

Response

List of uninvoiced billable payments

statusstring required

Example response

{
  "status": "Success",
  "data": {
    "UninvoicedPayments": [
      {
        "id": "payment_request_id",
        "blockchainIdentifier": "blockchain_identifier",
        "onChainState": "Withdrawn",
        "createdAt": "2025-09-15T10:00:00.000Z",
        "buyerWalletVkey": "buyer_wallet_vkey",
        "buyerWalletAddress": "addr1...",
        "RequestedFunds": [
          {
            "unit": "",
            "amount": "5000000"
          }
        ]
      }
    ]
  }
}

Changes

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