Invoices

All invoice events will return the following invoice object. This is the same object as the invoice api returns. API Endpoint

{
  "invoiceNumber": "string",
  "runId": 0,
  "date": "string",
  "status": "string",
  "amount": 0,
  "merchantCode": "string",
  "paid": {
    "paidDate": "2025-10-14T03:33:28.475Z",
    "paidAmount": 0,
    "paidMessage": "string",
    "receiptNumber": "string"
  },
  "rewardAmount": 0,
  "feeAmount": 0,
  "gstAmount": 0,
  "transactionCount": 0,
  "emailSent": true,
  "hasPdf": true,
  "includedTransactionsFrom": "2025-10-14T03:33:28.475Z",
  "includedTransactionsTo": "2025-10-14T03:33:28.475Z",
  "lineItems": [
    {
      "lineItemId": 0,
      "type": "string",
      "title": "string",
      "description": "string",
      "unitCost": 0,
      "quantity": 0,
      "tax": 0,
      "totalExTax": 0,
      "totalIncTax": 0
    }
  ],
  "includedTransactionIds": [
    "string"
  ]
}

Events

invoice.raised - This event will be triggered every time an invoice is raised for a merchant in the program.
invoice.paid - This event will be triggered every time an invoice payment has been received.
invoice.paymenterror - This event is triggered whenever an invoice payment encounters an error.
invoice.sent - This event is triggered after an invoice email has been successfully sent.

Events​

Events