Skip to content

Invoice Paid

Emitted when payment for an invoice has been completed in ChronosHub. The payload carries the financial details of the transaction — amount, tax, currency, payment method, and any institutional agreement that applied.

Payload

json
{
  "invoiceId": 987654,
  "publicationId": "PUB-2026-000123",
  "datePaymentCompleted": "2026-04-20T14:15:00Z",
  "invoiceRef": "INV-2026-000123",
  "paymentType": "CreditCard",
  "price": 1200.00,
  "currency": "USD",
  "paymentCharge": 35.50,
  "paymentCompletedBy": "user-abc123",
  "vat": 240.00,
  "vatPercent": 20.0,
  "orderDiscount": 100.00,
  "institutionalAgreementName": "Example University Read & Publish",
  "institutionalAgreementType": "ReadAndPublish"
}

Fields

FieldTypeDescription
invoiceIdintegerIdentifier of the invoice in ChronosHub.
publicationIdstringIdentifier of the publication this invoice relates to.
datePaymentCompletedstring (ISO 8601 date-time, UTC)Timestamp at which the payment was completed.
invoiceRefstringPartner- or publisher-facing invoice reference (for example, the printed invoice number). Empty string when no reference is available.
paymentTypestringHow the invoice was paid (for example, CreditCard, Invoice).
pricedecimalNet price of the invoice, in the currency given by currency. Excludes VAT and payment charges.
currencystring (ISO 4217)Three-letter currency code for all monetary fields in this payload (for example, USD, EUR, GBP).
paymentChargedecimalSurcharge applied by the payment provider (for example, a card processing fee), in the same currency as price. Defaults to 0.
paymentCompletedBystringIdentifier of the user who completed the payment.
vatdecimalVAT amount included in the invoice, in the same currency as price. Defaults to 0.
vatPercentnumber (float)VAT rate applied to the invoice, expressed as a percentage (for example, 20.0 for 20%). Defaults to 0.
orderDiscountdecimalDiscount applied to the order, in the same currency as price. Defaults to 0.
institutionalAgreementNamestringName of the institutional agreement that funded or discounted this invoice (for example, Italy CARE-CRUI Agreement, Research 4 Life - AL, German Academic Consortium Discount). Empty string when no agreement applied.
institutionalAgreementTypestringCategory of the institutional agreement (for example, Voucher, Waiver, Discount). Empty string when no agreement applied.

Notes

  • All timestamps are serialised as ISO 8601 strings.
  • Monetary amounts (price, paymentCharge, vat, orderDiscount) are expressed in the currency given by currency and are serialised as JSON numbers with decimal precision.
  • This payload describes the event data only — not the transport-level envelope (event id, event type, signature headers, and so on).