Events Reference

Event Types

About Events
DlfChanges
Period
TniChanges
_journeys-_common-ContractJourney
_journeys-_common-SubjectContractJourney
account.communications_preferences_updated-v1
account.created-v1
account.occupied-v1
account.updated-v1
account_metadata.created-v1
account_metadata.removed-v1
account_metadata.updated-v1
account_property_effective_period_metadata.created-v1
account_property_effective_period_metadata.removed-v1
account_property_effective_period_metadata.updated-v1
account_user.created-v1
account_user.password_changed-v1
account_user.password_reset_requested-v1
account_user.psr_records_updated-v1
account_user.removed-v1
account_user.updated-v1
account_user.verification_completed-v1
account_user.verification_started-v1
account_user_metadata.created-v1
account_user_metadata.removed-v1
account_user_metadata.updated-v1
accounts-account_user-_PsrRecord
accounts-accounts-AccountCommsPreferencesChanges
accounts-house_move-Account
accounts-house_move-SupplyPoint
affiliates.affiliate-account-contract-created-v1
agreement.created-v1
agreement.revoked-v1
agreement.terminated-v1
agreement.updated-v1
approvals.approval.approved-v1
approvals.approval.created-v1
approvals.approval.rejected-v1
approvals.approval_request.approved-v1
approvals.approval_request.assigned-v1
approvals.approval_request.rejected-v1
aus.electricity.move-in.completed-v1
aus.electricity.move-out.completed-v1
aus.industry.electricity.amend_meter_route_details.accepted-v1
aus.industry.electricity.amend_meter_route_details.received-v1
aus.industry.electricity.cats_change_response.received-v1
aus.industry.electricity.cats_notification.received-v1
aus.industry.electricity.dlf_code_value.changed-v1
aus.industry.electricity.life_support_confirmation_osj.requested-v1
aus.industry.electricity.life_support_request.received-v1
aus.industry.electricity.meter_fault_and_issue_notification.received-v1
aus.industry.electricity.meter_point.de_energised-v1
aus.industry.electricity.notice_of_metering_works.received-v1
aus.industry.electricity.notified_party.received-v1
aus.industry.electricity.planned_interruption_notification.received-v1
aus.industry.electricity.register.changed-v1
aus.industry.electricity.register.network_tariff_code.change.reminder.created-v1
aus.industry.electricity.register.network_tariff_code.changed-v1
aus.industry.electricity.register.network_tariff_code.changed.v2-v1
aus.industry.electricity.service_order.cancelled-v1
aus.industry.electricity.service_order.closed-v1
aus.industry.electricity.service_order.completed-v1
aus.industry.electricity.service_order_request.received-v1
aus.industry.electricity.shared_fuse_notification.accepted-v1
aus.industry.electricity.shared_fuse_notification.received-v1
aus.industry.electricity.site_access_request.received-v1
aus.industry.marginal-loss-factor.value-changed-v1
aus.industry.site-address.updated-v1
aus.meter-readings.electricity.accumulation.created-v1
aus.meter-readings.gas.accumulation.created-v1
aus.siphon.electricity-failure.received-v1
aus.siphon.electricity-message.received-v1
aus.siphon.electricity-water-mrvs-message-received-v1
aus.siphon.unknown-message.received-v1
billing-_billing-Account
billing-_billing-Ledger
billing-_billing-LedgerEntry
billing-_billing-LedgerEntryRemoval
billing-_billing-_ChargePeriod
billing.billing_document.issued-v1
billing.billing_document_representation.dispatched-v1
billing.billing_document_representation.dispatched-v2
billing.billing_document_representation.dispatched-v3
billing.billing_options.updated-v1
billing.charging-ledger.assigned-to-agreement-v1
billing.charging.supply-point.triggered-v1
billing.duos_invoice.cancel-v1
billing.duos_invoice.new-v1
billing.duos_invoice.replace-v1
billing.final_bill-v1
billing.ledger.entry_posted-v1
billing.ledger.entry_posted-v2
billing.ledger.entry_removed-v1
billing.ledger.entry_removed-v2
billing.pathway_traversal.failed-v1
billing.pathway_traversal.succeeded-v1
billing.rebate.accepted-v1
billing.rebate.created-v1
billing.rebate.declined-v1
billing.rebate.updated-v1
business.created-v1
business.updated-v1
business_operations_team.updated-v1
campaign_account.added-v1
campaign_account.removed-v1
campaign_account.updated-v1
cashflow-_payments-Account
cashflow-_payments-Ledger
cashflow-_payments-Payment
charging.priming.errored-v1
collection_proceeding.created-v1
collection_process.raised-v1
collection_process.reactivated-v1
collection_process.run_termination_requested-v1
collection_process.withdrawn-v1
collection_process.withdrawn-v2
comms.account-call.updated-v1
comms.push-notification.received-unregistered-or-expired-token-v1
comms.transcription.created-v1
concession.validated-v1
consents-consents-_Consent
consents-consents-_SigningIdentity
consents.consent.created-v1
consents.consent.updated-v1
contracts.created-v1
contracts.journeys.creation.started-v1
contracts.journeys.termination.started-v1
contracts.journeys.variation.started-v1
contracts.rescinded-v1
contracts.revoked-v1
contracts.terminated-v1
contracts.terms-varied-v1
customer_access.partner_roles.created-v1
customer_access.partner_user_roles.created-v1
data_import.import_process.cancelled-v1
data_import.import_process.complete-v1
data_import.import_process.dry_run_complete-v1
data_import.import_process.dry_run_error-v1
data_import.import_process.error-v1
data_import.order_process.cancelled-v1
data_import.order_process.complete-v1
data_import.order_process.error-v1
debt.actioning.automated_debt_write_back.completed-v1
debt.actioning.automated_debt_write_back.failed-v1
debt.actioning.automated_debt_write_back.skipped-v1
delinquent_debt.position_changed-v1
delinquent_debt.position_changed-v2
deposit_agreement.accepted-v1
deposit_agreement.fulfilled-v1
deposit_agreement.instalment_returned-v1
deposit_agreement.returned-v1
deposit_agreement.withdrawn-v1
dunning_path_paused-v1
dunning_path_started-v1
dunning_path_unpaused-v1
dunning_path_withdrawn-v1
electricity.child-life-support-record.updated-v1
events-industry-MeteringAgreementTransitionContext
events-register-ElecRegisterNTCChangeData
events-register-MeterSnapshot
events-register-NetworkTariffCodeSnapshot
events-register-RegisterChange
events-register-RegisterSnapshot
events-register-TariffState
events-register-TriggerExtra
fieldworks.elec_supply_abolishment_so_requested-v1
fieldworks.gas_supply_abolishment_so_requested-v1
gas.child-life-support-record.updated-v1
goods.purchase-created-v1
goods.quote.created-for-account-v1
goods.quote.created-without-account-v1
industry.aus.electricity.change_metering_coordinator.cancelled-v1
industry.aus.electricity.change_metering_coordinator.completed-v1
industry.aus.electricity.change_metering_coordinator.objection_raised-v1
industry.aus.electricity.change_metering_coordinator.pending-v1
industry.aus.electricity.change_metering_coordinator.pending_validation-v1
industry.aus.electricity.change_metering_coordinator.rejected-v1
industry.aus.electricity.change_metering_coordinator.request_failed-v1
industry.aus.electricity.change_metering_coordinator.requested-v1
industry.aus.electricity.change_of_supply.completed-v1
industry.aus.electricity.ci_dma_sla.feature_disabled-v1
industry.aus.electricity.ci_prechecks.cancelled-v1
industry.aus.electricity.ci_prechecks.commence-v1
industry.aus.electricity.meter_exchange_service_order.accepted-v1
industry.aus.electricity.meter_exchange_service_order.cancelled-v1
industry.aus.electricity.meter_exchange_service_order.completed-v1
industry.aus.electricity.meter_exchange_service_order.disputed-v1
industry.aus.electricity.meter_exchange_service_order.not_completed-v1
industry.aus.electricity.meter_exchange_service_order.partially_completed-v1
industry.aus.electricity.meter_exchange_service_order.rejected-v1
industry.aus.electricity.meter_exchange_service_order.request_failed-v1
industry.aus.electricity.meter_exchange_service_order.requested-v1
industry.aus.electricity.meter_point.defect_changed-v1
industry.aus.electricity.meter_point.standing_data_dlf_code_changed-v1
industry.aus.electricity.meter_point.standing_data_sync_completed_successfully-v1
industry.aus.electricity.meter_point.standing_data_tni_code_changed-v1
industry.aus.electricity.service_order.not_completed.shared_fuse_scoping_request_required-v1
industry.aus.electricity.site_access_notification.accepted_by_industry-v1
industry.aus.electricity.site_access_notification.awaiting_delivery-v1
industry.aus.electricity.site_access_notification.rejected_by_industry-v1
industry.aus.electricity.site_access_notification.sent_to_industry-v1
industry.aus.meter_data_quality.resolution_cancelled-v1
industry.aus.meter_data_quality.resolution_cancelled-v2
industry.aus.meter_data_quality.resolution_requested-v1
industry.aus.outage_contact.created-v1
industry.aus.outage_contact.ended-v1
industry.aus.outage_contact.store.failed-v1
industry.electricity.change_of_energisation.unsolicited_message-v1
industry.electricity.change_of_service.meter_deactivated-v1
industry.electricity.change_of_supply.gain.initiated-v1
industry.electricity.change_of_supply.loss.complete-v1
industry.gas.change_of_supply.gain.initiated-v1
industry.gas.change_of_supply.loss.complete-v1
ink-_actions-_InkAction
ink-_content-_InkContent
ink-_content-_InkMessageContent
ink-_messages-InkConversation
ink-_messages-_InkFailureData
ink-_messages-_InkMessage
ink-_messages-_InkMessageWithVendor
ink.actions.run-v1
ink.content.inbound-message-tagged-v1
ink.conversation.assigned_to_bucket-v1
ink.conversation.assigned_to_timeline-v1
ink.conversation.await_customer_reply-v1
ink.conversation.closed-v1
ink.conversation.open_status_changed-v1
ink.conversation.opened-v1
ink.conversation.priority.changed-v1
ink.conversation.snoozed-v1
ink.conversation.unassigned_from_bucket-v1
ink.conversation.unassigned_from_timeline-v1
ink.live-chat.closed-v1
ink.live-chat.initiated-v1
ink.live-chat.messages.outbound-message-created-v1
ink.message_attachment.safe-v1
ink.message_attachment.unsafe-v1
ink.messages.inbound-email-migration-v1
ink.messages.inbound-message-created-v1
ink.messages.inbound-message-ingested-v1
ink.messages.outbound-message-created-v1
ink.messages.outbound-message-failed-v1
ink.messages.phishing-report-dismissed-v1
ink.messages.reported-phishing-v1
ink.messages.reported-spam-v1
ink.messages.spam-report-dismissed-v1
internal_company.created-v1
late_payment_fee_application_service_completed-v1
late_payment_fee_application_service_fee_applied-v1
late_payment_fee_application_service_started-v1
late_payment_fee_calculation_service_completed-v1
late_payment_fee_calculation_service_started-v1
late_payment_fee_calculator_completed-v1
late_payment_fee_calculator_fee_applied-v1
late_payment_fee_calculator_started-v1
late_payment_fee_waived-v1
leads.lead.stage-updated-v1
leads.opportunity.document-attached-to-opportunity-v1
leads.opportunity.offer-group.created-v2
leads.opportunity.stage-updated-v1
lifecycle-enrollment-SupplyPoint
lifecycle-join_supplier-ActivatedSupplyPoint
lifecycle-join_supplier-ActivationInitiatedSupplyPoint
lifecycle-join_supplier-Agreement
lifecycle-join_supplier-SupplyPeriodData
lifecycle-join_supplier-SupplyPoint
lifecycle-leave_supplier-SupplyPoint
lifecycle-leave_supplier-TerminatedSupplyPoint
lifecycle.enrollment.loyalty-points-qualification-reversed-v1
lifecycle.enrollment.supply-status-qualifies-account-for-loyalty-point-v2
lifecycle.join-supplier.activation.completed-v1
lifecycle.join-supplier.activation.initiated-v1
lifecycle.join-supplier.agreement.created-v1
lifecycle.join-supplier.cancellation-requested-v1
lifecycle.join-supplier.cancelled-v1
lifecycle.join-supplier.completed-v1
lifecycle.join-supplier.requested-v1
lifecycle.join-supplier.reversal-requested-v1
lifecycle.join-supplier.reversed-v1
lifecycle.join-supplier.supply-period.created-v1
lifecycle.join_supplier._ensure_payment_instructions.step_completed-v2
lifecycle.join_supplier._ensure_payment_instructions.step_initiated-v2
lifecycle.join_supplier.terms-and-conditions.accepted-v2
lifecycle.leave-supplier.cancellation-requested-v2
lifecycle.leave-supplier.cancelled-v2
lifecycle.leave-supplier.completed-v3
lifecycle.leave-supplier.requested-v2
lifecycle.leave-supplier.requested-v3
lifecycle.leave-supplier.reversal-requested-v2
lifecycle.leave-supplier.termination.confirmed-v2
lifecycle.leave-supplier.updated-v2
lifecycle.leave-supplier.updated-v3
lifecycle.support-site.sale-1.0.0
loyalty-points.user-role-removal-v1
market_supply-products-Product
meter_data_quality.resolution_cancelled-v1
meter_data_quality.resolution_cancelled-v2
meter_data_quality.resolution_requested-v1
meter_points-meter_details-Meter
meter_points-meter_details-Register
meter_points-meter_details-RemovedMeter
meterpoint.elec.cos_gain.registration.requested-v1
meterpoint.gas.api_backfill-v1
meterpoint.gas.appoint_mam.requested-v1
meterpoint.gas.backfill-v1
meterpoint.gas.change_of_cohort.requested-v1
meterpoint.gas.change_of_mam.requested-v1
meterpoint.gas.cos_gain.mtd_received-v1
meterpoint.gas.cos_gain.registration.confirmed-v1
meterpoint.gas.cos_gain.registration.requested-v1
meterpoint.gas.cos_loss.confirmed-v1
meterpoint.gas.deappoint_mam.requested-v1
meterpoint.gas.disputed_closing_reading.accepted.by_us-v1
meterpoint.gas.disputed_closing_reading.accepted.other_supplier-v1
meterpoint.gas.disputed_closing_reading.alternative_proposed.by_us-v1
meterpoint.gas.disputed_closing_reading.alternative_proposed.other_supplier-v1
meterpoint.gas.disputed_closing_reading.queried.by_us-v1
meterpoint.gas.disputed_closing_reading.started.by_us-v1
meterpoint.gas.disputed_closing_reading.started.other_supplier-v1
meterpoint.gas.disputed_opening_reading.accepted.by_us-v1
meterpoint.gas.disputed_opening_reading.accepted.other_supplier-v1
meterpoint.gas.disputed_opening_reading.alternative_proposed.by_us-v1
meterpoint.gas.disputed_opening_reading.alternative_proposed.other_supplier-v1
meterpoint.gas.disputed_opening_reading.queried.by_us-v1
meterpoint.gas.disputed_opening_reading.started.by_us-v1
meterpoint.gas.disputed_opening_reading.started.other_supplier-v1
meterpoint.gas.et_gain.accepted.by_other_supplier-v1
meterpoint.gas.et_gain.accepted.by_us-v1
meterpoint.gas.et_gain.rejected.by_other_supplier-v1
meterpoint.gas.et_gain.rejected.by_us-v1
meterpoint.gas.et_gain.started.by_other_supplier-v1
meterpoint.gas.et_gain.started.by_us-v1
meterpoint.gas.et_loss.accepted.by_other_supplier-v1
meterpoint.gas.et_loss.accepted.by_us-v1
meterpoint.gas.et_loss.rejected.by_other_supplier-v1
meterpoint.gas.et_loss.rejected.by_us-v1
meterpoint.gas.et_loss.started.by_other_supplier-v1
meterpoint.gas.et_loss.started.by_us-v1
meterpoint.gas.meter-technical-details.update.requested-v1
meterpoint.gas.meter_exchanged-v1
meterpoint.gas.reading-v1
meterpoint.reading.gap.filled-v1
meterpoint.reading.gap.filling.failed-v1
meterpoint.reading.gap.found-v1
meterpoint.reading.missing.filled-v1
meterpoint.reading.missing.filling.failed-v1
meterpoint.reading.missing.found-v1
on_site_jobs.appointment.booked-v1
on_site_jobs.appointment.cancelled-v1
on_site_jobs.appointment.completed-v1
on_site_jobs.appointment.job_notes_updated-v1
on_site_jobs.request.appointment_failed-v1
on_site_jobs.request.approval_rejected-v1
on_site_jobs.request.completed-v1
on_site_jobs.request.created-v1
partner_access.granted-v1
partner_user.created-v1
partner_user.removed-v1
partner_user.updated-v1
partner_user_access.granted-v1
partner_user_access.revoked-v1
payment-group.actioned-v1
payment-group.closed-v1
payment-group.completed-v1
payment.cleared-v1
payment.failed-v1
payment.failed_late-v1
payment.pending-v1
payment.re_presented-v1
payment.scheduled-v1
payment_obligation.overdue-v1
payment_plan.status_changed-v1
payment_promise.broken-v1
payment_promise.created-v1
payments-repayments-Account
payments-repayments-Agent
payments-repayments-Ledger
payments-repayments-Payment
payments.payment-preferences.manual-payments-activated-v1
payments.payment-preferences.preferred-method-set-for-automatic-payments-v1
payments.payment-schedule-preference-mismatch-detected-v1
payments.payment_adequacy.review_wont_be_applied-v1
payments.payment_method.account_user_matching.failed-v1
payments.payment_method.new-v1
payments.payment_method.removed-v1
payments.payment_schedule.new-v1
payments.payment_schedule.removed-v1
payments.payment_schedule.updated-v1
pending_nmi_status_update.record.cancelled-v1
pending_nmi_status_update.record.created-v1
pending_nmi_status_update.record.rejected-v1
personal-issues.created-v1
personal-issues.removed-v1
personal-issues.updated-v1
product-switch.completed-v1
product-switch.initiated-v1
property.move-in.cancelled-v1
property.move-in.date-updated-v1
property.move-in.market-supply.requested-v1
property.move-in.requested-v1
property.move-in.requested-v2
property.move-out.cancelled-v1
property.move-out.date-updated-v1
property.move-out.requested-v1
property.retrospective-move-out.completed-v1
property.updated-v1
property_metadata.created-v1
property_metadata.removed-v1
property_metadata.updated-v1
quoting.rates-requested-v1
referrals.referral-created-v1
referrals.referral-paid-v1
referrals.reward-created-v1
refund.requested-v1
reminder.cancelled-v1
reminder.cancelled-v2
reminder.completed-v1
reminder.completed-v2
repayment-group.actioned-v1
repayment-group.closed-v1
repayment-group.completed-v1
repayment.approved-v1
repayment.failed-v1
repayment.failed-v2
repayment.failed_late-v1
repayment.paid-v1
repayment.requested-v1
repayment.submitted-v1
risk_assessment_completed-v1
risk_assessment_started-v1
security.account_user.denied_access-v1
security.account_user.forcibly_logged_out-v1
service-order.link-requested-v1
supply-point.gain.completed-v1
supply-point.termination.completed-v1
supplypoint.gbr_electricity.gain.meter-details-received-v1
tech.kraken.flow.aus_electricity.ci_prechecks.progress.v1-v1
tech.kraken.flow.aus_electricity.request_change_metering_coordinator.v1-v1
tech.kraken.flow.aus_electricity.request_meter_exchange_service_order.v1-v1
tech.kraken.workflow.cancelled.v1-v1
tech.kraken.workflow.completed.v1-v1
tech.kraken.workflow.created.v1-v1
tech.kraken.workflow.errored.v1-v1
tech.kraken.workflow.failed.v1-v1
tech.kraken.workflow.skipped.v1-v1
tech.kraken.workflow.stalled.v1-v1
tech.kraken.workflow.started.v1-v1
tech.kraken.workflow.step.cancelled.v1-v1
tech.kraken.workflow.step.completed.v1-v1
tech.kraken.workflow.step.created.v1-v1
tech.kraken.workflow.step.errored.v1-v1
tech.kraken.workflow.step.failed.v1-v1
tech.kraken.workflow.step.skipped.v1-v1
tech.kraken.workflow.step.stalled.v1-v1
tech.kraken.workflow.step.started.v1-v1
transactional-messaging.message.dispatched-v1
transactional-messaging.trigger.failed-message-processed-v1
transactional-messaging.trigger.failed-message-processing-failed-v1
transactional-messaging.trigger.processed-v1
transactional-messaging.trigger.processing-failed-v1
transactional_messaging-process_trigger-_MessageEvent
transactional_messaging-process_trigger-_TransactionalMessage
translation_management.CLIENT_MANAGED_TRANSLATION_SOURCE_DELETED-v1
translation_management.CLIENT_MANAGED_TRANSLATION_SOURCE_EDITED-v1
user_access.granted-v1
user_access.revoked-v1
voice-call_participants-_CallParticipantIdentity
voice-transcriptions-_Call
voice-transcriptions-_CallParticipantWorker
voice-transcriptions-_CallRecordingV1
voice-transcriptions-_CallRecordingV2
voice-transcriptions-_CallTag
voice-transcriptions-_TranscriptionFile
voice-wrap_up_call-_CallParticipants
voice-wrap_up_call-_CallTag
voice-wrap_up_call-_Note
voice.call-participant.identity-updated-v1
voice.call.wrapped-v1
voice.campaign.update-item-v1
voice.transcription.failed-v1
voice.transcription.processed-v1
voice.transcription.processed-v2
voucher.multiple_purchased-v1
voucher.purchased-v1
voucher.redeemed-v1
voucher.refunded-v1
voucher.transferred-v1
watermeter.aus_industry.created-v1
watermeter.aus_industry.updated-v1
workflow.cancelled.via_support_site-v1
workflow.step.cancelled.via_support_site-v1

About Events

External Events are OpenAPI-spec payloads emitted by kraken to AWS Eventbridge.

DlfChanges

	Name	Type
required	nmi	`string`
required	dlf_before	`string`
required	dlf_after	`string`
required	period	Period

{
  "nmi": "string",
  "dlf_before": "string",
  "dlf_after": "string",
  "period": {
    "start": "string",
    "end": "string",
    "boundaries": "string"
  }
}

Period

	Name	Type
required	start	`string`
required	end	`string`
required	boundaries	`string`

{
  "start": "string",
  "end": "string",
  "boundaries": "string"
}

TniChanges

	Name	Type
required	nmi	`string`
required	tni_before	`string`
required	tni_after	`string`
required	period	Period

{
  "nmi": "string",
  "tni_before": "string",
  "tni_after": "string",
  "period": {
    "start": "string",
    "end": "string",
    "boundaries": "string"
  }
}

_journeys-_common-ContractJourney

	Name	Type
required	number	`string`
required	type	`string`
required	requested_at	`string`

{
  "number": "string",
  "type": "string",
  "requested_at": "string"
}

_journeys-_common-SubjectContractJourney

	Name	Type
required	number	`string`
required	subject_number	`string`

{
  "number": "string",
  "subject_number": "string"
}

account.communications_preferences_updated-v1

	Name	Type
required	account_number	`string`
required	changes	accounts-accounts-AccountCommsPreferencesChanges

Event Type	Payload Version
account.communications_preferences_updated	v1

{
  "account_number": "string",
  "changes": {
    "requires_postal_comms": [
      "boolean"
    ],
    "preferred_language_for_comms": [
      "string"
    ],
    "document_accessibility": [
      "string"
    ]
  }
}

account.created-v1

	Name	Type
required	account_number	`string`
required	account_user_emails	`array[string]`
	is_imported	`boolean`

Event Type	Payload Version
account.created	v1

{
  "account_number": "string",
  "account_user_emails": [
    "string"
  ],
  "is_imported": "boolean"
}

account.occupied-v1

	Name	Type
required	account_number	`string`

Event Type	Payload Version
account.occupied	v1

{
  "account_number": "string"
}

account.updated-v1

	Name	Type
required	account_number	`string`
required	account_user_emails	`array[string]`
required	changes	`object`
	is_override	`boolean`

Event Type	Payload Version
account.updated	v1

{
  "account_number": "string",
  "account_user_emails": [
    "string"
  ],
  "changes": "object",
  "is_override": "boolean"
}

account_metadata.created-v1

	Name	Type
required	account_number	`string`
required	key	`string`
required	value	`string`

Event Type	Payload Version
account_metadata.created	v1

{
  "account_number": "string",
  "key": "string",
  "value": "string"
}

account_metadata.removed-v1

	Name	Type
required	account_number	`string`
required	key	`string`
required	value	`string`

Event Type	Payload Version
account_metadata.removed	v1

{
  "account_number": "string",
  "key": "string",
  "value": "string"
}

account_metadata.updated-v1

	Name	Type
required	account_number	`string`
required	changes	`object`

Event Type	Payload Version
account_metadata.updated	v1

{
  "account_number": "string",
  "changes": "object"
}

account_property_effective_period_metadata.created-v1

	Name	Type
required	account_property_effective_period_id	`integer`
required	key	`string`
required	value	`string`

Event Type	Payload Version
account_property_effective_period_metadata.created	v1

{
  "account_property_effective_period_id": "integer",
  "key": "string",
  "value": "string"
}

account_property_effective_period_metadata.removed-v1

	Name	Type
required	account_property_effective_period_id	`integer`
required	key	`string`
required	value	`string`

Event Type	Payload Version
account_property_effective_period_metadata.removed	v1

{
  "account_property_effective_period_id": "integer",
  "key": "string",
  "value": "string"
}

account_property_effective_period_metadata.updated-v1

	Name	Type
required	account_property_effective_period_id	`integer`
required	changes	`object`

Event Type	Payload Version
account_property_effective_period_metadata.updated	v1

{
  "account_property_effective_period_id": "integer",
  "changes": "object"
}

account_user.created-v1

	Name	Type
required	user_id	`integer`
required	user_email	`string`
required	linked_accounts	`array`
	user_identifiers	`object`
	initiator_type	`string`
	is_customer_initiated	`boolean`

Event Type	Payload Version
account_user.created	v1

{
  "user_id": "integer",
  "user_email": "string",
  "linked_accounts": [
    "object"
  ],
  "user_identifiers": "object",
  "initiator_type": "string",
  "is_customer_initiated": "boolean"
}

account_user.password_changed-v1

	Name	Type
required	user_id	`integer`

Event Type	Payload Version
account_user.password_changed	v1

{
  "user_id": "integer"
}

account_user.password_reset_requested-v1

	Name	Type
required	account_user_id	`integer`
required	account_user_number	`string`

Event Type	Payload Version
account_user.password_reset_requested	v1

{
  "account_user_id": "integer",
  "account_user_number": "string"
}

account_user.psr_records_updated-v1

	Name	Type
required	user_id	`integer`
required	created_records	array[accounts-account_user-_PsrRecord]
required	updated_records	array[accounts-account_user-_PsrRecord]
required	deleted_records	array[accounts-account_user-_PsrRecord]

Event Type	Payload Version
account_user.psr_records_updated	v1

{
  "user_id": "integer",
  "created_records": [
    {
      "description": "string",
      "electricity_industry_code": "string",
      "gas_industry_code": "string"
    }
  ],
  "updated_records": [
    {
      "description": "string",
      "electricity_industry_code": "string",
      "gas_industry_code": "string"
    }
  ],
  "deleted_records": [
    {
      "description": "string",
      "electricity_industry_code": "string",
      "gas_industry_code": "string"
    }
  ]
}

account_user.removed-v1

	Name	Type
required	user_id	`integer`
required	user_email	`string`
required	linked_accounts	`array`
	user_identifiers	`object`
	initiator_type	`string`
	is_customer_initiated	`boolean`

Event Type	Payload Version
account_user.removed	v1

{
  "user_id": "integer",
  "user_email": "string",
  "linked_accounts": [
    "object"
  ],
  "user_identifiers": "object",
  "initiator_type": "string",
  "is_customer_initiated": "boolean"
}

account_user.updated-v1

	Name	Type
required	user_id	`integer`
required	user_email	`string`
required	linked_accounts	`array`
	user_identifiers	`object`
	initiator_type	`string`
	is_customer_initiated	`boolean`
required	changes	`object`
	is_override	`boolean`

Event Type	Payload Version
account_user.updated	v1

{
  "user_id": "integer",
  "user_email": "string",
  "linked_accounts": [
    "object"
  ],
  "user_identifiers": "object",
  "initiator_type": "string",
  "is_customer_initiated": "boolean",
  "changes": "object",
  "is_override": "boolean"
}

account_user.verification_completed-v1

	Name	Type
required	user_number	`string`
required	verification_id	`integer`
required	verification_type	`string`

Event Type	Payload Version
account_user.verification_completed	v1

{
  "user_number": "string",
  "verification_id": "integer",
  "verification_type": "string"
}

account_user.verification_started-v1

	Name	Type
required	user_number	`string`
required	verification_id	`integer`
required	verification_type	`string`

Event Type	Payload Version
account_user.verification_started	v1

{
  "user_number": "string",
  "verification_id": "integer",
  "verification_type": "string"
}

account_user_metadata.created-v1

	Name	Type
required	user_id	`integer`
required	key	`string`
required	value	`string`

Event Type	Payload Version
account_user_metadata.created	v1

{
  "user_id": "integer",
  "key": "string",
  "value": "string"
}

account_user_metadata.removed-v1

	Name	Type
required	user_id	`integer`
required	key	`string`
required	value	`string`

Event Type	Payload Version
account_user_metadata.removed	v1

{
  "user_id": "integer",
  "key": "string",
  "value": "string"
}

account_user_metadata.updated-v1

	Name	Type
required	user_id	`integer`
required	changes	`object`

Event Type	Payload Version
account_user_metadata.updated	v1

{
  "user_id": "integer",
  "changes": "object"
}

accounts-account_user-_PsrRecord

	Name	Type
required	description	`string`
required	electricity_industry_code	`string`
required	gas_industry_code	`string`

{
  "description": "string",
  "electricity_industry_code": "string",
  "gas_industry_code": "string"
}

accounts-accounts-AccountCommsPreferencesChanges

	Name	Type
	requires_postal_comms	`array[boolean]`
	preferred_language_for_comms	`array[string]`
	document_accessibility	`array[string]`

{
  "requires_postal_comms": [
    "boolean"
  ],
  "preferred_language_for_comms": [
    "string"
  ],
  "document_accessibility": [
    "string"
  ]
}

accounts-house_move-Account

	Name	Type
required	number	`string`
required	external_reference	`string`

{
  "number": "string",
  "external_reference": "string"
}

accounts-house_move-SupplyPoint

	Name	Type
required	id	`string`
	industry	`string`
	tariff_code	`string`
	tariff_payment_method	`string`

{
  "id": "string",
  "industry": "string",
  "tariff_code": "string",
  "tariff_payment_method": "string"
}

affiliates.affiliate-account-contract-created-v1

	Name	Type
required	affiliate_account_contract_id	`integer`
required	affiliate_contract_id	`integer`
required	account_number	`string`
required	fuel	`string`

Event Type	Payload Version
affiliates.affiliate-account-contract-created	v1

{
  "affiliate_account_contract_id": "integer",
  "affiliate_contract_id": "integer",
  "account_number": "string",
  "fuel": "string"
}

agreement.created-v1

	Name	Type
required	agreement_id	`integer`
required	account_number	`string`
required	valid_from	`string`
required	product_code	`string`

Event Type	Payload Version
agreement.created	v1

{
  "agreement_id": "integer",
  "account_number": "string",
  "valid_from": "string",
  "product_code": "string"
}

agreement.revoked-v1

	Name	Type
required	agreement_id	`integer`

Event Type	Payload Version
agreement.revoked	v1

{
  "agreement_id": "integer"
}

agreement.terminated-v1

	Name	Type
required	agreement_id	`integer`

Event Type	Payload Version
agreement.terminated	v1

{
  "agreement_id": "integer"
}

agreement.updated-v1

	Name	Type
required	agreement_id	`integer`
required	changes	`object`
	is_override	`boolean`

Event Type	Payload Version
agreement.updated	v1

{
  "agreement_id": "integer",
  "changes": "object",
  "is_override": "boolean"
}

approvals.approval.approved-v1

	Name	Type
required	approval_id	`string`
required	process_type	`string`
required	process_data	`object`
required	approved_at	`string`

Event Type	Payload Version
approvals.approval.approved	v1

{
  "approval_id": "string",
  "process_type": "string",
  "process_data": "object",
  "approved_at": "string"
}

approvals.approval.created-v1

	Name	Type
required	approval_id	`string`
required	process_type	`string`
required	requested_by_id	`integer`
required	requested_at	`string`

Event Type	Payload Version
approvals.approval.created	v1

{
  "approval_id": "string",
  "process_type": "string",
  "requested_by_id": "integer",
  "requested_at": "string"
}

approvals.approval.rejected-v1

	Name	Type
required	approval_id	`string`
required	process_type	`string`
required	process_data	`object`
required	rejected_at	`string`

Event Type	Payload Version
approvals.approval.rejected	v1

{
  "approval_id": "string",
  "process_type": "string",
  "process_data": "object",
  "rejected_at": "string"
}

approvals.approval_request.approved-v1

	Name	Type
required	approval_id	`string`
required	request_id	`string`
required	approved_by_id	`integer`
required	approved_at	`string`

Event Type	Payload Version
approvals.approval_request.approved	v1

{
  "approval_id": "string",
  "request_id": "string",
  "approved_by_id": "integer",
  "approved_at": "string"
}

approvals.approval_request.assigned-v1

	Name	Type
required	approval_id	`string`
required	request_id	`string`
required	assigned_to_id	`integer`
required	assigned_at	`string`

Event Type	Payload Version
approvals.approval_request.assigned	v1

{
  "approval_id": "string",
  "request_id": "string",
  "assigned_to_id": "integer",
  "assigned_at": "string"
}

approvals.approval_request.rejected-v1

	Name	Type
required	approval_id	`string`
required	request_id	`string`
required	rejected_by_id	`integer`
required	rejection_reason	`string`
required	rejected_at	`string`

Event Type	Payload Version
approvals.approval_request.rejected	v1

{
  "approval_id": "string",
  "request_id": "string",
  "rejected_by_id": "integer",
  "rejection_reason": "string",
  "rejected_at": "string"
}

aus.electricity.move-in.completed-v1

	Name	Type
required	nmi	`string`
required	property_id	`integer`
required	move_in_date	`string`
required	account_number	`string`

Event Type	Payload Version
aus.electricity.move-in.completed	v1

{
  "nmi": "string",
  "property_id": "integer",
  "move_in_date": "string",
  "account_number": "string"
}

aus.electricity.move-out.completed-v1

	Name	Type
required	nmi	`string`
required	property_id	`integer`
required	move_out_date	`string`
required	account_number	`string`

Event Type	Payload Version
aus.electricity.move-out.completed	v1

{
  "nmi": "string",
  "property_id": "integer",
  "move_out_date": "string",
  "account_number": "string"
}

aus.industry.electricity.amend_meter_route_details.accepted-v1

	Name	Type
required	nmi	`string`
required	transaction_id	`string`

Event Type	Payload Version
aus.industry.electricity.amend_meter_route_details.accepted	v1

{
  "nmi": "string",
  "transaction_id": "string"
}

aus.industry.electricity.amend_meter_route_details.received-v1

	Name	Type
required	nmi	`string`
required	siphon_event_id	`string`

Event Type	Payload Version
aus.industry.electricity.amend_meter_route_details.received	v1

{
  "nmi": "string",
  "siphon_event_id": "string"
}

aus.industry.electricity.cats_change_response.received-v1

	Name	Type
required	nmi	`string`
required	siphon_event_id	`string`
required	change_reason_code	`string`
required	initiating_event_id	`string`
required	change_request_id	`string`

Event Type	Payload Version
aus.industry.electricity.cats_change_response.received	v1

{
  "nmi": "string",
  "siphon_event_id": "string",
  "change_reason_code": "string",
  "initiating_event_id": "string",
  "change_request_id": "string"
}

aus.industry.electricity.cats_notification.received-v1

	Name	Type
required	nmi	`string`
required	role	`string`
required	siphon_event_id	`string`
required	change_reason_code	`string`
required	change_status_code	`string`
required	change_request_id	`string`

Event Type	Payload Version
aus.industry.electricity.cats_notification.received	v1

{
  "nmi": "string",
  "role": "string",
  "siphon_event_id": "string",
  "change_reason_code": "string",
  "change_status_code": "string",
  "change_request_id": "string"
}

aus.industry.electricity.dlf_code_value.changed-v1

	Name	Type
required	code	`string`
required	from_date	`string`
required	to_date	`string`
required	value	`string`

Event Type	Payload Version
aus.industry.electricity.dlf_code_value.changed	v1

{
  "code": "string",
  "from_date": "string",
  "to_date": "string",
  "value": "string"
}

aus.industry.electricity.life_support_confirmation_osj.requested-v1

	Name	Type
required	nmi	`string`
required	effective_period_id	`integer`

Event Type	Payload Version
aus.industry.electricity.life_support_confirmation_osj.requested	v1

{
  "nmi": "string",
  "effective_period_id": "integer"
}

aus.industry.electricity.life_support_request.received-v1

	Name	Type
required	nmi	`string`
required	siphon_event_id	`string`

Event Type	Payload Version
aus.industry.electricity.life_support_request.received	v1

{
  "nmi": "string",
  "siphon_event_id": "string"
}

aus.industry.electricity.meter_fault_and_issue_notification.received-v1

	Name	Type
required	nmi	`string`
required	siphon_event_id	`string`

Event Type	Payload Version
aus.industry.electricity.meter_fault_and_issue_notification.received	v1

{
  "nmi": "string",
  "siphon_event_id": "string"
}

aus.industry.electricity.meter_point.de_energised-v1

	Name	Type
required	nmi	`string`

Event Type	Payload Version
aus.industry.electricity.meter_point.de_energised	v1

{
  "nmi": "string"
}

aus.industry.electricity.notice_of_metering_works.received-v1

	Name	Type
required	nmi	`string`
required	siphon_event_id	`string`

Event Type	Payload Version
aus.industry.electricity.notice_of_metering_works.received	v1

{
  "nmi": "string",
  "siphon_event_id": "string"
}

aus.industry.electricity.notified_party.received-v1

	Name	Type
required	nmi	`string`
required	siphon_event_id	`string`

Event Type	Payload Version
aus.industry.electricity.notified_party.received	v1

{
  "nmi": "string",
  "siphon_event_id": "string"
}

aus.industry.electricity.planned_interruption_notification.received-v1

	Name	Type
required	nmi	`string`
required	siphon_event_id	`string`

Event Type	Payload Version
aus.industry.electricity.planned_interruption_notification.received	v1

{
  "nmi": "string",
  "siphon_event_id": "string"
}

aus.industry.electricity.register.changed-v1

	Name	Type
required	nmi	`string`
required	serial_number	`string`
required	register_identifier	`string`
required	active_from	`string`

Event Type	Payload Version
aus.industry.electricity.register.changed	v1

{
  "nmi": "string",
  "serial_number": "string",
  "register_identifier": "string",
  "active_from": "string"
}

aus.industry.electricity.register.network_tariff_code.change.reminder.created-v1

	Name	Type
required	reminder_id	`integer`
required	account_id	`integer`
required	nmi	`string`
required	reminder_type	`string`
	effective_change_date	`string`
	trigger_extra	`object`

Event Type	Payload Version
aus.industry.electricity.register.network_tariff_code.change.reminder.created	v1

{
  "reminder_id": "integer",
  "account_id": "integer",
  "nmi": "string",
  "reminder_type": "string",
  "effective_change_date": "string",
  "trigger_extra": "object"
}

aus.industry.electricity.register.network_tariff_code.changed-v1

	Name	Type
required	nmi	`string`
required	serial_number	`string`
required	register_identifier	`string`
required	network_tariff_code	`string`

Event Type	Payload Version
aus.industry.electricity.register.network_tariff_code.changed	v1

{
  "nmi": "string",
  "serial_number": "string",
  "register_identifier": "string",
  "network_tariff_code": "string"
}

aus.industry.electricity.register.network_tariff_code.changed.v2-v1

	Name	Type
required	nmi	`string`
required	event_data	events-register-ElecRegisterNTCChangeData

Event Type	Payload Version
aus.industry.electricity.register.network_tariff_code.changed.v2	v1

{
  "nmi": "string",
  "event_data": {
    "before": [
      {
        "id": "integer",
        "serial_number": "string",
        "registers": [
          {
            "id": "integer",
            "register_identifier": "string",
            "time_of_day": "string",
            "controlled_load": "string",
            "network_tariff_codes": [
              "..."
            ]
          }
        ]
      }
    ],
    "after": [
      {
        "id": "integer",
        "serial_number": "string",
        "registers": [
          {
            "id": "integer",
            "register_identifier": "string",
            "time_of_day": "string",
            "controlled_load": "string",
            "network_tariff_codes": [
              "..."
            ]
          }
        ]
      }
    ]
  }
}

aus.industry.electricity.service_order.cancelled-v1

	Name	Type
required	electricity_service_order_id	`integer`
required	service_order_number	`string`
	cancellation_category	`string`
	cancellation_subcategory	`string`
	action_source	`string`
	support_user_id	`integer`

Event Type	Payload Version
aus.industry.electricity.service_order.cancelled	v1

{
  "electricity_service_order_id": "integer",
  "service_order_number": "string",
  "cancellation_category": "string",
  "cancellation_subcategory": "string",
  "action_source": "string",
  "support_user_id": "integer"
}

aus.industry.electricity.service_order.closed-v1

	Name	Type
	electricity_service_order_id	`integer`
required	nmi	`string`
required	service_order_number	`string`
required	service_order_status	`string`

Event Type	Payload Version
aus.industry.electricity.service_order.closed	v1

{
  "electricity_service_order_id": "integer",
  "nmi": "string",
  "service_order_number": "string",
  "service_order_status": "string"
}

aus.industry.electricity.service_order.completed-v1

	Name	Type
required	electricity_service_order_id	`integer`
required	service_order_number	`string`
	cancellation_category	`string`
	cancellation_subcategory	`string`
	action_source	`string`
	support_user_id	`integer`

Event Type	Payload Version
aus.industry.electricity.service_order.completed	v1

{
  "electricity_service_order_id": "integer",
  "service_order_number": "string",
  "cancellation_category": "string",
  "cancellation_subcategory": "string",
  "action_source": "string",
  "support_user_id": "integer"
}

aus.industry.electricity.service_order_request.received-v1

	Name	Type
required	nmi	`string`
	electricity_service_order_id	`integer`
required	work_type	`string`
required	work_sub_type	`string`
required	siphon_event_id	`string`
required	service_order_number	`string`
required	action_type	`string`
required	scheduled_date	`string`
	initiating_participant_id	`string`
	recipient_participant_id	`string`

Event Type	Payload Version
aus.industry.electricity.service_order_request.received	v1

{
  "nmi": "string",
  "electricity_service_order_id": "integer",
  "work_type": "string",
  "work_sub_type": "string",
  "siphon_event_id": "string",
  "service_order_number": "string",
  "action_type": "string",
  "scheduled_date": "string",
  "initiating_participant_id": "string",
  "recipient_participant_id": "string"
}

aus.industry.electricity.shared_fuse_notification.accepted-v1

	Name	Type
required	nmi	`string`
required	transaction_id	`string`

Event Type	Payload Version
aus.industry.electricity.shared_fuse_notification.accepted	v1

{
  "nmi": "string",
  "transaction_id": "string"
}

aus.industry.electricity.shared_fuse_notification.received-v1

	Name	Type
required	nmi	`string`
required	siphon_event_id	`string`

Event Type	Payload Version
aus.industry.electricity.shared_fuse_notification.received	v1

{
  "nmi": "string",
  "siphon_event_id": "string"
}

aus.industry.electricity.site_access_request.received-v1

	Name	Type
required	nmi	`string`
required	siphon_event_id	`string`

Event Type	Payload Version
aus.industry.electricity.site_access_request.received	v1

{
  "nmi": "string",
  "siphon_event_id": "string"
}

aus.industry.marginal-loss-factor.value-changed-v1

	Name	Type
required	connection_point_id	`string`
required	effective_date	`string`
	previous_effective_date	`string`
required	region_id	`string`
required	transmission_loss_factor	`string`
required	previous_transmission_loss_factor	`string`

Event Type	Payload Version
aus.industry.marginal-loss-factor.value-changed	v1

{
  "connection_point_id": "string",
  "effective_date": "string",
  "previous_effective_date": "string",
  "region_id": "string",
  "transmission_loss_factor": "string",
  "previous_transmission_loss_factor": "string"
}

aus.industry.site-address.updated-v1

	Name	Type
required	property_pk	`integer`
required	site_address_pk	`integer`

Event Type	Payload Version
aus.industry.site-address.updated	v1

{
  "property_pk": "integer",
  "site_address_pk": "integer"
}

aus.meter-readings.electricity.accumulation.created-v1

	Name	Type
required	reading_id	`integer`
required	source	`string`

Event Type	Payload Version
aus.meter-readings.electricity.accumulation.created	v1

{
  "reading_id": "integer",
  "source": "string"
}

aus.meter-readings.gas.accumulation.created-v1

	Name	Type
required	reading_id	`integer`
required	event_type	`string`

Event Type	Payload Version
aus.meter-readings.gas.accumulation.created	v1

{
  "reading_id": "integer",
  "event_type": "string"
}

aus.siphon.electricity-failure.received-v1

	Name	Type
required	failure_id	`integer`

Event Type	Payload Version
aus.siphon.electricity-failure.received	v1

{
  "failure_id": "integer"
}

aus.siphon.electricity-message.received-v1

	Name	Type
required	message_id	`integer`

Event Type	Payload Version
aus.siphon.electricity-message.received	v1

{
  "message_id": "integer"
}

aus.siphon.electricity-water-mrvs-message-received-v1

	Name	Type
required	message_id	`integer`

Event Type	Payload Version
aus.siphon.electricity-water-mrvs-message-received	v1

{
  "message_id": "integer"
}

aus.siphon.unknown-message.received-v1

	Name	Type
required	message_id	`integer`

Event Type	Payload Version
aus.siphon.unknown-message.received	v1

{
  "message_id": "integer"
}

billing-_billing-Account

	Name	Type
required	number	`string`

{
  "number": "string"
}

billing-_billing-Ledger

	Name	Type
required	account	billing-_billing-Account
required	number	`string`
	id	`string`

{
  "account": {
    "number": "string"
  },
  "number": "string",
  "id": "string"
}

billing-_billing-LedgerEntry

	Name	Type
required	id	`integer`
required	is_charge	`boolean`
required	is_credit	`boolean`
required	is_payment	`boolean`
required	is_repayment	`boolean`
required	is_reversal	`boolean`
required	is_reversed	`boolean`
	source_id	`integer`
	source_type	`string`

{
  "id": "integer",
  "is_charge": "boolean",
  "is_credit": "boolean",
  "is_payment": "boolean",
  "is_repayment": "boolean",
  "is_reversal": "boolean",
  "is_reversed": "boolean",
  "source_id": "integer",
  "source_type": "string"
}

billing-_billing-LedgerEntryRemoval

	Name	Type
required	id	`integer`
required	amount	`integer`
required	is_charge	`boolean`
required	is_credit	`boolean`
required	is_payment	`boolean`
required	is_repayment	`boolean`
required	is_reversal	`boolean`
required	is_reversed	`boolean`
required	source_reason	`string`

{
  "id": "integer",
  "amount": "integer",
  "is_charge": "boolean",
  "is_credit": "boolean",
  "is_payment": "boolean",
  "is_repayment": "boolean",
  "is_reversal": "boolean",
  "is_reversed": "boolean",
  "source_reason": "string"
}

billing-_billing-_ChargePeriod

	Name	Type
required	start_at	`string`
required	end_at	`string`

{
  "start_at": "string",
  "end_at": "string"
}

billing.billing_document.issued-v1

	Name	Type
required	account_number	`string`
required	billing_document_id	`integer`
required	billing_document_identifier	`string`

Event Type	Payload Version
billing.billing_document.issued	v1

{
  "account_number": "string",
  "billing_document_id": "integer",
  "billing_document_identifier": "string"
}

billing.billing_document_representation.dispatched-v1

	Name	Type
required	account_number	`string`
required	billing_document_id	`integer`
required	billing_document_identifier	`string`

Event Type	Payload Version
billing.billing_document_representation.dispatched	v1

{
  "account_number": "string",
  "billing_document_id": "integer",
  "billing_document_identifier": "string"
}

billing.billing_document_representation.dispatched-v2

	Name	Type
required	account_number	`string`
required	billing_document_id	`integer`
required	billing_document_identifier	`string`
required	billing_document_representation_dispatch_id	`integer`
required	billing_document_representations_id	`array[integer]`

Event Type	Payload Version
billing.billing_document_representation.dispatched	v2

{
  "account_number": "string",
  "billing_document_id": "integer",
  "billing_document_identifier": "string",
  "billing_document_representation_dispatch_id": "integer",
  "billing_document_representations_id": [
    "integer"
  ]
}

billing.billing_document_representation.dispatched-v3

	Name	Type
required	account_number	`string`
required	billing_document_id	`integer`
required	billing_document_identifier	`string`
required	billing_document_representation_dispatch_id	`integer`
required	billing_document_representations_id	`array[integer]`
required	support_user_id	`integer`

Event Type	Payload Version
billing.billing_document_representation.dispatched	v3

{
  "account_number": "string",
  "billing_document_id": "integer",
  "billing_document_identifier": "string",
  "billing_document_representation_dispatch_id": "integer",
  "billing_document_representations_id": [
    "integer"
  ],
  "support_user_id": "integer"
}

billing.billing_options.updated-v1

	Name	Type
required	account_number	`string`
required	previous_billing_options_id	`integer`
required	new_billing_options_id	`integer`
required	support_user_id	`integer`

Event Type	Payload Version
billing.billing_options.updated	v1

{
  "account_number": "string",
  "previous_billing_options_id": "integer",
  "new_billing_options_id": "integer",
  "support_user_id": "integer"
}

billing.charging-ledger.assigned-to-agreement-v1

	Name	Type
required	ledger_number	`string`
required	agreement_id	`integer`
required	assigned_at	`string`

Event Type	Payload Version
billing.charging-ledger.assigned-to-agreement	v1

{
  "ledger_number": "string",
  "agreement_id": "integer",
  "assigned_at": "string"
}

billing.charging.supply-point.triggered-v1

	Name	Type
required	supply_point_id	`integer`
required	charge_period	billing-_billing-_ChargePeriod

Event Type	Payload Version
billing.charging.supply-point.triggered	v1

{
  "supply_point_id": "integer",
  "charge_period": {
    "start_at": "string",
    "end_at": "string"
  }
}

billing.duos_invoice.cancel-v1

	Name	Type
required	invoice_event_id	`integer`

Event Type	Payload Version
billing.duos_invoice.cancel	v1

{
  "invoice_event_id": "integer"
}

billing.duos_invoice.new-v1

	Name	Type
required	invoice_event_id	`integer`

Event Type	Payload Version
billing.duos_invoice.new	v1

{
  "invoice_event_id": "integer"
}

billing.duos_invoice.replace-v1

	Name	Type
required	invoice_event_id	`integer`

Event Type	Payload Version
billing.duos_invoice.replace	v1

{
  "invoice_event_id": "integer"
}

billing.final_bill-v1

	Name	Type
required	account_number	`string`
required	account_user_emails	`array[string]`
required	statement_id	`integer`

Event Type	Payload Version
billing.final_bill	v1

{
  "account_number": "string",
  "account_user_emails": [
    "string"
  ],
  "statement_id": "integer"
}

billing.ledger.entry_posted-v1

	Name	Type
required	ledger	billing-_billing-Ledger

Event Type	Payload Version
billing.ledger.entry_posted	v1

{
  "ledger": {
    "account": {
      "number": "string"
    },
    "number": "string",
    "id": "string"
  }
}

billing.ledger.entry_posted-v2

	Name	Type
required	ledger	billing-_billing-Ledger
required	entry	billing-_billing-LedgerEntry

Event Type	Payload Version
billing.ledger.entry_posted	v2

{
  "ledger": {
    "account": {
      "number": "string"
    },
    "number": "string",
    "id": "string"
  },
  "entry": {
    "id": "integer",
    "is_charge": "boolean",
    "is_credit": "boolean",
    "is_payment": "boolean",
    "is_repayment": "boolean",
    "is_reversal": "boolean",
    "is_reversed": "boolean",
    "source_id": "integer",
    "source_type": "string"
  }
}

billing.ledger.entry_removed-v1

	Name	Type
required	ledger	billing-_billing-Ledger

Event Type	Payload Version
billing.ledger.entry_removed	v1

{
  "ledger": {
    "account": {
      "number": "string"
    },
    "number": "string",
    "id": "string"
  }
}

billing.ledger.entry_removed-v2

	Name	Type
required	ledger	billing-_billing-Ledger
required	entry	billing-_billing-LedgerEntryRemoval

Event Type	Payload Version
billing.ledger.entry_removed	v2

{
  "ledger": {
    "account": {
      "number": "string"
    },
    "number": "string",
    "id": "string"
  },
  "entry": {
    "id": "integer",
    "amount": "integer",
    "is_charge": "boolean",
    "is_credit": "boolean",
    "is_payment": "boolean",
    "is_repayment": "boolean",
    "is_reversal": "boolean",
    "is_reversed": "boolean",
    "source_reason": "string"
  }
}

billing.pathway_traversal.failed-v1

	Name	Type
required	pathway_id	`string`
required	traversal_attempt_id	`integer`
required	traversal_attempt_context	`object`
required	trigger_id	`integer`
required	failed_action_name	`string`
required	failed_action_error	`string`
required	failed_at	`string`

Event Type	Payload Version
billing.pathway_traversal.failed	v1

{
  "pathway_id": "string",
  "traversal_attempt_id": "integer",
  "traversal_attempt_context": "object",
  "trigger_id": "integer",
  "failed_action_name": "string",
  "failed_action_error": "string",
  "failed_at": "string"
}

billing.pathway_traversal.succeeded-v1

	Name	Type
required	pathway_id	`string`
required	traversal_attempt_id	`integer`
required	trigger_id	`integer`
required	succeeded_at	`string`

Event Type	Payload Version
billing.pathway_traversal.succeeded	v1

{
  "pathway_id": "string",
  "traversal_attempt_id": "integer",
  "trigger_id": "integer",
  "succeeded_at": "string"
}

billing.rebate.accepted-v1

	Name	Type
required	account_number	`string`
required	rebate_period_id	`integer`
required	rebate_type	`string`
required	effective_from	`string`
required	effective_to	`string`

Event Type	Payload Version
billing.rebate.accepted	v1

{
  "account_number": "string",
  "rebate_period_id": "integer",
  "rebate_type": "string",
  "effective_from": "string",
  "effective_to": "string"
}

billing.rebate.created-v1

	Name	Type
required	account_number	`string`
required	rebate_period_id	`integer`
required	rebate_type	`string`
required	effective_from	`string`
required	effective_to	`string`
required	is_application_accepted	`boolean`

Event Type	Payload Version
billing.rebate.created	v1

{
  "account_number": "string",
  "rebate_period_id": "integer",
  "rebate_type": "string",
  "effective_from": "string",
  "effective_to": "string",
  "is_application_accepted": "boolean"
}

billing.rebate.declined-v1

	Name	Type
required	account_number	`string`
required	rebate_period_id	`integer`
required	rebate_type	`string`
required	effective_from	`string`
required	effective_to	`string`
required	decline_reason	`string`

Event Type	Payload Version
billing.rebate.declined	v1

{
  "account_number": "string",
  "rebate_period_id": "integer",
  "rebate_type": "string",
  "effective_from": "string",
  "effective_to": "string",
  "decline_reason": "string"
}

billing.rebate.updated-v1

	Name	Type
required	account_number	`string`
required	rebate_period_id	`integer`
required	rebate_type	`string`
required	effective_from	`string`
required	effective_to	`string`
required	is_application_accepted	`boolean`

Event Type	Payload Version
billing.rebate.updated	v1

{
  "account_number": "string",
  "rebate_period_id": "integer",
  "rebate_type": "string",
  "effective_from": "string",
  "effective_to": "string",
  "is_application_accepted": "boolean"
}

business.created-v1

	Name	Type
required	id	`integer`

Event Type	Payload Version
business.created	v1

{
  "id": "integer"
}

business.updated-v1

	Name	Type
required	id	`integer`
required	changes	`object`

Event Type	Payload Version
business.updated	v1

{
  "id": "integer",
  "changes": "object"
}

business_operations_team.updated-v1

	Name	Type
required	id	`integer`
required	operations_team_id	`integer`

Event Type	Payload Version
business_operations_team.updated	v1

{
  "id": "integer",
  "operations_team_id": "integer"
}

campaign_account.added-v1

	Name	Type
required	account_number	`string`
required	campaign_name	`string`
	campaign_slug	`string`
	campaign_expiry_date	`string`
	campaign_account_expiry_date	`string`

Event Type	Payload Version
campaign_account.added	v1

{
  "account_number": "string",
  "campaign_name": "string",
  "campaign_slug": "string",
  "campaign_expiry_date": "string",
  "campaign_account_expiry_date": "string"
}

campaign_account.removed-v1

	Name	Type
required	account_number	`string`
required	campaign_name	`string`
	campaign_slug	`string`

Event Type	Payload Version
campaign_account.removed	v1

{
  "account_number": "string",
  "campaign_name": "string",
  "campaign_slug": "string"
}

campaign_account.updated-v1

	Name	Type
required	account_number	`string`
required	campaign_name	`string`
	campaign_slug	`string`
required	changes	`object`

Event Type	Payload Version
campaign_account.updated	v1

{
  "account_number": "string",
  "campaign_name": "string",
  "campaign_slug": "string",
  "changes": "object"
}

cashflow-_payments-Account

	Name	Type
required	number	`string`

{
  "number": "string"
}

cashflow-_payments-Ledger

	Name	Type
required	account	cashflow-_payments-Account
	id	`string`

{
  "account": {
    "number": "string"
  },
  "id": "string"
}

cashflow-_payments-Payment

	Name	Type
required	id	`integer`
required	amount	`integer`
required	payment_date	`string`
required	description	`string`
	failure_reason	`string`

{
  "id": "integer",
  "amount": "integer",
  "payment_date": "string",
  "description": "string",
  "failure_reason": "string"
}

charging.priming.errored-v1

	Name	Type
required	errors	`array[string]`
required	supply_point_id	`string`
required	period_start	`string`
required	period_end	`string`

Event Type	Payload Version
charging.priming.errored	v1

{
  "errors": [
    "string"
  ],
  "supply_point_id": "string",
  "period_start": "string",
  "period_end": "string"
}

collection_proceeding.created-v1

	Name	Type
required	id	`integer`
required	account_number	`string`
	amount	`integer`
	campaign	`string`
required	is_white_label	`boolean`
required	agency_code	`string`

Event Type	Payload Version
collection_proceeding.created	v1

{
  "id": "integer",
  "account_number": "string",
  "amount": "integer",
  "campaign": "string",
  "is_white_label": "boolean",
  "agency_code": "string"
}

collection_process.raised-v1

	Name	Type
required	number	`string`
required	account_number	`string`
	ledger	`string`
	billing_document	`string`
required	config_code	`string`

Event Type	Payload Version
collection_process.raised	v1

{
  "number": "string",
  "account_number": "string",
  "ledger": "string",
  "billing_document": "string",
  "config_code": "string"
}

collection_process.reactivated-v1

	Name	Type
required	number	`string`

Event Type	Payload Version
collection_process.reactivated	v1

{
  "number": "string"
}

collection_process.run_termination_requested-v1

	Name	Type
required	number	`string`

Event Type	Payload Version
collection_process.run_termination_requested	v1

{
  "number": "string"
}

collection_process.withdrawn-v1

	Name	Type
required	number	`string`
required	account_number	`string`
required	external_reference	`string`

Event Type	Payload Version
collection_process.withdrawn	v1

{
  "number": "string",
  "account_number": "string",
  "external_reference": "string"
}

collection_process.withdrawn-v2

	Name	Type
required	number	`string`
required	account_number	`string`

Event Type	Payload Version
collection_process.withdrawn	v2

{
  "number": "string",
  "account_number": "string"
}

comms.account-call.updated-v1

	Name	Type
required	account_number	`string`
required	call_id	`integer`
required	call_key	`string`
required	transcript_key	`string`
required	redacted_transcript_key	`string`
required	bucket	`string`
required	changes	`object`

Event Type	Payload Version
comms.account-call.updated	v1

{
  "account_number": "string",
  "call_id": "integer",
  "call_key": "string",
  "transcript_key": "string",
  "redacted_transcript_key": "string",
  "bucket": "string",
  "changes": "object"
}

comms.push-notification.received-unregistered-or-expired-token-v1

	Name	Type
required	push_notification_binding_id	`integer`

Event Type	Payload Version
comms.push-notification.received-unregistered-or-expired-token	v1

{
  "push_notification_binding_id": "integer"
}

comms.transcription.created-v1

	Name	Type
required	account_number	`string`
required	call_id	`integer`
required	call_key	`string`
required	transcript_key	`string`
required	redacted_transcript_key	`string`
required	bucket	`string`

Event Type	Payload Version
comms.transcription.created	v1

{
  "account_number": "string",
  "call_id": "integer",
  "call_key": "string",
  "transcript_key": "string",
  "redacted_transcript_key": "string",
  "bucket": "string"
}

concession.validated-v1

	Name	Type
required	account_user_id	`integer`
required	concession_id	`integer`
required	is_card_valid	`boolean`
required	is_first_validation	`boolean`
required	validated_at	`string`
	validation_dt	`string`
	failure_code	`string`
	failure_reason	`string`

Event Type	Payload Version
concession.validated	v1

{
  "account_user_id": "integer",
  "concession_id": "integer",
  "is_card_valid": "boolean",
  "is_first_validation": "boolean",
  "validated_at": "string",
  "validation_dt": "string",
  "failure_code": "string",
  "failure_reason": "string"
}

consents-consents-_Consent

	Name	Type
required	id	`integer`
required	consent_type_code	`string`
required	value	`string`
required	signed_at	`string`

{
  "id": "integer",
  "consent_type_code": "string",
  "value": "string",
  "signed_at": "string"
}

consents-consents-_SigningIdentity

	Name	Type
required	identity_type	`string`
required	identity	`string`

{
  "identity_type": "string",
  "identity": "string"
}

consents.consent.created-v1

	Name	Type
required	signing_identity	consents-consents-_SigningIdentity
required	consent	consents-consents-_Consent

Event Type	Payload Version
consents.consent.created	v1

{
  "signing_identity": {
    "identity_type": "string",
    "identity": "string"
  },
  "consent": {
    "id": "integer",
    "consent_type_code": "string",
    "value": "string",
    "signed_at": "string"
  }
}

consents.consent.updated-v1

	Name	Type
required	signing_identity	consents-consents-_SigningIdentity
required	consent	consents-consents-_Consent

Event Type	Payload Version
consents.consent.updated	v1

{
  "signing_identity": {
    "identity_type": "string",
    "identity": "string"
  },
  "consent": {
    "id": "integer",
    "consent_type_code": "string",
    "value": "string",
    "signed_at": "string"
  }
}

contracts.created-v1

	Name	Type
required	contract_identifier	`string`
required	occurred_at	`string`
	sales_record_identifier	`string`
	partner_commission_numbers	`array[string]`
	partner_commission_overrides	`object`

Event Type	Payload Version
contracts.created	v1

{
  "contract_identifier": "string",
  "occurred_at": "string",
  "sales_record_identifier": "string",
  "partner_commission_numbers": [
    "string"
  ],
  "partner_commission_overrides": "object"
}

contracts.journeys.creation.started-v1

	Name	Type
required	contract_journey	_journeys-_common-ContractJourney
required	contract_identifier	`string`
required	occurred_at	`string`
required	subject_contract_journeys	array[_journeys-_common-SubjectContractJourney]

Event Type	Payload Version
contracts.journeys.creation.started	v1

{
  "contract_journey": {
    "number": "string",
    "type": "string",
    "requested_at": "string"
  },
  "contract_identifier": "string",
  "occurred_at": "string",
  "subject_contract_journeys": [
    {
      "number": "string",
      "subject_number": "string"
    }
  ]
}

contracts.journeys.termination.started-v1

	Name	Type
required	contract_journey	_journeys-_common-ContractJourney
required	contract_identifier	`string`
required	occurred_at	`string`
required	subject_contract_journeys	array[_journeys-_common-SubjectContractJourney]

Event Type	Payload Version
contracts.journeys.termination.started	v1

{
  "contract_journey": {
    "number": "string",
    "type": "string",
    "requested_at": "string"
  },
  "contract_identifier": "string",
  "occurred_at": "string",
  "subject_contract_journeys": [
    {
      "number": "string",
      "subject_number": "string"
    }
  ]
}

contracts.journeys.variation.started-v1

	Name	Type
required	contract_journey	_journeys-_common-ContractJourney
required	contract_identifier	`string`
required	occurred_at	`string`

Event Type	Payload Version
contracts.journeys.variation.started	v1

{
  "contract_journey": {
    "number": "string",
    "type": "string",
    "requested_at": "string"
  },
  "contract_identifier": "string",
  "occurred_at": "string"
}

contracts.rescinded-v1

	Name	Type
required	contract_identifier	`string`
required	occurred_at	`string`

Event Type	Payload Version
contracts.rescinded	v1

{
  "contract_identifier": "string",
  "occurred_at": "string"
}

contracts.revoked-v1

	Name	Type
required	contract_identifier	`string`
required	occurred_at	`string`

Event Type	Payload Version
contracts.revoked	v1

{
  "contract_identifier": "string",
  "occurred_at": "string"
}

contracts.terminated-v1

	Name	Type
required	contract_identifier	`string`
required	occurred_at	`string`

Event Type	Payload Version
contracts.terminated	v1

{
  "contract_identifier": "string",
  "occurred_at": "string"
}

contracts.terms-varied-v1

	Name	Type
required	contract_identifier	`string`
required	occurred_at	`string`

Event Type	Payload Version
contracts.terms-varied	v1

{
  "contract_identifier": "string",
  "occurred_at": "string"
}

customer_access.partner_roles.created-v1

	Name	Type
required	code	`string`
required	permissions	`array[string]`

Event Type	Payload Version
customer_access.partner_roles.created	v1

{
  "code": "string",
  "permissions": [
    "string"
  ]
}

customer_access.partner_user_roles.created-v1

	Name	Type
required	code	`string`
required	permissions	`array[string]`

Event Type	Payload Version
customer_access.partner_user_roles.created	v1

{
  "code": "string",
  "permissions": [
    "string"
  ]
}

data_import.import_process.cancelled-v1

	Name	Type
required	resource_type	`string`
required	external_identifier	`string`
required	expiry_window_end	`string`

Event Type	Payload Version
data_import.import_process.cancelled	v1

{
  "resource_type": "string",
  "external_identifier": "string",
  "expiry_window_end": "string"
}

data_import.import_process.complete-v1

	Name	Type
required	resource_type	`string`
required	external_identifier	`string`
required	identifier	`string`

Event Type	Payload Version
data_import.import_process.complete	v1

{
  "resource_type": "string",
  "external_identifier": "string",
  "identifier": "string"
}

data_import.import_process.dry_run_complete-v1

	Name	Type
required	resource_type	`string`
required	external_identifier	`string`

Event Type	Payload Version
data_import.import_process.dry_run_complete	v1

{
  "resource_type": "string",
  "external_identifier": "string"
}

data_import.import_process.dry_run_error-v1

	Name	Type
required	resource_type	`string`
required	external_identifier	`string`
required	error_code	`string`
required	error_detail	`string`

Event Type	Payload Version
data_import.import_process.dry_run_error	v1

{
  "resource_type": "string",
  "external_identifier": "string",
  "error_code": "string",
  "error_detail": "string"
}

data_import.import_process.error-v1

	Name	Type
required	resource_type	`string`
required	external_identifier	`string`
required	error_code	`string`
required	error_detail	`string`

Event Type	Payload Version
data_import.import_process.error	v1

{
  "resource_type": "string",
  "external_identifier": "string",
  "error_code": "string",
  "error_detail": "string"
}

data_import.order_process.cancelled-v1

	Name	Type
required	external_order_id	`string`
required	expiry_window_end	`string`

Event Type	Payload Version
data_import.order_process.cancelled	v1

{
  "external_order_id": "string",
  "expiry_window_end": "string"
}

data_import.order_process.complete-v1

	Name	Type
required	external_order_id	`string`
required	process_id	`string`

Event Type	Payload Version
data_import.order_process.complete	v1

{
  "external_order_id": "string",
  "process_id": "string"
}

data_import.order_process.error-v1

	Name	Type
required	external_order_id	`string`
required	error_code	`string`
required	error_detail	`string`

Event Type	Payload Version
data_import.order_process.error	v1

{
  "external_order_id": "string",
  "error_code": "string",
  "error_detail": "string"
}

debt.actioning.automated_debt_write_back.completed-v1

	Name	Type
required	ledger_number	`string`
required	account_number	`string`
required	amount	`integer`

Event Type	Payload Version
debt.actioning.automated_debt_write_back.completed	v1

{
  "ledger_number": "string",
  "account_number": "string",
  "amount": "integer"
}

debt.actioning.automated_debt_write_back.failed-v1

	Name	Type
required	ledger_number	`string`
required	account_number	`string`
required	reason	`string`
required	exception	`string`

Event Type	Payload Version
debt.actioning.automated_debt_write_back.failed	v1

{
  "ledger_number": "string",
  "account_number": "string",
  "reason": "string",
  "exception": "string"
}

debt.actioning.automated_debt_write_back.skipped-v1

	Name	Type
required	ledger_number	`string`
required	account_number	`string`
required	reason	`string`

Event Type	Payload Version
debt.actioning.automated_debt_write_back.skipped	v1

{
  "ledger_number": "string",
  "account_number": "string",
  "reason": "string"
}

delinquent_debt.position_changed-v1

	Name	Type
required	ledger_number	`string`
required	changed_on	`string`
required	previous_value	`integer`
required	new_value	`integer`

Event Type	Payload Version
delinquent_debt.position_changed	v1

{
  "ledger_number": "string",
  "changed_on": "string",
  "previous_value": "integer",
  "new_value": "integer"
}

delinquent_debt.position_changed-v2

	Name	Type
required	ledger_number	`string`
required	changed_on	`string`
required	previous_value	`integer`
required	new_value	`integer`
required	account_number	`string`

Event Type	Payload Version
delinquent_debt.position_changed	v2

{
  "ledger_number": "string",
  "changed_on": "string",
  "previous_value": "integer",
  "new_value": "integer",
  "account_number": "string"
}

deposit_agreement.accepted-v1

	Name	Type
required	deposit_key	`string`
required	reason	`string`
required	amount	`integer`
required	account_number	`string`
required	ledger_identifier	`string`
required	accepted_at	`string`

Event Type	Payload Version
deposit_agreement.accepted	v1

{
  "deposit_key": "string",
  "reason": "string",
  "amount": "integer",
  "account_number": "string",
  "ledger_identifier": "string",
  "accepted_at": "string"
}

deposit_agreement.fulfilled-v1

	Name	Type
required	deposit_key	`string`
required	reason	`string`
required	amount	`integer`
required	account_number	`string`
required	ledger_identifier	`string`
required	fulfilled_at	`string`

Event Type	Payload Version
deposit_agreement.fulfilled	v1

{
  "deposit_key": "string",
  "reason": "string",
  "amount": "integer",
  "account_number": "string",
  "ledger_identifier": "string",
  "fulfilled_at": "string"
}

deposit_agreement.instalment_returned-v1

	Name	Type
required	deposit_key	`string`
required	reason	`string`
required	amount	`integer`
required	account_number	`string`
required	ledger_identifier	`string`
required	returned_amount	`integer`
required	returned_at	`string`

Event Type	Payload Version
deposit_agreement.instalment_returned	v1

{
  "deposit_key": "string",
  "reason": "string",
  "amount": "integer",
  "account_number": "string",
  "ledger_identifier": "string",
  "returned_amount": "integer",
  "returned_at": "string"
}

deposit_agreement.returned-v1

	Name	Type
required	deposit_key	`string`
required	reason	`string`
required	amount	`integer`
required	account_number	`string`
required	ledger_identifier	`string`
required	returned_at	`string`

Event Type	Payload Version
deposit_agreement.returned	v1

{
  "deposit_key": "string",
  "reason": "string",
  "amount": "integer",
  "account_number": "string",
  "ledger_identifier": "string",
  "returned_at": "string"
}

deposit_agreement.withdrawn-v1

	Name	Type
required	deposit_key	`string`
required	reason	`string`
required	amount	`integer`
required	account_number	`string`
required	ledger_identifier	`string`
required	withdrawn_at	`string`

Event Type	Payload Version
deposit_agreement.withdrawn	v1

{
  "deposit_key": "string",
  "reason": "string",
  "amount": "integer",
  "account_number": "string",
  "ledger_identifier": "string",
  "withdrawn_at": "string"
}

dunning_path_paused-v1

	Name	Type
required	account_number	`string`
required	dunning_path_name	`string`
required	dunning_process_id	`string`
required	pause_start_date	`string`
required	pause_end_date	`string`
required	created_note	`string`

Event Type	Payload Version
dunning_path_paused	v1

{
  "account_number": "string",
  "dunning_path_name": "string",
  "dunning_process_id": "string",
  "pause_start_date": "string",
  "pause_end_date": "string",
  "created_note": "string"
}

dunning_path_started-v1

	Name	Type
required	dunning_path_name	`string`
required	dunning_process_id	`string`
required	account_number	`string`
required	created_note	`string`
required	start_date	`string`

Event Type	Payload Version
dunning_path_started	v1

{
  "dunning_path_name": "string",
  "dunning_process_id": "string",
  "account_number": "string",
  "created_note": "string",
  "start_date": "string"
}

dunning_path_unpaused-v1

	Name	Type
required	account_number	`string`
required	dunning_path_name	`string`
required	dunning_process_id	`string`

Event Type	Payload Version
dunning_path_unpaused	v1

{
  "account_number": "string",
  "dunning_path_name": "string",
  "dunning_process_id": "string"
}

dunning_path_withdrawn-v1

	Name	Type
required	account_number	`string`
required	dunning_path_name	`string`
required	dunning_process_id	`string`
required	withdrawn_date	`string`
required	withdrawn_note	`string`

Event Type	Payload Version
dunning_path_withdrawn	v1

{
  "account_number": "string",
  "dunning_path_name": "string",
  "dunning_process_id": "string",
  "withdrawn_date": "string",
  "withdrawn_note": "string"
}

electricity.child-life-support-record.updated-v1

	Name	Type
required	parent_nmi	`string`

Event Type	Payload Version
electricity.child-life-support-record.updated	v1

{
  "parent_nmi": "string"
}

events-industry-MeteringAgreementTransitionContext

	Name	Type
	flow_run_id	`string`
	metering_agreement_transition_id	`integer`

{
  "flow_run_id": "string",
  "metering_agreement_transition_id": "integer"
}

events-register-ElecRegisterNTCChangeData

	Name	Type
required	before	array[events-register-MeterSnapshot]
required	after	array[events-register-MeterSnapshot]

{
  "before": [
    {
      "id": "integer",
      "serial_number": "string",
      "registers": [
        {
          "id": "integer",
          "register_identifier": "string",
          "time_of_day": "string",
          "controlled_load": "string",
          "network_tariff_codes": [
            {
              "id": "integer",
              "active_to": "string",
              "active_from": "string",
              "network_tariff_code": "string"
            }
          ]
        }
      ]
    }
  ],
  "after": [
    {
      "id": "integer",
      "serial_number": "string",
      "registers": [
        {
          "id": "integer",
          "register_identifier": "string",
          "time_of_day": "string",
          "controlled_load": "string",
          "network_tariff_codes": [
            {
              "id": "integer",
              "active_to": "string",
              "active_from": "string",
              "network_tariff_code": "string"
            }
          ]
        }
      ]
    }
  ]
}

events-register-MeterSnapshot

	Name	Type
required	id	`integer`
required	serial_number	`string`
required	registers	array[events-register-RegisterSnapshot]

{
  "id": "integer",
  "serial_number": "string",
  "registers": [
    {
      "id": "integer",
      "register_identifier": "string",
      "time_of_day": "string",
      "controlled_load": "string",
      "network_tariff_codes": [
        {
          "id": "integer",
          "active_to": "string",
          "active_from": "string",
          "network_tariff_code": "string"
        }
      ]
    }
  ]
}

events-register-NetworkTariffCodeSnapshot

	Name	Type
required	id	`integer`
	active_to	`string`
	active_from	`string`
required	network_tariff_code	`string`

{
  "id": "integer",
  "active_to": "string",
  "active_from": "string",
  "network_tariff_code": "string"
}

events-register-RegisterChange

	Name	Type
required	register_identifier	`string`
required	serial_number	`string`
	product_id	`string`
	product_name	`string`
	supply_daily_charge	`string`
	meter_installation_type	`string`
required	before	events-register-TariffState
required	after	events-register-TariffState

{
  "register_identifier": "string",
  "serial_number": "string",
  "product_id": "string",
  "product_name": "string",
  "supply_daily_charge": "string",
  "meter_installation_type": "string",
  "before": {
    "controlled_load": "string",
    "market_ntc": "string",
    "effective_ntc": "string",
    "ntc_active_from": "string",
    "ntc_active_to": "string"
  },
  "after": {
    "controlled_load": "string",
    "market_ntc": "string",
    "effective_ntc": "string",
    "ntc_active_from": "string",
    "ntc_active_to": "string"
  }
}

events-register-RegisterSnapshot

	Name	Type
required	id	`integer`
required	register_identifier	`string`
required	time_of_day	`string`
required	controlled_load	`string`
required	network_tariff_codes	array[events-register-NetworkTariffCodeSnapshot]

{
  "id": "integer",
  "register_identifier": "string",
  "time_of_day": "string",
  "controlled_load": "string",
  "network_tariff_codes": [
    {
      "id": "integer",
      "active_to": "string",
      "active_from": "string",
      "network_tariff_code": "string"
    }
  ]
}

events-register-TariffState

	Name	Type
required	controlled_load	`string`
required	market_ntc	`string`
required	effective_ntc	`string`
required	ntc_active_from	`string`
	ntc_active_to	`string`

{
  "controlled_load": "string",
  "market_ntc": "string",
  "effective_ntc": "string",
  "ntc_active_from": "string",
  "ntc_active_to": "string"
}

events-register-TriggerExtra

	Name	Type
required	registers	array[events-register-RegisterChange]

{
  "registers": [
    {
      "register_identifier": "string",
      "serial_number": "string",
      "product_id": "string",
      "product_name": "string",
      "supply_daily_charge": "string",
      "meter_installation_type": "string",
      "before": {
        "controlled_load": "string",
        "market_ntc": "string",
        "effective_ntc": "string",
        "ntc_active_from": "string",
        "ntc_active_to": "string"
      },
      "after": {
        "controlled_load": "string",
        "market_ntc": "string",
        "effective_ntc": "string",
        "ntc_active_from": "string",
        "ntc_active_to": "string"
      }
    }
  ]
}

fieldworks.elec_supply_abolishment_so_requested-v1

	Name	Type
required	job_id	`integer`

Event Type	Payload Version
fieldworks.elec_supply_abolishment_so_requested	v1

{
  "job_id": "integer"
}

fieldworks.gas_supply_abolishment_so_requested-v1

	Name	Type
required	job_id	`integer`

Event Type	Payload Version
fieldworks.gas_supply_abolishment_so_requested	v1

{
  "job_id": "integer"
}

gas.child-life-support-record.updated-v1

	Name	Type
required	parent_mirn	`string`

Event Type	Payload Version
gas.child-life-support-record.updated	v1

{
  "parent_mirn": "string"
}

goods.purchase-created-v1

	Name	Type
required	purchase_id	`integer`
required	account_id	`integer`
	support_user_id	`integer`

Event Type	Payload Version
goods.purchase-created	v1

{
  "purchase_id": "integer",
  "account_id": "integer",
  "support_user_id": "integer"
}

goods.quote.created-for-account-v1

	Name	Type
required	account_number	`string`
required	market_name	`string`
required	quote_id	`integer`
required	client_params	`object`
required	lead_id	`integer`

Event Type	Payload Version
goods.quote.created-for-account	v1

{
  "account_number": "string",
  "market_name": "string",
  "quote_id": "integer",
  "client_params": "object",
  "lead_id": "integer"
}

goods.quote.created-without-account-v1

	Name	Type
required	market_name	`string`
required	quote_id	`integer`
required	contact_info	`object`
required	client_params	`object`
required	lead_id	`integer`

Event Type	Payload Version
goods.quote.created-without-account	v1

{
  "market_name": "string",
  "quote_id": "integer",
  "contact_info": "object",
  "client_params": "object",
  "lead_id": "integer"
}

industry.aus.electricity.change_metering_coordinator.cancelled-v1

	Name	Type
required	change_reason_code	`string`
required	change_request_id	`string`
	context	events-industry-MeteringAgreementTransitionContext
	details	`string`
required	nmi	`string`

Event Type	Payload Version
industry.aus.electricity.change_metering_coordinator.cancelled	v1

{
  "change_reason_code": "string",
  "change_request_id": "string",
  "context": {
    "flow_run_id": "string",
    "metering_agreement_transition_id": "integer"
  },
  "details": "string",
  "nmi": "string"
}

industry.aus.electricity.change_metering_coordinator.completed-v1

	Name	Type
required	change_reason_code	`string`
required	change_request_id	`string`
	context	events-industry-MeteringAgreementTransitionContext
	details	`string`
required	nmi	`string`

Event Type	Payload Version
industry.aus.electricity.change_metering_coordinator.completed	v1

{
  "change_reason_code": "string",
  "change_request_id": "string",
  "context": {
    "flow_run_id": "string",
    "metering_agreement_transition_id": "integer"
  },
  "details": "string",
  "nmi": "string"
}

industry.aus.electricity.change_metering_coordinator.objection_raised-v1

	Name	Type
required	change_reason_code	`string`
required	change_request_id	`string`
	context	events-industry-MeteringAgreementTransitionContext
	details	`string`
required	nmi	`string`

Event Type	Payload Version
industry.aus.electricity.change_metering_coordinator.objection_raised	v1

{
  "change_reason_code": "string",
  "change_request_id": "string",
  "context": {
    "flow_run_id": "string",
    "metering_agreement_transition_id": "integer"
  },
  "details": "string",
  "nmi": "string"
}

industry.aus.electricity.change_metering_coordinator.pending-v1

	Name	Type
required	change_reason_code	`string`
required	change_request_id	`string`
	context	events-industry-MeteringAgreementTransitionContext
	details	`string`
required	nmi	`string`

Event Type	Payload Version
industry.aus.electricity.change_metering_coordinator.pending	v1

{
  "change_reason_code": "string",
  "change_request_id": "string",
  "context": {
    "flow_run_id": "string",
    "metering_agreement_transition_id": "integer"
  },
  "details": "string",
  "nmi": "string"
}

industry.aus.electricity.change_metering_coordinator.pending_validation-v1

	Name	Type
required	change_reason_code	`string`
required	change_request_id	`string`
	context	events-industry-MeteringAgreementTransitionContext
	details	`string`
required	nmi	`string`

Event Type	Payload Version
industry.aus.electricity.change_metering_coordinator.pending_validation	v1

{
  "change_reason_code": "string",
  "change_request_id": "string",
  "context": {
    "flow_run_id": "string",
    "metering_agreement_transition_id": "integer"
  },
  "details": "string",
  "nmi": "string"
}

industry.aus.electricity.change_metering_coordinator.rejected-v1

	Name	Type
required	change_reason_code	`string`
required	change_request_id	`string`
	context	events-industry-MeteringAgreementTransitionContext
	details	`string`
required	nmi	`string`

Event Type	Payload Version
industry.aus.electricity.change_metering_coordinator.rejected	v1

{
  "change_reason_code": "string",
  "change_request_id": "string",
  "context": {
    "flow_run_id": "string",
    "metering_agreement_transition_id": "integer"
  },
  "details": "string",
  "nmi": "string"
}

industry.aus.electricity.change_metering_coordinator.request_failed-v1

	Name	Type
required	nmi	`string`
required	change_reason_code	`string`
	context	events-industry-MeteringAgreementTransitionContext
required	error_code	`string`
	details	`string`

Event Type	Payload Version
industry.aus.electricity.change_metering_coordinator.request_failed	v1

{
  "nmi": "string",
  "change_reason_code": "string",
  "context": {
    "flow_run_id": "string",
    "metering_agreement_transition_id": "integer"
  },
  "error_code": "string",
  "details": "string"
}

industry.aus.electricity.change_metering_coordinator.requested-v1

	Name	Type
required	change_reason_code	`string`
required	change_request_id	`string`
	context	events-industry-MeteringAgreementTransitionContext
	details	`string`
required	nmi	`string`

Event Type	Payload Version
industry.aus.electricity.change_metering_coordinator.requested	v1

{
  "change_reason_code": "string",
  "change_request_id": "string",
  "context": {
    "flow_run_id": "string",
    "metering_agreement_transition_id": "integer"
  },
  "details": "string",
  "nmi": "string"
}

industry.aus.electricity.change_of_supply.completed-v1

	Name	Type
required	change_request_id	`integer`

Event Type	Payload Version
industry.aus.electricity.change_of_supply.completed	v1

{
  "change_request_id": "integer"
}

industry.aus.electricity.ci_dma_sla.feature_disabled-v1

	Name	Type
required	inbound_event_type	`string`
	nmi	`string`
	transition_id	`integer`
	context	events-industry-MeteringAgreementTransitionContext

Event Type	Payload Version
industry.aus.electricity.ci_dma_sla.feature_disabled	v1

{
  "inbound_event_type": "string",
  "nmi": "string",
  "transition_id": "integer",
  "context": {
    "flow_run_id": "string",
    "metering_agreement_transition_id": "integer"
  }
}

industry.aus.electricity.ci_prechecks.cancelled-v1

	Name	Type
required	metering_agreement_transition_id	`integer`
required	account_number	`string`
required	nmi	`string`
required	transition_date	`string`
required	transition_type	`string`
required	cancelled_reason	`string`
required	initiating_mechanism	`string`
required	cancelled_at	`string`
	flow_run_id	`string`
	initiating_reference_id	`string`
	restart_transition_id	`integer`
	operator_id	`integer`

Event Type	Payload Version
industry.aus.electricity.ci_prechecks.cancelled	v1

{
  "metering_agreement_transition_id": "integer",
  "account_number": "string",
  "nmi": "string",
  "transition_date": "string",
  "transition_type": "string",
  "cancelled_reason": "string",
  "initiating_mechanism": "string",
  "cancelled_at": "string",
  "flow_run_id": "string",
  "initiating_reference_id": "string",
  "restart_transition_id": "integer",
  "operator_id": "integer"
}

industry.aus.electricity.ci_prechecks.commence-v1

	Name	Type
required	transition_id	`integer`
required	nmi	`string`
required	account_number	`string`
required	transition_start_date	`string`
required	transition_type	`string`
required	is_contract_start	`boolean`
required	frmp_id_current	`string`
	mc_id_current	`string`
	mc_id_next	`string`
	mpb_id_current	`string`
	mpb_id_next	`string`
required	nmi_classification_code	`string`
required	jurisdiction	`string`
required	lnsp_id	`string`
required	customer_threshold_code	`string`
required	is_manually_read	`boolean`
required	nmi_status	`string`

Event Type	Payload Version
industry.aus.electricity.ci_prechecks.commence	v1

{
  "transition_id": "integer",
  "nmi": "string",
  "account_number": "string",
  "transition_start_date": "string",
  "transition_type": "string",
  "is_contract_start": "boolean",
  "frmp_id_current": "string",
  "mc_id_current": "string",
  "mc_id_next": "string",
  "mpb_id_current": "string",
  "mpb_id_next": "string",
  "nmi_classification_code": "string",
  "jurisdiction": "string",
  "lnsp_id": "string",
  "customer_threshold_code": "string",
  "is_manually_read": "boolean",
  "nmi_status": "string"
}

industry.aus.electricity.meter_exchange_service_order.accepted-v1

	Name	Type
required	nmi	`string`
	service_order_id	`integer`
required	service_order_number	`string`
required	service_order_type	`string`
required	service_order_subtype	`string`
required	status	`string`
	response_code	`string`
	details	`string`
	context	events-industry-MeteringAgreementTransitionContext

Event Type	Payload Version
industry.aus.electricity.meter_exchange_service_order.accepted	v1

{
  "nmi": "string",
  "service_order_id": "integer",
  "service_order_number": "string",
  "service_order_type": "string",
  "service_order_subtype": "string",
  "status": "string",
  "response_code": "string",
  "details": "string",
  "context": {
    "flow_run_id": "string",
    "metering_agreement_transition_id": "integer"
  }
}

industry.aus.electricity.meter_exchange_service_order.cancelled-v1

	Name	Type
required	nmi	`string`
	service_order_id	`integer`
required	service_order_number	`string`
required	service_order_type	`string`
required	service_order_subtype	`string`
required	status	`string`
	response_code	`string`
	details	`string`
	context	events-industry-MeteringAgreementTransitionContext

Event Type	Payload Version
industry.aus.electricity.meter_exchange_service_order.cancelled	v1

{
  "nmi": "string",
  "service_order_id": "integer",
  "service_order_number": "string",
  "service_order_type": "string",
  "service_order_subtype": "string",
  "status": "string",
  "response_code": "string",
  "details": "string",
  "context": {
    "flow_run_id": "string",
    "metering_agreement_transition_id": "integer"
  }
}

industry.aus.electricity.meter_exchange_service_order.completed-v1

	Name	Type
required	nmi	`string`
	service_order_id	`integer`
required	service_order_number	`string`
required	service_order_type	`string`
required	service_order_subtype	`string`
required	status	`string`
	response_code	`string`
	details	`string`
	context	events-industry-MeteringAgreementTransitionContext

Event Type	Payload Version
industry.aus.electricity.meter_exchange_service_order.completed	v1

{
  "nmi": "string",
  "service_order_id": "integer",
  "service_order_number": "string",
  "service_order_type": "string",
  "service_order_subtype": "string",
  "status": "string",
  "response_code": "string",
  "details": "string",
  "context": {
    "flow_run_id": "string",
    "metering_agreement_transition_id": "integer"
  }
}

industry.aus.electricity.meter_exchange_service_order.disputed-v1

	Name	Type
required	nmi	`string`
	service_order_id	`integer`
required	service_order_number	`string`
required	service_order_type	`string`
required	service_order_subtype	`string`
required	status	`string`
	response_code	`string`
	details	`string`
	context	events-industry-MeteringAgreementTransitionContext

Event Type	Payload Version
industry.aus.electricity.meter_exchange_service_order.disputed	v1

{
  "nmi": "string",
  "service_order_id": "integer",
  "service_order_number": "string",
  "service_order_type": "string",
  "service_order_subtype": "string",
  "status": "string",
  "response_code": "string",
  "details": "string",
  "context": {
    "flow_run_id": "string",
    "metering_agreement_transition_id": "integer"
  }
}

industry.aus.electricity.meter_exchange_service_order.not_completed-v1

	Name	Type
required	nmi	`string`
	service_order_id	`integer`
required	service_order_number	`string`
required	service_order_type	`string`
required	service_order_subtype	`string`
required	status	`string`
	response_code	`string`
	details	`string`
	context	events-industry-MeteringAgreementTransitionContext

Event Type	Payload Version
industry.aus.electricity.meter_exchange_service_order.not_completed	v1

{
  "nmi": "string",
  "service_order_id": "integer",
  "service_order_number": "string",
  "service_order_type": "string",
  "service_order_subtype": "string",
  "status": "string",
  "response_code": "string",
  "details": "string",
  "context": {
    "flow_run_id": "string",
    "metering_agreement_transition_id": "integer"
  }
}

industry.aus.electricity.meter_exchange_service_order.partially_completed-v1

	Name	Type
required	nmi	`string`
	service_order_id	`integer`
required	service_order_number	`string`
required	service_order_type	`string`
required	service_order_subtype	`string`
required	status	`string`
	response_code	`string`
	details	`string`
	context	events-industry-MeteringAgreementTransitionContext

Event Type	Payload Version
industry.aus.electricity.meter_exchange_service_order.partially_completed	v1

{
  "nmi": "string",
  "service_order_id": "integer",
  "service_order_number": "string",
  "service_order_type": "string",
  "service_order_subtype": "string",
  "status": "string",
  "response_code": "string",
  "details": "string",
  "context": {
    "flow_run_id": "string",
    "metering_agreement_transition_id": "integer"
  }
}

industry.aus.electricity.meter_exchange_service_order.rejected-v1

	Name	Type
required	nmi	`string`
	service_order_id	`integer`
required	service_order_number	`string`
required	service_order_type	`string`
required	service_order_subtype	`string`
required	status	`string`
	response_code	`string`
	details	`string`
	context	events-industry-MeteringAgreementTransitionContext

Event Type	Payload Version
industry.aus.electricity.meter_exchange_service_order.rejected	v1

{
  "nmi": "string",
  "service_order_id": "integer",
  "service_order_number": "string",
  "service_order_type": "string",
  "service_order_subtype": "string",
  "status": "string",
  "response_code": "string",
  "details": "string",
  "context": {
    "flow_run_id": "string",
    "metering_agreement_transition_id": "integer"
  }
}

industry.aus.electricity.meter_exchange_service_order.request_failed-v1

	Name	Type
required	nmi	`string`
required	service_order_type	`string`
required	service_order_subtype	`string`
	context	events-industry-MeteringAgreementTransitionContext
required	error_code	`string`
	details	`string`

Event Type	Payload Version
industry.aus.electricity.meter_exchange_service_order.request_failed	v1

{
  "nmi": "string",
  "service_order_type": "string",
  "service_order_subtype": "string",
  "context": {
    "flow_run_id": "string",
    "metering_agreement_transition_id": "integer"
  },
  "error_code": "string",
  "details": "string"
}

industry.aus.electricity.meter_exchange_service_order.requested-v1

	Name	Type
required	nmi	`string`
	service_order_id	`integer`
required	service_order_number	`string`
required	service_order_type	`string`
required	service_order_subtype	`string`
required	status	`string`
	response_code	`string`
	details	`string`
	context	events-industry-MeteringAgreementTransitionContext

Event Type	Payload Version
industry.aus.electricity.meter_exchange_service_order.requested	v1

{
  "nmi": "string",
  "service_order_id": "integer",
  "service_order_number": "string",
  "service_order_type": "string",
  "service_order_subtype": "string",
  "status": "string",
  "response_code": "string",
  "details": "string",
  "context": {
    "flow_run_id": "string",
    "metering_agreement_transition_id": "integer"
  }
}

industry.aus.electricity.meter_point.defect_changed-v1

	Name	Type
required	nmi	`string`
required	change_type	`string`
required	defect_description	`array[string]`
required	defect_status	`array[string]`
required	defect_flag	`array[string]`
required	defect_issuing_mc	`array[string]`
required	defect_type	`array[string]`

Event Type	Payload Version
industry.aus.electricity.meter_point.defect_changed	v1

{
  "nmi": "string",
  "change_type": "string",
  "defect_description": [
    "string"
  ],
  "defect_status": [
    "string"
  ],
  "defect_flag": [
    "string"
  ],
  "defect_issuing_mc": [
    "string"
  ],
  "defect_type": [
    "string"
  ]
}

industry.aus.electricity.meter_point.standing_data_dlf_code_changed-v1

	Name	Type
	initiating_type	`string`
required	meter_point_event_id	`integer`
required	meter_point_id	`integer`
required	nmi	`string`
required	changes	array[DlfChanges]

Event Type	Payload Version
industry.aus.electricity.meter_point.standing_data_dlf_code_changed	v1

{
  "initiating_type": "string",
  "meter_point_event_id": "integer",
  "meter_point_id": "integer",
  "nmi": "string",
  "changes": [
    {
      "nmi": "string",
      "dlf_before": "string",
      "dlf_after": "string",
      "period": {
        "start": "string",
        "end": "string",
        "boundaries": "string"
      }
    }
  ]
}

industry.aus.electricity.meter_point.standing_data_sync_completed_successfully-v1

	Name	Type
	initiating_type	`string`
required	meter_point_event_id	`integer`
required	meter_point_id	`integer`
required	nmi	`string`
required	property_id	`integer`

Event Type	Payload Version
industry.aus.electricity.meter_point.standing_data_sync_completed_successfully	v1

{
  "initiating_type": "string",
  "meter_point_event_id": "integer",
  "meter_point_id": "integer",
  "nmi": "string",
  "property_id": "integer"
}

industry.aus.electricity.meter_point.standing_data_tni_code_changed-v1

	Name	Type
	initiating_type	`string`
required	meter_point_event_id	`integer`
required	meter_point_id	`integer`
required	nmi	`string`
required	changes	array[TniChanges]

Event Type	Payload Version
industry.aus.electricity.meter_point.standing_data_tni_code_changed	v1

{
  "initiating_type": "string",
  "meter_point_event_id": "integer",
  "meter_point_id": "integer",
  "nmi": "string",
  "changes": [
    {
      "nmi": "string",
      "tni_before": "string",
      "tni_after": "string",
      "period": {
        "start": "string",
        "end": "string",
        "boundaries": "string"
      }
    }
  ]
}

industry.aus.electricity.service_order.not_completed.shared_fuse_scoping_request_required-v1

	Name	Type
required	service_order_id	`integer`

Event Type	Payload Version
industry.aus.electricity.service_order.not_completed.shared_fuse_scoping_request_required	v1

{
  "service_order_id": "integer"
}

industry.aus.electricity.site_access_notification.accepted_by_industry-v1

	Name	Type
required	meter_point_identifier	`string`
required	initiating_transaction_id	`string`

Event Type	Payload Version
industry.aus.electricity.site_access_notification.accepted_by_industry	v1

{
  "meter_point_identifier": "string",
  "initiating_transaction_id": "string"
}

industry.aus.electricity.site_access_notification.awaiting_delivery-v1

	Name	Type
required	supply_point_id	`string`
required	effective_at	`string`
required	to_participant_id	`string`
required	fuel	`string`
	sar_transaction_id	`string`

Event Type	Payload Version
industry.aus.electricity.site_access_notification.awaiting_delivery	v1

{
  "supply_point_id": "string",
  "effective_at": "string",
  "to_participant_id": "string",
  "fuel": "string",
  "sar_transaction_id": "string"
}

industry.aus.electricity.site_access_notification.rejected_by_industry-v1

	Name	Type
required	meter_point_identifier	`string`
required	initiating_transaction_id	`string`

Event Type	Payload Version
industry.aus.electricity.site_access_notification.rejected_by_industry	v1

{
  "meter_point_identifier": "string",
  "initiating_transaction_id": "string"
}

industry.aus.electricity.site_access_notification.sent_to_industry-v1

	Name	Type
required	meter_point_identifier	`string`
required	effective_at	`string`
required	sent_to	`string`
required	transaction_id	`string`

Event Type	Payload Version
industry.aus.electricity.site_access_notification.sent_to_industry	v1

{
  "meter_point_identifier": "string",
  "effective_at": "string",
  "sent_to": "string",
  "transaction_id": "string"
}

industry.aus.meter_data_quality.resolution_cancelled-v1

	Name	Type
required	issue_id	`integer`
required	issue_category	`string`
required	issue_subcategory	`string`
required	issue_status	`string`
required	market_supply_point_id	`string`
required	opened_at	`string`
required	period_start	`string`
required	period_end	`string`
required	reading_type	`string`
required	utility	`string`
required	market_name	`string`
	meter_data_provider	`string`
	retailer	`string`
	cadence	`string`

Event Type	Payload Version
industry.aus.meter_data_quality.resolution_cancelled	v1

{
  "issue_id": "integer",
  "issue_category": "string",
  "issue_subcategory": "string",
  "issue_status": "string",
  "market_supply_point_id": "string",
  "opened_at": "string",
  "period_start": "string",
  "period_end": "string",
  "reading_type": "string",
  "utility": "string",
  "market_name": "string",
  "meter_data_provider": "string",
  "retailer": "string",
  "cadence": "string"
}

industry.aus.meter_data_quality.resolution_cancelled-v2

	Name	Type
required	issue_id	`integer`
required	issue_category	`string`
required	issue_subcategory	`string`
required	issue_status	`string`
required	market_supply_point_id	`string`
required	opened_at	`string`
required	period_start	`string`
required	period_end	`string`
required	reading_type	`string`
required	utility	`string`
required	source	`string`
required	market_name	`string`
	meter_data_provider	`string`
	retailer	`string`
	cadence	`string`

Event Type	Payload Version
industry.aus.meter_data_quality.resolution_cancelled	v2

{
  "issue_id": "integer",
  "issue_category": "string",
  "issue_subcategory": "string",
  "issue_status": "string",
  "market_supply_point_id": "string",
  "opened_at": "string",
  "period_start": "string",
  "period_end": "string",
  "reading_type": "string",
  "utility": "string",
  "source": "string",
  "market_name": "string",
  "meter_data_provider": "string",
  "retailer": "string",
  "cadence": "string"
}

industry.aus.meter_data_quality.resolution_requested-v1

	Name	Type
required	issue_id	`integer`
required	issue_category	`string`
required	issue_subcategory	`string`
required	issue_status	`string`
required	market_supply_point_id	`string`
required	opened_at	`string`
required	period_start	`string`
required	period_end	`string`
required	reading_type	`string`
required	utility	`string`
required	market_name	`string`
	meter_data_provider	`string`
	retailer	`string`
	cadence	`string`

Event Type	Payload Version
industry.aus.meter_data_quality.resolution_requested	v1

{
  "issue_id": "integer",
  "issue_category": "string",
  "issue_subcategory": "string",
  "issue_status": "string",
  "market_supply_point_id": "string",
  "opened_at": "string",
  "period_start": "string",
  "period_end": "string",
  "reading_type": "string",
  "utility": "string",
  "market_name": "string",
  "meter_data_provider": "string",
  "retailer": "string",
  "cadence": "string"
}

industry.aus.outage_contact.created-v1

	Name	Type
required	supply_point_identifier	`string`
required	nmi	`string`
required	account_number	`string`
required	property_id	`integer`
required	effective_from	`string`
	updated_at	`string`

Event Type	Payload Version
industry.aus.outage_contact.created	v1

{
  "supply_point_identifier": "string",
  "nmi": "string",
  "account_number": "string",
  "property_id": "integer",
  "effective_from": "string",
  "updated_at": "string"
}

industry.aus.outage_contact.ended-v1

	Name	Type
required	supply_point_identifier	`string`
required	nmi	`string`
required	active_to	`string`

Event Type	Payload Version
industry.aus.outage_contact.ended	v1

{
  "supply_point_identifier": "string",
  "nmi": "string",
  "active_to": "string"
}

industry.aus.outage_contact.store.failed-v1

	Name	Type
required	supply_point_identifier	`string`
required	reason	`string`

Event Type	Payload Version
industry.aus.outage_contact.store.failed	v1

{
  "supply_point_identifier": "string",
  "reason": "string"
}

industry.electricity.change_of_energisation.unsolicited_message-v1

	Name	Type
required	mpan	`string`
required	energisation_status	`string`
required	effective_from	`string`

Event Type	Payload Version
industry.electricity.change_of_energisation.unsolicited_message	v1

{
  "mpan": "string",
  "energisation_status": "string",
  "effective_from": "string"
}

industry.electricity.change_of_service.meter_deactivated-v1

	Name	Type
required	mpan	`string`
required	serial_number	`string`
required	effective_from	`string`

Event Type	Payload Version
industry.electricity.change_of_service.meter_deactivated	v1

{
  "mpan": "string",
  "serial_number": "string",
  "effective_from": "string"
}

industry.electricity.change_of_supply.gain.initiated-v1

	Name	Type
required	meter_point_identifier	`string`

Event Type	Payload Version
industry.electricity.change_of_supply.gain.initiated	v1

{
  "meter_point_identifier": "string"
}

industry.electricity.change_of_supply.loss.complete-v1

	Name	Type
required	account_number	`string`
required	mpan	`string`
required	supply_end_date	`string`
required	new_supplier_id	`string`

Event Type	Payload Version
industry.electricity.change_of_supply.loss.complete	v1

{
  "account_number": "string",
  "mpan": "string",
  "supply_end_date": "string",
  "new_supplier_id": "string"
}

industry.gas.change_of_supply.gain.initiated-v1

	Name	Type
required	meter_point_identifier	`string`

Event Type	Payload Version
industry.gas.change_of_supply.gain.initiated	v1

{
  "meter_point_identifier": "string"
}

industry.gas.change_of_supply.loss.complete-v1

	Name	Type
required	account_number	`string`
required	mprn	`string`
required	supply_end_date	`string`
required	new_supplier_id	`string`

Event Type	Payload Version
industry.gas.change_of_supply.loss.complete	v1

{
  "account_number": "string",
  "mprn": "string",
  "supply_end_date": "string",
  "new_supplier_id": "string"
}

ink-_actions-_InkAction

	Name	Type
required	code	`string`
required	succeeded	`boolean`
required	stop_further_evaluation	`boolean`

{
  "code": "string",
  "succeeded": "boolean",
  "stop_further_evaluation": "boolean"
}

ink-_content-_InkContent

	Name	Type
	from_address	`string`
	subject	`string`
	to_addresses	`array[string]`
required	tags	`array[string]`

{
  "from_address": "string",
  "subject": "string",
  "to_addresses": [
    "string"
  ],
  "tags": [
    "string"
  ]
}

ink-_content-_InkMessageContent

	Name	Type
required	message_id	`integer`
required	occurred_at	`string`
required	channel	`string`
required	content	ink-_content-_InkContent

{
  "message_id": "integer",
  "occurred_at": "string",
  "channel": "string",
  "content": {
    "from_address": "string",
    "subject": "string",
    "to_addresses": [
      "string"
    ],
    "tags": [
      "string"
    ]
  }
}

ink-_messages-InkConversation

	Name	Type
required	conversation_relay_id	`string`
required	account_number	`string`
required	message	ink-_messages-_InkMessage

{
  "conversation_relay_id": "string",
  "account_number": "string",
  "message": {
    "relay_id": "string",
    "channel": "string",
    "occurred_at": "string"
  }
}

ink-_messages-_InkFailureData

	Name	Type
required	type	`string`
required	reason	`string`
required	occurred_at	`string`

{
  "type": "string",
  "reason": "string",
  "occurred_at": "string"
}

ink-_messages-_InkMessage

	Name	Type
required	relay_id	`string`
required	channel	`string`
required	occurred_at	`string`

{
  "relay_id": "string",
  "channel": "string",
  "occurred_at": "string"
}

ink-_messages-_InkMessageWithVendor

	Name	Type
required	relay_id	`string`
required	vendor	`string`
required	vendor_id	`string`
required	channel	`string`
required	occurred_at	`string`

{
  "relay_id": "string",
  "vendor": "string",
  "vendor_id": "string",
  "channel": "string",
  "occurred_at": "string"
}

ink.actions.run-v1

	Name	Type
required	conversation_relay_id	`string`
required	message_relay_id	`string`
required	actions_results	array[ink-_actions-_InkAction]

Event Type	Payload Version
ink.actions.run	v1

{
  "conversation_relay_id": "string",
  "message_relay_id": "string",
  "actions_results": [
    {
      "code": "string",
      "succeeded": "boolean",
      "stop_further_evaluation": "boolean"
    }
  ]
}

ink.content.inbound-message-tagged-v1

	Name	Type
required	conversation_id	`integer`
required	conversation_relay_id	`string`
required	account_number	`string`
required	message	ink-_content-_InkMessageContent

Event Type	Payload Version
ink.content.inbound-message-tagged	v1

{
  "conversation_id": "integer",
  "conversation_relay_id": "string",
  "account_number": "string",
  "message": {
    "message_id": "integer",
    "occurred_at": "string",
    "channel": "string",
    "content": {
      "from_address": "string",
      "subject": "string",
      "to_addresses": [
        "string"
      ],
      "tags": [
        "string"
      ]
    }
  }
}

ink.conversation.assigned_to_bucket-v1

	Name	Type
required	conversation_relay_id	`string`
required	bucket_relay_id	`string`
required	support_user_id	`integer`
required	organisation_id	`integer`

Event Type	Payload Version
ink.conversation.assigned_to_bucket	v1

{
  "conversation_relay_id": "string",
  "bucket_relay_id": "string",
  "support_user_id": "integer",
  "organisation_id": "integer"
}

ink.conversation.assigned_to_timeline-v1

	Name	Type
required	conversation_relay_id	`string`
required	timeline_relay_id	`string`
required	support_user_id	`integer`

Event Type	Payload Version
ink.conversation.assigned_to_timeline	v1

{
  "conversation_relay_id": "string",
  "timeline_relay_id": "string",
  "support_user_id": "integer"
}

ink.conversation.await_customer_reply-v1

	Name	Type
required	conversation_id	`integer`
required	conversation_relay_id	`string`
required	account_number	`string`
required	latest_contacted_account_user_number	`string`
required	support_user_id	`integer`
required	organisation_id	`integer`

Event Type	Payload Version
ink.conversation.await_customer_reply	v1

{
  "conversation_id": "integer",
  "conversation_relay_id": "string",
  "account_number": "string",
  "latest_contacted_account_user_number": "string",
  "support_user_id": "integer",
  "organisation_id": "integer"
}

ink.conversation.closed-v1

	Name	Type
required	conversation_id	`integer`
required	conversation_relay_id	`string`
required	account_number	`string`
required	latest_contacted_account_user_number	`string`
required	support_user_id	`integer`
required	organisation_id	`integer`
required	closed_at	`string`
required	reason	`string`

Event Type	Payload Version
ink.conversation.closed	v1

{
  "conversation_id": "integer",
  "conversation_relay_id": "string",
  "account_number": "string",
  "latest_contacted_account_user_number": "string",
  "support_user_id": "integer",
  "organisation_id": "integer",
  "closed_at": "string",
  "reason": "string"
}

ink.conversation.open_status_changed-v1

	Name	Type
required	conversation_id	`integer`
required	conversation_relay_id	`string`
required	account_number	`string`
required	latest_contacted_account_user_number	`string`
required	support_user_id	`integer`
required	organisation_id	`integer`
required	new_status	`string`
required	previous_status	`string`

Event Type	Payload Version
ink.conversation.open_status_changed	v1

{
  "conversation_id": "integer",
  "conversation_relay_id": "string",
  "account_number": "string",
  "latest_contacted_account_user_number": "string",
  "support_user_id": "integer",
  "organisation_id": "integer",
  "new_status": "string",
  "previous_status": "string"
}

ink.conversation.opened-v1

	Name	Type
required	conversation_id	`integer`
required	conversation_relay_id	`string`
required	account_number	`string`
required	latest_contacted_account_user_number	`string`
required	support_user_id	`integer`
required	organisation_id	`integer`

Event Type	Payload Version
ink.conversation.opened	v1

{
  "conversation_id": "integer",
  "conversation_relay_id": "string",
  "account_number": "string",
  "latest_contacted_account_user_number": "string",
  "support_user_id": "integer",
  "organisation_id": "integer"
}

ink.conversation.priority.changed-v1

	Name	Type
required	conversation_id	`integer`
required	conversation_relay_id	`string`
required	old_priority	`number`
required	new_priority	`number`
required	prioritized_at	`string`
required	message_id	`integer`
required	message_relay_id	`string`
required	account_number	`string`
required	latest_contacted_account_user_number	`string`
required	support_user_id	`integer`
required	organisation_id	`integer`

Event Type	Payload Version
ink.conversation.priority.changed	v1

{
  "conversation_id": "integer",
  "conversation_relay_id": "string",
  "old_priority": "number",
  "new_priority": "number",
  "prioritized_at": "string",
  "message_id": "integer",
  "message_relay_id": "string",
  "account_number": "string",
  "latest_contacted_account_user_number": "string",
  "support_user_id": "integer",
  "organisation_id": "integer"
}

ink.conversation.snoozed-v1

	Name	Type
required	conversation_id	`integer`
required	conversation_relay_id	`string`
required	account_number	`string`
required	latest_contacted_account_user_number	`string`
required	support_user_id	`integer`
required	organisation_id	`integer`
required	snoozed_to	`string`
required	ink_note_relay_id	`string`

Event Type	Payload Version
ink.conversation.snoozed	v1

{
  "conversation_id": "integer",
  "conversation_relay_id": "string",
  "account_number": "string",
  "latest_contacted_account_user_number": "string",
  "support_user_id": "integer",
  "organisation_id": "integer",
  "snoozed_to": "string",
  "ink_note_relay_id": "string"
}

ink.conversation.unassigned_from_bucket-v1

	Name	Type
required	conversation_relay_id	`string`
required	bucket_relay_id	`string`
required	support_user_id	`integer`
required	organisation_id	`integer`

Event Type	Payload Version
ink.conversation.unassigned_from_bucket	v1

{
  "conversation_relay_id": "string",
  "bucket_relay_id": "string",
  "support_user_id": "integer",
  "organisation_id": "integer"
}

ink.conversation.unassigned_from_timeline-v1

	Name	Type
required	conversation_relay_id	`string`
required	timeline_relay_id	`string`
required	support_user_id	`integer`

Event Type	Payload Version
ink.conversation.unassigned_from_timeline	v1

{
  "conversation_relay_id": "string",
  "timeline_relay_id": "string",
  "support_user_id": "integer"
}

ink.live-chat.closed-v1

	Name	Type
required	live_chat_conversation_relay_id	`string`
required	close_reason	`string`

Event Type	Payload Version
ink.live-chat.closed	v1

{
  "live_chat_conversation_relay_id": "string",
  "close_reason": "string"
}

ink.live-chat.initiated-v1

	Name	Type
required	live_chat_conversation	ink-_messages-InkConversation

Event Type	Payload Version
ink.live-chat.initiated	v1

{
  "live_chat_conversation": {
    "conversation_relay_id": "string",
    "account_number": "string",
    "message": {
      "relay_id": "string",
      "channel": "string",
      "occurred_at": "string"
    }
  }
}

ink.live-chat.messages.outbound-message-created-v1

	Name	Type
required	live_chat_conversation	ink-_messages-InkConversation

Event Type	Payload Version
ink.live-chat.messages.outbound-message-created	v1

{
  "live_chat_conversation": {
    "conversation_relay_id": "string",
    "account_number": "string",
    "message": {
      "relay_id": "string",
      "channel": "string",
      "occurred_at": "string"
    }
  }
}

ink.message_attachment.safe-v1

	Name	Type
required	filename	`string`
required	s3_key	`string`
required	s3_bucket	`string`
required	size_in_bytes	`integer`

Event Type	Payload Version
ink.message_attachment.safe	v1

{
  "filename": "string",
  "s3_key": "string",
  "s3_bucket": "string",
  "size_in_bytes": "integer"
}

ink.message_attachment.unsafe-v1

	Name	Type
required	filename	`string`
required	s3_key	`string`
required	s3_bucket	`string`
required	size_in_bytes	`integer`

Event Type	Payload Version
ink.message_attachment.unsafe	v1

{
  "filename": "string",
  "s3_key": "string",
  "s3_bucket": "string",
  "size_in_bytes": "integer"
}

ink.messages.inbound-email-migration-v1

	Name	Type
required	message_id	`string`
required	s3_key	`string`
required	s3_bucket	`string`

Event Type	Payload Version
ink.messages.inbound-email-migration	v1

{
  "message_id": "string",
  "s3_key": "string",
  "s3_bucket": "string"
}

ink.messages.inbound-message-created-v1

	Name	Type
required	conversation_relay_id	`string`
required	account_number	`string`
required	message	ink-_messages-_InkMessage

Event Type	Payload Version
ink.messages.inbound-message-created	v1

{
  "conversation_relay_id": "string",
  "account_number": "string",
  "message": {
    "relay_id": "string",
    "channel": "string",
    "occurred_at": "string"
  }
}

ink.messages.inbound-message-ingested-v1

	Name	Type
required	channel	`string`
required	vendor	`string`
required	vendor_id	`string`
required	message_relay_id	`string`

Event Type	Payload Version
ink.messages.inbound-message-ingested	v1

{
  "channel": "string",
  "vendor": "string",
  "vendor_id": "string",
  "message_relay_id": "string"
}

ink.messages.outbound-message-created-v1

	Name	Type
required	conversation_relay_id	`string`
required	account_number	`string`
required	message	ink-_messages-_InkMessage

Event Type	Payload Version
ink.messages.outbound-message-created	v1

{
  "conversation_relay_id": "string",
  "account_number": "string",
  "message": {
    "relay_id": "string",
    "channel": "string",
    "occurred_at": "string"
  }
}

ink.messages.outbound-message-failed-v1

	Name	Type
required	conversation_relay_id	`string`
required	message	ink-_messages-_InkMessageWithVendor
required	failure	ink-_messages-_InkFailureData

Event Type	Payload Version
ink.messages.outbound-message-failed	v1

{
  "conversation_relay_id": "string",
  "message": {
    "relay_id": "string",
    "vendor": "string",
    "vendor_id": "string",
    "channel": "string",
    "occurred_at": "string"
  },
  "failure": {
    "type": "string",
    "reason": "string",
    "occurred_at": "string"
  }
}

ink.messages.phishing-report-dismissed-v1

	Name	Type
required	conversation_relay_id	`string`
required	account_number	`string`
required	message	ink-_messages-_InkMessage

Event Type	Payload Version
ink.messages.phishing-report-dismissed	v1

{
  "conversation_relay_id": "string",
  "account_number": "string",
  "message": {
    "relay_id": "string",
    "channel": "string",
    "occurred_at": "string"
  }
}

ink.messages.reported-phishing-v1

	Name	Type
required	conversation_relay_id	`string`
required	account_number	`string`
required	message	ink-_messages-_InkMessage

Event Type	Payload Version
ink.messages.reported-phishing	v1

{
  "conversation_relay_id": "string",
  "account_number": "string",
  "message": {
    "relay_id": "string",
    "channel": "string",
    "occurred_at": "string"
  }
}

ink.messages.reported-spam-v1

	Name	Type
required	conversation_relay_id	`string`
required	account_number	`string`
required	message	ink-_messages-_InkMessage

Event Type	Payload Version
ink.messages.reported-spam	v1

{
  "conversation_relay_id": "string",
  "account_number": "string",
  "message": {
    "relay_id": "string",
    "channel": "string",
    "occurred_at": "string"
  }
}

ink.messages.spam-report-dismissed-v1

	Name	Type
required	conversation_relay_id	`string`
required	account_number	`string`
required	message	ink-_messages-_InkMessage

Event Type	Payload Version
ink.messages.spam-report-dismissed	v1

{
  "conversation_relay_id": "string",
  "account_number": "string",
  "message": {
    "relay_id": "string",
    "channel": "string",
    "occurred_at": "string"
  }
}

internal_company.created-v1

	Name	Type
required	id	`string`
required	actor	`object`
required	displayable_number	`string`
required	name	`string`
required	primary_registration_number	`string`
required	secondary_registration_number	`string`
required	primary_tax_identifier_number	`string`
required	legal_address	`object`

Event Type	Payload Version
internal_company.created	v1

{
  "id": "string",
  "actor": "object",
  "displayable_number": "string",
  "name": "string",
  "primary_registration_number": "string",
  "secondary_registration_number": "string",
  "primary_tax_identifier_number": "string",
  "legal_address": "object"
}

late_payment_fee_application_service_completed-v1

	Name	Type
required	run_id	`string`
required	account_number	`string`
required	fees_applied_count	`integer`
required	fees_unapplied_count	`integer`

Event Type	Payload Version
late_payment_fee_application_service_completed	v1

{
  "run_id": "string",
  "account_number": "string",
  "fees_applied_count": "integer",
  "fees_unapplied_count": "integer"
}

late_payment_fee_application_service_fee_applied-v1

	Name	Type
required	run_id	`string`
required	account_number	`string`
required	fee_amount	`integer`
required	fee_date	`string`
	fee_type	`string`
required	charge_id	`string`

Event Type	Payload Version
late_payment_fee_application_service_fee_applied	v1

{
  "run_id": "string",
  "account_number": "string",
  "fee_amount": "integer",
  "fee_date": "string",
  "fee_type": "string",
  "charge_id": "string"
}

late_payment_fee_application_service_started-v1

	Name	Type
required	run_id	`string`
required	account_number	`string`

Event Type	Payload Version
late_payment_fee_application_service_started	v1

{
  "run_id": "string",
  "account_number": "string"
}

late_payment_fee_calculation_service_completed-v1

	Name	Type
required	run_id	`string`
required	account_number	`string`
required	fees_calculated_count	`integer`

Event Type	Payload Version
late_payment_fee_calculation_service_completed	v1

{
  "run_id": "string",
  "account_number": "string",
  "fees_calculated_count": "integer"
}

late_payment_fee_calculation_service_started-v1

	Name	Type
required	run_id	`string`
required	account_number	`string`

Event Type	Payload Version
late_payment_fee_calculation_service_started	v1

{
  "run_id": "string",
  "account_number": "string"
}

late_payment_fee_calculator_completed-v1

	Name	Type
required	run_id	`string`
required	account_number	`string`
required	fees_applied_count	`integer`
required	fees_unapplied_count	`integer`

Event Type	Payload Version
late_payment_fee_calculator_completed	v1

{
  "run_id": "string",
  "account_number": "string",
  "fees_applied_count": "integer",
  "fees_unapplied_count": "integer"
}

late_payment_fee_calculator_fee_applied-v1

	Name	Type
required	run_id	`string`
required	account_number	`string`
required	charge_id	`string`

Event Type	Payload Version
late_payment_fee_calculator_fee_applied	v1

{
  "run_id": "string",
  "account_number": "string",
  "charge_id": "string"
}

late_payment_fee_calculator_started-v1

	Name	Type
required	run_id	`string`
required	account_number	`string`

Event Type	Payload Version
late_payment_fee_calculator_started	v1

{
  "run_id": "string",
  "account_number": "string"
}

late_payment_fee_waived-v1

	Name	Type
required	fee_id	`integer`
required	waived_at	`string`
required	support_user_id	`integer`

Event Type	Payload Version
late_payment_fee_waived	v1

{
  "fee_id": "integer",
  "waived_at": "string",
  "support_user_id": "integer"
}

leads.lead.stage-updated-v1

	Name	Type
required	lead_number	`string`
required	funnel_code	`string`
required	stage	`string`

Event Type	Payload Version
leads.lead.stage-updated	v1

{
  "lead_number": "string",
  "funnel_code": "string",
  "stage": "string"
}

leads.opportunity.document-attached-to-opportunity-v1

	Name	Type
required	opportunity_number	`string`
required	attachment_id	`integer`
required	category	`string`

Event Type	Payload Version
leads.opportunity.document-attached-to-opportunity	v1

{
  "opportunity_number": "string",
  "attachment_id": "integer",
  "category": "string"
}

leads.opportunity.offer-group.created-v2

	Name	Type
required	opportunity_number	`string`
required	offer_group_identifier	`string`

Event Type	Payload Version
leads.opportunity.offer-group.created	v2

{
  "opportunity_number": "string",
  "offer_group_identifier": "string"
}

leads.opportunity.stage-updated-v1

	Name	Type
required	opportunity_number	`string`
required	funnel_code	`string`
required	stage	`string`

Event Type	Payload Version
leads.opportunity.stage-updated	v1

{
  "opportunity_number": "string",
  "funnel_code": "string",
  "stage": "string"
}

lifecycle-enrollment-SupplyPoint

	Name	Type
required	market_name	`string`
required	external_identifier	`string`
required	confirmed_ssd	`string`
required	was_cancelled	`boolean`

{
  "market_name": "string",
  "external_identifier": "string",
  "confirmed_ssd": "string",
  "was_cancelled": "boolean"
}

lifecycle-join_supplier-ActivatedSupplyPoint

	Name	Type
required	external_identifier	`string`
required	market_name	`string`
required	confirmed_supply_start_date	`string`

{
  "external_identifier": "string",
  "market_name": "string",
  "confirmed_supply_start_date": "string"
}

lifecycle-join_supplier-ActivationInitiatedSupplyPoint

	Name	Type
required	external_identifier	`string`
required	market_name	`string`

{
  "external_identifier": "string",
  "market_name": "string"
}

lifecycle-join_supplier-Agreement

	Name	Type
required	id	`integer`
required	valid_from	`string`
required	valid_to	`string`
required	product_code	`string`

{
  "id": "integer",
  "valid_from": "string",
  "valid_to": "string",
  "product_code": "string"
}

lifecycle-join_supplier-SupplyPeriodData

	Name	Type
required	id	`integer`
required	supply_start_at	`string`
required	supply_end_at	`string`

{
  "id": "integer",
  "supply_start_at": "string",
  "supply_end_at": "string"
}

lifecycle-join_supplier-SupplyPoint

	Name	Type
required	external_identifier	`string`
required	market_name	`string`
required	requested_supply_start_date	`string`

{
  "external_identifier": "string",
  "market_name": "string",
  "requested_supply_start_date": "string"
}

lifecycle-leave_supplier-SupplyPoint

	Name	Type
required	market_identifier	`string`
required	external_identifier	`string`
required	market_name	`string`

{
  "market_identifier": "string",
  "external_identifier": "string",
  "market_name": "string"
}

lifecycle-leave_supplier-TerminatedSupplyPoint

	Name	Type
required	external_identifier	`string`
required	market_name	`string`
required	confirmed_supply_end_date	`string`

{
  "external_identifier": "string",
  "market_name": "string",
  "confirmed_supply_end_date": "string"
}

lifecycle.enrollment.loyalty-points-qualification-reversed-v1

	Name	Type
required	join_supplier_process_number	`string`
required	account_number	`string`
required	supply_points_no_longer_coming_on_supply	array[lifecycle-enrollment-SupplyPoint]
required	all_supply_points	array[lifecycle-enrollment-SupplyPoint]

Event Type	Payload Version
lifecycle.enrollment.loyalty-points-qualification-reversed	v1

{
  "join_supplier_process_number": "string",
  "account_number": "string",
  "supply_points_no_longer_coming_on_supply": [
    {
      "market_name": "string",
      "external_identifier": "string",
      "confirmed_ssd": "string",
      "was_cancelled": "boolean"
    }
  ],
  "all_supply_points": [
    {
      "market_name": "string",
      "external_identifier": "string",
      "confirmed_ssd": "string",
      "was_cancelled": "boolean"
    }
  ]
}

lifecycle.enrollment.supply-status-qualifies-account-for-loyalty-point-v2

	Name	Type
required	join_supplier_process_id	`integer`
required	join_supplier_process_number	`string`
required	account_number	`string`
required	supply_points_past_ssd	array[lifecycle-enrollment-SupplyPoint]
required	all_supply_points	array[lifecycle-enrollment-SupplyPoint]

Event Type	Payload Version
lifecycle.enrollment.supply-status-qualifies-account-for-loyalty-point	v2

{
  "join_supplier_process_id": "integer",
  "join_supplier_process_number": "string",
  "account_number": "string",
  "supply_points_past_ssd": [
    {
      "market_name": "string",
      "external_identifier": "string",
      "confirmed_ssd": "string",
      "was_cancelled": "boolean"
    }
  ],
  "all_supply_points": [
    {
      "market_name": "string",
      "external_identifier": "string",
      "confirmed_ssd": "string",
      "was_cancelled": "boolean"
    }
  ]
}

lifecycle.join-supplier.activation.completed-v1

	Name	Type
required	account_number	`string`
required	join_supplier_process_number	`string`
required	subtype	`string`
required	activation_journey_type	`string`
required	supply_point	lifecycle-join_supplier-ActivatedSupplyPoint

Event Type	Payload Version
lifecycle.join-supplier.activation.completed	v1

{
  "account_number": "string",
  "join_supplier_process_number": "string",
  "subtype": "string",
  "activation_journey_type": "string",
  "supply_point": {
    "external_identifier": "string",
    "market_name": "string",
    "confirmed_supply_start_date": "string"
  }
}

lifecycle.join-supplier.activation.initiated-v1

	Name	Type
required	account_number	`string`
required	join_supplier_process_number	`string`
required	subtype	`string`
required	activation_journey_type	`string`
required	supply_point	lifecycle-join_supplier-ActivationInitiatedSupplyPoint

Event Type	Payload Version
lifecycle.join-supplier.activation.initiated	v1

{
  "account_number": "string",
  "join_supplier_process_number": "string",
  "subtype": "string",
  "activation_journey_type": "string",
  "supply_point": {
    "external_identifier": "string",
    "market_name": "string"
  }
}

lifecycle.join-supplier.agreement.created-v1

	Name	Type
required	account_number	`string`
required	join_supplier_process_number	`string`
required	supply_point	lifecycle-join_supplier-ActivatedSupplyPoint
required	agreements	array[lifecycle-join_supplier-Agreement]
required	contract_identifiers	`array[string]`

Event Type	Payload Version
lifecycle.join-supplier.agreement.created	v1

{
  "account_number": "string",
  "join_supplier_process_number": "string",
  "supply_point": {
    "external_identifier": "string",
    "market_name": "string",
    "confirmed_supply_start_date": "string"
  },
  "agreements": [
    {
      "id": "integer",
      "valid_from": "string",
      "valid_to": "string",
      "product_code": "string"
    }
  ],
  "contract_identifiers": [
    "string"
  ]
}

lifecycle.join-supplier.cancellation-requested-v1

	Name	Type
required	account_number	`string`
required	join_supplier_process_number	`string`
required	subtype	`string`
required	supply_points	array[lifecycle-join_supplier-SupplyPoint]

Event Type	Payload Version
lifecycle.join-supplier.cancellation-requested	v1

{
  "account_number": "string",
  "join_supplier_process_number": "string",
  "subtype": "string",
  "supply_points": [
    {
      "external_identifier": "string",
      "market_name": "string",
      "requested_supply_start_date": "string"
    }
  ]
}

lifecycle.join-supplier.cancelled-v1

	Name	Type
required	account_number	`string`
required	join_supplier_process_number	`string`
required	subtype	`string`
required	supply_points	array[lifecycle-join_supplier-SupplyPoint]

Event Type	Payload Version
lifecycle.join-supplier.cancelled	v1

{
  "account_number": "string",
  "join_supplier_process_number": "string",
  "subtype": "string",
  "supply_points": [
    {
      "external_identifier": "string",
      "market_name": "string",
      "requested_supply_start_date": "string"
    }
  ]
}

lifecycle.join-supplier.completed-v1

	Name	Type
required	account_number	`string`
required	join_supplier_process_number	`string`
required	subtype	`string`
required	supply_points	array[lifecycle-join_supplier-ActivatedSupplyPoint]

Event Type	Payload Version
lifecycle.join-supplier.completed	v1

{
  "account_number": "string",
  "join_supplier_process_number": "string",
  "subtype": "string",
  "supply_points": [
    {
      "external_identifier": "string",
      "market_name": "string",
      "confirmed_supply_start_date": "string"
    }
  ]
}

lifecycle.join-supplier.requested-v1

	Name	Type
required	account_number	`string`
required	join_supplier_process_number	`string`
required	subtype	`string`
required	supply_points	array[lifecycle-join_supplier-SupplyPoint]
required	requested_at	`string`

Event Type	Payload Version
lifecycle.join-supplier.requested	v1

{
  "account_number": "string",
  "join_supplier_process_number": "string",
  "subtype": "string",
  "supply_points": [
    {
      "external_identifier": "string",
      "market_name": "string",
      "requested_supply_start_date": "string"
    }
  ],
  "requested_at": "string"
}

lifecycle.join-supplier.reversal-requested-v1

	Name	Type
required	account_number	`string`
required	join_supplier_process_number	`string`
required	subtype	`string`
required	supply_points	array[lifecycle-join_supplier-SupplyPoint]

Event Type	Payload Version
lifecycle.join-supplier.reversal-requested	v1

{
  "account_number": "string",
  "join_supplier_process_number": "string",
  "subtype": "string",
  "supply_points": [
    {
      "external_identifier": "string",
      "market_name": "string",
      "requested_supply_start_date": "string"
    }
  ]
}

lifecycle.join-supplier.reversed-v1

	Name	Type
required	account_number	`string`
required	join_supplier_process_number	`string`
required	subtype	`string`
required	supply_points	array[lifecycle-join_supplier-SupplyPoint]

Event Type	Payload Version
lifecycle.join-supplier.reversed	v1

{
  "account_number": "string",
  "join_supplier_process_number": "string",
  "subtype": "string",
  "supply_points": [
    {
      "external_identifier": "string",
      "market_name": "string",
      "requested_supply_start_date": "string"
    }
  ]
}

lifecycle.join-supplier.supply-period.created-v1

	Name	Type
required	account_number	`string`
required	join_supplier_process_number	`string`
required	supply_point	lifecycle-join_supplier-ActivatedSupplyPoint
required	supply_period	lifecycle-join_supplier-SupplyPeriodData
required	contract_identifiers	`array[string]`

Event Type	Payload Version
lifecycle.join-supplier.supply-period.created	v1

{
  "account_number": "string",
  "join_supplier_process_number": "string",
  "supply_point": {
    "external_identifier": "string",
    "market_name": "string",
    "confirmed_supply_start_date": "string"
  },
  "supply_period": {
    "id": "integer",
    "supply_start_at": "string",
    "supply_end_at": "string"
  },
  "contract_identifiers": [
    "string"
  ]
}

lifecycle.join_supplier._ensure_payment_instructions.step_completed-v2

	Name	Type
required	join_supplier_process_id	`integer`
required	join_supplier_process_number	`string`
required	account_number	`string`

Event Type	Payload Version
lifecycle.join_supplier._ensure_payment_instructions.step_completed	v2

{
  "join_supplier_process_id": "integer",
  "join_supplier_process_number": "string",
  "account_number": "string"
}

lifecycle.join_supplier._ensure_payment_instructions.step_initiated-v2

	Name	Type
required	join_supplier_process_id	`integer`
required	join_supplier_process_number	`string`
required	account_number	`string`

Event Type	Payload Version
lifecycle.join_supplier._ensure_payment_instructions.step_initiated	v2

{
  "join_supplier_process_id": "integer",
  "join_supplier_process_number": "string",
  "account_number": "string"
}

lifecycle.join_supplier.terms-and-conditions.accepted-v2

	Name	Type
required	join_supplier_process_id	`integer`
required	join_supplier_process_number	`string`

Event Type	Payload Version
lifecycle.join_supplier.terms-and-conditions.accepted	v2

{
  "join_supplier_process_id": "integer",
  "join_supplier_process_number": "string"
}

lifecycle.leave-supplier.cancellation-requested-v2

	Name	Type
required	account_number	`string`
required	leave_supplier_process_id	`integer`
required	leave_supplier_process_number	`string`
required	supply_points	array[lifecycle-leave_supplier-SupplyPoint]

Event Type	Payload Version
lifecycle.leave-supplier.cancellation-requested	v2

{
  "account_number": "string",
  "leave_supplier_process_id": "integer",
  "leave_supplier_process_number": "string",
  "supply_points": [
    {
      "market_identifier": "string",
      "external_identifier": "string",
      "market_name": "string"
    }
  ]
}

lifecycle.leave-supplier.cancelled-v2

	Name	Type
required	account_number	`string`
required	leave_supplier_process_id	`integer`
required	leave_supplier_process_number	`string`
required	supply_points	array[lifecycle-leave_supplier-SupplyPoint]

Event Type	Payload Version
lifecycle.leave-supplier.cancelled	v2

{
  "account_number": "string",
  "leave_supplier_process_id": "integer",
  "leave_supplier_process_number": "string",
  "supply_points": [
    {
      "market_identifier": "string",
      "external_identifier": "string",
      "market_name": "string"
    }
  ]
}

lifecycle.leave-supplier.completed-v3

	Name	Type
required	account_number	`string`
required	leave_supplier_process_id	`integer`
required	leave_supplier_process_number	`string`
required	leave_supplier_process_subtype	`string`
required	supply_points	array[lifecycle-leave_supplier-TerminatedSupplyPoint]

Event Type	Payload Version
lifecycle.leave-supplier.completed	v3

{
  "account_number": "string",
  "leave_supplier_process_id": "integer",
  "leave_supplier_process_number": "string",
  "leave_supplier_process_subtype": "string",
  "supply_points": [
    {
      "external_identifier": "string",
      "market_name": "string",
      "confirmed_supply_end_date": "string"
    }
  ]
}

lifecycle.leave-supplier.requested-v2

	Name	Type
required	account_number	`string`
required	leave_supplier_process_id	`integer`
required	supply_points	array[lifecycle-leave_supplier-SupplyPoint]
required	requested_supply_end_at	`string`
required	requested_supply_end_date	`string`
required	requested_at	`string`
required	is_passive	`boolean`
	passive_loss_instigated_supply_point_id	`integer`

Event Type	Payload Version
lifecycle.leave-supplier.requested	v2

{
  "account_number": "string",
  "leave_supplier_process_id": "integer",
  "supply_points": [
    {
      "market_identifier": "string",
      "external_identifier": "string",
      "market_name": "string"
    }
  ],
  "requested_supply_end_at": "string",
  "requested_supply_end_date": "string",
  "requested_at": "string",
  "is_passive": "boolean",
  "passive_loss_instigated_supply_point_id": "integer"
}

lifecycle.leave-supplier.requested-v3

	Name	Type
required	account_number	`string`
required	leave_supplier_process_id	`integer`
required	leave_supplier_process_number	`string`
required	supply_points	array[lifecycle-leave_supplier-SupplyPoint]
required	requested_supply_end_at	`string`
required	requested_supply_end_date	`string`
required	requested_at	`string`
required	is_passive	`boolean`
	passive_loss_instigated_supply_point_id	`integer`

Event Type	Payload Version
lifecycle.leave-supplier.requested	v3

{
  "account_number": "string",
  "leave_supplier_process_id": "integer",
  "leave_supplier_process_number": "string",
  "supply_points": [
    {
      "market_identifier": "string",
      "external_identifier": "string",
      "market_name": "string"
    }
  ],
  "requested_supply_end_at": "string",
  "requested_supply_end_date": "string",
  "requested_at": "string",
  "is_passive": "boolean",
  "passive_loss_instigated_supply_point_id": "integer"
}

lifecycle.leave-supplier.reversal-requested-v2

	Name	Type
required	account_number	`string`
required	leave_supplier_process_id	`integer`
required	leave_supplier_process_number	`string`
required	supply_points	array[lifecycle-leave_supplier-SupplyPoint]

Event Type	Payload Version
lifecycle.leave-supplier.reversal-requested	v2

{
  "account_number": "string",
  "leave_supplier_process_id": "integer",
  "leave_supplier_process_number": "string",
  "supply_points": [
    {
      "market_identifier": "string",
      "external_identifier": "string",
      "market_name": "string"
    }
  ]
}

lifecycle.leave-supplier.termination.confirmed-v2

	Name	Type
required	account_number	`string`
required	leave_supplier_process_id	`integer`
required	leave_supplier_process_number	`string`
required	leave_supplier_process_subtype	`string`
required	supply_point	lifecycle-leave_supplier-TerminatedSupplyPoint

Event Type	Payload Version
lifecycle.leave-supplier.termination.confirmed	v2

{
  "account_number": "string",
  "leave_supplier_process_id": "integer",
  "leave_supplier_process_number": "string",
  "leave_supplier_process_subtype": "string",
  "supply_point": {
    "external_identifier": "string",
    "market_name": "string",
    "confirmed_supply_end_date": "string"
  }
}

lifecycle.leave-supplier.updated-v2

	Name	Type
required	account_number	`string`
required	leave_supplier_process_id	`integer`
required	supply_points	array[lifecycle-leave_supplier-SupplyPoint]
required	requested_supply_end_at	`string`
required	requested_supply_end_date	`string`
required	updated_at	`string`
required	is_passive	`boolean`
	passive_loss_instigated_supply_point_id	`integer`

Event Type	Payload Version
lifecycle.leave-supplier.updated	v2

{
  "account_number": "string",
  "leave_supplier_process_id": "integer",
  "supply_points": [
    {
      "market_identifier": "string",
      "external_identifier": "string",
      "market_name": "string"
    }
  ],
  "requested_supply_end_at": "string",
  "requested_supply_end_date": "string",
  "updated_at": "string",
  "is_passive": "boolean",
  "passive_loss_instigated_supply_point_id": "integer"
}

lifecycle.leave-supplier.updated-v3

	Name	Type
required	account_number	`string`
required	leave_supplier_process_id	`integer`
required	leave_supplier_process_number	`string`
required	supply_points	array[lifecycle-leave_supplier-SupplyPoint]
required	requested_supply_end_at	`string`
required	requested_supply_end_date	`string`
required	updated_at	`string`
required	is_passive	`boolean`
	passive_loss_instigated_supply_point_id	`integer`

Event Type	Payload Version
lifecycle.leave-supplier.updated	v3

{
  "account_number": "string",
  "leave_supplier_process_id": "integer",
  "leave_supplier_process_number": "string",
  "supply_points": [
    {
      "market_identifier": "string",
      "external_identifier": "string",
      "market_name": "string"
    }
  ],
  "requested_supply_end_at": "string",
  "requested_supply_end_date": "string",
  "updated_at": "string",
  "is_passive": "boolean",
  "passive_loss_instigated_supply_point_id": "integer"
}

lifecycle.support-site.sale-1.0.0

	Name	Type
required	support_user_id	`string`
required	supply_start_date	`string`
required	trigger_action	`string`

Event Type	Payload Version
lifecycle.support-site.sale	1.0.0

{
  "support_user_id": "string",
  "supply_start_date": "string",
  "trigger_action": "string"
}

loyalty-points.user-role-removal-v1

	Name	Type
required	user_id	`integer`
required	account_id	`integer`

Event Type	Payload Version
loyalty-points.user-role-removal	v1

{
  "user_id": "integer",
  "account_id": "integer"
}

market_supply-products-Product

	Name	Type
required	code	`string`
required	market_name	`string`
required	brand_code	`string`

{
  "code": "string",
  "market_name": "string",
  "brand_code": "string"
}

meter_data_quality.resolution_cancelled-v1

	Name	Type
required	issue_id	`integer`
required	issue_category	`string`
required	issue_subcategory	`string`
required	issue_status	`string`
required	market_supply_point_id	`string`
required	opened_at	`string`
required	period_start	`string`
required	period_end	`string`
required	reading_type	`string`
required	utility	`string`

Event Type	Payload Version
meter_data_quality.resolution_cancelled	v1

{
  "issue_id": "integer",
  "issue_category": "string",
  "issue_subcategory": "string",
  "issue_status": "string",
  "market_supply_point_id": "string",
  "opened_at": "string",
  "period_start": "string",
  "period_end": "string",
  "reading_type": "string",
  "utility": "string"
}

meter_data_quality.resolution_cancelled-v2

	Name	Type
required	issue_id	`integer`
required	issue_category	`string`
required	issue_subcategory	`string`
required	issue_status	`string`
required	market_supply_point_id	`string`
required	opened_at	`string`
required	period_start	`string`
required	period_end	`string`
required	reading_type	`string`
required	utility	`string`
required	source	`string`

Event Type	Payload Version
meter_data_quality.resolution_cancelled	v2

{
  "issue_id": "integer",
  "issue_category": "string",
  "issue_subcategory": "string",
  "issue_status": "string",
  "market_supply_point_id": "string",
  "opened_at": "string",
  "period_start": "string",
  "period_end": "string",
  "reading_type": "string",
  "utility": "string",
  "source": "string"
}

meter_data_quality.resolution_requested-v1

	Name	Type
required	issue_id	`integer`
required	issue_category	`string`
required	issue_subcategory	`string`
required	issue_status	`string`
required	market_supply_point_id	`string`
required	opened_at	`string`
required	period_start	`string`
required	period_end	`string`
required	reading_type	`string`
required	utility	`string`

Event Type	Payload Version
meter_data_quality.resolution_requested	v1

{
  "issue_id": "integer",
  "issue_category": "string",
  "issue_subcategory": "string",
  "issue_status": "string",
  "market_supply_point_id": "string",
  "opened_at": "string",
  "period_start": "string",
  "period_end": "string",
  "reading_type": "string",
  "utility": "string"
}

meter_points-meter_details-Meter

	Name	Type
required	serial_number	`string`
required	current_rating	`integer`
required	location	`string`
required	make_and_type	`string`
required	meter_asset_provider_mpid	`string`
required	meter_type	`string`
required	retrieval_method	`string`
required	retrieval_method_effective_from	`string`
required	meter_cop	`string`
required	meter_cop_dispensation	`string`
required	communications_address	`string`
required	communications_method	`string`
required	vt_ratio	`string`
required	installation_date	`string`
required	timing_device_id	`string`
required	is_tele_switch	`boolean`
required	ct_ratio	`string`
required	registers	array[meter_points-meter_details-Register]

{
  "serial_number": "string",
  "current_rating": "integer",
  "location": "string",
  "make_and_type": "string",
  "meter_asset_provider_mpid": "string",
  "meter_type": "string",
  "retrieval_method": "string",
  "retrieval_method_effective_from": "string",
  "meter_cop": "string",
  "meter_cop_dispensation": "string",
  "communications_address": "string",
  "communications_method": "string",
  "vt_ratio": "string",
  "installation_date": "string",
  "timing_device_id": "string",
  "is_tele_switch": "boolean",
  "ct_ratio": "string",
  "registers": [
    {
      "register_id": "string",
      "register_type": "string",
      "measurement_quantity": "string",
      "multiplier": "string",
      "digits": "integer",
      "is_main": "boolean",
      "associated_meter_serial": "string",
      "associated_register_id": "string"
    }
  ]
}

meter_points-meter_details-Register

	Name	Type
required	register_id	`string`
required	register_type	`string`
required	measurement_quantity	`string`
required	multiplier	`string`
required	digits	`integer`
required	is_main	`boolean`
required	associated_meter_serial	`string`
required	associated_register_id	`string`

{
  "register_id": "string",
  "register_type": "string",
  "measurement_quantity": "string",
  "multiplier": "string",
  "digits": "integer",
  "is_main": "boolean",
  "associated_meter_serial": "string",
  "associated_register_id": "string"
}

meter_points-meter_details-RemovedMeter

	Name	Type
required	serial_number	`string`
required	date_of_removal	`string`
required	meter_asset_provider_mpid	`string`

{
  "serial_number": "string",
  "date_of_removal": "string",
  "meter_asset_provider_mpid": "string"
}

meterpoint.elec.cos_gain.registration.requested-v1

	Name	Type
required	mpan	`string`
required	supply_start_date	`string`
required	supplier_mpid	`string`
required	account_number	`string`
required	is_internal_transfer	`boolean`
required	is_migrated	`boolean`
required	is_export	`boolean`

Event Type	Payload Version
meterpoint.elec.cos_gain.registration.requested	v1

{
  "mpan": "string",
  "supply_start_date": "string",
  "supplier_mpid": "string",
  "account_number": "string",
  "is_internal_transfer": "boolean",
  "is_migrated": "boolean",
  "is_export": "boolean"
}

meterpoint.gas.api_backfill-v1

	Name	Type
required	mprn	`string`
required	supplier	`string`
required	supply_start_date	`string`
required	meter_reading_factor	`string`
required	nomination_shipper_ref	`string`
required	supply_end_date	`string`

Event Type	Payload Version
meterpoint.gas.api_backfill	v1

{
  "mprn": "string",
  "supplier": "string",
  "supply_start_date": "string",
  "meter_reading_factor": "string",
  "nomination_shipper_ref": "string",
  "supply_end_date": "string"
}

meterpoint.gas.appoint_mam.requested-v1

	Name	Type
required	mprn	`string`
required	mam_to_appoint	`string`
required	force_appointment	`boolean`
required	owner	`string`
required	model	`string`
required	manufacturer	`string`
required	manufactured_year	`integer`
required	location	`string`
required	location_description	`string`
required	status	`string`
required	meter_type	`string`
required	meter_mechanism	`string`

Event Type	Payload Version
meterpoint.gas.appoint_mam.requested	v1

{
  "mprn": "string",
  "mam_to_appoint": "string",
  "force_appointment": "boolean",
  "owner": "string",
  "model": "string",
  "manufacturer": "string",
  "manufactured_year": "integer",
  "location": "string",
  "location_description": "string",
  "status": "string",
  "meter_type": "string",
  "meter_mechanism": "string"
}

meterpoint.gas.backfill-v1

	Name	Type
required	mprn	`string`
required	supplier	`string`
required	supply_start_date	`string`
required	sub_building_name	`string`
required	building_name	`string`
required	building_number	`string`
required	dependent_street	`string`
required	principal_street	`string`
required	double_dependent_locality	`string`
required	dependent_locality	`string`
required	post_town	`string`
required	county	`string`
required	postcode	`string`
required	meter_serial_number	`string`
required	meter_digits	`integer`
required	meter_mechanism	`string`
required	meter_is_imperial	`boolean`
required	meter_reading_factor	`string`
required	last_reading	`string`
required	last_reading_on	`string`
required	nomination_shipper_ref	`string`
required	cohort	`string`

Event Type	Payload Version
meterpoint.gas.backfill	v1

{
  "mprn": "string",
  "supplier": "string",
  "supply_start_date": "string",
  "sub_building_name": "string",
  "building_name": "string",
  "building_number": "string",
  "dependent_street": "string",
  "principal_street": "string",
  "double_dependent_locality": "string",
  "dependent_locality": "string",
  "post_town": "string",
  "county": "string",
  "postcode": "string",
  "meter_serial_number": "string",
  "meter_digits": "integer",
  "meter_mechanism": "string",
  "meter_is_imperial": "boolean",
  "meter_reading_factor": "string",
  "last_reading": "string",
  "last_reading_on": "string",
  "nomination_shipper_ref": "string",
  "cohort": "string"
}

meterpoint.gas.change_of_cohort.requested-v1

	Name	Type
required	mprn	`string`
required	cohort	`string`

Event Type	Payload Version
meterpoint.gas.change_of_cohort.requested	v1

{
  "mprn": "string",
  "cohort": "string"
}

meterpoint.gas.change_of_mam.requested-v1

	Name	Type
required	mprn	`string`
required	mam_to_appoint	`string`
required	force_appointment	`boolean`
required	owner	`string`
required	model	`string`
required	manufacturer	`string`
required	manufactured_year	`integer`
required	location	`string`
required	location_description	`string`
required	status	`string`
required	meter_type	`string`
required	meter_mechanism	`string`
required	effective_from_date	`string`
required	current_mam	`string`

Event Type	Payload Version
meterpoint.gas.change_of_mam.requested	v1

{
  "mprn": "string",
  "mam_to_appoint": "string",
  "force_appointment": "boolean",
  "owner": "string",
  "model": "string",
  "manufacturer": "string",
  "manufactured_year": "integer",
  "location": "string",
  "location_description": "string",
  "status": "string",
  "meter_type": "string",
  "meter_mechanism": "string",
  "effective_from_date": "string",
  "current_mam": "string"
}

meterpoint.gas.cos_gain.mtd_received-v1

	Name	Type
required	mprn	`string`
required	building_name	`string`
required	building_number	`integer`
required	dependent_street	`string`
required	principle_street	`string`
required	dependent_locality	`string`
required	post_town	`string`
required	county	`string`
required	meter_serial_number	`string`
required	meter_digits	`integer`
required	meter_mechanism	`string`
required	meter_type	`string`
required	meter_is_imperial	`boolean`
required	meter_reading_factor	`integer`
	meter_link_code	`string`
required	owner	`string`
required	model	`string`
required	manufacturer	`string`
required	manufactured_year	`integer`
required	location	`string`
required	location_description	`string`
required	instructions	`string`
required	status	`string`
required	pulse_value	`number`
required	correction_factor	`number`
required	bypass_fitted	`boolean`
required	collar_fitted	`boolean`
required	last_inspection_on	`string`
required	last_reading	`integer`
required	last_reading_on	`string`

Event Type	Payload Version
meterpoint.gas.cos_gain.mtd_received	v1

{
  "mprn": "string",
  "building_name": "string",
  "building_number": "integer",
  "dependent_street": "string",
  "principle_street": "string",
  "dependent_locality": "string",
  "post_town": "string",
  "county": "string",
  "meter_serial_number": "string",
  "meter_digits": "integer",
  "meter_mechanism": "string",
  "meter_type": "string",
  "meter_is_imperial": "boolean",
  "meter_reading_factor": "integer",
  "meter_link_code": "string",
  "owner": "string",
  "model": "string",
  "manufacturer": "string",
  "manufactured_year": "integer",
  "location": "string",
  "location_description": "string",
  "instructions": "string",
  "status": "string",
  "pulse_value": "number",
  "correction_factor": "number",
  "bypass_fitted": "boolean",
  "collar_fitted": "boolean",
  "last_inspection_on": "string",
  "last_reading": "integer",
  "last_reading_on": "string"
}

meterpoint.gas.cos_gain.registration.confirmed-v1

	Name	Type
required	mprn	`string`
required	previous_mam	`string`
required	is_domestic	`boolean`
required	is_igt_mam	`boolean`

Event Type	Payload Version
meterpoint.gas.cos_gain.registration.confirmed	v1

{
  "mprn": "string",
  "previous_mam": "string",
  "is_domestic": "boolean",
  "is_igt_mam": "boolean"
}

meterpoint.gas.cos_gain.registration.requested-v1

	Name	Type
required	mprn	`string`
required	supply_start_date	`string`
required	supplier_mpid	`string`
required	account_number	`string`

Event Type	Payload Version
meterpoint.gas.cos_gain.registration.requested	v1

{
  "mprn": "string",
  "supply_start_date": "string",
  "supplier_mpid": "string",
  "account_number": "string"
}

meterpoint.gas.cos_loss.confirmed-v1

	Name	Type
required	account_id	`integer`
required	mprn	`string`
required	supply_end_date	`string`
required	meter_exists	`boolean`
required	meter_serial_number	`string`
required	meter_digits	`integer`
required	meter_mechanism	`string`
required	meter_imperial_metric_indicator	`string`
required	meter_reading_factor	`number`
required	new_supplier	`string`

Event Type	Payload Version
meterpoint.gas.cos_loss.confirmed	v1

{
  "account_id": "integer",
  "mprn": "string",
  "supply_end_date": "string",
  "meter_exists": "boolean",
  "meter_serial_number": "string",
  "meter_digits": "integer",
  "meter_mechanism": "string",
  "meter_imperial_metric_indicator": "string",
  "meter_reading_factor": "number",
  "new_supplier": "string"
}

meterpoint.gas.deappoint_mam.requested-v1

	Name	Type
required	mprn	`string`
required	mam_to_deappoint	`string`
required	effective_to_date	`string`
required	is_cos_loss	`boolean`
required	new_supplier	`string`
required	current_mam	`string`

Event Type	Payload Version
meterpoint.gas.deappoint_mam.requested	v1

{
  "mprn": "string",
  "mam_to_deappoint": "string",
  "effective_to_date": "string",
  "is_cos_loss": "boolean",
  "new_supplier": "string",
  "current_mam": "string"
}

meterpoint.gas.disputed_closing_reading.accepted.by_us-v1

	Name	Type
required	mprn	`string`
required	supplier	`string`
required	reference_number	`integer`
required	transfer_date	`string`
required	initiating_organisation	`string`
required	io_contact_name	`string`
required	recipient_organisation	`string`
required	ro_contact_name	`string`
required	meter_serial	`string`
required	meter_digits	`integer`
required	house_name_number	`string`
required	postcode	`string`
required	disputed_reading	`integer`
required	disputed_reading_is_actual	`boolean`
required	proposed_reading	`integer`
required	proposed_reading_is_actual	`boolean`
required	status_response	`string`
required	root_cause	`string`
required	rejection_acceptance_code	`string`
required	criteria	`string`
required	comments	`string`
required	is_gain	`boolean`

Event Type	Payload Version
meterpoint.gas.disputed_closing_reading.accepted.by_us	v1

{
  "mprn": "string",
  "supplier": "string",
  "reference_number": "integer",
  "transfer_date": "string",
  "initiating_organisation": "string",
  "io_contact_name": "string",
  "recipient_organisation": "string",
  "ro_contact_name": "string",
  "meter_serial": "string",
  "meter_digits": "integer",
  "house_name_number": "string",
  "postcode": "string",
  "disputed_reading": "integer",
  "disputed_reading_is_actual": "boolean",
  "proposed_reading": "integer",
  "proposed_reading_is_actual": "boolean",
  "status_response": "string",
  "root_cause": "string",
  "rejection_acceptance_code": "string",
  "criteria": "string",
  "comments": "string",
  "is_gain": "boolean"
}

meterpoint.gas.disputed_closing_reading.accepted.other_supplier-v1

	Name	Type
required	mprn	`string`
required	supplier	`string`
required	reference_number	`integer`
required	transfer_date	`string`
required	initiating_organisation	`string`
required	io_contact_name	`string`
required	recipient_organisation	`string`
required	ro_contact_name	`string`
required	meter_serial	`string`
required	meter_digits	`integer`
required	house_name_number	`string`
required	postcode	`string`
required	disputed_reading	`integer`
required	disputed_reading_is_actual	`boolean`
required	proposed_reading	`integer`
required	proposed_reading_is_actual	`boolean`
required	status_response	`string`
required	root_cause	`string`
required	rejection_acceptance_code	`string`
required	criteria	`string`
required	comments	`string`
required	is_gain	`boolean`

Event Type	Payload Version
meterpoint.gas.disputed_closing_reading.accepted.other_supplier	v1

{
  "mprn": "string",
  "supplier": "string",
  "reference_number": "integer",
  "transfer_date": "string",
  "initiating_organisation": "string",
  "io_contact_name": "string",
  "recipient_organisation": "string",
  "ro_contact_name": "string",
  "meter_serial": "string",
  "meter_digits": "integer",
  "house_name_number": "string",
  "postcode": "string",
  "disputed_reading": "integer",
  "disputed_reading_is_actual": "boolean",
  "proposed_reading": "integer",
  "proposed_reading_is_actual": "boolean",
  "status_response": "string",
  "root_cause": "string",
  "rejection_acceptance_code": "string",
  "criteria": "string",
  "comments": "string",
  "is_gain": "boolean"
}

meterpoint.gas.disputed_closing_reading.alternative_proposed.by_us-v1

	Name	Type
required	mprn	`string`
required	supplier	`string`
required	reference_number	`integer`
required	transfer_date	`string`
required	initiating_organisation	`string`
required	io_contact_name	`string`
required	recipient_organisation	`string`
required	ro_contact_name	`string`
required	meter_serial	`string`
required	meter_digits	`integer`
required	house_name_number	`string`
required	postcode	`string`
required	disputed_reading	`integer`
required	disputed_reading_is_actual	`boolean`
required	proposed_reading	`integer`
required	proposed_reading_is_actual	`boolean`
required	status_response	`string`
required	root_cause	`string`
required	rejection_acceptance_code	`string`
required	criteria	`string`
required	comments	`string`
required	is_gain	`boolean`

Event Type	Payload Version
meterpoint.gas.disputed_closing_reading.alternative_proposed.by_us	v1

{
  "mprn": "string",
  "supplier": "string",
  "reference_number": "integer",
  "transfer_date": "string",
  "initiating_organisation": "string",
  "io_contact_name": "string",
  "recipient_organisation": "string",
  "ro_contact_name": "string",
  "meter_serial": "string",
  "meter_digits": "integer",
  "house_name_number": "string",
  "postcode": "string",
  "disputed_reading": "integer",
  "disputed_reading_is_actual": "boolean",
  "proposed_reading": "integer",
  "proposed_reading_is_actual": "boolean",
  "status_response": "string",
  "root_cause": "string",
  "rejection_acceptance_code": "string",
  "criteria": "string",
  "comments": "string",
  "is_gain": "boolean"
}

meterpoint.gas.disputed_closing_reading.alternative_proposed.other_supplier-v1

	Name	Type
required	mprn	`string`
required	supplier	`string`
required	reference_number	`integer`
required	transfer_date	`string`
required	initiating_organisation	`string`
required	io_contact_name	`string`
required	recipient_organisation	`string`
required	ro_contact_name	`string`
required	meter_serial	`string`
required	meter_digits	`integer`
required	house_name_number	`string`
required	postcode	`string`
required	disputed_reading	`integer`
required	disputed_reading_is_actual	`boolean`
required	proposed_reading	`integer`
required	proposed_reading_is_actual	`boolean`
required	status_response	`string`
required	root_cause	`string`
required	rejection_acceptance_code	`string`
required	criteria	`string`
required	comments	`string`
required	is_gain	`boolean`

Event Type	Payload Version
meterpoint.gas.disputed_closing_reading.alternative_proposed.other_supplier	v1

{
  "mprn": "string",
  "supplier": "string",
  "reference_number": "integer",
  "transfer_date": "string",
  "initiating_organisation": "string",
  "io_contact_name": "string",
  "recipient_organisation": "string",
  "ro_contact_name": "string",
  "meter_serial": "string",
  "meter_digits": "integer",
  "house_name_number": "string",
  "postcode": "string",
  "disputed_reading": "integer",
  "disputed_reading_is_actual": "boolean",
  "proposed_reading": "integer",
  "proposed_reading_is_actual": "boolean",
  "status_response": "string",
  "root_cause": "string",
  "rejection_acceptance_code": "string",
  "criteria": "string",
  "comments": "string",
  "is_gain": "boolean"
}

meterpoint.gas.disputed_closing_reading.queried.by_us-v1

	Name	Type
required	mprn	`string`
required	supplier	`string`
required	reference_number	`integer`
required	transfer_date	`string`
required	initiating_organisation	`string`
required	io_contact_name	`string`
required	recipient_organisation	`string`
required	ro_contact_name	`string`
required	meter_serial	`string`
required	meter_digits	`integer`
required	house_name_number	`string`
required	postcode	`string`
required	disputed_reading	`integer`
required	disputed_reading_is_actual	`boolean`
required	proposed_reading	`integer`
required	proposed_reading_is_actual	`boolean`
required	status_response	`string`
required	root_cause	`string`
required	rejection_acceptance_code	`string`
required	criteria	`string`
required	comments	`string`
required	is_gain	`boolean`

Event Type	Payload Version
meterpoint.gas.disputed_closing_reading.queried.by_us	v1

{
  "mprn": "string",
  "supplier": "string",
  "reference_number": "integer",
  "transfer_date": "string",
  "initiating_organisation": "string",
  "io_contact_name": "string",
  "recipient_organisation": "string",
  "ro_contact_name": "string",
  "meter_serial": "string",
  "meter_digits": "integer",
  "house_name_number": "string",
  "postcode": "string",
  "disputed_reading": "integer",
  "disputed_reading_is_actual": "boolean",
  "proposed_reading": "integer",
  "proposed_reading_is_actual": "boolean",
  "status_response": "string",
  "root_cause": "string",
  "rejection_acceptance_code": "string",
  "criteria": "string",
  "comments": "string",
  "is_gain": "boolean"
}

meterpoint.gas.disputed_closing_reading.started.by_us-v1

	Name	Type
required	mprn	`string`
required	supplier	`string`
required	reference_number	`integer`
required	transfer_date	`string`
required	initiating_organisation	`string`
required	io_contact_name	`string`
required	recipient_organisation	`string`
required	ro_contact_name	`string`
required	meter_serial	`string`
required	meter_digits	`integer`
required	house_name_number	`string`
required	postcode	`string`
required	disputed_reading	`integer`
required	disputed_reading_is_actual	`boolean`
required	proposed_reading	`integer`
required	proposed_reading_is_actual	`boolean`
required	status_response	`string`
required	root_cause	`string`
required	rejection_acceptance_code	`string`
required	criteria	`string`
required	comments	`string`
required	is_gain	`boolean`

Event Type	Payload Version
meterpoint.gas.disputed_closing_reading.started.by_us	v1

{
  "mprn": "string",
  "supplier": "string",
  "reference_number": "integer",
  "transfer_date": "string",
  "initiating_organisation": "string",
  "io_contact_name": "string",
  "recipient_organisation": "string",
  "ro_contact_name": "string",
  "meter_serial": "string",
  "meter_digits": "integer",
  "house_name_number": "string",
  "postcode": "string",
  "disputed_reading": "integer",
  "disputed_reading_is_actual": "boolean",
  "proposed_reading": "integer",
  "proposed_reading_is_actual": "boolean",
  "status_response": "string",
  "root_cause": "string",
  "rejection_acceptance_code": "string",
  "criteria": "string",
  "comments": "string",
  "is_gain": "boolean"
}

meterpoint.gas.disputed_closing_reading.started.other_supplier-v1

	Name	Type
required	mprn	`string`
required	supplier	`string`
required	reference_number	`integer`
required	transfer_date	`string`
required	initiating_organisation	`string`
required	io_contact_name	`string`
required	recipient_organisation	`string`
required	ro_contact_name	`string`
required	meter_serial	`string`
required	meter_digits	`integer`
required	house_name_number	`string`
required	postcode	`string`
required	disputed_reading	`integer`
required	disputed_reading_is_actual	`boolean`
required	proposed_reading	`integer`
required	proposed_reading_is_actual	`boolean`
required	status_response	`string`
required	root_cause	`string`
required	rejection_acceptance_code	`string`
required	criteria	`string`
required	comments	`string`
required	is_gain	`boolean`

Event Type	Payload Version
meterpoint.gas.disputed_closing_reading.started.other_supplier	v1

{
  "mprn": "string",
  "supplier": "string",
  "reference_number": "integer",
  "transfer_date": "string",
  "initiating_organisation": "string",
  "io_contact_name": "string",
  "recipient_organisation": "string",
  "ro_contact_name": "string",
  "meter_serial": "string",
  "meter_digits": "integer",
  "house_name_number": "string",
  "postcode": "string",
  "disputed_reading": "integer",
  "disputed_reading_is_actual": "boolean",
  "proposed_reading": "integer",
  "proposed_reading_is_actual": "boolean",
  "status_response": "string",
  "root_cause": "string",
  "rejection_acceptance_code": "string",
  "criteria": "string",
  "comments": "string",
  "is_gain": "boolean"
}

meterpoint.gas.disputed_opening_reading.accepted.by_us-v1

	Name	Type
required	mprn	`string`
required	supplier	`string`
required	reference_number	`integer`
required	transfer_date	`string`
required	initiating_organisation	`string`
required	io_contact_name	`string`
required	recipient_organisation	`string`
required	ro_contact_name	`string`
required	meter_serial	`string`
required	meter_digits	`integer`
required	house_name_number	`string`
required	postcode	`string`
required	disputed_reading	`integer`
required	disputed_reading_is_actual	`boolean`
required	proposed_reading	`integer`
required	proposed_reading_is_actual	`boolean`
required	status_response	`string`
required	root_cause	`string`
required	rejection_acceptance_code	`string`
required	criteria	`string`
required	comments	`string`
required	is_gain	`boolean`

Event Type	Payload Version
meterpoint.gas.disputed_opening_reading.accepted.by_us	v1

{
  "mprn": "string",
  "supplier": "string",
  "reference_number": "integer",
  "transfer_date": "string",
  "initiating_organisation": "string",
  "io_contact_name": "string",
  "recipient_organisation": "string",
  "ro_contact_name": "string",
  "meter_serial": "string",
  "meter_digits": "integer",
  "house_name_number": "string",
  "postcode": "string",
  "disputed_reading": "integer",
  "disputed_reading_is_actual": "boolean",
  "proposed_reading": "integer",
  "proposed_reading_is_actual": "boolean",
  "status_response": "string",
  "root_cause": "string",
  "rejection_acceptance_code": "string",
  "criteria": "string",
  "comments": "string",
  "is_gain": "boolean"
}

meterpoint.gas.disputed_opening_reading.accepted.other_supplier-v1

	Name	Type
required	mprn	`string`
required	supplier	`string`
required	reference_number	`integer`
required	transfer_date	`string`
required	initiating_organisation	`string`
required	io_contact_name	`string`
required	recipient_organisation	`string`
required	ro_contact_name	`string`
required	meter_serial	`string`
required	meter_digits	`integer`
required	house_name_number	`string`
required	postcode	`string`
required	disputed_reading	`integer`
required	disputed_reading_is_actual	`boolean`
required	proposed_reading	`integer`
required	proposed_reading_is_actual	`boolean`
required	status_response	`string`
required	root_cause	`string`
required	rejection_acceptance_code	`string`
required	criteria	`string`
required	comments	`string`
required	is_gain	`boolean`

Event Type	Payload Version
meterpoint.gas.disputed_opening_reading.accepted.other_supplier	v1

{
  "mprn": "string",
  "supplier": "string",
  "reference_number": "integer",
  "transfer_date": "string",
  "initiating_organisation": "string",
  "io_contact_name": "string",
  "recipient_organisation": "string",
  "ro_contact_name": "string",
  "meter_serial": "string",
  "meter_digits": "integer",
  "house_name_number": "string",
  "postcode": "string",
  "disputed_reading": "integer",
  "disputed_reading_is_actual": "boolean",
  "proposed_reading": "integer",
  "proposed_reading_is_actual": "boolean",
  "status_response": "string",
  "root_cause": "string",
  "rejection_acceptance_code": "string",
  "criteria": "string",
  "comments": "string",
  "is_gain": "boolean"
}

meterpoint.gas.disputed_opening_reading.alternative_proposed.by_us-v1

	Name	Type
required	mprn	`string`
required	supplier	`string`
required	reference_number	`integer`
required	transfer_date	`string`
required	initiating_organisation	`string`
required	io_contact_name	`string`
required	recipient_organisation	`string`
required	ro_contact_name	`string`
required	meter_serial	`string`
required	meter_digits	`integer`
required	house_name_number	`string`
required	postcode	`string`
required	disputed_reading	`integer`
required	disputed_reading_is_actual	`boolean`
required	proposed_reading	`integer`
required	proposed_reading_is_actual	`boolean`
required	status_response	`string`
required	root_cause	`string`
required	rejection_acceptance_code	`string`
required	criteria	`string`
required	comments	`string`
required	is_gain	`boolean`

Event Type	Payload Version
meterpoint.gas.disputed_opening_reading.alternative_proposed.by_us	v1

{
  "mprn": "string",
  "supplier": "string",
  "reference_number": "integer",
  "transfer_date": "string",
  "initiating_organisation": "string",
  "io_contact_name": "string",
  "recipient_organisation": "string",
  "ro_contact_name": "string",
  "meter_serial": "string",
  "meter_digits": "integer",
  "house_name_number": "string",
  "postcode": "string",
  "disputed_reading": "integer",
  "disputed_reading_is_actual": "boolean",
  "proposed_reading": "integer",
  "proposed_reading_is_actual": "boolean",
  "status_response": "string",
  "root_cause": "string",
  "rejection_acceptance_code": "string",
  "criteria": "string",
  "comments": "string",
  "is_gain": "boolean"
}

meterpoint.gas.disputed_opening_reading.alternative_proposed.other_supplier-v1

	Name	Type
required	mprn	`string`
required	supplier	`string`
required	reference_number	`integer`
required	transfer_date	`string`
required	initiating_organisation	`string`
required	io_contact_name	`string`
required	recipient_organisation	`string`
required	ro_contact_name	`string`
required	meter_serial	`string`
required	meter_digits	`integer`
required	house_name_number	`string`
required	postcode	`string`
required	disputed_reading	`integer`
required	disputed_reading_is_actual	`boolean`
required	proposed_reading	`integer`
required	proposed_reading_is_actual	`boolean`
required	status_response	`string`
required	root_cause	`string`
required	rejection_acceptance_code	`string`
required	criteria	`string`
required	comments	`string`
required	is_gain	`boolean`

Event Type	Payload Version
meterpoint.gas.disputed_opening_reading.alternative_proposed.other_supplier	v1

{
  "mprn": "string",
  "supplier": "string",
  "reference_number": "integer",
  "transfer_date": "string",
  "initiating_organisation": "string",
  "io_contact_name": "string",
  "recipient_organisation": "string",
  "ro_contact_name": "string",
  "meter_serial": "string",
  "meter_digits": "integer",
  "house_name_number": "string",
  "postcode": "string",
  "disputed_reading": "integer",
  "disputed_reading_is_actual": "boolean",
  "proposed_reading": "integer",
  "proposed_reading_is_actual": "boolean",
  "status_response": "string",
  "root_cause": "string",
  "rejection_acceptance_code": "string",
  "criteria": "string",
  "comments": "string",
  "is_gain": "boolean"
}

meterpoint.gas.disputed_opening_reading.queried.by_us-v1

	Name	Type
required	mprn	`string`
required	supplier	`string`
required	reference_number	`integer`
required	transfer_date	`string`
required	initiating_organisation	`string`
required	io_contact_name	`string`
required	recipient_organisation	`string`
required	ro_contact_name	`string`
required	meter_serial	`string`
required	meter_digits	`integer`
required	house_name_number	`string`
required	postcode	`string`
required	disputed_reading	`integer`
required	disputed_reading_is_actual	`boolean`
required	proposed_reading	`integer`
required	proposed_reading_is_actual	`boolean`
required	status_response	`string`
required	root_cause	`string`
required	rejection_acceptance_code	`string`
required	criteria	`string`
required	comments	`string`
required	is_gain	`boolean`

Event Type	Payload Version
meterpoint.gas.disputed_opening_reading.queried.by_us	v1

{
  "mprn": "string",
  "supplier": "string",
  "reference_number": "integer",
  "transfer_date": "string",
  "initiating_organisation": "string",
  "io_contact_name": "string",
  "recipient_organisation": "string",
  "ro_contact_name": "string",
  "meter_serial": "string",
  "meter_digits": "integer",
  "house_name_number": "string",
  "postcode": "string",
  "disputed_reading": "integer",
  "disputed_reading_is_actual": "boolean",
  "proposed_reading": "integer",
  "proposed_reading_is_actual": "boolean",
  "status_response": "string",
  "root_cause": "string",
  "rejection_acceptance_code": "string",
  "criteria": "string",
  "comments": "string",
  "is_gain": "boolean"
}

meterpoint.gas.disputed_opening_reading.started.by_us-v1

	Name	Type
required	mprn	`string`
required	supplier	`string`
required	reference_number	`integer`
required	transfer_date	`string`
required	initiating_organisation	`string`
required	io_contact_name	`string`
required	recipient_organisation	`string`
required	ro_contact_name	`string`
required	meter_serial	`string`
required	meter_digits	`integer`
required	house_name_number	`string`
required	postcode	`string`
required	disputed_reading	`integer`
required	disputed_reading_is_actual	`boolean`
required	proposed_reading	`integer`
required	proposed_reading_is_actual	`boolean`
required	status_response	`string`
required	root_cause	`string`
required	rejection_acceptance_code	`string`
required	criteria	`string`
required	comments	`string`
required	is_gain	`boolean`

Event Type	Payload Version
meterpoint.gas.disputed_opening_reading.started.by_us	v1

{
  "mprn": "string",
  "supplier": "string",
  "reference_number": "integer",
  "transfer_date": "string",
  "initiating_organisation": "string",
  "io_contact_name": "string",
  "recipient_organisation": "string",
  "ro_contact_name": "string",
  "meter_serial": "string",
  "meter_digits": "integer",
  "house_name_number": "string",
  "postcode": "string",
  "disputed_reading": "integer",
  "disputed_reading_is_actual": "boolean",
  "proposed_reading": "integer",
  "proposed_reading_is_actual": "boolean",
  "status_response": "string",
  "root_cause": "string",
  "rejection_acceptance_code": "string",
  "criteria": "string",
  "comments": "string",
  "is_gain": "boolean"
}

meterpoint.gas.disputed_opening_reading.started.other_supplier-v1

	Name	Type
required	mprn	`string`
required	supplier	`string`
required	reference_number	`integer`
required	transfer_date	`string`
required	initiating_organisation	`string`
required	io_contact_name	`string`
required	recipient_organisation	`string`
required	ro_contact_name	`string`
required	meter_serial	`string`
required	meter_digits	`integer`
required	house_name_number	`string`
required	postcode	`string`
required	disputed_reading	`integer`
required	disputed_reading_is_actual	`boolean`
required	proposed_reading	`integer`
required	proposed_reading_is_actual	`boolean`
required	status_response	`string`
required	root_cause	`string`
required	rejection_acceptance_code	`string`
required	criteria	`string`
required	comments	`string`
required	is_gain	`boolean`

Event Type	Payload Version
meterpoint.gas.disputed_opening_reading.started.other_supplier	v1

{
  "mprn": "string",
  "supplier": "string",
  "reference_number": "integer",
  "transfer_date": "string",
  "initiating_organisation": "string",
  "io_contact_name": "string",
  "recipient_organisation": "string",
  "ro_contact_name": "string",
  "meter_serial": "string",
  "meter_digits": "integer",
  "house_name_number": "string",
  "postcode": "string",
  "disputed_reading": "integer",
  "disputed_reading_is_actual": "boolean",
  "proposed_reading": "integer",
  "proposed_reading_is_actual": "boolean",
  "status_response": "string",
  "root_cause": "string",
  "rejection_acceptance_code": "string",
  "criteria": "string",
  "comments": "string",
  "is_gain": "boolean"
}

meterpoint.gas.et_gain.accepted.by_other_supplier-v1

	Name	Type
required	mprn	`string`
required	supplier	`string`
required	reference_number	`integer`
required	transfer_date	`string`
required	sub_building_name	`string`
required	building_name	`string`
required	building_number	`string`
required	deliver_point_alias	`string`
required	street_name	`string`
required	postcode	`string`
required	initial_contact_date	`string`
required	initiating_organisation	`string`
required	io_contact_name	`string`
required	responding_organisation	`string`
required	ro_contact_name	`string`
required	status_response	`string`
required	rejection_acceptance_code	`string`
required	reason_for_return	`string`
required	comments	`string`
required	customer_name	`string`
required	other_supplier	`string`
required	contact_name	`string`

Event Type	Payload Version
meterpoint.gas.et_gain.accepted.by_other_supplier	v1

{
  "mprn": "string",
  "supplier": "string",
  "reference_number": "integer",
  "transfer_date": "string",
  "sub_building_name": "string",
  "building_name": "string",
  "building_number": "string",
  "deliver_point_alias": "string",
  "street_name": "string",
  "postcode": "string",
  "initial_contact_date": "string",
  "initiating_organisation": "string",
  "io_contact_name": "string",
  "responding_organisation": "string",
  "ro_contact_name": "string",
  "status_response": "string",
  "rejection_acceptance_code": "string",
  "reason_for_return": "string",
  "comments": "string",
  "customer_name": "string",
  "other_supplier": "string",
  "contact_name": "string"
}

meterpoint.gas.et_gain.accepted.by_us-v1

	Name	Type
required	mprn	`string`
required	supplier	`string`
required	reference_number	`integer`
required	transfer_date	`string`
required	sub_building_name	`string`
required	building_name	`string`
required	building_number	`string`
required	deliver_point_alias	`string`
required	street_name	`string`
required	postcode	`string`
required	initial_contact_date	`string`
required	initiating_organisation	`string`
required	io_contact_name	`string`
required	responding_organisation	`string`
required	ro_contact_name	`string`
required	status_response	`string`
required	rejection_acceptance_code	`string`
required	reason_for_return	`string`
required	comments	`string`
required	customer_name	`string`
required	other_supplier	`string`
required	contact_name	`string`

Event Type	Payload Version
meterpoint.gas.et_gain.accepted.by_us	v1

{
  "mprn": "string",
  "supplier": "string",
  "reference_number": "integer",
  "transfer_date": "string",
  "sub_building_name": "string",
  "building_name": "string",
  "building_number": "string",
  "deliver_point_alias": "string",
  "street_name": "string",
  "postcode": "string",
  "initial_contact_date": "string",
  "initiating_organisation": "string",
  "io_contact_name": "string",
  "responding_organisation": "string",
  "ro_contact_name": "string",
  "status_response": "string",
  "rejection_acceptance_code": "string",
  "reason_for_return": "string",
  "comments": "string",
  "customer_name": "string",
  "other_supplier": "string",
  "contact_name": "string"
}

meterpoint.gas.et_gain.rejected.by_other_supplier-v1

	Name	Type
required	mprn	`string`
required	supplier	`string`
required	reference_number	`integer`
required	transfer_date	`string`
required	sub_building_name	`string`
required	building_name	`string`
required	building_number	`string`
required	deliver_point_alias	`string`
required	street_name	`string`
required	postcode	`string`
required	initial_contact_date	`string`
required	initiating_organisation	`string`
required	io_contact_name	`string`
required	responding_organisation	`string`
required	ro_contact_name	`string`
required	status_response	`string`
required	rejection_acceptance_code	`string`
required	reason_for_return	`string`
required	comments	`string`
required	customer_name	`string`
required	other_supplier	`string`
required	contact_name	`string`

Event Type	Payload Version
meterpoint.gas.et_gain.rejected.by_other_supplier	v1

{
  "mprn": "string",
  "supplier": "string",
  "reference_number": "integer",
  "transfer_date": "string",
  "sub_building_name": "string",
  "building_name": "string",
  "building_number": "string",
  "deliver_point_alias": "string",
  "street_name": "string",
  "postcode": "string",
  "initial_contact_date": "string",
  "initiating_organisation": "string",
  "io_contact_name": "string",
  "responding_organisation": "string",
  "ro_contact_name": "string",
  "status_response": "string",
  "rejection_acceptance_code": "string",
  "reason_for_return": "string",
  "comments": "string",
  "customer_name": "string",
  "other_supplier": "string",
  "contact_name": "string"
}

meterpoint.gas.et_gain.rejected.by_us-v1

	Name	Type
required	mprn	`string`
required	supplier	`string`
required	reference_number	`integer`
required	transfer_date	`string`
required	sub_building_name	`string`
required	building_name	`string`
required	building_number	`string`
required	deliver_point_alias	`string`
required	street_name	`string`
required	postcode	`string`
required	initial_contact_date	`string`
required	initiating_organisation	`string`
required	io_contact_name	`string`
required	responding_organisation	`string`
required	ro_contact_name	`string`
required	status_response	`string`
required	rejection_acceptance_code	`string`
required	reason_for_return	`string`
required	comments	`string`
required	customer_name	`string`
required	other_supplier	`string`
required	contact_name	`string`

Event Type	Payload Version
meterpoint.gas.et_gain.rejected.by_us	v1

{
  "mprn": "string",
  "supplier": "string",
  "reference_number": "integer",
  "transfer_date": "string",
  "sub_building_name": "string",
  "building_name": "string",
  "building_number": "string",
  "deliver_point_alias": "string",
  "street_name": "string",
  "postcode": "string",
  "initial_contact_date": "string",
  "initiating_organisation": "string",
  "io_contact_name": "string",
  "responding_organisation": "string",
  "ro_contact_name": "string",
  "status_response": "string",
  "rejection_acceptance_code": "string",
  "reason_for_return": "string",
  "comments": "string",
  "customer_name": "string",
  "other_supplier": "string",
  "contact_name": "string"
}

meterpoint.gas.et_gain.started.by_other_supplier-v1

	Name	Type
required	mprn	`string`
required	supplier	`string`
required	reference_number	`integer`
required	transfer_date	`string`
required	sub_building_name	`string`
required	building_name	`string`
required	building_number	`string`
required	deliver_point_alias	`string`
required	street_name	`string`
required	postcode	`string`
required	initial_contact_date	`string`
required	initiating_organisation	`string`
required	io_contact_name	`string`
required	responding_organisation	`string`
required	ro_contact_name	`string`
required	status_response	`string`
required	rejection_acceptance_code	`string`
required	reason_for_return	`string`
required	comments	`string`
required	customer_name	`string`
required	other_supplier	`string`
required	contact_name	`string`

Event Type	Payload Version
meterpoint.gas.et_gain.started.by_other_supplier	v1

{
  "mprn": "string",
  "supplier": "string",
  "reference_number": "integer",
  "transfer_date": "string",
  "sub_building_name": "string",
  "building_name": "string",
  "building_number": "string",
  "deliver_point_alias": "string",
  "street_name": "string",
  "postcode": "string",
  "initial_contact_date": "string",
  "initiating_organisation": "string",
  "io_contact_name": "string",
  "responding_organisation": "string",
  "ro_contact_name": "string",
  "status_response": "string",
  "rejection_acceptance_code": "string",
  "reason_for_return": "string",
  "comments": "string",
  "customer_name": "string",
  "other_supplier": "string",
  "contact_name": "string"
}

meterpoint.gas.et_gain.started.by_us-v1

	Name	Type
required	mprn	`string`
required	supplier	`string`
required	reference_number	`integer`
required	transfer_date	`string`
required	sub_building_name	`string`
required	building_name	`string`
required	building_number	`string`
required	deliver_point_alias	`string`
required	street_name	`string`
required	postcode	`string`
required	initial_contact_date	`string`
required	initiating_organisation	`string`
required	io_contact_name	`string`
required	responding_organisation	`string`
required	ro_contact_name	`string`
required	status_response	`string`
required	rejection_acceptance_code	`string`
required	reason_for_return	`string`
required	comments	`string`
required	customer_name	`string`
required	other_supplier	`string`
required	contact_name	`string`

Event Type	Payload Version
meterpoint.gas.et_gain.started.by_us	v1

{
  "mprn": "string",
  "supplier": "string",
  "reference_number": "integer",
  "transfer_date": "string",
  "sub_building_name": "string",
  "building_name": "string",
  "building_number": "string",
  "deliver_point_alias": "string",
  "street_name": "string",
  "postcode": "string",
  "initial_contact_date": "string",
  "initiating_organisation": "string",
  "io_contact_name": "string",
  "responding_organisation": "string",
  "ro_contact_name": "string",
  "status_response": "string",
  "rejection_acceptance_code": "string",
  "reason_for_return": "string",
  "comments": "string",
  "customer_name": "string",
  "other_supplier": "string",
  "contact_name": "string"
}

meterpoint.gas.et_loss.accepted.by_other_supplier-v1

	Name	Type
required	mprn	`string`
required	supplier	`string`
required	reference_number	`integer`
required	transfer_date	`string`
required	sub_building_name	`string`
required	building_name	`string`
required	building_number	`string`
required	deliver_point_alias	`string`
required	street_name	`string`
required	postcode	`string`
required	initial_contact_date	`string`
required	initiating_organisation	`string`
required	io_contact_name	`string`
required	responding_organisation	`string`
required	ro_contact_name	`string`
required	status_response	`string`
required	rejection_acceptance_code	`string`
required	reason_for_return	`string`
required	comments	`string`
required	customer_name	`string`
required	other_supplier	`string`
required	contact_name	`string`

Event Type	Payload Version
meterpoint.gas.et_loss.accepted.by_other_supplier	v1

{
  "mprn": "string",
  "supplier": "string",
  "reference_number": "integer",
  "transfer_date": "string",
  "sub_building_name": "string",
  "building_name": "string",
  "building_number": "string",
  "deliver_point_alias": "string",
  "street_name": "string",
  "postcode": "string",
  "initial_contact_date": "string",
  "initiating_organisation": "string",
  "io_contact_name": "string",
  "responding_organisation": "string",
  "ro_contact_name": "string",
  "status_response": "string",
  "rejection_acceptance_code": "string",
  "reason_for_return": "string",
  "comments": "string",
  "customer_name": "string",
  "other_supplier": "string",
  "contact_name": "string"
}

meterpoint.gas.et_loss.accepted.by_us-v1

	Name	Type
required	mprn	`string`
required	supplier	`string`
required	reference_number	`integer`
required	transfer_date	`string`
required	sub_building_name	`string`
required	building_name	`string`
required	building_number	`string`
required	deliver_point_alias	`string`
required	street_name	`string`
required	postcode	`string`
required	initial_contact_date	`string`
required	initiating_organisation	`string`
required	io_contact_name	`string`
required	responding_organisation	`string`
required	ro_contact_name	`string`
required	status_response	`string`
required	rejection_acceptance_code	`string`
required	reason_for_return	`string`
required	comments	`string`
required	customer_name	`string`
required	other_supplier	`string`
required	contact_name	`string`

Event Type	Payload Version
meterpoint.gas.et_loss.accepted.by_us	v1

{
  "mprn": "string",
  "supplier": "string",
  "reference_number": "integer",
  "transfer_date": "string",
  "sub_building_name": "string",
  "building_name": "string",
  "building_number": "string",
  "deliver_point_alias": "string",
  "street_name": "string",
  "postcode": "string",
  "initial_contact_date": "string",
  "initiating_organisation": "string",
  "io_contact_name": "string",
  "responding_organisation": "string",
  "ro_contact_name": "string",
  "status_response": "string",
  "rejection_acceptance_code": "string",
  "reason_for_return": "string",
  "comments": "string",
  "customer_name": "string",
  "other_supplier": "string",
  "contact_name": "string"
}

meterpoint.gas.et_loss.rejected.by_other_supplier-v1

	Name	Type
required	mprn	`string`
required	supplier	`string`
required	reference_number	`integer`
required	transfer_date	`string`
required	sub_building_name	`string`
required	building_name	`string`
required	building_number	`string`
required	deliver_point_alias	`string`
required	street_name	`string`
required	postcode	`string`
required	initial_contact_date	`string`
required	initiating_organisation	`string`
required	io_contact_name	`string`
required	responding_organisation	`string`
required	ro_contact_name	`string`
required	status_response	`string`
required	rejection_acceptance_code	`string`
required	reason_for_return	`string`
required	comments	`string`
required	customer_name	`string`
required	other_supplier	`string`
required	contact_name	`string`

Event Type	Payload Version
meterpoint.gas.et_loss.rejected.by_other_supplier	v1

{
  "mprn": "string",
  "supplier": "string",
  "reference_number": "integer",
  "transfer_date": "string",
  "sub_building_name": "string",
  "building_name": "string",
  "building_number": "string",
  "deliver_point_alias": "string",
  "street_name": "string",
  "postcode": "string",
  "initial_contact_date": "string",
  "initiating_organisation": "string",
  "io_contact_name": "string",
  "responding_organisation": "string",
  "ro_contact_name": "string",
  "status_response": "string",
  "rejection_acceptance_code": "string",
  "reason_for_return": "string",
  "comments": "string",
  "customer_name": "string",
  "other_supplier": "string",
  "contact_name": "string"
}

meterpoint.gas.et_loss.rejected.by_us-v1

	Name	Type
required	mprn	`string`
required	supplier	`string`
required	reference_number	`integer`
required	transfer_date	`string`
required	sub_building_name	`string`
required	building_name	`string`
required	building_number	`string`
required	deliver_point_alias	`string`
required	street_name	`string`
required	postcode	`string`
required	initial_contact_date	`string`
required	initiating_organisation	`string`
required	io_contact_name	`string`
required	responding_organisation	`string`
required	ro_contact_name	`string`
required	status_response	`string`
required	rejection_acceptance_code	`string`
required	reason_for_return	`string`
required	comments	`string`
required	customer_name	`string`
required	other_supplier	`string`
required	contact_name	`string`

Event Type	Payload Version
meterpoint.gas.et_loss.rejected.by_us	v1

{
  "mprn": "string",
  "supplier": "string",
  "reference_number": "integer",
  "transfer_date": "string",
  "sub_building_name": "string",
  "building_name": "string",
  "building_number": "string",
  "deliver_point_alias": "string",
  "street_name": "string",
  "postcode": "string",
  "initial_contact_date": "string",
  "initiating_organisation": "string",
  "io_contact_name": "string",
  "responding_organisation": "string",
  "ro_contact_name": "string",
  "status_response": "string",
  "rejection_acceptance_code": "string",
  "reason_for_return": "string",
  "comments": "string",
  "customer_name": "string",
  "other_supplier": "string",
  "contact_name": "string"
}

meterpoint.gas.et_loss.started.by_other_supplier-v1

	Name	Type
required	mprn	`string`
required	supplier	`string`
required	reference_number	`integer`
required	transfer_date	`string`
required	sub_building_name	`string`
required	building_name	`string`
required	building_number	`string`
required	deliver_point_alias	`string`
required	street_name	`string`
required	postcode	`string`
required	initial_contact_date	`string`
required	initiating_organisation	`string`
required	io_contact_name	`string`
required	responding_organisation	`string`
required	ro_contact_name	`string`
required	status_response	`string`
required	rejection_acceptance_code	`string`
required	reason_for_return	`string`
required	comments	`string`
required	customer_name	`string`
required	other_supplier	`string`
required	contact_name	`string`

Event Type	Payload Version
meterpoint.gas.et_loss.started.by_other_supplier	v1

{
  "mprn": "string",
  "supplier": "string",
  "reference_number": "integer",
  "transfer_date": "string",
  "sub_building_name": "string",
  "building_name": "string",
  "building_number": "string",
  "deliver_point_alias": "string",
  "street_name": "string",
  "postcode": "string",
  "initial_contact_date": "string",
  "initiating_organisation": "string",
  "io_contact_name": "string",
  "responding_organisation": "string",
  "ro_contact_name": "string",
  "status_response": "string",
  "rejection_acceptance_code": "string",
  "reason_for_return": "string",
  "comments": "string",
  "customer_name": "string",
  "other_supplier": "string",
  "contact_name": "string"
}

meterpoint.gas.et_loss.started.by_us-v1

	Name	Type
required	mprn	`string`
required	supplier	`string`
required	reference_number	`integer`
required	transfer_date	`string`
required	sub_building_name	`string`
required	building_name	`string`
required	building_number	`string`
required	deliver_point_alias	`string`
required	street_name	`string`
required	postcode	`string`
required	initial_contact_date	`string`
required	initiating_organisation	`string`
required	io_contact_name	`string`
required	responding_organisation	`string`
required	ro_contact_name	`string`
required	status_response	`string`
required	rejection_acceptance_code	`string`
required	reason_for_return	`string`
required	comments	`string`
required	customer_name	`string`
required	other_supplier	`string`
required	contact_name	`string`

Event Type	Payload Version
meterpoint.gas.et_loss.started.by_us	v1

{
  "mprn": "string",
  "supplier": "string",
  "reference_number": "integer",
  "transfer_date": "string",
  "sub_building_name": "string",
  "building_name": "string",
  "building_number": "string",
  "deliver_point_alias": "string",
  "street_name": "string",
  "postcode": "string",
  "initial_contact_date": "string",
  "initiating_organisation": "string",
  "io_contact_name": "string",
  "responding_organisation": "string",
  "ro_contact_name": "string",
  "status_response": "string",
  "rejection_acceptance_code": "string",
  "reason_for_return": "string",
  "comments": "string",
  "customer_name": "string",
  "other_supplier": "string",
  "contact_name": "string"
}

meterpoint.gas.meter-technical-details.update.requested-v1

	Name	Type
required	mprn	`string`
required	transaction_reference	`string`
required	transaction_status	`string`
required	market_sector	`string`
required	transaction_type	`string`
required	meter_link	`string`
required	address_type	`string`
required	asset_transaction_type	`string`
required	asset_class	`string`
required	num_dials_or_digits	`integer`
required	units_of_measure	`string`
required	meter_type	`string`
required	mechanism	`string`
required	reading_value	`string`
required	contract_reference	`string`
required	transaction_comment	`string`
required	transaction_type_reason	`string`
required	cross_ref_other_internal_job_reference	`string`
required	cross_ref_other_external_job_reference	`string`
required	transaction_status_change_reason	`string`
required	date_of_notice	`string`
required	registration_body	`string`
required	registration_reference	`string`
required	effective_from_date	`string`
required	effective_to_date	`string`
required	meter_point_status	`string`
required	meter_point_data_update	`string`
required	meter_point_location	`string`
required	meter_point_location_notes	`string`
required	access_instructions	`string`
required	meter_point_conversion_factor	`number`
required	last_inspection_date	`string`
required	metering_pressure	`number`
required	address_notes	`string`
required	sub_building_name_number	`string`
required	building_name_number	`string`
required	dependent_thoroughfare	`string`
required	thoroughfare	`string`
required	double_dependent_locality	`string`
required	dependent_locality	`string`
required	post_town	`string`
required	county	`string`
required	post_code	`string`
required	grid_coord_x	`integer`
required	grid_coord_y	`integer`
required	grid_coord_z	`integer`
required	unique_property_reference_number	`string`
required	asset_data_update	`string`
required	product_id	`string`
required	payment_method	`string`
required	model_code	`string`
required	manufacturer_code	`string`
required	year_of_manufacture	`integer`
required	serial_number	`string`
required	asset_location	`string`
required	asset_location_notes	`string`
required	asset_status	`string`
required	appointment_date_qualifier	`string`
required	appointment_date_from	`string`
required	appointment_date_to	`string`
required	appointment_time_qualifier	`string`
required	appointment_time_from	`string`
required	appointment_time_to	`string`
required	register_type	`string`
required	register_data_update	`string`
required	multiplication_factor	`number`
required	converter_data_update	`string`
required	conversion_basis	`string`
required	converter_conversion_factor	`number`
required	meter_data_update	`string`
required	measuring_capacity	`number`
required	meter_usage	`string`
required	collar_status	`string`
required	oami_inspection_date	`string`
required	meter_role	`string`
required	market_participant_role	`string`
required	last_refurbished_date	`string`
required	pulse_value	`number`
required	reading_date	`string`
required	round_the_clock	`integer`

Event Type	Payload Version
meterpoint.gas.meter-technical-details.update.requested	v1

{
  "mprn": "string",
  "transaction_reference": "string",
  "transaction_status": "string",
  "market_sector": "string",
  "transaction_type": "string",
  "meter_link": "string",
  "address_type": "string",
  "asset_transaction_type": "string",
  "asset_class": "string",
  "num_dials_or_digits": "integer",
  "units_of_measure": "string",
  "meter_type": "string",
  "mechanism": "string",
  "reading_value": "string",
  "contract_reference": "string",
  "transaction_comment": "string",
  "transaction_type_reason": "string",
  "cross_ref_other_internal_job_reference": "string",
  "cross_ref_other_external_job_reference": "string",
  "transaction_status_change_reason": "string",
  "date_of_notice": "string",
  "registration_body": "string",
  "registration_reference": "string",
  "effective_from_date": "string",
  "effective_to_date": "string",
  "meter_point_status": "string",
  "meter_point_data_update": "string",
  "meter_point_location": "string",
  "meter_point_location_notes": "string",
  "access_instructions": "string",
  "meter_point_conversion_factor": "number",
  "last_inspection_date": "string",
  "metering_pressure": "number",
  "address_notes": "string",
  "sub_building_name_number": "string",
  "building_name_number": "string",
  "dependent_thoroughfare": "string",
  "thoroughfare": "string",
  "double_dependent_locality": "string",
  "dependent_locality": "string",
  "post_town": "string",
  "county": "string",
  "post_code": "string",
  "grid_coord_x": "integer",
  "grid_coord_y": "integer",
  "grid_coord_z": "integer",
  "unique_property_reference_number": "string",
  "asset_data_update": "string",
  "product_id": "string",
  "payment_method": "string",
  "model_code": "string",
  "manufacturer_code": "string",
  "year_of_manufacture": "integer",
  "serial_number": "string",
  "asset_location": "string",
  "asset_location_notes": "string",
  "asset_status": "string",
  "appointment_date_qualifier": "string",
  "appointment_date_from": "string",
  "appointment_date_to": "string",
  "appointment_time_qualifier": "string",
  "appointment_time_from": "string",
  "appointment_time_to": "string",
  "register_type": "string",
  "register_data_update": "string",
  "multiplication_factor": "number",
  "converter_data_update": "string",
  "conversion_basis": "string",
  "converter_conversion_factor": "number",
  "meter_data_update": "string",
  "measuring_capacity": "number",
  "meter_usage": "string",
  "collar_status": "string",
  "oami_inspection_date": "string",
  "meter_role": "string",
  "market_participant_role": "string",
  "last_refurbished_date": "string",
  "pulse_value": "number",
  "reading_date": "string",
  "round_the_clock": "integer"
}

meterpoint.gas.meter_exchanged-v1

	Name	Type
required	mprn	`string`
required	meter_serial_number	`string`
required	meter_digits	`integer`
required	meter_mechanism	`string`
required	meter_is_imperial	`boolean`
required	meter_reading_factor	`number`

Event Type	Payload Version
meterpoint.gas.meter_exchanged	v1

{
  "mprn": "string",
  "meter_serial_number": "string",
  "meter_digits": "integer",
  "meter_mechanism": "string",
  "meter_is_imperial": "boolean",
  "meter_reading_factor": "number"
}

meterpoint.gas.reading-v1

	Name	Type
required	mprn	`string`
required	reading	`integer`
required	date	`string`
required	meter_digits	`integer`
required	meter_serial_number	`string`

Event Type	Payload Version
meterpoint.gas.reading	v1

{
  "mprn": "string",
  "reading": "integer",
  "date": "string",
  "meter_digits": "integer",
  "meter_serial_number": "string"
}

meterpoint.reading.gap.filled-v1

	Name	Type
required	meter_point_identifier	`string`
required	start_at	`string`
required	end_at	`string`
	device_id	`string`
	register_id	`string`
	direction	`string`
	supply_type	`string`
	meter_reading_type	`string`
	extras	`object`
	store_full_series	`boolean`

Event Type	Payload Version
meterpoint.reading.gap.filled	v1

{
  "meter_point_identifier": "string",
  "start_at": "string",
  "end_at": "string",
  "device_id": "string",
  "register_id": "string",
  "direction": "string",
  "supply_type": "string",
  "meter_reading_type": "string",
  "extras": "object",
  "store_full_series": "boolean"
}

meterpoint.reading.gap.filling.failed-v1

	Name	Type
required	meter_point_identifier	`string`
required	start_at	`string`
required	end_at	`string`
	device_id	`string`
	register_id	`string`
	direction	`string`
	supply_type	`string`
	meter_reading_type	`string`
	extras	`object`
	store_full_series	`boolean`

Event Type	Payload Version
meterpoint.reading.gap.filling.failed	v1

{
  "meter_point_identifier": "string",
  "start_at": "string",
  "end_at": "string",
  "device_id": "string",
  "register_id": "string",
  "direction": "string",
  "supply_type": "string",
  "meter_reading_type": "string",
  "extras": "object",
  "store_full_series": "boolean"
}

meterpoint.reading.gap.found-v1

	Name	Type
required	meter_point_identifier	`string`
required	start_at	`string`
required	end_at	`string`
	device_id	`string`
	register_id	`string`
	direction	`string`
	supply_type	`string`
	meter_reading_type	`string`
	extras	`object`
	store_full_series	`boolean`

Event Type	Payload Version
meterpoint.reading.gap.found	v1

{
  "meter_point_identifier": "string",
  "start_at": "string",
  "end_at": "string",
  "device_id": "string",
  "register_id": "string",
  "direction": "string",
  "supply_type": "string",
  "meter_reading_type": "string",
  "extras": "object",
  "store_full_series": "boolean"
}

meterpoint.reading.missing.filled-v1

	Name	Type
required	meter_point_identifier	`string`
required	start_at	`string`
required	end_at	`string`
	device_id	`string`
	register_id	`string`
	direction	`string`
	supply_type	`string`
	meter_reading_type	`string`
	extras	`object`
	store_full_series	`boolean`

Event Type	Payload Version
meterpoint.reading.missing.filled	v1

{
  "meter_point_identifier": "string",
  "start_at": "string",
  "end_at": "string",
  "device_id": "string",
  "register_id": "string",
  "direction": "string",
  "supply_type": "string",
  "meter_reading_type": "string",
  "extras": "object",
  "store_full_series": "boolean"
}

meterpoint.reading.missing.filling.failed-v1

	Name	Type
required	meter_point_identifier	`string`
required	start_at	`string`
required	end_at	`string`
	device_id	`string`
	register_id	`string`
	direction	`string`
	supply_type	`string`
	meter_reading_type	`string`
	extras	`object`
	store_full_series	`boolean`

Event Type	Payload Version
meterpoint.reading.missing.filling.failed	v1

{
  "meter_point_identifier": "string",
  "start_at": "string",
  "end_at": "string",
  "device_id": "string",
  "register_id": "string",
  "direction": "string",
  "supply_type": "string",
  "meter_reading_type": "string",
  "extras": "object",
  "store_full_series": "boolean"
}

meterpoint.reading.missing.found-v1

	Name	Type
required	meter_point_identifier	`string`
required	start_at	`string`
required	end_at	`string`
	device_id	`string`
	register_id	`string`
	direction	`string`
	supply_type	`string`
	meter_reading_type	`string`
	extras	`object`
	store_full_series	`boolean`

Event Type	Payload Version
meterpoint.reading.missing.found	v1

{
  "meter_point_identifier": "string",
  "start_at": "string",
  "end_at": "string",
  "device_id": "string",
  "register_id": "string",
  "direction": "string",
  "supply_type": "string",
  "meter_reading_type": "string",
  "extras": "object",
  "store_full_series": "boolean"
}

on_site_jobs.appointment.booked-v1

	Name	Type
required	id	`string`
required	request_id	`string`
required	status	`string`
required	agent	`string`
required	kraken_work_category	`string`
required	external_job_type	`string`
required	previous_status	`string`

Event Type	Payload Version
on_site_jobs.appointment.booked	v1

{
  "id": "string",
  "request_id": "string",
  "status": "string",
  "agent": "string",
  "kraken_work_category": "string",
  "external_job_type": "string",
  "previous_status": "string"
}

on_site_jobs.appointment.cancelled-v1

	Name	Type
required	id	`string`
required	request_id	`string`
required	status	`string`
required	agent	`string`
required	kraken_work_category	`string`
required	external_job_type	`string`
required	previous_status	`string`

Event Type	Payload Version
on_site_jobs.appointment.cancelled	v1

{
  "id": "string",
  "request_id": "string",
  "status": "string",
  "agent": "string",
  "kraken_work_category": "string",
  "external_job_type": "string",
  "previous_status": "string"
}

on_site_jobs.appointment.completed-v1

	Name	Type
required	id	`string`
required	request_id	`string`
required	status	`string`
required	agent	`string`
required	kraken_work_category	`string`
required	external_job_type	`string`
required	previous_status	`string`

Event Type	Payload Version
on_site_jobs.appointment.completed	v1

{
  "id": "string",
  "request_id": "string",
  "status": "string",
  "agent": "string",
  "kraken_work_category": "string",
  "external_job_type": "string",
  "previous_status": "string"
}

on_site_jobs.appointment.job_notes_updated-v1

	Name	Type
required	id	`string`
required	request_id	`string`
required	status	`string`
required	agent	`string`
required	kraken_work_category	`string`
required	external_job_type	`string`
required	affected_job_notes_keys	`array[string]`

Event Type	Payload Version
on_site_jobs.appointment.job_notes_updated	v1

{
  "id": "string",
  "request_id": "string",
  "status": "string",
  "agent": "string",
  "kraken_work_category": "string",
  "external_job_type": "string",
  "affected_job_notes_keys": [
    "string"
  ]
}

on_site_jobs.request.appointment_failed-v1

	Name	Type
required	id	`string`
required	status	`string`
required	reason	`string`
required	sub_reason	`string`
required	is_emergency	`boolean`
required	agent	`string`
required	previous_status	`string`

Event Type	Payload Version
on_site_jobs.request.appointment_failed	v1

{
  "id": "string",
  "status": "string",
  "reason": "string",
  "sub_reason": "string",
  "is_emergency": "boolean",
  "agent": "string",
  "previous_status": "string"
}

on_site_jobs.request.approval_rejected-v1

	Name	Type
required	id	`string`
required	status	`string`
required	reason	`string`
required	sub_reason	`string`
required	is_emergency	`boolean`
required	agent	`string`
required	previous_status	`string`

Event Type	Payload Version
on_site_jobs.request.approval_rejected	v1

{
  "id": "string",
  "status": "string",
  "reason": "string",
  "sub_reason": "string",
  "is_emergency": "boolean",
  "agent": "string",
  "previous_status": "string"
}

on_site_jobs.request.completed-v1

	Name	Type
required	id	`string`
required	status	`string`
required	reason	`string`
required	sub_reason	`string`
required	is_emergency	`boolean`
required	agent	`string`
required	previous_status	`string`

Event Type	Payload Version
on_site_jobs.request.completed	v1

{
  "id": "string",
  "status": "string",
  "reason": "string",
  "sub_reason": "string",
  "is_emergency": "boolean",
  "agent": "string",
  "previous_status": "string"
}

on_site_jobs.request.created-v1

	Name	Type
required	id	`string`
required	status	`string`
required	reason	`string`
required	sub_reason	`string`
required	is_emergency	`boolean`
required	agent	`string`
required	previous_status	`string`

Event Type	Payload Version
on_site_jobs.request.created	v1

{
  "id": "string",
  "status": "string",
  "reason": "string",
  "sub_reason": "string",
  "is_emergency": "boolean",
  "agent": "string",
  "previous_status": "string"
}

partner_access.granted-v1

	Name	Type
required	allocation_id	`integer`
required	target_reference	`string`
required	target_type	`string`
required	role_id	`integer`
required	start_at	`string`
required	end_at	`string`
required	partner_reference	`string`

Event Type	Payload Version
partner_access.granted	v1

{
  "allocation_id": "integer",
  "target_reference": "string",
  "target_type": "string",
  "role_id": "integer",
  "start_at": "string",
  "end_at": "string",
  "partner_reference": "string"
}

partner_user.created-v1

	Name	Type
required	partner_user_id	`integer`
required	partner_user_number	`string`
required	partner_user_email	`string`
required	partner_organisation_number	`string`

Event Type	Payload Version
partner_user.created	v1

{
  "partner_user_id": "integer",
  "partner_user_number": "string",
  "partner_user_email": "string",
  "partner_organisation_number": "string"
}

partner_user.removed-v1

	Name	Type
required	partner_user_id	`integer`
required	partner_user_number	`string`
required	partner_user_email	`string`
required	partner_organisation_number	`string`

Event Type	Payload Version
partner_user.removed	v1

{
  "partner_user_id": "integer",
  "partner_user_number": "string",
  "partner_user_email": "string",
  "partner_organisation_number": "string"
}

partner_user.updated-v1

	Name	Type
required	partner_user_id	`integer`
required	partner_user_number	`string`
required	partner_user_email	`string`
required	partner_organisation_number	`string`
required	changes	`object`

Event Type	Payload Version
partner_user.updated	v1

{
  "partner_user_id": "integer",
  "partner_user_number": "string",
  "partner_user_email": "string",
  "partner_organisation_number": "string",
  "changes": "object"
}

partner_user_access.granted-v1

	Name	Type
required	allocation_id	`integer`
required	target_reference	`string`
required	target_type	`string`
required	role_id	`integer`
required	start_at	`string`
required	end_at	`string`
required	partner_user_reference	`string`

Event Type	Payload Version
partner_user_access.granted	v1

{
  "allocation_id": "integer",
  "target_reference": "string",
  "target_type": "string",
  "role_id": "integer",
  "start_at": "string",
  "end_at": "string",
  "partner_user_reference": "string"
}

partner_user_access.revoked-v1

	Name	Type
required	allocation_id	`integer`
required	target_reference	`string`
required	target_type	`string`
required	role_id	`integer`
required	start_at	`string`
required	end_at	`string`
required	partner_user_reference	`string`

Event Type	Payload Version
partner_user_access.revoked	v1

{
  "allocation_id": "integer",
  "target_reference": "string",
  "target_type": "string",
  "role_id": "integer",
  "start_at": "string",
  "end_at": "string",
  "partner_user_reference": "string"
}

payment-group.actioned-v1

	Name	Type
required	id	`integer`
required	group_reference	`string`
required	actioned_at	`string`

Event Type	Payload Version
payment-group.actioned	v1

{
  "id": "integer",
  "group_reference": "string",
  "actioned_at": "string"
}

payment-group.closed-v1

	Name	Type
required	id	`integer`
required	group_reference	`string`
required	potential_value	`integer`
required	closed_at	`string`

Event Type	Payload Version
payment-group.closed	v1

{
  "id": "integer",
  "group_reference": "string",
  "potential_value": "integer",
  "closed_at": "string"
}

payment-group.completed-v1

	Name	Type
required	id	`integer`
required	group_reference	`string`
required	potential_value	`integer`
required	cleared_value	`integer`
required	failed_value	`integer`
required	completed_at	`string`

Event Type	Payload Version
payment-group.completed	v1

{
  "id": "integer",
  "group_reference": "string",
  "potential_value": "integer",
  "cleared_value": "integer",
  "failed_value": "integer",
  "completed_at": "string"
}

payment.cleared-v1

	Name	Type
required	id	`integer`
required	amount	`integer`
required	ledger	cashflow-_payments-Ledger
required	payment_reason	`string`
required	payment_type	`string`

Event Type	Payload Version
payment.cleared	v1

{
  "id": "integer",
  "amount": "integer",
  "ledger": {
    "account": {
      "number": "string"
    },
    "id": "string"
  },
  "payment_reason": "string",
  "payment_type": "string"
}

payment.failed-v1

	Name	Type
required	id	`integer`
required	amount	`integer`
required	ledger	cashflow-_payments-Ledger
required	failure_reason	`string`
required	description	`string`
required	payment_date	`string`

Event Type	Payload Version
payment.failed	v1

{
  "id": "integer",
  "amount": "integer",
  "ledger": {
    "account": {
      "number": "string"
    },
    "id": "string"
  },
  "failure_reason": "string",
  "description": "string",
  "payment_date": "string"
}

payment.failed_late-v1

	Name	Type
required	id	`integer`
required	amount	`integer`
required	ledger	cashflow-_payments-Ledger
required	failure_reason	`string`
required	description	`string`
required	payment_date	`string`

Event Type	Payload Version
payment.failed_late	v1

{
  "id": "integer",
  "amount": "integer",
  "ledger": {
    "account": {
      "number": "string"
    },
    "id": "string"
  },
  "failure_reason": "string",
  "description": "string",
  "payment_date": "string"
}

payment.pending-v1

	Name	Type
required	id	`integer`
required	amount	`integer`
required	ledger	cashflow-_payments-Ledger

Event Type	Payload Version
payment.pending	v1

{
  "id": "integer",
  "amount": "integer",
  "ledger": {
    "account": {
      "number": "string"
    },
    "id": "string"
  }
}

payment.re_presented-v1

	Name	Type
required	failed_payment	cashflow-_payments-Payment
required	new_payment	cashflow-_payments-Payment
required	ledger	cashflow-_payments-Ledger

Event Type	Payload Version
payment.re_presented	v1

{
  "failed_payment": {
    "id": "integer",
    "amount": "integer",
    "payment_date": "string",
    "description": "string",
    "failure_reason": "string"
  },
  "new_payment": {
    "id": "integer",
    "amount": "integer",
    "payment_date": "string",
    "description": "string",
    "failure_reason": "string"
  },
  "ledger": {
    "account": {
      "number": "string"
    },
    "id": "string"
  }
}

payment.scheduled-v1

	Name	Type
required	id	`integer`
required	amount	`integer`
required	ledger	cashflow-_payments-Ledger

Event Type	Payload Version
payment.scheduled	v1

{
  "id": "integer",
  "amount": "integer",
  "ledger": {
    "account": {
      "number": "string"
    },
    "id": "string"
  }
}

payment_obligation.overdue-v1

	Name	Type
required	account_number	`string`
required	supplementary_ledger_id	`integer`
required	supplementary_ledger_number	`string`
required	amount	`integer`
required	amount_outstanding	`integer`
required	payment_obligation_id	`integer`
required	due_date	`string`

Event Type	Payload Version
payment_obligation.overdue	v1

{
  "account_number": "string",
  "supplementary_ledger_id": "integer",
  "supplementary_ledger_number": "string",
  "amount": "integer",
  "amount_outstanding": "integer",
  "payment_obligation_id": "integer",
  "due_date": "string"
}

payment_plan.status_changed-v1

	Name	Type
required	account_number	`string`
required	payment_plan_id	`integer`
required	old_status	`string`
required	new_status	`string`

Event Type	Payload Version
payment_plan.status_changed	v1

{
  "account_number": "string",
  "payment_plan_id": "integer",
  "old_status": "string",
  "new_status": "string"
}

payment_promise.broken-v1

	Name	Type
required	account_number	`string`
required	account_payment_id	`integer`

Event Type	Payload Version
payment_promise.broken	v1

{
  "account_number": "string",
  "account_payment_id": "integer"
}

payment_promise.created-v1

	Name	Type
required	account_number	`string`
required	account_payment_id	`integer`
required	amount	`integer`

Event Type	Payload Version
payment_promise.created	v1

{
  "account_number": "string",
  "account_payment_id": "integer",
  "amount": "integer"
}

payments-repayments-Account

	Name	Type
required	number	`string`

{
  "number": "string"
}

payments-repayments-Agent

	Name	Type
required	actor_type	`string`
required	id	`string`

{
  "actor_type": "string",
  "id": "string"
}

payments-repayments-Ledger

	Name	Type
	id	`string`
required	account	payments-repayments-Account

{
  "id": "string",
  "account": {
    "number": "string"
  }
}

payments-repayments-Payment

	Name	Type
required	id	`integer`
required	amount	`integer`
required	payment_date	`string`

{
  "id": "integer",
  "amount": "integer",
  "payment_date": "string"
}

payments.payment-preferences.manual-payments-activated-v1

	Name	Type
required	ledger_numbers	`array[string]`
required	from_datetime	`string`

Event Type	Payload Version
payments.payment-preferences.manual-payments-activated	v1

{
  "ledger_numbers": [
    "string"
  ],
  "from_datetime": "string"
}

payments.payment-preferences.preferred-method-set-for-automatic-payments-v1

	Name	Type
required	ledger_numbers	`array[string]`
required	from_datetime	`string`
required	payment_method_id	`string`

Event Type	Payload Version
payments.payment-preferences.preferred-method-set-for-automatic-payments	v1

{
  "ledger_numbers": [
    "string"
  ],
  "from_datetime": "string",
  "payment_method_id": "string"
}

payments.payment-schedule-preference-mismatch-detected-v1

	Name	Type
required	account_number	`string`
required	ledger_number	`string`
required	schedule_id	`integer`
required	schedule_type	`string`
required	payment_preference	`string`

Event Type	Payload Version
payments.payment-schedule-preference-mismatch-detected	v1

{
  "account_number": "string",
  "ledger_number": "string",
  "schedule_id": "integer",
  "schedule_type": "string",
  "payment_preference": "string"
}

payments.payment_adequacy.review_wont_be_applied-v1

	Name	Type
required	account_number	`string`
required	ledger_number	`string`
required	reason	`string`

Event Type	Payload Version
payments.payment_adequacy.review_wont_be_applied	v1

{
  "account_number": "string",
  "ledger_number": "string",
  "reason": "string"
}

payments.payment_method.account_user_matching.failed-v1

	Name	Type
required	instruction_id	`string`

Event Type	Payload Version
payments.payment_method.account_user_matching.failed	v1

{
  "instruction_id": "string"
}

payments.payment_method.new-v1

	Name	Type
required	account_number	`string`
required	ledger_identifier	`string`
required	usable_from	`string`
required	payment_instruction_id	`string`
required	usable_to	`string`

Event Type	Payload Version
payments.payment_method.new	v1

{
  "account_number": "string",
  "ledger_identifier": "string",
  "usable_from": "string",
  "payment_instruction_id": "string",
  "usable_to": "string"
}

payments.payment_method.removed-v1

	Name	Type
required	account_number	`string`
required	ledger_identifier	`string`
required	usable_from	`string`
required	payment_instruction_id	`string`
required	usable_to	`string`

Event Type	Payload Version
payments.payment_method.removed	v1

{
  "account_number": "string",
  "ledger_identifier": "string",
  "usable_from": "string",
  "payment_instruction_id": "string",
  "usable_to": "string"
}

payments.payment_schedule.new-v1

	Name	Type
required	account_number	`string`
required	ledger_identifier	`string`
required	payment_schedule_id	`string`
required	payment_schedule_type	`string`
required	usable_from	`string`
required	usable_to	`string`
required	is_variable_payment_amount	`boolean`

Event Type	Payload Version
payments.payment_schedule.new	v1

{
  "account_number": "string",
  "ledger_identifier": "string",
  "payment_schedule_id": "string",
  "payment_schedule_type": "string",
  "usable_from": "string",
  "usable_to": "string",
  "is_variable_payment_amount": "boolean"
}

payments.payment_schedule.removed-v1

	Name	Type
required	account_number	`string`
required	ledger_identifier	`string`
required	payment_schedule_id	`string`
required	preceding_schedule_id	`string`
required	payment_frequency	`string`
required	payment_frequency_multiplier	`integer`
required	valid_from	`string`
required	is_variable_payment_amount	`boolean`
required	is_exempt_from_payment_adequacy	`boolean`

Event Type	Payload Version
payments.payment_schedule.removed	v1

{
  "account_number": "string",
  "ledger_identifier": "string",
  "payment_schedule_id": "string",
  "preceding_schedule_id": "string",
  "payment_frequency": "string",
  "payment_frequency_multiplier": "integer",
  "valid_from": "string",
  "is_variable_payment_amount": "boolean",
  "is_exempt_from_payment_adequacy": "boolean"
}

payments.payment_schedule.updated-v1

	Name	Type
required	account_number	`string`
required	ledger_identifier	`string`
required	payment_schedule_id	`string`
required	changes	`object`

Event Type	Payload Version
payments.payment_schedule.updated	v1

{
  "account_number": "string",
  "ledger_identifier": "string",
  "payment_schedule_id": "string",
  "changes": "object"
}

pending_nmi_status_update.record.cancelled-v1

	Name	Type
required	nmi	`string`
required	nmi_status	`string`
required	property_id	`integer`
required	from_date	`string`
required	to_date	`string`

Event Type	Payload Version
pending_nmi_status_update.record.cancelled	v1

{
  "nmi": "string",
  "nmi_status": "string",
  "property_id": "integer",
  "from_date": "string",
  "to_date": "string"
}

pending_nmi_status_update.record.created-v1

	Name	Type
required	nmi	`string`
required	nmi_status	`string`
required	property_id	`integer`
required	from_date	`string`
required	to_date	`string`

Event Type	Payload Version
pending_nmi_status_update.record.created	v1

{
  "nmi": "string",
  "nmi_status": "string",
  "property_id": "integer",
  "from_date": "string",
  "to_date": "string"
}

pending_nmi_status_update.record.rejected-v1

	Name	Type
required	nmi	`string`
required	nmi_status	`string`
required	property_id	`integer`
required	from_date	`string`
required	to_date	`string`

Event Type	Payload Version
pending_nmi_status_update.record.rejected	v1

{
  "nmi": "string",
  "nmi_status": "string",
  "property_id": "integer",
  "from_date": "string",
  "to_date": "string"
}

personal-issues.created-v1

	Name	Type
required	category	`string`
required	subcategory	`string`
required	description	`string`
required	created_by_support_user	`string`
	content	`object`
required	account_number	`string`
required	account_id	`integer`
required	account_user_id	`integer`

Event Type	Payload Version
personal-issues.created	v1

{
  "category": "string",
  "subcategory": "string",
  "description": "string",
  "created_by_support_user": "string",
  "content": "object",
  "account_number": "string",
  "account_id": "integer",
  "account_user_id": "integer"
}

personal-issues.removed-v1

	Name	Type
required	category	`string`
required	subcategory	`string`
required	description	`string`
required	created_by_support_user	`string`
	content	`object`
required	account_number	`string`
required	account_id	`integer`
required	account_user_id	`integer`

Event Type	Payload Version
personal-issues.removed	v1

{
  "category": "string",
  "subcategory": "string",
  "description": "string",
  "created_by_support_user": "string",
  "content": "object",
  "account_number": "string",
  "account_id": "integer",
  "account_user_id": "integer"
}

personal-issues.updated-v1

	Name	Type
required	category	`string`
required	subcategory	`string`
required	description	`string`
required	created_by_support_user	`string`
	content	`object`
required	account_number	`string`
required	account_id	`integer`
required	account_user_id	`integer`

Event Type	Payload Version
personal-issues.updated	v1

{
  "category": "string",
  "subcategory": "string",
  "description": "string",
  "created_by_support_user": "string",
  "content": "object",
  "account_number": "string",
  "account_id": "integer",
  "account_user_id": "integer"
}

product-switch.completed-v1

	Name	Type
required	account_number	`string`
required	supply_point_id	`integer`
required	previous_agreement_id	`integer`
required	new_agreement_id	`integer`
required	new_product	market_supply-products-Product

Event Type	Payload Version
product-switch.completed	v1

{
  "account_number": "string",
  "supply_point_id": "integer",
  "previous_agreement_id": "integer",
  "new_agreement_id": "integer",
  "new_product": {
    "code": "string",
    "market_name": "string",
    "brand_code": "string"
  }
}

product-switch.initiated-v1

	Name	Type
required	product_switch_process_id	`integer`

Event Type	Payload Version
product-switch.initiated	v1

{
  "product_switch_process_id": "integer"
}

property.move-in.cancelled-v1

	Name	Type
required	account	accounts-house_move-Account
required	property_id	`integer`

Event Type	Payload Version
property.move-in.cancelled	v1

{
  "account": {
    "number": "string",
    "external_reference": "string"
  },
  "property_id": "integer"
}

property.move-in.date-updated-v1

	Name	Type
required	account	accounts-house_move-Account
required	property_id	`integer`
required	updated_move_in_date	`string`

Event Type	Payload Version
property.move-in.date-updated	v1

{
  "account": {
    "number": "string",
    "external_reference": "string"
  },
  "property_id": "integer",
  "updated_move_in_date": "string"
}

property.move-in.market-supply.requested-v1

	Name	Type
required	account	accounts-house_move-Account
required	property_id	`integer`
required	supply_point_ids	`array[integer]`
required	move_in_date	`string`
required	has_structured_billing_address	`boolean`

Event Type	Payload Version
property.move-in.market-supply.requested	v1

{
  "account": {
    "number": "string",
    "external_reference": "string"
  },
  "property_id": "integer",
  "supply_point_ids": [
    "integer"
  ],
  "move_in_date": "string",
  "has_structured_billing_address": "boolean"
}

property.move-in.requested-v1

	Name	Type
required	account	accounts-house_move-Account
required	property_id	`integer`
required	supply_points	array[accounts-house_move-SupplyPoint]
required	move_in_date	`string`

Event Type	Payload Version
property.move-in.requested	v1

{
  "account": {
    "number": "string",
    "external_reference": "string"
  },
  "property_id": "integer",
  "supply_points": [
    {
      "id": "string",
      "industry": "string",
      "tariff_code": "string",
      "tariff_payment_method": "string"
    }
  ],
  "move_in_date": "string"
}

property.move-in.requested-v2

	Name	Type
required	account	accounts-house_move-Account
required	property_ids	`array[integer]`
required	supply_points	array[accounts-house_move-SupplyPoint]
required	move_in_date	`string`

Event Type	Payload Version
property.move-in.requested	v2

{
  "account": {
    "number": "string",
    "external_reference": "string"
  },
  "property_ids": [
    "integer"
  ],
  "supply_points": [
    {
      "id": "string",
      "industry": "string",
      "tariff_code": "string",
      "tariff_payment_method": "string"
    }
  ],
  "move_in_date": "string"
}

property.move-out.cancelled-v1

	Name	Type
required	account	accounts-house_move-Account
required	property_id	`integer`
required	supply_points	array[accounts-house_move-SupplyPoint]
required	cancelled_move_out_date	`string`

Event Type	Payload Version
property.move-out.cancelled	v1

{
  "account": {
    "number": "string",
    "external_reference": "string"
  },
  "property_id": "integer",
  "supply_points": [
    {
      "id": "string",
      "industry": "string",
      "tariff_code": "string",
      "tariff_payment_method": "string"
    }
  ],
  "cancelled_move_out_date": "string"
}

property.move-out.date-updated-v1

	Name	Type
required	account	accounts-house_move-Account
required	property_id	`integer`
required	supply_points	array[accounts-house_move-SupplyPoint]
required	updated_move_out_date	`string`

Event Type	Payload Version
property.move-out.date-updated	v1

{
  "account": {
    "number": "string",
    "external_reference": "string"
  },
  "property_id": "integer",
  "supply_points": [
    {
      "id": "string",
      "industry": "string",
      "tariff_code": "string",
      "tariff_payment_method": "string"
    }
  ],
  "updated_move_out_date": "string"
}

property.move-out.requested-v1

	Name	Type
required	account	accounts-house_move-Account
required	property_id	`integer`
required	supply_points	array[accounts-house_move-SupplyPoint]
required	move_out_date	`string`

Event Type	Payload Version
property.move-out.requested	v1

{
  "account": {
    "number": "string",
    "external_reference": "string"
  },
  "property_id": "integer",
  "supply_points": [
    {
      "id": "string",
      "industry": "string",
      "tariff_code": "string",
      "tariff_payment_method": "string"
    }
  ],
  "move_out_date": "string"
}

property.retrospective-move-out.completed-v1

	Name	Type
required	account	accounts-house_move-Account
required	supply_point_id	`integer`
required	move_out_date	`string`

Event Type	Payload Version
property.retrospective-move-out.completed	v1

{
  "account": {
    "number": "string",
    "external_reference": "string"
  },
  "supply_point_id": "integer",
  "move_out_date": "string"
}

property.updated-v1

	Name	Type
required	property_id	`integer`
required	account_number	`string`
required	changes	`object`

Event Type	Payload Version
property.updated	v1

{
  "property_id": "integer",
  "account_number": "string",
  "changes": "object"
}

property_metadata.created-v1

	Name	Type
required	property_id	`integer`
required	key	`string`
required	value	`string`

Event Type	Payload Version
property_metadata.created	v1

{
  "property_id": "integer",
  "key": "string",
  "value": "string"
}

property_metadata.removed-v1

	Name	Type
required	property_id	`integer`
required	key	`string`
required	value	`string`

Event Type	Payload Version
property_metadata.removed	v1

{
  "property_id": "integer",
  "key": "string",
  "value": "string"
}

property_metadata.updated-v1

	Name	Type
required	property_id	`integer`
required	changes	`object`

Event Type	Payload Version
property_metadata.updated	v1

{
  "property_id": "integer",
  "changes": "object"
}

quoting.rates-requested-v1

	Name	Type
required	quote_configurations	`array[string]`

Event Type	Payload Version
quoting.rates-requested	v1

{
  "quote_configurations": [
    "string"
  ]
}

referrals.referral-created-v1

	Name	Type
required	referred_account_number	`string`
required	referring_account_number	`string`
required	referral_id	`integer`
required	referral_scheme_code	`string`

Event Type	Payload Version
referrals.referral-created	v1

{
  "referred_account_number": "string",
  "referring_account_number": "string",
  "referral_id": "integer",
  "referral_scheme_code": "string"
}

referrals.referral-paid-v1

	Name	Type
required	account_number	`string`
required	referral_id	`integer`
required	referral_scheme_code	`string`
required	is_referring_account	`boolean`

Event Type	Payload Version
referrals.referral-paid	v1

{
  "account_number": "string",
  "referral_id": "integer",
  "referral_scheme_code": "string",
  "is_referring_account": "boolean"
}

referrals.reward-created-v1

	Name	Type
required	referred_account_number	`string`
required	referral_id	`integer`
required	referral_scheme_code	`string`

Event Type	Payload Version
referrals.reward-created	v1

{
  "referred_account_number": "string",
  "referral_id": "integer",
  "referral_scheme_code": "string"
}

refund.requested-v1

	Name	Type
required	id	`integer`
required	amount	`integer`
required	ledger	payments-repayments-Ledger
required	reason	`string`
required	payment	payments-repayments-Payment
required	requested_by	payments-repayments-Agent

Event Type	Payload Version
refund.requested	v1

{
  "id": "integer",
  "amount": "integer",
  "ledger": {
    "id": "string",
    "account": {
      "number": "string"
    }
  },
  "reason": "string",
  "payment": {
    "id": "integer",
    "amount": "integer",
    "payment_date": "string"
  },
  "requested_by": {
    "actor_type": "string",
    "id": "string"
  }
}

reminder.cancelled-v1

	Name	Type
required	reminder_id	`integer`
required	account_number	`string`
required	reminder_type	`string`
required	reminder_params	`object`

Event Type	Payload Version
reminder.cancelled	v1

{
  "reminder_id": "integer",
  "account_number": "string",
  "reminder_type": "string",
  "reminder_params": "object"
}

reminder.cancelled-v2

	Name	Type
required	reminder_id	`integer`
required	account_number	`string`
required	reminder_type	`string`
required	reminder_params	`object`

Event Type	Payload Version
reminder.cancelled	v2

{
  "reminder_id": "integer",
  "account_number": "string",
  "reminder_type": "string",
  "reminder_params": "object"
}

reminder.completed-v1

	Name	Type
required	reminder_id	`integer`
required	account_number	`string`
required	reminder_type	`string`
required	reminder_params	`object`

Event Type	Payload Version
reminder.completed	v1

{
  "reminder_id": "integer",
  "account_number": "string",
  "reminder_type": "string",
  "reminder_params": "object"
}

reminder.completed-v2

	Name	Type
required	reminder_id	`integer`
required	account_number	`string`
required	reminder_type	`string`
required	reminder_params	`object`

Event Type	Payload Version
reminder.completed	v2

{
  "reminder_id": "integer",
  "account_number": "string",
  "reminder_type": "string",
  "reminder_params": "object"
}

repayment-group.actioned-v1

	Name	Type
required	id	`integer`
required	group_reference	`string`
required	actioned_at	`string`

Event Type	Payload Version
repayment-group.actioned	v1

{
  "id": "integer",
  "group_reference": "string",
  "actioned_at": "string"
}

repayment-group.closed-v1

	Name	Type
required	id	`integer`
required	group_reference	`string`
required	closed_at	`string`

Event Type	Payload Version
repayment-group.closed	v1

{
  "id": "integer",
  "group_reference": "string",
  "closed_at": "string"
}

repayment-group.completed-v1

	Name	Type
required	id	`integer`
required	group_reference	`string`
required	completed_at	`string`

Event Type	Payload Version
repayment-group.completed	v1

{
  "id": "integer",
  "group_reference": "string",
  "completed_at": "string"
}

repayment.approved-v1

	Name	Type
required	id	`integer`
required	amount	`integer`
required	ledger	payments-repayments-Ledger
required	approved_by	payments-repayments-Agent
required	note	`string`

Event Type	Payload Version
repayment.approved	v1

{
  "id": "integer",
  "amount": "integer",
  "ledger": {
    "id": "string",
    "account": {
      "number": "string"
    }
  },
  "approved_by": {
    "actor_type": "string",
    "id": "string"
  },
  "note": "string"
}

repayment.failed-v1

	Name	Type
required	id	`integer`
required	amount	`integer`
required	ledger	payments-repayments-Ledger
required	failure_reason	`string`

Event Type	Payload Version
repayment.failed	v1

{
  "id": "integer",
  "amount": "integer",
  "ledger": {
    "id": "string",
    "account": {
      "number": "string"
    }
  },
  "failure_reason": "string"
}

repayment.failed-v2

	Name	Type
required	id	`integer`
required	amount	`integer`
required	ledger	payments-repayments-Ledger
required	failure_reason	`string`
required	note	`string`

Event Type	Payload Version
repayment.failed	v2

{
  "id": "integer",
  "amount": "integer",
  "ledger": {
    "id": "string",
    "account": {
      "number": "string"
    }
  },
  "failure_reason": "string",
  "note": "string"
}

repayment.failed_late-v1

	Name	Type
required	id	`integer`
required	amount	`integer`
required	ledger	payments-repayments-Ledger
required	note	`string`
required	failure_reason	`string`

Event Type	Payload Version
repayment.failed_late	v1

{
  "id": "integer",
  "amount": "integer",
  "ledger": {
    "id": "string",
    "account": {
      "number": "string"
    }
  },
  "note": "string",
  "failure_reason": "string"
}

repayment.paid-v1

	Name	Type
required	id	`integer`
required	amount	`integer`
required	ledger	payments-repayments-Ledger
required	marked_by	payments-repayments-Agent
required	note	`string`

Event Type	Payload Version
repayment.paid	v1

{
  "id": "integer",
  "amount": "integer",
  "ledger": {
    "id": "string",
    "account": {
      "number": "string"
    }
  },
  "marked_by": {
    "actor_type": "string",
    "id": "string"
  },
  "note": "string"
}

repayment.requested-v1

	Name	Type
required	id	`integer`
required	amount	`integer`
required	ledger	payments-repayments-Ledger
required	reason	`string`
required	requested_by	payments-repayments-Agent

Event Type	Payload Version
repayment.requested	v1

{
  "id": "integer",
  "amount": "integer",
  "ledger": {
    "id": "string",
    "account": {
      "number": "string"
    }
  },
  "reason": "string",
  "requested_by": {
    "actor_type": "string",
    "id": "string"
  }
}

repayment.submitted-v1

	Name	Type
required	id	`integer`
required	amount	`integer`
required	ledger	payments-repayments-Ledger
required	submitted_by	payments-repayments-Agent
required	note	`string`

Event Type	Payload Version
repayment.submitted	v1

{
  "id": "integer",
  "amount": "integer",
  "ledger": {
    "id": "string",
    "account": {
      "number": "string"
    }
  },
  "submitted_by": {
    "actor_type": "string",
    "id": "string"
  },
  "note": "string"
}

risk_assessment_completed-v1

	Name	Type
	account_number	`string`
required	risk_assessment_id	`string`
required	assessment_risk	`string`
	run_event	`string`
required	risk_identified_assessors	`array[string]`
required	risk_absent_assessors	`array[string]`
required	risk_indeterminate_assessors	`array[string]`
required	risk_non_applicable_assessors	`array[string]`

Event Type	Payload Version
risk_assessment_completed	v1

{
  "account_number": "string",
  "risk_assessment_id": "string",
  "assessment_risk": "string",
  "run_event": "string",
  "risk_identified_assessors": [
    "string"
  ],
  "risk_absent_assessors": [
    "string"
  ],
  "risk_indeterminate_assessors": [
    "string"
  ],
  "risk_non_applicable_assessors": [
    "string"
  ]
}

risk_assessment_started-v1

	Name	Type
	account_number	`string`
required	risk_assessment_id	`string`
	run_event	`string`

Event Type	Payload Version
risk_assessment_started	v1

{
  "account_number": "string",
  "risk_assessment_id": "string",
  "run_event": "string"
}

security.account_user.denied_access-v1

	Name	Type
required	account_user_id	`integer`
required	account_user_number	`string`
required	delegates_logged_out	`boolean`

Event Type	Payload Version
security.account_user.denied_access	v1

{
  "account_user_id": "integer",
  "account_user_number": "string",
  "delegates_logged_out": "boolean"
}

security.account_user.forcibly_logged_out-v1

	Name	Type
required	account_user_id	`integer`
required	account_user_number	`string`
required	delegates_logged_out	`boolean`

Event Type	Payload Version
security.account_user.forcibly_logged_out	v1

{
  "account_user_id": "integer",
  "account_user_number": "string",
  "delegates_logged_out": "boolean"
}

service-order.link-requested-v1

	Name	Type
required	service_order_id	`integer`
required	work_request_id	`string`
required	created_at	`string`

Event Type	Payload Version
service-order.link-requested	v1

{
  "service_order_id": "integer",
  "work_request_id": "string",
  "created_at": "string"
}

supply-point.gain.completed-v1

	Name	Type
required	market	`string`
required	market_identifier	`string`
required	market_identifier_name	`string`
required	account_number	`string`
required	supply_start_at	`string`

Event Type	Payload Version
supply-point.gain.completed	v1

{
  "market": "string",
  "market_identifier": "string",
  "market_identifier_name": "string",
  "account_number": "string",
  "supply_start_at": "string"
}

supply-point.termination.completed-v1

	Name	Type
required	market	`string`
required	market_identifier	`string`
required	market_identifier_name	`string`
required	account_number	`string`
required	supply_end_at	`string`

Event Type	Payload Version
supply-point.termination.completed	v1

{
  "market": "string",
  "market_identifier": "string",
  "market_identifier_name": "string",
  "account_number": "string",
  "supply_end_at": "string"
}

supplypoint.gbr_electricity.gain.meter-details-received-v1

	Name	Type
required	mpan	`string`
required	mtd_effective_from	`string`
required	measurement_class	`string`
required	is_energised	`boolean`
required	standard_settlement_configuration	`string`
required	ssc_effective_from	`string`
required	non_settlement_function_code	`string`
required	nsfc_effective_from	`string`
required	meters	array[meter_points-meter_details-Meter]
required	removed_meters	array[meter_points-meter_details-RemovedMeter]

Event Type	Payload Version
supplypoint.gbr_electricity.gain.meter-details-received	v1

{
  "mpan": "string",
  "mtd_effective_from": "string",
  "measurement_class": "string",
  "is_energised": "boolean",
  "standard_settlement_configuration": "string",
  "ssc_effective_from": "string",
  "non_settlement_function_code": "string",
  "nsfc_effective_from": "string",
  "meters": [
    {
      "serial_number": "string",
      "current_rating": "integer",
      "location": "string",
      "make_and_type": "string",
      "meter_asset_provider_mpid": "string",
      "meter_type": "string",
      "retrieval_method": "string",
      "retrieval_method_effective_from": "string",
      "meter_cop": "string",
      "meter_cop_dispensation": "string",
      "communications_address": "string",
      "communications_method": "string",
      "vt_ratio": "string",
      "installation_date": "string",
      "timing_device_id": "string",
      "is_tele_switch": "boolean",
      "ct_ratio": "string",
      "registers": [
        {
          "register_id": "string",
          "register_type": "string",
          "measurement_quantity": "string",
          "multiplier": "string",
          "digits": "integer",
          "is_main": "boolean",
          "associated_meter_serial": "string",
          "associated_register_id": "string"
        }
      ]
    }
  ],
  "removed_meters": [
    {
      "serial_number": "string",
      "date_of_removal": "string",
      "meter_asset_provider_mpid": "string"
    }
  ]
}

tech.kraken.flow.aus_electricity.ci_prechecks.progress.v1-v1

	Name	Type
required	transition_id	`integer`
required	nmi	`string`
required	step_id	`string`
required	step_status	`string`
	details	`string`

Event Type	Payload Version
tech.kraken.flow.aus_electricity.ci_prechecks.progress.v1	v1

{
  "transition_id": "integer",
  "nmi": "string",
  "step_id": "string",
  "step_status": "string",
  "details": "string"
}

tech.kraken.flow.aus_electricity.request_change_metering_coordinator.v1-v1

	Name	Type
required	account_number	`string`
required	nmi	`string`
required	transition_id	`integer`
required	transaction_purpose	`string`
required	mc_id	`string`
	proposed_date	`string`
	change_reason_code	`string`
	jurisdiction_code	`string`
	nmi_classification_code	`string`

Event Type	Payload Version
tech.kraken.flow.aus_electricity.request_change_metering_coordinator.v1	v1

{
  "account_number": "string",
  "nmi": "string",
  "transition_id": "integer",
  "transaction_purpose": "string",
  "mc_id": "string",
  "proposed_date": "string",
  "change_reason_code": "string",
  "jurisdiction_code": "string",
  "nmi_classification_code": "string"
}

tech.kraken.flow.aus_electricity.request_meter_exchange_service_order.v1-v1

	Name	Type
required	account_number	`string`
required	nmi	`string`
required	transition_id	`integer`
required	transaction_purpose	`string`
required	scheduled_date	`string`
required	mpb_id	`string`
	access_details	`string`
	hazards	`array[string]`
	special_instructions	`string`
	customer_consultation_required	`boolean`
	appointment_reference	`string`
	appointment_preferred_date	`string`
	appointment_preferred_time	`string`

Event Type	Payload Version
tech.kraken.flow.aus_electricity.request_meter_exchange_service_order.v1	v1

{
  "account_number": "string",
  "nmi": "string",
  "transition_id": "integer",
  "transaction_purpose": "string",
  "scheduled_date": "string",
  "mpb_id": "string",
  "access_details": "string",
  "hazards": [
    "string"
  ],
  "special_instructions": "string",
  "customer_consultation_required": "boolean",
  "appointment_reference": "string",
  "appointment_preferred_date": "string",
  "appointment_preferred_time": "string"
}

tech.kraken.workflow.cancelled.v1-v1

	Name	Type
required	workflow_id	`integer`
required	workflow_name	`string`
required	previous_status	`string`
required	reason	`string`
required	direction	`string`

Event Type	Payload Version
tech.kraken.workflow.cancelled.v1	v1

{
  "workflow_id": "integer",
  "workflow_name": "string",
  "previous_status": "string",
  "reason": "string",
  "direction": "string"
}

tech.kraken.workflow.completed.v1-v1

	Name	Type
required	workflow_id	`integer`
required	workflow_name	`string`
required	previous_status	`string`
required	reason	`string`
required	direction	`string`

Event Type	Payload Version
tech.kraken.workflow.completed.v1	v1

{
  "workflow_id": "integer",
  "workflow_name": "string",
  "previous_status": "string",
  "reason": "string",
  "direction": "string"
}

tech.kraken.workflow.created.v1-v1

	Name	Type
required	workflow_id	`integer`
required	workflow_name	`string`
required	previous_status	`string`
required	reason	`string`
required	direction	`string`

Event Type	Payload Version
tech.kraken.workflow.created.v1	v1

{
  "workflow_id": "integer",
  "workflow_name": "string",
  "previous_status": "string",
  "reason": "string",
  "direction": "string"
}

tech.kraken.workflow.errored.v1-v1

	Name	Type
required	workflow_id	`integer`
required	workflow_name	`string`
required	previous_status	`string`
required	reason	`string`
required	direction	`string`

Event Type	Payload Version
tech.kraken.workflow.errored.v1	v1

{
  "workflow_id": "integer",
  "workflow_name": "string",
  "previous_status": "string",
  "reason": "string",
  "direction": "string"
}

tech.kraken.workflow.failed.v1-v1

	Name	Type
required	workflow_id	`integer`
required	workflow_name	`string`
required	previous_status	`string`
required	reason	`string`
required	direction	`string`

Event Type	Payload Version
tech.kraken.workflow.failed.v1	v1

{
  "workflow_id": "integer",
  "workflow_name": "string",
  "previous_status": "string",
  "reason": "string",
  "direction": "string"
}

tech.kraken.workflow.skipped.v1-v1

	Name	Type
required	workflow_id	`integer`
required	workflow_name	`string`
required	previous_status	`string`
required	reason	`string`
required	direction	`string`

Event Type	Payload Version
tech.kraken.workflow.skipped.v1	v1

{
  "workflow_id": "integer",
  "workflow_name": "string",
  "previous_status": "string",
  "reason": "string",
  "direction": "string"
}

tech.kraken.workflow.stalled.v1-v1

	Name	Type
required	workflow_id	`integer`
required	workflow_name	`string`
required	previous_status	`string`
required	reason	`string`
required	direction	`string`

Event Type	Payload Version
tech.kraken.workflow.stalled.v1	v1

{
  "workflow_id": "integer",
  "workflow_name": "string",
  "previous_status": "string",
  "reason": "string",
  "direction": "string"
}

tech.kraken.workflow.started.v1-v1

	Name	Type
required	workflow_id	`integer`
required	workflow_name	`string`
required	previous_status	`string`
required	reason	`string`
required	direction	`string`

Event Type	Payload Version
tech.kraken.workflow.started.v1	v1

{
  "workflow_id": "integer",
  "workflow_name": "string",
  "previous_status": "string",
  "reason": "string",
  "direction": "string"
}

tech.kraken.workflow.step.cancelled.v1-v1

	Name	Type
required	workflow_id	`integer`
required	workflow_name	`string`
required	step_id	`integer`
required	step_name	`string`
required	step_slug	`string`
required	previous_status	`string`
required	reason	`string`
required	direction	`string`

Event Type	Payload Version
tech.kraken.workflow.step.cancelled.v1	v1

{
  "workflow_id": "integer",
  "workflow_name": "string",
  "step_id": "integer",
  "step_name": "string",
  "step_slug": "string",
  "previous_status": "string",
  "reason": "string",
  "direction": "string"
}

tech.kraken.workflow.step.completed.v1-v1

	Name	Type
required	workflow_id	`integer`
required	workflow_name	`string`
required	step_id	`integer`
required	step_name	`string`
required	step_slug	`string`
required	previous_status	`string`
required	reason	`string`
required	direction	`string`

Event Type	Payload Version
tech.kraken.workflow.step.completed.v1	v1

{
  "workflow_id": "integer",
  "workflow_name": "string",
  "step_id": "integer",
  "step_name": "string",
  "step_slug": "string",
  "previous_status": "string",
  "reason": "string",
  "direction": "string"
}

tech.kraken.workflow.step.created.v1-v1

	Name	Type
required	workflow_id	`integer`
required	workflow_name	`string`
required	step_id	`integer`
required	step_name	`string`
required	step_slug	`string`
required	previous_status	`string`
required	reason	`string`
required	direction	`string`

Event Type	Payload Version
tech.kraken.workflow.step.created.v1	v1

{
  "workflow_id": "integer",
  "workflow_name": "string",
  "step_id": "integer",
  "step_name": "string",
  "step_slug": "string",
  "previous_status": "string",
  "reason": "string",
  "direction": "string"
}

tech.kraken.workflow.step.errored.v1-v1

	Name	Type
required	workflow_id	`integer`
required	workflow_name	`string`
required	step_id	`integer`
required	step_name	`string`
required	step_slug	`string`
required	previous_status	`string`
required	reason	`string`
required	direction	`string`

Event Type	Payload Version
tech.kraken.workflow.step.errored.v1	v1

{
  "workflow_id": "integer",
  "workflow_name": "string",
  "step_id": "integer",
  "step_name": "string",
  "step_slug": "string",
  "previous_status": "string",
  "reason": "string",
  "direction": "string"
}

tech.kraken.workflow.step.failed.v1-v1

	Name	Type
required	workflow_id	`integer`
required	workflow_name	`string`
required	step_id	`integer`
required	step_name	`string`
required	step_slug	`string`
required	previous_status	`string`
required	reason	`string`
required	direction	`string`

Event Type	Payload Version
tech.kraken.workflow.step.failed.v1	v1

{
  "workflow_id": "integer",
  "workflow_name": "string",
  "step_id": "integer",
  "step_name": "string",
  "step_slug": "string",
  "previous_status": "string",
  "reason": "string",
  "direction": "string"
}

tech.kraken.workflow.step.skipped.v1-v1

	Name	Type
required	workflow_id	`integer`
required	workflow_name	`string`
required	step_id	`integer`
required	step_name	`string`
required	step_slug	`string`
required	previous_status	`string`
required	reason	`string`
required	direction	`string`

Event Type	Payload Version
tech.kraken.workflow.step.skipped.v1	v1

{
  "workflow_id": "integer",
  "workflow_name": "string",
  "step_id": "integer",
  "step_name": "string",
  "step_slug": "string",
  "previous_status": "string",
  "reason": "string",
  "direction": "string"
}

tech.kraken.workflow.step.stalled.v1-v1

	Name	Type
required	workflow_id	`integer`
required	workflow_name	`string`
required	step_id	`integer`
required	step_name	`string`
required	step_slug	`string`
required	previous_status	`string`
required	reason	`string`
required	direction	`string`

Event Type	Payload Version
tech.kraken.workflow.step.stalled.v1	v1

{
  "workflow_id": "integer",
  "workflow_name": "string",
  "step_id": "integer",
  "step_name": "string",
  "step_slug": "string",
  "previous_status": "string",
  "reason": "string",
  "direction": "string"
}

tech.kraken.workflow.step.started.v1-v1

	Name	Type
required	workflow_id	`integer`
required	workflow_name	`string`
required	step_id	`integer`
required	step_name	`string`
required	step_slug	`string`
required	previous_status	`string`
required	reason	`string`
required	direction	`string`

Event Type	Payload Version
tech.kraken.workflow.step.started.v1	v1

{
  "workflow_id": "integer",
  "workflow_name": "string",
  "step_id": "integer",
  "step_name": "string",
  "step_slug": "string",
  "previous_status": "string",
  "reason": "string",
  "direction": "string"
}

transactional-messaging.message.dispatched-v1

	Name	Type
required	trigger_type_code	`string`
required	trigger_id	`string`

Event Type	Payload Version
transactional-messaging.message.dispatched	v1

{
  "trigger_type_code": "string",
  "trigger_id": "string"
}

transactional-messaging.trigger.failed-message-processed-v1

	Name	Type
required	trigger_type_code	`string`
required	trigger_id	`string`
	message	transactional_messaging-process_trigger-_TransactionalMessage
	event	transactional_messaging-process_trigger-_MessageEvent

Event Type	Payload Version
transactional-messaging.trigger.failed-message-processed	v1

{
  "trigger_type_code": "string",
  "trigger_id": "string",
  "message": {
    "id": "string",
    "channel": "string"
  },
  "event": {
    "event_type": "string"
  }
}

transactional-messaging.trigger.failed-message-processing-failed-v1

	Name	Type
required	trigger_type_code	`string`
required	trigger_id	`string`
	message	transactional_messaging-process_trigger-_TransactionalMessage
	event	transactional_messaging-process_trigger-_MessageEvent

Event Type	Payload Version
transactional-messaging.trigger.failed-message-processing-failed	v1

{
  "trigger_type_code": "string",
  "trigger_id": "string",
  "message": {
    "id": "string",
    "channel": "string"
  },
  "event": {
    "event_type": "string"
  }
}

transactional-messaging.trigger.processed-v1

	Name	Type
required	trigger_type_code	`string`
required	trigger_id	`string`

Event Type	Payload Version
transactional-messaging.trigger.processed	v1

{
  "trigger_type_code": "string",
  "trigger_id": "string"
}

transactional-messaging.trigger.processing-failed-v1

	Name	Type
required	trigger_type_code	`string`
required	trigger_id	`string`

Event Type	Payload Version
transactional-messaging.trigger.processing-failed	v1

{
  "trigger_type_code": "string",
  "trigger_id": "string"
}

transactional_messaging-process_trigger-_MessageEvent

	Name	Type
required	event_type	`string`

{
  "event_type": "string"
}

transactional_messaging-process_trigger-_TransactionalMessage

	Name	Type
required	id	`string`
required	channel	`string`

{
  "id": "string",
  "channel": "string"
}

translation_management.CLIENT_MANAGED_TRANSLATION_SOURCE_DELETED-v1

	Name	Type
required	translation_key	`string`
required	internal_lang_codes	`array[string]`

Event Type	Payload Version
translation_management.CLIENT_MANAGED_TRANSLATION_SOURCE_DELETED	v1

{
  "translation_key": "string",
  "internal_lang_codes": [
    "string"
  ]
}

translation_management.CLIENT_MANAGED_TRANSLATION_SOURCE_EDITED-v1

	Name	Type
required	translation_key	`string`
required	internal_lang_codes	`array[string]`

Event Type	Payload Version
translation_management.CLIENT_MANAGED_TRANSLATION_SOURCE_EDITED	v1

{
  "translation_key": "string",
  "internal_lang_codes": [
    "string"
  ]
}

user_access.granted-v1

	Name	Type
required	allocation_id	`integer`
required	user_id	`integer`
required	target_id	`integer`
required	target_type	`string`
required	role_id	`integer`
required	start_at	`string`
required	end_at	`string`

Event Type	Payload Version
user_access.granted	v1

{
  "allocation_id": "integer",
  "user_id": "integer",
  "target_id": "integer",
  "target_type": "string",
  "role_id": "integer",
  "start_at": "string",
  "end_at": "string"
}

user_access.revoked-v1

	Name	Type
required	allocation_id	`integer`
required	user_id	`integer`
required	target_id	`integer`
required	target_type	`string`
required	role_id	`integer`
required	start_at	`string`
required	end_at	`string`

Event Type	Payload Version
user_access.revoked	v1

{
  "allocation_id": "integer",
  "user_id": "integer",
  "target_id": "integer",
  "target_type": "string",
  "role_id": "integer",
  "start_at": "string",
  "end_at": "string"
}

voice-call_participants-_CallParticipantIdentity

	Name	Type
required	entity_id	`integer`
required	type	`string`

{
  "entity_id": "integer",
  "type": "string"
}

voice-transcriptions-_Call

	Name	Type
required	id	`integer`
required	created_at	`string`
required	direction	`string`
required	participant_workers	array[voice-transcriptions-_CallParticipantWorker]
required	tags	array[voice-transcriptions-_CallTag]

{
  "id": "integer",
  "created_at": "string",
  "direction": "string",
  "participant_workers": [
    {
      "support_user_id": "integer",
      "joined_at": "string",
      "left_at": "string"
    }
  ],
  "tags": [
    {
      "id": "integer"
    }
  ]
}

voice-transcriptions-_CallParticipantWorker

	Name	Type
required	support_user_id	`integer`
required	joined_at	`string`
required	left_at	`string`

{
  "support_user_id": "integer",
  "joined_at": "string",
  "left_at": "string"
}

voice-transcriptions-_CallRecordingV1

	Name	Type
required	id	`integer`
required	s3_bucket	`string`
required	s3_key	`string`

{
  "id": "integer",
  "s3_bucket": "string",
  "s3_key": "string"
}

voice-transcriptions-_CallRecordingV2

	Name	Type
required	id	`integer`
required	s3_bucket	`string`
required	s3_key	`string`
required	duration_seconds	`integer`

{
  "id": "integer",
  "s3_bucket": "string",
  "s3_key": "string",
  "duration_seconds": "integer"
}

voice-transcriptions-_CallTag

	Name	Type
required	id	`integer`

{
  "id": "integer"
}

voice-transcriptions-_TranscriptionFile

	Name	Type
required	s3_bucket	`string`
required	s3_key	`string`
required	type	`string`

{
  "s3_bucket": "string",
  "s3_key": "string",
  "type": "string"
}

voice-wrap_up_call-_CallParticipants

	Name	Type
required	id	`integer`
required	account_id	`integer`
required	account_number	`string`
required	account_user_id	`integer`
required	account_user_number	`string`
required	inferred_account_user_number	`string`
required	support_user_id	`integer`
required	joined_at	`string`
required	left_at	`string`

{
  "id": "integer",
  "account_id": "integer",
  "account_number": "string",
  "account_user_id": "integer",
  "account_user_number": "string",
  "inferred_account_user_number": "string",
  "support_user_id": "integer",
  "joined_at": "string",
  "left_at": "string"
}

voice-wrap_up_call-_CallTag

	Name	Type
required	id	`integer`

{
  "id": "integer"
}

voice-wrap_up_call-_Note

	Name	Type
required	id	`integer`

{
  "id": "integer"
}

voice.call-participant.identity-updated-v1

	Name	Type
required	call_id	`integer`
required	call_participant_id	`integer`
required	updated_identities	array[voice-call_participants-_CallParticipantIdentity]
required	new_account_number	`string`

Event Type	Payload Version
voice.call-participant.identity-updated	v1

{
  "call_id": "integer",
  "call_participant_id": "integer",
  "updated_identities": [
    {
      "entity_id": "integer",
      "type": "string"
    }
  ],
  "new_account_number": "string"
}

voice.call.wrapped-v1

	Name	Type
required	id	`integer`
required	created_at	`string`
required	direction	`string`
required	tags	array[voice-wrap_up_call-_CallTag]
required	notes	array[voice-wrap_up_call-_Note]
required	participants	array[voice-wrap_up_call-_CallParticipants]

Event Type	Payload Version
voice.call.wrapped	v1

{
  "id": "integer",
  "created_at": "string",
  "direction": "string",
  "tags": [
    {
      "id": "integer"
    }
  ],
  "notes": [
    {
      "id": "integer"
    }
  ],
  "participants": [
    {
      "id": "integer",
      "account_id": "integer",
      "account_number": "string",
      "account_user_id": "integer",
      "account_user_number": "string",
      "inferred_account_user_number": "string",
      "support_user_id": "integer",
      "joined_at": "string",
      "left_at": "string"
    }
  ]
}

voice.campaign.update-item-v1

	Name	Type
required	campaign_item_id	`integer`
required	campaign_id	`integer`
required	status	`string`
required	account_id	`integer`
required	phone_number	`string`

Event Type	Payload Version
voice.campaign.update-item	v1

{
  "campaign_item_id": "integer",
  "campaign_id": "integer",
  "status": "string",
  "account_id": "integer",
  "phone_number": "string"
}

voice.transcription.failed-v1

	Name	Type
required	account_number	`string`
required	call	voice-transcriptions-_Call
required	call_recording	voice-transcriptions-_CallRecordingV2
required	error	`string`

Event Type	Payload Version
voice.transcription.failed	v1

{
  "account_number": "string",
  "call": {
    "id": "integer",
    "created_at": "string",
    "direction": "string",
    "participant_workers": [
      {
        "support_user_id": "integer",
        "joined_at": "string",
        "left_at": "string"
      }
    ],
    "tags": [
      {
        "id": "integer"
      }
    ]
  },
  "call_recording": {
    "id": "integer",
    "s3_bucket": "string",
    "s3_key": "string",
    "duration_seconds": "integer"
  },
  "error": "string"
}

voice.transcription.processed-v1

	Name	Type
required	call_id	`integer`
required	account_number	`string`
required	transcription_files	array[voice-transcriptions-_TranscriptionFile]
required	call_recording	voice-transcriptions-_CallRecordingV1

Event Type	Payload Version
voice.transcription.processed	v1

{
  "call_id": "integer",
  "account_number": "string",
  "transcription_files": [
    {
      "s3_bucket": "string",
      "s3_key": "string",
      "type": "string"
    }
  ],
  "call_recording": {
    "id": "integer",
    "s3_bucket": "string",
    "s3_key": "string"
  }
}

voice.transcription.processed-v2

	Name	Type
required	account_number	`string`
required	call	voice-transcriptions-_Call
required	call_recording	voice-transcriptions-_CallRecordingV2
required	transcription_files	array[voice-transcriptions-_TranscriptionFile]

Event Type	Payload Version
voice.transcription.processed	v2

{
  "account_number": "string",
  "call": {
    "id": "integer",
    "created_at": "string",
    "direction": "string",
    "participant_workers": [
      {
        "support_user_id": "integer",
        "joined_at": "string",
        "left_at": "string"
      }
    ],
    "tags": [
      {
        "id": "integer"
      }
    ]
  },
  "call_recording": {
    "id": "integer",
    "s3_bucket": "string",
    "s3_key": "string",
    "duration_seconds": "integer"
  },
  "transcription_files": [
    {
      "s3_bucket": "string",
      "s3_key": "string",
      "type": "string"
    }
  ]
}

voucher.multiple_purchased-v1

	Name	Type
required	voucher_purchase_ids	`array[integer]`

Event Type	Payload Version
voucher.multiple_purchased	v1

{
  "voucher_purchase_ids": [
    "integer"
  ]
}

voucher.purchased-v1

	Name	Type
required	voucher_purchase_id	`integer`

Event Type	Payload Version
voucher.purchased	v1

{
  "voucher_purchase_id": "integer"
}

voucher.redeemed-v1

	Name	Type
required	voucher_purchase_id	`integer`

Event Type	Payload Version
voucher.redeemed	v1

{
  "voucher_purchase_id": "integer"
}

voucher.refunded-v1

	Name	Type
required	voucher_purchase_id	`integer`

Event Type	Payload Version
voucher.refunded	v1

{
  "voucher_purchase_id": "integer"
}

voucher.transferred-v1

	Name	Type
required	voucher_purchase_id	`integer`
required	from_account_number	`string`
required	to_account_number	`string`
required	transferred_at	`string`
required	transfer_note	`string`

Event Type	Payload Version
voucher.transferred	v1

{
  "voucher_purchase_id": "integer",
  "from_account_number": "string",
  "to_account_number": "string",
  "transferred_at": "string",
  "transfer_note": "string"
}

watermeter.aus_industry.created-v1

	Name	Type
required	meter_point_identifier	`string`
required	serial_number	`string`
required	make_and_model	`string`
required	read_method	`string`
required	reading_route_sequence	`integer`
required	location	`string`
required	access_details	`string`
required	measurement_unit	`string`
required	number_of_dials	`integer`
required	key_details	`string`
required	construction_date	`string`
required	installation_date	`string`
required	active_from	`string`
required	active_to	`string`
required	created_at	`string`
required	updated_at	`string`
	_changes	`object`

Event Type	Payload Version
watermeter.aus_industry.created	v1

{
  "meter_point_identifier": "string",
  "serial_number": "string",
  "make_and_model": "string",
  "read_method": "string",
  "reading_route_sequence": "integer",
  "location": "string",
  "access_details": "string",
  "measurement_unit": "string",
  "number_of_dials": "integer",
  "key_details": "string",
  "construction_date": "string",
  "installation_date": "string",
  "active_from": "string",
  "active_to": "string",
  "created_at": "string",
  "updated_at": "string",
  "_changes": "object"
}

watermeter.aus_industry.updated-v1

	Name	Type
required	meter_point_identifier	`string`
required	serial_number	`string`
required	make_and_model	`string`
required	read_method	`string`
required	reading_route_sequence	`integer`
required	location	`string`
required	access_details	`string`
required	measurement_unit	`string`
required	number_of_dials	`integer`
required	key_details	`string`
required	construction_date	`string`
required	installation_date	`string`
required	active_from	`string`
required	active_to	`string`
required	created_at	`string`
required	updated_at	`string`
	_changes	`object`

Event Type	Payload Version
watermeter.aus_industry.updated	v1

{
  "meter_point_identifier": "string",
  "serial_number": "string",
  "make_and_model": "string",
  "read_method": "string",
  "reading_route_sequence": "integer",
  "location": "string",
  "access_details": "string",
  "measurement_unit": "string",
  "number_of_dials": "integer",
  "key_details": "string",
  "construction_date": "string",
  "installation_date": "string",
  "active_from": "string",
  "active_to": "string",
  "created_at": "string",
  "updated_at": "string",
  "_changes": "object"
}

workflow.cancelled.via_support_site-v1

	Name	Type
required	workflow_id	`integer`

Event Type	Payload Version
workflow.cancelled.via_support_site	v1

{
  "workflow_id": "integer"
}

workflow.step.cancelled.via_support_site-v1

	Name	Type
required	step_id	`integer`

Event Type	Payload Version
workflow.step.cancelled.via_support_site	v1

{
  "step_id": "integer"
}

Events Reference

Event Properties

JSON Payload Representation

Event Properties

JSON Payload Representation

Event Properties

JSON Payload Representation

Event Properties

JSON Payload Representation

Event Properties

JSON Payload Representation

Event Properties

Metadata

JSON Payload Representation

Event Properties

Metadata

JSON Payload Representation

Event Properties

Metadata

JSON Payload Representation

Event Properties

Metadata

JSON Payload Representation

Event Properties

Metadata

JSON Payload Representation

Event Properties

Metadata

JSON Payload Representation

Event Properties

Metadata

JSON Payload Representation

Event Properties

Metadata

JSON Payload Representation

Event Properties

Metadata

JSON Payload Representation

Event Properties

Metadata

JSON Payload Representation

Event Properties

Metadata

JSON Payload Representation

Event Properties

Metadata

JSON Payload Representation

Event Properties

Metadata

JSON Payload Representation

Event Properties

Metadata

JSON Payload Representation

Event Properties

Metadata

JSON Payload Representation

Event Properties

Metadata

JSON Payload Representation

Event Properties

Metadata

JSON Payload Representation

Event Properties

Metadata

JSON Payload Representation

Event Properties

Metadata

JSON Payload Representation

Event Properties

Metadata

JSON Payload Representation

Event Properties

Metadata

JSON Payload Representation

Event Properties

JSON Payload Representation

Event Properties

JSON Payload Representation

Event Properties

JSON Payload Representation