Skip to main content

Events Reference

Event Types

About Events

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

_core-_amend_subject-AmendedSubject

Event Properties

NameType
requiredtypestring
requiredidentifierstring
requiredeffective_fromstring
requiredeffective_tostring

JSON Payload Representation

{
  "type": "string",
  "identifier": "string",
  "effective_from": "string",
  "effective_to": "string"
}

_electricity-_change_of_ownership_not_udd_response-BillingAddress

Event Properties

NameType
requiredstreet_typestring
requiredstreet_namestring
requiredstreet_numberstring
requiredpostcodestring
requiredistat_codestring
requiredcitystring
requiredprovincestring
requiredcountrystring
requiredadditional_infostring

JSON Payload Representation

{
  "street_type": "string",
  "street_name": "string",
  "street_number": "string",
  "postcode": "string",
  "istat_code": "string",
  "city": "string",
  "province": "string",
  "country": "string",
  "additional_info": "string"
}

_electricity-_change_of_ownership_not_udd_response-ResidenceAddress

Event Properties

NameType
requiredstreet_typestring
requiredstreet_namestring
requiredstreet_numberstring
requiredpostcodestring
requiredistat_codestring
requiredcitystring
requiredprovincestring
requiredcountrystring
requiredadditional_infostring

JSON Payload Representation

{
  "street_type": "string",
  "street_name": "string",
  "street_number": "string",
  "postcode": "string",
  "istat_code": "string",
  "city": "string",
  "province": "string",
  "country": "string",
  "additional_info": "string"
}

_gas-_self_reading_validation_outcome-_ReadingDetail

Event Properties

NameType
requiredreading_typestring
requiredvalidation_outcomestring
requirednotesstring
requiredattemptsinteger
requiredcollection_datestring
requiredtotal_withdrawal_readinginteger
requiredtotal_converter_readinginteger
requiredeffective_measurement_datestring
requiredeffective_meter_readinginteger
requiredeffective_converter_readinginteger

JSON Payload Representation

{
  "reading_type": "string",
  "validation_outcome": "string",
  "notes": "string",
  "attempts": "integer",
  "collection_date": "string",
  "total_withdrawal_reading": "integer",
  "total_converter_reading": "integer",
  "effective_measurement_date": "string",
  "effective_meter_reading": "integer",
  "effective_converter_reading": "integer"
}

_gas-_self_reading_validation_outcome-_TechnicalData

Event Properties

NameType
requiredtreatmentstring
requiredmeter_numberstring
requiredconverter_numberstring
requiredmeter_digitsinteger
requiredconverter_digitsinteger
requiredcorrection_coefficientnumber
requiredreading_frequencyinteger
requiredmeter_accessibilityinteger
requiredcollection_typestring
requiredcollection_outcomestring
requiredfailed_collection_causeinteger
requiredalternative_collection_modestring
requiredobstructive_causestring
requiredcompensation_rightstring
requirednext_window_startstring
requirednext_window_endstring
requiredsubstitute_annual_volumenumber
requiredmeter_group_classstring
requiredconverter_presentstring
requiredintegrated_measurement_groupstring

JSON Payload Representation

{
  "treatment": "string",
  "meter_number": "string",
  "converter_number": "string",
  "meter_digits": "integer",
  "converter_digits": "integer",
  "correction_coefficient": "number",
  "reading_frequency": "integer",
  "meter_accessibility": "integer",
  "collection_type": "string",
  "collection_outcome": "string",
  "failed_collection_cause": "integer",
  "alternative_collection_mode": "string",
  "obstructive_cause": "string",
  "compensation_right": "string",
  "next_window_start": "string",
  "next_window_end": "string",
  "substitute_annual_volume": "number",
  "meter_group_class": "string",
  "converter_present": "string",
  "integrated_measurement_group": "string"
}

_journeys-_common-ContractJourney

Event Properties

NameType
requirednumberstring
requiredtypestring
requiredrequested_atstring

JSON Payload Representation

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

_journeys-_common-SubjectContractJourney

Event Properties

NameType
requirednumberstring
requiredsubject_numberstring

JSON Payload Representation

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

account.communications_preferences_updated-v1

Event Properties

NameType
requiredaccount_numberstring
requiredchangesaccounts-accounts-AccountCommsPreferencesChanges

Metadata

Event TypePayload Version
account.communications_preferences_updatedv1

JSON Payload Representation

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

account.created-v1

Event Properties

NameType
requiredaccount_numberstring
requiredaccount_user_emailsarray[string]
is_importedboolean

Metadata

Event TypePayload Version
account.createdv1

JSON Payload Representation

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

account.occupied-v1

Event Properties

NameType
requiredaccount_numberstring

Metadata

Event TypePayload Version
account.occupiedv1

JSON Payload Representation

{
  "account_number": "string"
}

account.reactivated-v1

Event Properties

NameType
requiredaccount_numberstring
requiredprevious_statusstring
requiredreactivation_sourcestring

Metadata

Event TypePayload Version
account.reactivatedv1

JSON Payload Representation

{
  "account_number": "string",
  "previous_status": "string",
  "reactivation_source": "string"
}

account.smart-meter-read-permission-changed-v1

Event Properties

NameType
requiredaccount_numberstring
requiredold_permissionstring
requirednew_permissionstring
requiredeffective_fromstring
requiredchanged_by_idstring
requiredchanged_by_typestring

Metadata

Event TypePayload Version
account.smart-meter-read-permission-changedv1

JSON Payload Representation

{
  "account_number": "string",
  "old_permission": "string",
  "new_permission": "string",
  "effective_from": "string",
  "changed_by_id": "string",
  "changed_by_type": "string"
}

account.updated-v1

Event Properties

NameType
requiredaccount_numberstring
requiredaccount_user_emailsarray[string]
requiredchangesobject
is_overrideboolean

Metadata

Event TypePayload Version
account.updatedv1

JSON Payload Representation

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

account_metadata.created-v1

Event Properties

NameType
requiredaccount_numberstring
requiredkeystring
requiredvaluestring

Metadata

Event TypePayload Version
account_metadata.createdv1

JSON Payload Representation

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

account_metadata.removed-v1

Event Properties

NameType
requiredaccount_numberstring
requiredkeystring
requiredvaluestring

Metadata

Event TypePayload Version
account_metadata.removedv1

JSON Payload Representation

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

account_metadata.updated-v1

Event Properties

NameType
requiredaccount_numberstring
requiredchangesobject

Metadata

Event TypePayload Version
account_metadata.updatedv1

JSON Payload Representation

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

account_property_effective_period_metadata.created-v1

Event Properties

NameType
requiredaccount_property_effective_period_idinteger
requiredkeystring
requiredvaluestring

Metadata

Event TypePayload Version
account_property_effective_period_metadata.createdv1

JSON Payload Representation

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

account_property_effective_period_metadata.removed-v1

Event Properties

NameType
requiredaccount_property_effective_period_idinteger
requiredkeystring
requiredvaluestring

Metadata

Event TypePayload Version
account_property_effective_period_metadata.removedv1

JSON Payload Representation

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

account_property_effective_period_metadata.updated-v1

Event Properties

NameType
requiredaccount_property_effective_period_idinteger
requiredchangesobject

Metadata

Event TypePayload Version
account_property_effective_period_metadata.updatedv1

JSON Payload Representation

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

account_user.created-v1

Event Properties

NameType
requireduser_idinteger
requireduser_emailstring
requireduser_numberstring
requiredlinked_accountsarray
user_identifiersobject
initiator_typestring
is_customer_initiatedboolean

Metadata

Event TypePayload Version
account_user.createdv1

JSON Payload Representation

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

account_user.password_changed-v1

Event Properties

NameType
requireduser_idinteger

Metadata

Event TypePayload Version
account_user.password_changedv1

JSON Payload Representation

{
  "user_id": "integer"
}

account_user.password_reset_requested-v1

Event Properties

NameType
requiredaccount_user_idinteger
requiredaccount_user_numberstring

Metadata

Event TypePayload Version
account_user.password_reset_requestedv1

JSON Payload Representation

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

account_user.psr_records_updated-v1

Event Properties

NameType
requireduser_idinteger
requiredcreated_records array[accounts-account_user-_PsrRecord]
requiredupdated_records array[accounts-account_user-_PsrRecord]
requireddeleted_records array[accounts-account_user-_PsrRecord]

Metadata

Event TypePayload Version
account_user.psr_records_updatedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requireduser_idinteger
requireduser_emailstring
requireduser_numberstring
requiredlinked_accountsarray
user_identifiersobject
initiator_typestring
is_customer_initiatedboolean

Metadata

Event TypePayload Version
account_user.removedv1

JSON Payload Representation

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

account_user.updated-v1

Event Properties

NameType
requireduser_idinteger
requireduser_emailstring
requireduser_numberstring
requiredlinked_accountsarray
user_identifiersobject
initiator_typestring
is_customer_initiatedboolean
requiredchangesobject
is_overrideboolean

Metadata

Event TypePayload Version
account_user.updatedv1

JSON Payload Representation

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

account_user.verification_completed-v1

Event Properties

NameType
requireduser_numberstring
requiredverification_idinteger
requiredverification_typestring

Metadata

Event TypePayload Version
account_user.verification_completedv1

JSON Payload Representation

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

account_user.verification_started-v1

Event Properties

NameType
requireduser_numberstring
requiredverification_idinteger
requiredverification_typestring

Metadata

Event TypePayload Version
account_user.verification_startedv1

JSON Payload Representation

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

account_user_metadata.created-v1

Event Properties

NameType
requireduser_idinteger
requiredkeystring
requiredvaluestring

Metadata

Event TypePayload Version
account_user_metadata.createdv1

JSON Payload Representation

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

account_user_metadata.removed-v1

Event Properties

NameType
requireduser_idinteger
requiredkeystring
requiredvaluestring

Metadata

Event TypePayload Version
account_user_metadata.removedv1

JSON Payload Representation

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

account_user_metadata.updated-v1

Event Properties

NameType
requireduser_idinteger
requiredchangesobject

Metadata

Event TypePayload Version
account_user_metadata.updatedv1

JSON Payload Representation

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

accounts-account_user-_PsrRecord

Event Properties

NameType
requireddescriptionstring
requiredelectricity_industry_codestring
requiredgas_industry_codestring

JSON Payload Representation

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

accounts-accounts-AccountCommsPreferencesChanges

Event Properties

NameType
requires_postal_commsarray[boolean]
preferred_language_for_commsarray[string]
document_accessibilityarray[string]

JSON Payload Representation

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

accounts-house_move-Account

Event Properties

NameType
requirednumberstring
requiredexternal_referencestring

JSON Payload Representation

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

accounts-house_move-SupplyPoint

Event Properties

NameType
requiredidstring
industrystring
tariff_codestring
tariff_payment_methodstring

JSON Payload Representation

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

affiliates.affiliate-account-contract-created-v1

Event Properties

NameType
requiredaffiliate_account_contract_idinteger
requiredaffiliate_contract_idinteger
requiredaccount_numberstring
requiredfuelstring

Metadata

Event TypePayload Version
affiliates.affiliate-account-contract-createdv1

JSON Payload Representation

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

agreement.created-v1

Event Properties

NameType
requiredagreement_idinteger
requiredaccount_numberstring
requiredvalid_fromstring
requiredproduct_codestring
account_contract_identifierstring
business_contract_identifierstring

Metadata

Event TypePayload Version
agreement.createdv1

JSON Payload Representation

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

agreement.revoked-v1

Event Properties

NameType
requiredagreement_idinteger

Metadata

Event TypePayload Version
agreement.revokedv1

JSON Payload Representation

{
  "agreement_id": "integer"
}

agreement.revoked-v2

Event Properties

NameType
requiredagreement_idinteger
requiredaccount_numberstring

Metadata

Event TypePayload Version
agreement.revokedv2

JSON Payload Representation

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

agreement.rollover.completed-v1

Event Properties

NameType
requiredaccount_numberstring
requiredsupply_point_idstring
requiredexpiring_agreement_idinteger
requiredrolled_on_to_agreement_idinteger
requirednew_productmarket_supply-products-Product
requiredrolled_on_to_agreement_valid_fromstring
requiredrolled_on_to_agreement_valid_tostring

Metadata

Event TypePayload Version
agreement.rollover.completedv1

JSON Payload Representation

{
  "account_number": "string",
  "supply_point_id": "string",
  "expiring_agreement_id": "integer",
  "rolled_on_to_agreement_id": "integer",
  "new_product": {
    "code": "string",
    "market_name": "string",
    "brand_code": "string"
  },
  "rolled_on_to_agreement_valid_from": "string",
  "rolled_on_to_agreement_valid_to": "string"
}

agreement.terminated-v1

Event Properties

NameType
requiredagreement_idinteger

Metadata

Event TypePayload Version
agreement.terminatedv1

JSON Payload Representation

{
  "agreement_id": "integer"
}

agreement.terminated-v2

Event Properties

NameType
requiredagreement_idinteger
requiredaccount_numberstring

Metadata

Event TypePayload Version
agreement.terminatedv2

JSON Payload Representation

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

agreement.updated-v1

Event Properties

NameType
requiredagreement_idinteger
requiredchangesobject
is_overrideboolean

Metadata

Event TypePayload Version
agreement.updatedv1

JSON Payload Representation

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

agreement.updated-v2

Event Properties

NameType
requiredagreement_idinteger
requiredchangesobject
is_overrideboolean
requiredaccount_numberstring

Metadata

Event TypePayload Version
agreement.updatedv2

JSON Payload Representation

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

approvals.approval.approved-v1

Event Properties

NameType
requiredapproval_idstring
requiredprocess_typestring
requiredprocess_dataobject
requiredapproved_atstring

Metadata

Event TypePayload Version
approvals.approval.approvedv1

JSON Payload Representation

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

approvals.approval.created-v1

Event Properties

NameType
requiredapproval_idstring
requiredprocess_typestring
requiredrequested_atstring
requiredassigned_to_idinteger
requiredrequested_by_idinteger

Metadata

Event TypePayload Version
approvals.approval.createdv1

JSON Payload Representation

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

approvals.approval.rejected-v1

Event Properties

NameType
requiredapproval_idstring
requiredprocess_typestring
requiredprocess_dataobject
requiredrejected_atstring

Metadata

Event TypePayload Version
approvals.approval.rejectedv1

JSON Payload Representation

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

approvals.approval_request.approved-v1

Event Properties

NameType
requiredapproval_idstring
requiredprocess_typestring
requiredrequest_idstring
requiredapproved_by_idinteger
requiredapproved_atstring
requiredapproval_reasonstring

Metadata

Event TypePayload Version
approvals.approval_request.approvedv1

JSON Payload Representation

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

approvals.approval_request.assigned-v1

Event Properties

NameType
requiredapproval_idstring
requiredprocess_typestring
requiredrequest_idstring
requiredassigned_to_idinteger
requiredassigned_atstring

Metadata

Event TypePayload Version
approvals.approval_request.assignedv1

JSON Payload Representation

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

approvals.approval_request.rejected-v1

Event Properties

NameType
requiredapproval_idstring
requiredprocess_typestring
requiredrequest_idstring
requiredrejected_by_idinteger
requiredrejection_reasonstring
requiredrejected_atstring

Metadata

Event TypePayload Version
approvals.approval_request.rejectedv1

JSON Payload Representation

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

auth-server.access-token.issued-v1

Event Properties

NameType
requireddelegatestring
requiredviewerstring
requiredviewer_idinteger

Metadata

Event TypePayload Version
auth-server.access-token.issuedv1

JSON Payload Representation

{
  "delegate": "string",
  "viewer": "string",
  "viewer_id": "integer"
}

auth_server.account_user.generate_mfa_challenge_error-v1

Event Properties

NameType
requiredaccount_user_idinteger
requiredaccount_user_numberstring
requireddevicestring

Metadata

Event TypePayload Version
auth_server.account_user.generate_mfa_challenge_errorv1

JSON Payload Representation

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

auth_server.account_user.logged_in-v1

Event Properties

NameType
requiredaccount_user_idinteger
requiredaccount_user_numberstring
requiredlogin_methodstring
requiredmfa_device_typestring

Metadata

Event TypePayload Version
auth_server.account_user.logged_inv1

JSON Payload Representation

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

auth_server.account_user.login_denied-v1

Event Properties

NameType
requiredaccount_user_idinteger
requiredaccount_user_numberstring
requiredenforced_security_rule_idsarray[integer]

Metadata

Event TypePayload Version
auth_server.account_user.login_deniedv1

JSON Payload Representation

{
  "account_user_id": "integer",
  "account_user_number": "string",
  "enforced_security_rule_ids": [
    "integer"
  ]
}

auth_server.account_user.login_failed-v1

Event Properties

NameType
requiredaccount_user_idinteger
requiredaccount_user_numberstring
requiredstepstring
requiredfailure_reasonstring
requiredbrandstring
requireduser_brandsarray[string]

Metadata

Event TypePayload Version
auth_server.account_user.login_failedv1

JSON Payload Representation

{
  "account_user_id": "integer",
  "account_user_number": "string",
  "step": "string",
  "failure_reason": "string",
  "brand": "string",
  "user_brands": [
    "string"
  ]
}

auth_server.account_user.login_step_completed-v1

Event Properties

NameType
requiredaccount_user_idinteger
requiredaccount_user_numberstring
requiredstepstring
requiredmfa_device_typestring

Metadata

Event TypePayload Version
auth_server.account_user.login_step_completedv1

JSON Payload Representation

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

billing-_billing-Account

Event Properties

NameType
requirednumberstring

JSON Payload Representation

{
  "number": "string"
}

billing-_billing-Ledger

Event Properties

NameType
requiredaccountbilling-_billing-Account
requirednumberstring
idstring

JSON Payload Representation

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

billing-_billing-LedgerEntry

Event Properties

NameType
requiredidinteger
requiredis_chargeboolean
requiredis_creditboolean
requiredis_paymentboolean
requiredis_repaymentboolean
requiredis_reversalboolean
requiredis_reversedboolean
source_idinteger
source_typestring

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredidinteger
requiredamountinteger
requiredis_chargeboolean
requiredis_creditboolean
requiredis_paymentboolean
requiredis_repaymentboolean
requiredis_reversalboolean
requiredis_reversedboolean
requiredsource_reasonstring

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredstart_atstring
requiredend_atstring

JSON Payload Representation

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

billing.billing_document.held-v1

Event Properties

NameType
requiredaccount_numberstring
requireddocument_typestring
requireddocument_idinteger
requireddocument_identifierstring
requireddocument_uuidstring
requiredhold_codestring
requiredis_strictboolean
requiredheld_atstring
requiredheld_by_idinteger

Metadata

Event TypePayload Version
billing.billing_document.heldv1

JSON Payload Representation

{
  "account_number": "string",
  "document_type": "string",
  "document_id": "integer",
  "document_identifier": "string",
  "document_uuid": "string",
  "hold_code": "string",
  "is_strict": "boolean",
  "held_at": "string",
  "held_by_id": "integer"
}

billing.billing_document.issued-v1

Event Properties

NameType
requiredaccount_numberstring
requiredbilling_document_idinteger
requiredbilling_document_identifierstring

Metadata

Event TypePayload Version
billing.billing_document.issuedv1

JSON Payload Representation

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

billing.billing_document.issued-v2

Event Properties

NameType
requiredaccount_numberstring
requiredbilling_document_idinteger
requiredbilling_document_identifierstring
requiredbilling_document_uuidstring

Metadata

Event TypePayload Version
billing.billing_document.issuedv2

JSON Payload Representation

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

billing.billing_document_representation.dispatched-v1

Event Properties

NameType
requiredaccount_numberstring
requiredbilling_document_idinteger
requiredbilling_document_identifierstring

Metadata

Event TypePayload Version
billing.billing_document_representation.dispatchedv1

JSON Payload Representation

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

billing.billing_document_representation.dispatched-v2

Event Properties

NameType
requiredaccount_numberstring
requiredbilling_document_idinteger
requiredbilling_document_identifierstring
requiredbilling_document_representation_dispatch_idinteger
requiredbilling_document_representations_idarray[integer]

Metadata

Event TypePayload Version
billing.billing_document_representation.dispatchedv2

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredaccount_numberstring
requiredbilling_document_idinteger
requiredbilling_document_identifierstring
requiredbilling_document_representation_dispatch_idinteger
requiredbilling_document_representations_idarray[integer]
requiredsupport_user_idinteger

Metadata

Event TypePayload Version
billing.billing_document_representation.dispatchedv3

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredaccount_numberstring
requiredprevious_billing_options_idinteger
requirednew_billing_options_idinteger
requiredsupport_user_idinteger

Metadata

Event TypePayload Version
billing.billing_options.updatedv1

JSON Payload Representation

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

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

Event Properties

NameType
requiredledger_numberstring
requiredagreement_idinteger
requiredassigned_atstring

Metadata

Event TypePayload Version
billing.charging-ledger.assigned-to-agreementv1

JSON Payload Representation

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

billing.charging.supply-point.triggered-v1

Event Properties

NameType
requiredsupply_point_idinteger
requiredcharge_periodbilling-_billing-_ChargePeriod

Metadata

Event TypePayload Version
billing.charging.supply-point.triggeredv1

JSON Payload Representation

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

billing.duos_invoice.cancel-v1

Event Properties

NameType
requiredinvoice_event_idinteger

Metadata

Event TypePayload Version
billing.duos_invoice.cancelv1

JSON Payload Representation

{
  "invoice_event_id": "integer"
}

billing.duos_invoice.new-v1

Event Properties

NameType
requiredinvoice_event_idinteger

Metadata

Event TypePayload Version
billing.duos_invoice.newv1

JSON Payload Representation

{
  "invoice_event_id": "integer"
}

billing.duos_invoice.replace-v1

Event Properties

NameType
requiredinvoice_event_idinteger

Metadata

Event TypePayload Version
billing.duos_invoice.replacev1

JSON Payload Representation

{
  "invoice_event_id": "integer"
}

billing.final_bill-v1

Event Properties

NameType
requiredaccount_numberstring
requiredaccount_user_emailsarray[string]
requiredstatement_idinteger

Metadata

Event TypePayload Version
billing.final_billv1

JSON Payload Representation

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

billing.issuance.external_status.created-v1

Event Properties

NameType
requiredbilling_document_identifierstring
requiredstatusstring
requiredstatus_codestring
requiredexternal_status_idinteger

Metadata

Event TypePayload Version
billing.issuance.external_status.createdv1

JSON Payload Representation

{
  "billing_document_identifier": "string",
  "status": "string",
  "status_code": "string",
  "external_status_id": "integer"
}

billing.issued_bill-v1

Event Properties

NameType
requiredaccount_numberstring
requiredstatement_idinteger

Metadata

Event TypePayload Version
billing.issued_billv1

JSON Payload Representation

{
  "account_number": "string",
  "statement_id": "integer"
}

billing.ledger.entry_posted-v1

Event Properties

NameType
requiredledgerbilling-_billing-Ledger

Metadata

Event TypePayload Version
billing.ledger.entry_postedv1

JSON Payload Representation

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

billing.ledger.entry_posted-v2

Event Properties

NameType
requiredledgerbilling-_billing-Ledger
requiredentrybilling-_billing-LedgerEntry

Metadata

Event TypePayload Version
billing.ledger.entry_postedv2

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredledgerbilling-_billing-Ledger

Metadata

Event TypePayload Version
billing.ledger.entry_removedv1

JSON Payload Representation

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

billing.ledger.entry_removed-v2

Event Properties

Metadata

Event TypePayload Version
billing.ledger.entry_removedv2

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredpathway_idstring
requiredtraversal_attempt_idinteger
requiredtraversal_attempt_contextobject
requiredtrigger_idinteger
requiredfailed_action_namestring
requiredfailed_action_errorstring
requiredfailed_atstring

Metadata

Event TypePayload Version
billing.pathway_traversal.failedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredpathway_idstring
requiredtraversal_attempt_idinteger
requiredtrigger_idinteger
requiredsucceeded_atstring

Metadata

Event TypePayload Version
billing.pathway_traversal.succeededv1

JSON Payload Representation

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

billing.rebate.accepted-v1

Event Properties

NameType
requiredaccount_numberstring
requiredrebate_period_idinteger
requiredrebate_typestring
requiredeffective_fromstring
requiredeffective_tostring

Metadata

Event TypePayload Version
billing.rebate.acceptedv1

JSON Payload Representation

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

billing.rebate.created-v1

Event Properties

NameType
requiredaccount_numberstring
requiredrebate_period_idinteger
requiredrebate_typestring
requiredeffective_fromstring
requiredeffective_tostring
requiredis_application_acceptedboolean

Metadata

Event TypePayload Version
billing.rebate.createdv1

JSON Payload Representation

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

billing.rebate.declined-v1

Event Properties

NameType
requiredaccount_numberstring
requiredrebate_period_idinteger
requiredrebate_typestring
requiredeffective_fromstring
requiredeffective_tostring
requireddecline_reasonstring

Metadata

Event TypePayload Version
billing.rebate.declinedv1

JSON Payload Representation

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

billing.rebate.updated-v1

Event Properties

NameType
requiredaccount_numberstring
requiredrebate_period_idinteger
requiredrebate_typestring
requiredeffective_fromstring
requiredeffective_tostring
requiredis_application_acceptedboolean

Metadata

Event TypePayload Version
billing.rebate.updatedv1

JSON Payload Representation

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

business.created-v1

Event Properties

NameType
requiredidinteger

Metadata

Event TypePayload Version
business.createdv1

JSON Payload Representation

{
  "id": "integer"
}

business.updated-v1

Event Properties

NameType
requiredidinteger
requiredchangesobject

Metadata

Event TypePayload Version
business.updatedv1

JSON Payload Representation

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

business_operations_team.updated-v1

Event Properties

NameType
requiredidinteger
requiredoperations_team_idinteger

Metadata

Event TypePayload Version
business_operations_team.updatedv1

JSON Payload Representation

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

campaign_account.added-v1

Event Properties

NameType
requiredaccount_numberstring
requiredcampaign_namestring
campaign_slugstring
campaign_expiry_datestring
campaign_account_expiry_datestring

Metadata

Event TypePayload Version
campaign_account.addedv1

JSON Payload Representation

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

campaign_account.removed-v1

Event Properties

NameType
requiredaccount_numberstring
requiredcampaign_namestring
campaign_slugstring

Metadata

Event TypePayload Version
campaign_account.removedv1

JSON Payload Representation

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

campaign_account.updated-v1

Event Properties

NameType
requiredaccount_numberstring
requiredcampaign_namestring
campaign_slugstring
requiredchangesobject

Metadata

Event TypePayload Version
campaign_account.updatedv1

JSON Payload Representation

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

cashflow-_payments-Account

Event Properties

NameType
requirednumberstring

JSON Payload Representation

{
  "number": "string"
}

cashflow-_payments-Ledger

Event Properties

NameType
requiredaccountcashflow-_payments-Account
idstring

JSON Payload Representation

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

cashflow-_payments-Payment

Event Properties

NameType
requiredidinteger
requiredamountinteger
requiredpayment_datestring
requireddescriptionstring
failure_reasonstring

JSON Payload Representation

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

charging.priming.errored-v1

Event Properties

NameType
requirederrorsarray[string]
requiredsupply_point_idstring
requiredperiod_startstring
requiredperiod_endstring

Metadata

Event TypePayload Version
charging.priming.erroredv1

JSON Payload Representation

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

collection_proceeding.created-v1

Event Properties

NameType
requiredidinteger
requiredaccount_numberstring
amountinteger
campaignstring
requiredis_white_labelboolean
requiredagency_codestring

Metadata

Event TypePayload Version
collection_proceeding.createdv1

JSON Payload Representation

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

collection_process.leave_supplier_instigated-v1

Event Properties

NameType
requirednumberstring
requiredaccount_numberstring
requiredleave_supplier_process_numberstring

Metadata

Event TypePayload Version
collection_process.leave_supplier_instigatedv1

JSON Payload Representation

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

collection_process.paused-v1

Event Properties

NameType
requirednumberstring
requiredaccount_numberstring
requiredsourcestring
requiredactive_pause_reasonsarray[string]

Metadata

Event TypePayload Version
collection_process.pausedv1

JSON Payload Representation

{
  "number": "string",
  "account_number": "string",
  "source": "string",
  "active_pause_reasons": [
    "string"
  ]
}

collection_process.raised-v1

Event Properties

NameType
requirednumberstring
requiredaccount_numberstring
ledgerstring
billing_documentstring
requiredconfig_codestring

Metadata

Event TypePayload Version
collection_process.raisedv1

JSON Payload Representation

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

collection_process.reactivated-v1

Event Properties

NameType
requirednumberstring

Metadata

Event TypePayload Version
collection_process.reactivatedv1

JSON Payload Representation

{
  "number": "string"
}

collection_process.run_termination_requested-v1

Event Properties

NameType
requirednumberstring

Metadata

Event TypePayload Version
collection_process.run_termination_requestedv1

JSON Payload Representation

{
  "number": "string"
}

collection_process.unpaused-v1

Event Properties

NameType
requirednumberstring
requiredaccount_numberstring
requiredsourcestring

Metadata

Event TypePayload Version
collection_process.unpausedv1

JSON Payload Representation

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

collection_process.withdrawn-v1

Event Properties

NameType
requirednumberstring
requiredaccount_numberstring
requiredexternal_referencestring

Metadata

Event TypePayload Version
collection_process.withdrawnv1

JSON Payload Representation

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

collection_process.withdrawn-v2

Event Properties

NameType
requirednumberstring
requiredaccount_numberstring

Metadata

Event TypePayload Version
collection_process.withdrawnv2

JSON Payload Representation

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

comms.account-call.updated-v1

Event Properties

NameType
requiredaccount_numberstring
requiredcall_idinteger
requiredcall_keystring
requiredtranscript_keystring
requiredredacted_transcript_keystring
requiredbucketstring
requiredchangesobject

Metadata

Event TypePayload Version
comms.account-call.updatedv1

JSON Payload Representation

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

comms.customer_email_bounced-v1

Event Properties

NameType
requiredaccount_numberstring
requireduser_idinteger
requiredmessage_idinteger
requiredtemplate_codestring
requiredbounced_atstring

Metadata

Event TypePayload Version
comms.customer_email_bouncedv1

JSON Payload Representation

{
  "account_number": "string",
  "user_id": "integer",
  "message_id": "integer",
  "template_code": "string",
  "bounced_at": "string"
}

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

Event Properties

NameType
requiredpush_notification_binding_idinteger

Metadata

Event TypePayload Version
comms.push-notification.received-unregistered-or-expired-tokenv1

JSON Payload Representation

{
  "push_notification_binding_id": "integer"
}

comms.transcription.created-v1

Event Properties

NameType
requiredaccount_numberstring
requiredcall_idinteger
requiredcall_keystring
requiredtranscript_keystring
requiredredacted_transcript_keystring
requiredbucketstring

Metadata

Event TypePayload Version
comms.transcription.createdv1

JSON Payload Representation

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

complex_quoting.cost_calculation_finished-v1

Event Properties

NameType
requiredquote_configuration_numberstring
requiredsucceededboolean
requiredtriggered_by_idinteger

Metadata

Event TypePayload Version
complex_quoting.cost_calculation_finishedv1

JSON Payload Representation

{
  "quote_configuration_number": "string",
  "succeeded": "boolean",
  "triggered_by_id": "integer"
}


consents-consents-_SigningIdentity

Event Properties

NameType
requiredidentity_typestring
requiredidentitystring

JSON Payload Representation

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

consents.consent.created-v1

Event Properties

NameType
requiredsigning_identityconsents-consents-_SigningIdentity
requiredconsentconsents-consents-_Consent

Metadata

Event TypePayload Version
consents.consent.createdv1

JSON Payload Representation

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

consents.consent.updated-v1

Event Properties

NameType
requiredsigning_identityconsents-consents-_SigningIdentity
requiredconsentconsents-consents-_Consent

Metadata

Event TypePayload Version
consents.consent.updatedv1

JSON Payload Representation

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

contract-groups.created-v1

Event Properties

NameType
requiredcontract_group_identifierstring
requiredgroup_typestring
requiredvalid_fromstring
valid_tostring
managing_party_identifierstring
external_identifierstring
namestring
requiredmemberships array[groups-_create-_Membership]
requiredtraits array[groups-_create-_Trait]

Metadata

Event TypePayload Version
contract-groups.createdv1

JSON Payload Representation

{
  "contract_group_identifier": "string",
  "group_type": "string",
  "valid_from": "string",
  "valid_to": "string",
  "managing_party_identifier": "string",
  "external_identifier": "string",
  "name": "string",
  "memberships": [
    {
      "contract_identifier": "string",
      "valid_from": "string",
      "valid_to": "string"
    }
  ],
  "traits": [
    {
      "identifier": "string",
      "type": "string",
      "data": "object"
    }
  ]
}

contract-groups.memberships-changed-v1

Event Properties

NameType
requiredcontract_group_identifierstring
requiredeffective_atstring
requiredmemberships_started array[groups-_memberships-_Membership]
requiredmemberships_ended array[groups-_memberships-_Membership]

Metadata

Event TypePayload Version
contract-groups.memberships-changedv1

JSON Payload Representation

{
  "contract_group_identifier": "string",
  "effective_at": "string",
  "memberships_started": [
    {
      "contract_identifier": "string",
      "valid_from": "string",
      "valid_to": "string"
    }
  ],
  "memberships_ended": [
    {
      "contract_identifier": "string",
      "valid_from": "string",
      "valid_to": "string"
    }
  ]
}

contract-groups.version-created-v1

Event Properties

NameType
requiredcontract_group_identifierstring
requiredeffective_periodgroups-_versions-_Period
requiredsuperseded_versions array[groups-_versions-_Version]
requiredcreated_versions array[groups-_versions-_Version]

Metadata

Event TypePayload Version
contract-groups.version-createdv1

JSON Payload Representation

{
  "contract_group_identifier": "string",
  "effective_period": {
    "start": "string",
    "end": "string"
  },
  "superseded_versions": [
    {
      "identifier": "string",
      "effective_period": {
        "start": "string",
        "end": "string"
      },
      "system_period": {
        "start": "string",
        "end": "string"
      },
      "traits": [
        {
          "identifier": "string",
          "type": "string",
          "data": "object"
        }
      ]
    }
  ],
  "created_versions": [
    {
      "identifier": "string",
      "effective_period": {
        "start": "string",
        "end": "string"
      },
      "system_period": {
        "start": "string",
        "end": "string"
      },
      "traits": [
        {
          "identifier": "string",
          "type": "string",
          "data": "object"
        }
      ]
    }
  ]
}

contracts.actualized-v1

Event Properties

NameType
requiredcontract_identifierstring
requiredversion_referenceinteger
requiredoccurred_atstring
requiredfor_subjectsarray[string]

Metadata

Event TypePayload Version
contracts.actualizedv1

JSON Payload Representation

{
  "contract_identifier": "string",
  "version_reference": "integer",
  "occurred_at": "string",
  "for_subjects": [
    "string"
  ]
}

contracts.created-v1

Event Properties

NameType
requiredcontract_identifierstring
requiredoccurred_atstring
sales_record_identifierstring

Metadata

Event TypePayload Version
contracts.createdv1

JSON Payload Representation

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

contracts.expired-v1

Event Properties

NameType
requiredcontract_identifierstring
requiredoccurred_atstring
requiredvalid_tostring

Metadata

Event TypePayload Version
contracts.expiredv1

JSON Payload Representation

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

contracts.expiry-approaching-v1

Event Properties

NameType
requiredcontract_identifierstring
requiredoccurred_atstring
requireddays_before_expiryinteger

Metadata

Event TypePayload Version
contracts.expiry-approachingv1

JSON Payload Representation

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

contracts.journeys.creation.started-v1

Event Properties

NameType
requiredcontract_journey_journeys-_common-ContractJourney
requiredcontract_identifierstring
requiredoccurred_atstring
requiredsubject_contract_journeys array[_journeys-_common-SubjectContractJourney]

Metadata

Event TypePayload Version
contracts.journeys.creation.startedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredcontract_journey_journeys-_common-ContractJourney
requiredcontract_identifierstring
requiredoccurred_atstring
requiredsubject_contract_journeys array[_journeys-_common-SubjectContractJourney]

Metadata

Event TypePayload Version
contracts.journeys.termination.startedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredcontract_journey_journeys-_common-ContractJourney
requiredcontract_identifierstring
requiredoccurred_atstring

Metadata

Event TypePayload Version
contracts.journeys.variation.startedv1

JSON Payload Representation

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

contracts.rescinded-v1

Event Properties

NameType
requiredcontract_identifierstring
requiredoccurred_atstring

Metadata

Event TypePayload Version
contracts.rescindedv1

JSON Payload Representation

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

contracts.revoked-v1

Event Properties

NameType
requiredcontract_identifierstring
requiredoccurred_atstring

Metadata

Event TypePayload Version
contracts.revokedv1

JSON Payload Representation

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

contracts.subject-amended-v1

Event Properties

NameType
requiredcontract_identifierstring
requiredoccurred_atstring
requiredadded array[_core-_amend_subject-AmendedSubject]
requiredupdated array[_core-_amend_subject-AmendedSubject]
requiredremoved array[_core-_amend_subject-AmendedSubject]

Metadata

Event TypePayload Version
contracts.subject-amendedv1

JSON Payload Representation

{
  "contract_identifier": "string",
  "occurred_at": "string",
  "added": [
    {
      "type": "string",
      "identifier": "string",
      "effective_from": "string",
      "effective_to": "string"
    }
  ],
  "updated": [
    {
      "type": "string",
      "identifier": "string",
      "effective_from": "string",
      "effective_to": "string"
    }
  ],
  "removed": [
    {
      "type": "string",
      "identifier": "string",
      "effective_from": "string",
      "effective_to": "string"
    }
  ]
}

contracts.terminated-v1

Event Properties

NameType
requiredcontract_identifierstring
requiredoccurred_atstring

Metadata

Event TypePayload Version
contracts.terminatedv1

JSON Payload Representation

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

contracts.terms-varied-v1

Event Properties

NameType
requiredcontract_identifierstring
requiredoccurred_atstring

Metadata

Event TypePayload Version
contracts.terms-variedv1

JSON Payload Representation

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

customer_access.partner_roles.created-v1

Event Properties

NameType
requiredcodestring
requiredpermissionsarray[string]

Metadata

Event TypePayload Version
customer_access.partner_roles.createdv1

JSON Payload Representation

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

customer_access.partner_roles.updated-v1

Event Properties

NameType
requiredcodestring
display_namestring
descriptionstring
permissionsarray[string]

Metadata

Event TypePayload Version
customer_access.partner_roles.updatedv1

JSON Payload Representation

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

customer_access.partner_user_roles.created-v1

Event Properties

NameType
requiredcodestring
requiredpermissionsarray[string]

Metadata

Event TypePayload Version
customer_access.partner_user_roles.createdv1

JSON Payload Representation

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

customer_access.partner_user_roles.updated-v1

Event Properties

NameType
requiredcodestring
display_namestring
descriptionstring
permissionsarray[string]

Metadata

Event TypePayload Version
customer_access.partner_user_roles.updatedv1

JSON Payload Representation

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

customer_access.user_roles.created-v1

Event Properties

NameType
requiredcodestring
requiredpermissionsarray[string]
requirednamestring

Metadata

Event TypePayload Version
customer_access.user_roles.createdv1

JSON Payload Representation

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

customer_access.user_roles.updated-v1

Event Properties

NameType
requiredcodestring
display_namestring
descriptionstring
permissionsarray[string]

Metadata

Event TypePayload Version
customer_access.user_roles.updatedv1

JSON Payload Representation

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

darwin-device-DispatchPayload

Event Properties

NameType
requiredbeginstring
requiredendstring
requiredpowerinteger

JSON Payload Representation

{
  "begin": "string",
  "end": "string",
  "power": "integer"
}

darwin-device-FlexDeviceDisconnectedPayload

Event Properties

NameType
requiredcausestring
requireddisconnected_socinteger

JSON Payload Representation

{
  "cause": "string",
  "disconnected_soc": "integer"
}

darwin-device-FlexDeviceOptimisationCreatedPayload

Event Properties

NameType
requireddispatches array[darwin-device-DispatchPayload]
requiredachievable_target_socinteger
requiredenergy_capacityinteger
requiredstart_socinteger
requireduser_target_socinteger
requiredoptimization_beginstring
requiredoptimization_endstring
requiredis_reoptimizationboolean
requiredforce_v1g_chargingboolean
requiredfleet_idstring

JSON Payload Representation

{
  "dispatches": [
    {
      "begin": "string",
      "end": "string",
      "power": "integer"
    }
  ],
  "achievable_target_soc": "integer",
  "energy_capacity": "integer",
  "start_soc": "integer",
  "user_target_soc": "integer",
  "optimization_begin": "string",
  "optimization_end": "string",
  "is_reoptimization": "boolean",
  "force_v1g_charging": "boolean",
  "fleet_id": "string"
}

data_import.import_process.cancelled-v1

Event Properties

NameType
requiredresource_typestring
requiredexternal_identifierstring
requiredexpiry_window_endstring

Metadata

Event TypePayload Version
data_import.import_process.cancelledv1

JSON Payload Representation

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

data_import.import_process.complete-v1

Event Properties

NameType
requiredresource_typestring
requiredexternal_identifierstring
requiredidentifierstring

Metadata

Event TypePayload Version
data_import.import_process.completev1

JSON Payload Representation

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

data_import.import_process.dry_run_complete-v1

Event Properties

NameType
requiredresource_typestring
requiredexternal_identifierstring

Metadata

Event TypePayload Version
data_import.import_process.dry_run_completev1

JSON Payload Representation

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

data_import.import_process.dry_run_error-v1

Event Properties

NameType
requiredresource_typestring
requiredexternal_identifierstring
requirederror_codestring
requirederror_detailstring

Metadata

Event TypePayload Version
data_import.import_process.dry_run_errorv1

JSON Payload Representation

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

data_import.import_process.error-v1

Event Properties

NameType
requiredresource_typestring
requiredexternal_identifierstring
requirederror_codestring
requirederror_detailstring

Metadata

Event TypePayload Version
data_import.import_process.errorv1

JSON Payload Representation

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

data_import.import_process.post_import.completed-v1

Event Properties

NameType
requiredresource_typestring
requiredimport_process_resource_typestring
requiredimport_process_external_identifierstring
requiredidentifierstring

Metadata

Event TypePayload Version
data_import.import_process.post_import.completedv1

JSON Payload Representation

{
  "resource_type": "string",
  "import_process_resource_type": "string",
  "import_process_external_identifier": "string",
  "identifier": "string"
}

data_import.import_process.post_import.error-v1

Event Properties

NameType
requiredresource_typestring
requiredimport_process_resource_typestring
requiredimport_process_external_identifierstring
requirederror_codestring
requirederror_detailstring

Metadata

Event TypePayload Version
data_import.import_process.post_import.errorv1

JSON Payload Representation

{
  "resource_type": "string",
  "import_process_resource_type": "string",
  "import_process_external_identifier": "string",
  "error_code": "string",
  "error_detail": "string"
}

data_import.order_process.cancelled-v1

Event Properties

NameType
requiredexternal_order_idstring
requiredexpiry_window_endstring

Metadata

Event TypePayload Version
data_import.order_process.cancelledv1

JSON Payload Representation

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

data_import.order_process.complete-v1

Event Properties

NameType
requiredexternal_order_idstring
requiredprocess_idstring

Metadata

Event TypePayload Version
data_import.order_process.completev1

JSON Payload Representation

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

data_import.order_process.error-v1

Event Properties

NameType
requiredexternal_order_idstring
requirederror_codestring
requirederror_detailstring

Metadata

Event TypePayload Version
data_import.order_process.errorv1

JSON Payload Representation

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

debt.actioning.automated_debt_write_back.completed-v1

Event Properties

NameType
requiredledger_numberstring
requiredaccount_numberstring
requiredamountinteger

Metadata

Event TypePayload Version
debt.actioning.automated_debt_write_back.completedv1

JSON Payload Representation

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

debt.actioning.automated_debt_write_back.failed-v1

Event Properties

NameType
requiredledger_numberstring
requiredaccount_numberstring
requiredreasonstring
requiredexceptionstring

Metadata

Event TypePayload Version
debt.actioning.automated_debt_write_back.failedv1

JSON Payload Representation

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

debt.actioning.automated_debt_write_back.skipped-v1

Event Properties

NameType
requiredledger_numberstring
requiredaccount_numberstring
requiredreasonstring

Metadata

Event TypePayload Version
debt.actioning.automated_debt_write_back.skippedv1

JSON Payload Representation

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

delinquent_debt.position_changed-v1

Event Properties

NameType
requiredledger_numberstring
requiredchanged_onstring
requiredprevious_valueinteger
requirednew_valueinteger

Metadata

Event TypePayload Version
delinquent_debt.position_changedv1

JSON Payload Representation

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

delinquent_debt.position_changed-v2

Event Properties

NameType
requiredledger_numberstring
requiredchanged_onstring
requiredprevious_valueinteger
requirednew_valueinteger
requiredaccount_numberstring

Metadata

Event TypePayload Version
delinquent_debt.position_changedv2

JSON Payload Representation

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

deposit_agreement.accepted-v1

Event Properties

NameType
requireddeposit_keystring
requiredreasonstring
requiredamountinteger
requiredaccount_numberstring
requiredledger_identifierstring
requiredaccepted_atstring

Metadata

Event TypePayload Version
deposit_agreement.acceptedv1

JSON Payload Representation

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

deposit_agreement.fulfilled-v1

Event Properties

NameType
requireddeposit_keystring
requiredreasonstring
requiredamountinteger
requiredaccount_numberstring
requiredledger_identifierstring
requiredfulfilled_atstring

Metadata

Event TypePayload Version
deposit_agreement.fulfilledv1

JSON Payload Representation

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

deposit_agreement.instalment_returned-v1

Event Properties

NameType
requireddeposit_keystring
requiredreasonstring
requiredamountinteger
requiredaccount_numberstring
requiredledger_identifierstring
requiredreturned_amountinteger
requiredreturned_atstring

Metadata

Event TypePayload Version
deposit_agreement.instalment_returnedv1

JSON Payload Representation

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

deposit_agreement.returned-v1

Event Properties

NameType
requireddeposit_keystring
requiredreasonstring
requiredamountinteger
requiredaccount_numberstring
requiredledger_identifierstring
requiredreturned_atstring

Metadata

Event TypePayload Version
deposit_agreement.returnedv1

JSON Payload Representation

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

deposit_agreement.withdrawn-v1

Event Properties

NameType
requireddeposit_keystring
requiredreasonstring
requiredamountinteger
requiredaccount_numberstring
requiredledger_identifierstring
requiredwithdrawn_atstring

Metadata

Event TypePayload Version
deposit_agreement.withdrawnv1

JSON Payload Representation

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

dunning_path_paused-v1

Event Properties

NameType
requiredaccount_numberstring
requireddunning_path_namestring
requireddunning_process_idstring
requiredpause_start_datestring
requiredpause_end_datestring
requiredcreated_notestring

Metadata

Event TypePayload Version
dunning_path_pausedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requireddunning_path_namestring
requireddunning_process_idstring
requiredaccount_numberstring
requiredcreated_notestring
requiredstart_datestring

Metadata

Event TypePayload Version
dunning_path_startedv1

JSON Payload Representation

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

dunning_path_unpaused-v1

Event Properties

NameType
requiredaccount_numberstring
requireddunning_path_namestring
requireddunning_process_idstring

Metadata

Event TypePayload Version
dunning_path_unpausedv1

JSON Payload Representation

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

dunning_path_withdrawn-v1

Event Properties

NameType
requiredaccount_numberstring
requireddunning_path_namestring
requireddunning_process_idstring
requiredwithdrawn_datestring
requiredwithdrawn_notestring

Metadata

Event TypePayload Version
dunning_path_withdrawnv1

JSON Payload Representation

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

external_messaging.uploaded_file.safe-v1

Event Properties

NameType
requiredfile_referencestring

Metadata

Event TypePayload Version
external_messaging.uploaded_file.safev1

JSON Payload Representation

{
  "file_reference": "string"
}

external_messaging.uploaded_file.unsafe-v1

Event Properties

NameType
requiredfile_referencestring

Metadata

Event TypePayload Version
external_messaging.uploaded_file.unsafev1

JSON Payload Representation

{
  "file_reference": "string"
}

flex_device.deauthenticated-v1

Event Properties

NameType
requiredaccount_numberstring
requiredproperty_idinteger
requireddevice_idstring
requiredsite_idstring
requireddevice_typestring
payloadobject

Metadata

Event TypePayload Version
flex_device.deauthenticatedv1

JSON Payload Representation

{
  "account_number": "string",
  "property_id": "integer",
  "device_id": "string",
  "site_id": "string",
  "device_type": "string",
  "payload": "object"
}

flex_device.disconnected-v1

Event Properties

NameType
requiredaccount_numberstring
requiredproperty_idinteger
requireddevice_idstring
requiredsite_idstring
requireddevice_typestring
requiredpayloaddarwin-device-FlexDeviceDisconnectedPayload

Metadata

Event TypePayload Version
flex_device.disconnectedv1

JSON Payload Representation

{
  "account_number": "string",
  "property_id": "integer",
  "device_id": "string",
  "site_id": "string",
  "device_type": "string",
  "payload": {
    "cause": "string",
    "disconnected_soc": "integer"
  }
}

flex_device.optimisation_created-v1

Event Properties

NameType
requiredaccount_numberstring
requiredproperty_idinteger
requireddevice_idstring
requiredsite_idstring
requireddevice_typestring
requiredpayloaddarwin-device-FlexDeviceOptimisationCreatedPayload

Metadata

Event TypePayload Version
flex_device.optimisation_createdv1

JSON Payload Representation

{
  "account_number": "string",
  "property_id": "integer",
  "device_id": "string",
  "site_id": "string",
  "device_type": "string",
  "payload": {
    "dispatches": [
      {
        "begin": "string",
        "end": "string",
        "power": "integer"
      }
    ],
    "achievable_target_soc": "integer",
    "energy_capacity": "integer",
    "start_soc": "integer",
    "user_target_soc": "integer",
    "optimization_begin": "string",
    "optimization_end": "string",
    "is_reoptimization": "boolean",
    "force_v1g_charging": "boolean",
    "fleet_id": "string"
  }
}

flex_device.registered-v1

Event Properties

NameType
requiredaccount_numberstring
requiredproperty_idinteger
requireddevice_idstring
requiredsite_idstring
requireddevice_typestring
payloadobject

Metadata

Event TypePayload Version
flex_device.registeredv1

JSON Payload Representation

{
  "account_number": "string",
  "property_id": "integer",
  "device_id": "string",
  "site_id": "string",
  "device_type": "string",
  "payload": "object"
}

goods.purchase-created-v1

Event Properties

NameType
requiredpurchase_idinteger
requiredaccount_idinteger
support_user_idinteger

Metadata

Event TypePayload Version
goods.purchase-createdv1

JSON Payload Representation

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

goods.quote.created-for-account-v1

Event Properties

NameType
requiredaccount_numberstring
requiredmarket_namestring
requiredquote_idinteger
requiredclient_paramsobject
requiredlead_idinteger

Metadata

Event TypePayload Version
goods.quote.created-for-accountv1

JSON Payload Representation

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

goods.quote.created-without-account-v1

Event Properties

NameType
requiredmarket_namestring
requiredquote_idinteger
requiredcontact_infoobject
requiredclient_paramsobject
requiredlead_idinteger

Metadata

Event TypePayload Version
goods.quote.created-without-accountv1

JSON Payload Representation

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

groups-_create-_Membership

Event Properties

NameType
requiredcontract_identifierstring
requiredvalid_fromstring
valid_tostring

JSON Payload Representation

{
  "contract_identifier": "string",
  "valid_from": "string",
  "valid_to": "string"
}

groups-_create-_Trait

Event Properties

NameType
requiredidentifierstring
requiredtypestring
requireddataobject

JSON Payload Representation

{
  "identifier": "string",
  "type": "string",
  "data": "object"
}

groups-_memberships-_Membership

Event Properties

NameType
requiredcontract_identifierstring
requiredvalid_fromstring
requiredvalid_tostring

JSON Payload Representation

{
  "contract_identifier": "string",
  "valid_from": "string",
  "valid_to": "string"
}

groups-_versions-_Period

Event Properties

NameType
requiredstartstring
requiredendstring

JSON Payload Representation

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

groups-_versions-_Trait

Event Properties

NameType
requiredidentifierstring
requiredtypestring
requireddataobject

JSON Payload Representation

{
  "identifier": "string",
  "type": "string",
  "data": "object"
}

groups-_versions-_Version

Event Properties

NameType
requiredidentifierstring
requiredeffective_periodgroups-_versions-_Period
requiredsystem_periodgroups-_versions-_Period
requiredtraits array[groups-_versions-_Trait]

JSON Payload Representation

{
  "identifier": "string",
  "effective_period": {
    "start": "string",
    "end": "string"
  },
  "system_period": {
    "start": "string",
    "end": "string"
  },
  "traits": [
    {
      "identifier": "string",
      "type": "string",
      "data": "object"
    }
  ]
}

industry.electricity.change_of_energisation.unsolicited_message-v1

Event Properties

NameType
requiredmpanstring
requiredenergisation_statusstring
requiredeffective_fromstring

Metadata

Event TypePayload Version
industry.electricity.change_of_energisation.unsolicited_messagev1

JSON Payload Representation

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

industry.electricity.change_of_service.meter_deactivated-v1

Event Properties

NameType
requiredmpanstring
requiredserial_numberstring
requiredeffective_fromstring

Metadata

Event TypePayload Version
industry.electricity.change_of_service.meter_deactivatedv1

JSON Payload Representation

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

industry.electricity.change_of_supply.gain.initiated-v1

Event Properties

NameType
requiredmeter_point_identifierstring

Metadata

Event TypePayload Version
industry.electricity.change_of_supply.gain.initiatedv1

JSON Payload Representation

{
  "meter_point_identifier": "string"
}

industry.electricity.change_of_supply.loss.complete-v1

Event Properties

NameType
requiredaccount_numberstring
requiredmpanstring
requiredsupply_end_datestring
requirednew_supplier_idstring

Metadata

Event TypePayload Version
industry.electricity.change_of_supply.loss.completev1

JSON Payload Representation

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

industry.electricity.export_installation.validated-v1

Event Properties

NameType
requiredimport_mpanstring
requiredaccount_numberstring
requiredproduct_codestring
requiredmanual_declared_net_capacitystring
requiredmanual_technology_typestring
requiredvalid_mcs_installationsarray[object]
requiredjourney_identifierstring

Metadata

Event TypePayload Version
industry.electricity.export_installation.validatedv1

JSON Payload Representation

{
  "import_mpan": "string",
  "account_number": "string",
  "product_code": "string",
  "manual_declared_net_capacity": "string",
  "manual_technology_type": "string",
  "valid_mcs_installations": [
    "object"
  ],
  "journey_identifier": "string"
}

industry.electricity.export_installation.validated-v2

Event Properties

NameType
requiredimport_mpanstring
requiredexport_mpanstring
requiredaccount_numberstring
requiredproduct_codestring
requiredmanual_declared_net_capacitystring
requiredmanual_technology_typestring
requiredvalid_mcs_installationsarray[object]
requiredjourney_identifierstring

Metadata

Event TypePayload Version
industry.electricity.export_installation.validatedv2

JSON Payload Representation

{
  "import_mpan": "string",
  "export_mpan": "string",
  "account_number": "string",
  "product_code": "string",
  "manual_declared_net_capacity": "string",
  "manual_technology_type": "string",
  "valid_mcs_installations": [
    "object"
  ],
  "journey_identifier": "string"
}

industry.gas.change_of_supply.gain.initiated-v1

Event Properties

NameType
requiredmeter_point_identifierstring

Metadata

Event TypePayload Version
industry.gas.change_of_supply.gain.initiatedv1

JSON Payload Representation

{
  "meter_point_identifier": "string"
}

industry.gas.change_of_supply.loss.complete-v1

Event Properties

NameType
requiredaccount_numberstring
requiredmprnstring
requiredsupply_end_datestring
requirednew_supplier_idstring

Metadata

Event TypePayload Version
industry.gas.change_of_supply.loss.completev1

JSON Payload Representation

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

ink-_actions-_InkAction

Event Properties

NameType
requiredcodestring
requiredsucceededboolean
requiredstop_further_evaluationboolean

JSON Payload Representation

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

ink-_content-_InkContent

Event Properties

NameType
from_addressstring
subjectstring
to_addressesarray[string]
requiredtagsarray[string]

JSON Payload Representation

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

ink-_content-_InkMessageContent

Event Properties

NameType
requiredmessage_idinteger
requiredoccurred_atstring
requiredchannelstring
requiredcontentink-_content-_InkContent

JSON Payload Representation

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

ink-_messages-InkConversation

Event Properties

NameType
requiredconversation_relay_idstring
requiredaccount_numberstring
requiredmessageink-_messages-_InkMessage

JSON Payload Representation

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

ink-_messages-_InkFailureData

Event Properties

NameType
requiredtypestring
requiredreasonstring
requiredoccurred_atstring

JSON Payload Representation

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

ink-_messages-_InkMessage

Event Properties

NameType
requiredrelay_idstring
requiredvendor_idstring
requiredchannelstring
requiredoccurred_atstring

JSON Payload Representation

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

ink-_messages-_InkMessageWithVendor

Event Properties

NameType
requiredrelay_idstring
requiredvendorstring
requiredvendor_idstring
requiredchannelstring
requiredoccurred_atstring

JSON Payload Representation

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

ink.actions.run-v1

Event Properties

NameType
requiredconversation_relay_idstring
requiredmessage_relay_idstring
requiredactions_results array[ink-_actions-_InkAction]

Metadata

Event TypePayload Version
ink.actions.runv1

JSON Payload Representation

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

ink.content.inbound-message-tagged-v1

Event Properties

NameType
requiredconversation_idinteger
requiredconversation_relay_idstring
requiredaccount_numberstring
requiredmessageink-_content-_InkMessageContent

Metadata

Event TypePayload Version
ink.content.inbound-message-taggedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredconversation_relay_idstring
requiredbucket_relay_idstring
requiredsupport_user_idinteger
requiredorganisation_idinteger
requiredactor_typestring
requiredactor_idinteger

Metadata

Event TypePayload Version
ink.conversation.assigned_to_bucketv1

JSON Payload Representation

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

ink.conversation.assigned_to_timeline-v1

Event Properties

NameType
requiredconversation_relay_idstring
requiredtimeline_relay_idstring
requiredsupport_user_idinteger

Metadata

Event TypePayload Version
ink.conversation.assigned_to_timelinev1

JSON Payload Representation

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

ink.conversation.await_customer_reply-v1

Event Properties

NameType
requiredconversation_idinteger
requiredconversation_relay_idstring
requiredaccount_numberstring
requiredlatest_contacted_account_user_numberstring
requiredsupport_user_idinteger
requiredactor_typestring
requiredactor_idinteger
requiredorganisation_idinteger

Metadata

Event TypePayload Version
ink.conversation.await_customer_replyv1

JSON Payload Representation

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

ink.conversation.closed-v1

Event Properties

NameType
requiredconversation_idinteger
requiredconversation_relay_idstring
requiredaccount_numberstring
requiredlatest_contacted_account_user_numberstring
requiredsupport_user_idinteger
requiredactor_typestring
requiredactor_idinteger
requiredorganisation_idinteger
requiredclosed_atstring
requiredreasonstring

Metadata

Event TypePayload Version
ink.conversation.closedv1

JSON Payload Representation

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

ink.conversation.open_status_changed-v1

Event Properties

NameType
requiredconversation_idinteger
requiredconversation_relay_idstring
requiredaccount_numberstring
requiredlatest_contacted_account_user_numberstring
requiredsupport_user_idinteger
requiredactor_typestring
requiredactor_idinteger
requiredorganisation_idinteger
requirednew_statusstring
requiredprevious_statusstring

Metadata

Event TypePayload Version
ink.conversation.open_status_changedv1

JSON Payload Representation

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

ink.conversation.opened-v1

Event Properties

NameType
requiredconversation_idinteger
requiredconversation_relay_idstring
requiredaccount_numberstring
requiredlatest_contacted_account_user_numberstring
requiredsupport_user_idinteger
requiredactor_typestring
requiredactor_idinteger
requiredorganisation_idinteger

Metadata

Event TypePayload Version
ink.conversation.openedv1

JSON Payload Representation

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

ink.conversation.priority.changed-v1

Event Properties

NameType
requiredconversation_idinteger
requiredconversation_relay_idstring
requiredold_prioritynumber
requirednew_prioritynumber
requiredprioritized_atstring
requiredmessage_idinteger
requiredmessage_relay_idstring
requiredaccount_numberstring
requiredlatest_contacted_account_user_numberstring
requiredsupport_user_idinteger
requiredorganisation_idinteger

Metadata

Event TypePayload Version
ink.conversation.priority.changedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredconversation_idinteger
requiredconversation_relay_idstring
requiredaccount_numberstring
requiredlatest_contacted_account_user_numberstring
requiredsupport_user_idinteger
requiredactor_typestring
requiredactor_idinteger
requiredorganisation_idinteger
requiredsnoozed_tostring
requiredink_note_relay_idstring

Metadata

Event TypePayload Version
ink.conversation.snoozedv1

JSON Payload Representation

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

ink.conversation.unassigned_from_bucket-v1

Event Properties

NameType
requiredconversation_relay_idstring
requiredbucket_relay_idstring
requiredsupport_user_idinteger
requiredorganisation_idinteger
requiredactor_typestring
requiredactor_idinteger

Metadata

Event TypePayload Version
ink.conversation.unassigned_from_bucketv1

JSON Payload Representation

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

ink.conversation.unassigned_from_timeline-v1

Event Properties

NameType
requiredconversation_relay_idstring
requiredtimeline_relay_idstring
requiredsupport_user_idinteger

Metadata

Event TypePayload Version
ink.conversation.unassigned_from_timelinev1

JSON Payload Representation

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

ink.live-chat.closed-v1

Event Properties

NameType
requiredlive_chat_conversation_relay_idstring
requiredclose_reasonstring
account_numberstring

Metadata

Event TypePayload Version
ink.live-chat.closedv1

JSON Payload Representation

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

ink.live-chat.initiated-v1

Event Properties

NameType
requiredlive_chat_conversationink-_messages-InkConversation

Metadata

Event TypePayload Version
ink.live-chat.initiatedv1

JSON Payload Representation

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

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

Event Properties

NameType
requiredlive_chat_conversationink-_messages-InkConversation

Metadata

Event TypePayload Version
ink.live-chat.messages.outbound-message-createdv1

JSON Payload Representation

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

ink.message_attachment.safe-v1

Event Properties

NameType
requiredfilenamestring
requireds3_keystring
requireds3_bucketstring
requiredsize_in_bytesinteger

Metadata

Event TypePayload Version
ink.message_attachment.safev1

JSON Payload Representation

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

ink.message_attachment.unsafe-v1

Event Properties

NameType
requiredfilenamestring
requireds3_keystring
requireds3_bucketstring
requiredsize_in_bytesinteger

Metadata

Event TypePayload Version
ink.message_attachment.unsafev1

JSON Payload Representation

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

ink.messages.inbound-email-migration-v1

Event Properties

NameType
requiredmessage_idstring
requireds3_keystring
requireds3_bucketstring

Metadata

Event TypePayload Version
ink.messages.inbound-email-migrationv1

JSON Payload Representation

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

ink.messages.inbound-message-created-v1

Event Properties

NameType
requiredconversation_relay_idstring
requiredaccount_numberstring
requiredmessageink-_messages-_InkMessage

Metadata

Event TypePayload Version
ink.messages.inbound-message-createdv1

JSON Payload Representation

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

ink.messages.inbound-message-ingested-v1

Event Properties

NameType
requiredchannelstring
requiredvendorstring
requiredvendor_idstring
requiredmessage_relay_idstring

Metadata

Event TypePayload Version
ink.messages.inbound-message-ingestedv1

JSON Payload Representation

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

ink.messages.outbound-message-created-v1

Event Properties

NameType
requiredconversation_relay_idstring
requiredaccount_numberstring
requiredmessageink-_messages-_InkMessage

Metadata

Event TypePayload Version
ink.messages.outbound-message-createdv1

JSON Payload Representation

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

ink.messages.outbound-message-failed-v1

Event Properties

NameType
requiredconversation_relay_idstring
requiredmessageink-_messages-_InkMessageWithVendor
requiredfailureink-_messages-_InkFailureData

Metadata

Event TypePayload Version
ink.messages.outbound-message-failedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredconversation_relay_idstring
requiredaccount_numberstring
requiredmessageink-_messages-_InkMessage

Metadata

Event TypePayload Version
ink.messages.phishing-report-dismissedv1

JSON Payload Representation

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

ink.messages.reported-phishing-v1

Event Properties

NameType
requiredconversation_relay_idstring
requiredaccount_numberstring
requiredmessageink-_messages-_InkMessage

Metadata

Event TypePayload Version
ink.messages.reported-phishingv1

JSON Payload Representation

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

ink.messages.reported-spam-v1

Event Properties

NameType
requiredconversation_relay_idstring
requiredaccount_numberstring
requiredmessageink-_messages-_InkMessage

Metadata

Event TypePayload Version
ink.messages.reported-spamv1

JSON Payload Representation

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

ink.messages.spam-report-dismissed-v1

Event Properties

NameType
requiredconversation_relay_idstring
requiredaccount_numberstring
requiredmessageink-_messages-_InkMessage

Metadata

Event TypePayload Version
ink.messages.spam-report-dismissedv1

JSON Payload Representation

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

internal_company.created-v1

Event Properties

NameType
requiredidstring
requiredactorobject
requireddisplayable_numberstring
requirednamestring
requiredprimary_registration_numberstring
requiredsecondary_registration_numberstring
requiredprimary_tax_identifier_numberstring
requiredlegal_addressobject

Metadata

Event TypePayload Version
internal_company.createdv1

JSON Payload Representation

{
  "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"
}

ita.supply_point_registry.active_supply_point_missing_from_rcu-v1

Event Properties

NameType
requiredsupply_point_external_identifierstring
requiredreference_datestring
requiredmarketstring

Metadata

Event TypePayload Version
ita.supply_point_registry.active_supply_point_missing_from_rcuv1

JSON Payload Representation

{
  "supply_point_external_identifier": "string",
  "reference_date": "string",
  "market": "string"
}

ita.supply_point_registry.supply_point_update.new_entry_for_found_inconsistency-v1

Event Properties

NameType
requiredsupply_point_external_identifierstring
requiredreference_datestring
requiredsystem_paramsobject
requiredexternal_paramsobject

Metadata

Event TypePayload Version
ita.supply_point_registry.supply_point_update.new_entry_for_found_inconsistencyv1

JSON Payload Representation

{
  "supply_point_external_identifier": "string",
  "reference_date": "string",
  "system_params": "object",
  "external_params": "object"
}

ita.supply_point_registry.supply_point_update.new_entry_for_missing_config_period-v1

Event Properties

NameType
requiredsupply_point_external_identifierstring
requiredreference_datestring

Metadata

Event TypePayload Version
ita.supply_point_registry.supply_point_update.new_entry_for_missing_config_periodv1

JSON Payload Representation

{
  "supply_point_external_identifier": "string",
  "reference_date": "string"
}

ita.supply_point_registry.supply_point_update.new_entry_for_supply_point_not_on_supply-v1

Event Properties

NameType
requiredsupply_point_external_identifierstring
requiredreference_datestring

Metadata

Event TypePayload Version
ita.supply_point_registry.supply_point_update.new_entry_for_supply_point_not_on_supplyv1

JSON Payload Representation

{
  "supply_point_external_identifier": "string",
  "reference_date": "string"
}

ita_industry.active-cancellation.admissibility-received-v1

Event Properties

NameType
requiredindustry_request_idstring
requiredis_admissibleboolean
requiredreason_codeinteger

Metadata

Event TypePayload Version
ita_industry.active-cancellation.admissibility-receivedv1

JSON Payload Representation

{
  "industry_request_id": "string",
  "is_admissible": "boolean",
  "reason_code": "integer"
}

ita_industry.active-cancellation.admissibility-received-v2

Event Properties

NameType
requiredindustry_request_idstring
requiredcancellation_industry_request_idstring
requiredcancellation_kraken_request_idstring
requiredis_admissibleboolean
requiredreason_codeinteger

Metadata

Event TypePayload Version
ita_industry.active-cancellation.admissibility-receivedv2

JSON Payload Representation

{
  "industry_request_id": "string",
  "cancellation_industry_request_id": "string",
  "cancellation_kraken_request_id": "string",
  "is_admissible": "boolean",
  "reason_code": "integer"
}

ita_industry.active-cancellation.outcome-received-v1

Event Properties

NameType
requiredindustry_request_idstring
requiredis_cancelledboolean
requiredreason_codeinteger

Metadata

Event TypePayload Version
ita_industry.active-cancellation.outcome-receivedv1

JSON Payload Representation

{
  "industry_request_id": "string",
  "is_cancelled": "boolean",
  "reason_code": "integer"
}

ita_industry.active-cancellation.outcome-received-v2

Event Properties

NameType
requiredindustry_request_idstring
requiredcancellation_industry_request_idstring
requiredcancellation_kraken_request_idstring
requiredis_cancelledboolean
requiredreason_codeinteger

Metadata

Event TypePayload Version
ita_industry.active-cancellation.outcome-receivedv2

JSON Payload Representation

{
  "industry_request_id": "string",
  "cancellation_industry_request_id": "string",
  "cancellation_kraken_request_id": "string",
  "is_cancelled": "boolean",
  "reason_code": "integer"
}

ita_industry.cancellation-request.sent-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredsent_atstring

Metadata

Event TypePayload Version
ita_industry.cancellation-request.sentv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "sent_at": "string"
}

ita_industry.change-of-ownership-pre-check.response-received-v1

Event Properties

NameType
requiredis_admissibleboolean
requirederror_codeinteger
requirederror_motivationstring
requiredindustry_request_idstring
requiredkraken_request_idstring
requiredpodstring
requiredpod_statusboolean
requiredmean_annual_powerstring
requiredvoltageinteger
requiredaddressobject
requiredmarket_typestring
requiredcommitted_powernumber
requiredavailable_powernumber
requiredcrpp_f1_aamnumber
requiredcrpp_f2_aamnumber
requiredcrpp_f3_aamnumber
requiredcrpp_f1_aam1number
requiredcrpp_f2_aam1number
requiredcrpp_f3_aam1number

Metadata

Event TypePayload Version
ita_industry.change-of-ownership-pre-check.response-receivedv1

JSON Payload Representation

{
  "is_admissible": "boolean",
  "error_code": "integer",
  "error_motivation": "string",
  "industry_request_id": "string",
  "kraken_request_id": "string",
  "pod": "string",
  "pod_status": "boolean",
  "mean_annual_power": "string",
  "voltage": "integer",
  "address": "object",
  "market_type": "string",
  "committed_power": "number",
  "available_power": "number",
  "crpp_f1_aam": "number",
  "crpp_f2_aam": "number",
  "crpp_f3_aam": "number",
  "crpp_f1_aam1": "number",
  "crpp_f2_aam1": "number",
  "crpp_f3_aam1": "number"
}

ita_industry.change-of-ownership-pre-check.response-received-v2

Event Properties

NameType
requiredis_admissibleboolean
requirederror_codeinteger
requirederror_motivationstring
requiredindustry_request_idstring
requiredkraken_request_idstring
requiredpodstring
requiredpod_statusboolean
requiredmean_annual_powerstring
requiredvoltageinteger
requiredaddressobject
requiredmarket_typestring
requiredcommitted_powernumber
requiredavailable_powernumber
requiredcrpp_f1_aamnumber
requiredcrpp_f2_aamnumber
requiredcrpp_f3_aamnumber
requiredcrpp_f1_aam1number
requiredcrpp_f2_aam1number
requiredcrpp_f3_aam1number
requiredrecent_switch_datesarray[string]
requiredrecent_voltura_tit_iii_datesarray[string]
requiredrecent_voltura_tit_iv_datesarray[string]

Metadata

Event TypePayload Version
ita_industry.change-of-ownership-pre-check.response-receivedv2

JSON Payload Representation

{
  "is_admissible": "boolean",
  "error_code": "integer",
  "error_motivation": "string",
  "industry_request_id": "string",
  "kraken_request_id": "string",
  "pod": "string",
  "pod_status": "boolean",
  "mean_annual_power": "string",
  "voltage": "integer",
  "address": "object",
  "market_type": "string",
  "committed_power": "number",
  "available_power": "number",
  "crpp_f1_aam": "number",
  "crpp_f2_aam": "number",
  "crpp_f3_aam": "number",
  "crpp_f1_aam1": "number",
  "crpp_f2_aam1": "number",
  "crpp_f3_aam1": "number",
  "recent_switch_dates": [
    "string"
  ],
  "recent_voltura_tit_iii_dates": [
    "string"
  ],
  "recent_voltura_tit_iv_dates": [
    "string"
  ]
}

ita_industry.change-of-ownership-switch-out.notice-received-v1

Event Properties

NameType
requiredpodstring
requiredswitch_out_datestring
requiredindustry_request_idstring

Metadata

Event TypePayload Version
ita_industry.change-of-ownership-switch-out.notice-receivedv1

JSON Payload Representation

{
  "pod": "string",
  "switch_out_date": "string",
  "industry_request_id": "string"
}

ita_industry.change-of-ownership.admissibility-received-v1

Event Properties

NameType
requiredis_admissibleboolean
requirederror_codeinteger
requirederror_motivationstring
requiredpodstring
requiredindustry_request_idstring
requiredkraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.change-of-ownership.admissibility-receivedv1

JSON Payload Representation

{
  "is_admissible": "boolean",
  "error_code": "integer",
  "error_motivation": "string",
  "pod": "string",
  "industry_request_id": "string",
  "kraken_request_id": "string"
}

ita_industry.change-of-ownership.cancellation-admissibility-received-v1

Event Properties

NameType
requiredis_admissibleboolean
requirederror_codeinteger
requirederror_motivationstring
requiredindustry_request_idstring
requiredkraken_request_idstring
requiredpodstring

Metadata

Event TypePayload Version
ita_industry.change-of-ownership.cancellation-admissibility-receivedv1

JSON Payload Representation

{
  "is_admissible": "boolean",
  "error_code": "integer",
  "error_motivation": "string",
  "industry_request_id": "string",
  "kraken_request_id": "string",
  "pod": "string"
}

ita_industry.change-of-ownership.non-udd-contract-activation-response-received-v1

Event Properties

NameType
requiredpodstring
requiredindustry_request_idstring
requiredfiscal_codestring
requiredvat_numberstring
requiredis_foreign_fiscal_codeboolean
requiredgiven_namestring
requiredfamily_namestring
requiredcompany_namestring
requiredemailstring
requiredtelephonestring
requiredbilling_address_electricity-_change_of_ownership_not_udd_response-BillingAddress
requiredresidence_address_electricity-_change_of_ownership_not_udd_response-ResidenceAddress
requiredchange_of_ownership_typestring
requiredcontract_typestring
requiredcustomer_typestring
requiredstart_datestring
requiredstart_date_recoverystring
requiredvatinteger
requiredexcisenumber
requiredprovincial_surtaxnumber
requiredmunicipal_surtaxnumber
requiredother_tax_informationstring
requiredmarket_typestring
requiredoffice_codestring
requiredpayment_vatstring
requiredmerchandise_codestring
requiredoffer_codestring
requiredself_certificationboolean

Metadata

Event TypePayload Version
ita_industry.change-of-ownership.non-udd-contract-activation-response-receivedv1

JSON Payload Representation

{
  "pod": "string",
  "industry_request_id": "string",
  "fiscal_code": "string",
  "vat_number": "string",
  "is_foreign_fiscal_code": "boolean",
  "given_name": "string",
  "family_name": "string",
  "company_name": "string",
  "email": "string",
  "telephone": "string",
  "billing_address": {
    "street_type": "string",
    "street_name": "string",
    "street_number": "string",
    "postcode": "string",
    "istat_code": "string",
    "city": "string",
    "province": "string",
    "country": "string",
    "additional_info": "string"
  },
  "residence_address": {
    "street_type": "string",
    "street_name": "string",
    "street_number": "string",
    "postcode": "string",
    "istat_code": "string",
    "city": "string",
    "province": "string",
    "country": "string",
    "additional_info": "string"
  },
  "change_of_ownership_type": "string",
  "contract_type": "string",
  "customer_type": "string",
  "start_date": "string",
  "start_date_recovery": "string",
  "vat": "integer",
  "excise": "number",
  "provincial_surtax": "number",
  "municipal_surtax": "number",
  "other_tax_information": "string",
  "market_type": "string",
  "office_code": "string",
  "payment_vat": "string",
  "merchandise_code": "string",
  "offer_code": "string",
  "self_certification": "boolean"
}

ita_industry.change-of-ownership.response-received-v1

Event Properties

NameType
requiredindustry_request_idstring
requiredkraken_request_idstring
requiredis_approvedboolean
requirederror_codeinteger
requirederror_motivationstring
requiredpodstring
requiredfiscal_codestring
requiredvat_numberstring
requiredis_foreign_fiscal_codeboolean
requirednamestring
requiredsurnamestring
requiredcompany_namestring
requiredstart_datestring

Metadata

Event TypePayload Version
ita_industry.change-of-ownership.response-receivedv1

JSON Payload Representation

{
  "industry_request_id": "string",
  "kraken_request_id": "string",
  "is_approved": "boolean",
  "error_code": "integer",
  "error_motivation": "string",
  "pod": "string",
  "fiscal_code": "string",
  "vat_number": "string",
  "is_foreign_fiscal_code": "boolean",
  "name": "string",
  "surname": "string",
  "company_name": "string",
  "start_date": "string"
}

ita_industry.functional-data.received-v1

Event Properties

NameType
requiredpodstring
requiredeffective_fromstring
requiredindustry_request_idstring
requiredkraken_request_idstring
request_correlation_idstring
meter_serial_numberstring
voltageinteger
committed_powerstring
available_powerstring
is_residentboolean
is_disconnectableboolean
supply_point_handlingstring
meter_point_typestring
tariff_codestring

Metadata

Event TypePayload Version
ita_industry.functional-data.receivedv1

JSON Payload Representation

{
  "pod": "string",
  "effective_from": "string",
  "industry_request_id": "string",
  "kraken_request_id": "string",
  "request_correlation_id": "string",
  "meter_serial_number": "string",
  "voltage": "integer",
  "committed_power": "string",
  "available_power": "string",
  "is_resident": "boolean",
  "is_disconnectable": "boolean",
  "supply_point_handling": "string",
  "meter_point_type": "string",
  "tariff_code": "string"
}

ita_industry.functional-data.received-v2

Event Properties

NameType
requiredpodstring
requiredeffective_fromstring
requiredindustry_request_idstring
meter_serial_numberstring
voltageinteger
committed_powerstring
available_powerstring
is_residentboolean
is_disconnectableboolean
supply_point_handlingstring
meter_point_typestring
tariff_codestring

Metadata

Event TypePayload Version
ita_industry.functional-data.receivedv2

JSON Payload Representation

{
  "pod": "string",
  "effective_from": "string",
  "industry_request_id": "string",
  "meter_serial_number": "string",
  "voltage": "integer",
  "committed_power": "string",
  "available_power": "string",
  "is_resident": "boolean",
  "is_disconnectable": "boolean",
  "supply_point_handling": "string",
  "meter_point_type": "string",
  "tariff_code": "string"
}

ita_industry.gas.change-of-ownership.final-outcome-received-v1

Event Properties

NameType
requiredcompany_namestring
requirederror_codeinteger
requirederror_reasonstring
requiredfiscal_codestring
requiredindustry_request_idstring
requiredis_approvedboolean
requiredis_foreign_fiscal_codeboolean
requiredkraken_request_idstring
requirednamestring
requiredpdrstring
requiredstart_datestring
requiredsurnamestring
requiredvat_numberstring

Metadata

Event TypePayload Version
ita_industry.gas.change-of-ownership.final-outcome-receivedv1

JSON Payload Representation

{
  "company_name": "string",
  "error_code": "integer",
  "error_reason": "string",
  "fiscal_code": "string",
  "industry_request_id": "string",
  "is_approved": "boolean",
  "is_foreign_fiscal_code": "boolean",
  "kraken_request_id": "string",
  "name": "string",
  "pdr": "string",
  "start_date": "string",
  "surname": "string",
  "vat_number": "string"
}

ita_industry.gas.change-of-ownership.pre-check.admissibility-received-v1

Event Properties

NameType
requiredis_admissibleboolean
requirederror_codeinteger
requirederror_reasonstring
requiredkraken_request_idstring
requiredindustry_request_idstring
requiredpdrstring
requiredremistring
requiredpdr_statusstring
requireddistributor_vat_numberstring
requiredstreet_typestring
requiredstreet_namestring
requiredstreet_numberstring
requiredcitystring
requiredprovince_codestring
requiredpostcodestring
requiredistat_codestring
requiredcountrystring
requiredaddress_other_infostring
requiredannual_consumptioninteger
requiredstandard_withdrawal_profilestring
requiredpdr_transport_capacityinteger
requiredmeter_serial_numberstring
requiredmeasurement_group_classstring
requiredis_managed_remotelyboolean
requiredmarket_of_originstring
requiredrecent_switch_datesarray[string]
requiredrecent_voltura_tit_iii_datesarray[string]
requiredrecent_voltura_tit_iv_datesarray[string]

Metadata

Event TypePayload Version
ita_industry.gas.change-of-ownership.pre-check.admissibility-receivedv1

JSON Payload Representation

{
  "is_admissible": "boolean",
  "error_code": "integer",
  "error_reason": "string",
  "kraken_request_id": "string",
  "industry_request_id": "string",
  "pdr": "string",
  "remi": "string",
  "pdr_status": "string",
  "distributor_vat_number": "string",
  "street_type": "string",
  "street_name": "string",
  "street_number": "string",
  "city": "string",
  "province_code": "string",
  "postcode": "string",
  "istat_code": "string",
  "country": "string",
  "address_other_info": "string",
  "annual_consumption": "integer",
  "standard_withdrawal_profile": "string",
  "pdr_transport_capacity": "integer",
  "meter_serial_number": "string",
  "measurement_group_class": "string",
  "is_managed_remotely": "boolean",
  "market_of_origin": "string",
  "recent_switch_dates": [
    "string"
  ],
  "recent_voltura_tit_iii_dates": [
    "string"
  ],
  "recent_voltura_tit_iv_dates": [
    "string"
  ]
}

ita_industry.gas.change-of-ownership.request.admissibility-received-v1

Event Properties

NameType
requiredpdrstring
requiredkraken_request_idstring
requiredindustry_request_idstring
requiredis_admissibleboolean
requirederror_codeinteger
requirederror_reasonstring

Metadata

Event TypePayload Version
ita_industry.gas.change-of-ownership.request.admissibility-receivedv1

JSON Payload Representation

{
  "pdr": "string",
  "kraken_request_id": "string",
  "industry_request_id": "string",
  "is_admissible": "boolean",
  "error_code": "integer",
  "error_reason": "string"
}

ita_industry.gas.functional-data.notice-received-v1

Event Properties

NameType
requiredpdrstring
requiredremistring
requiredclimate_zone_idstring
requiredpdr_usage_typestring
requiredmeter_group_classstring
requiredprofile_codestring
requiredannual_consumptioninteger
requiredsettlment_treatmentstring
requiredmeasurement_pressurestring
requiredmeter_serial_numberstring
requiredeffective_fromstring

Metadata

Event TypePayload Version
ita_industry.gas.functional-data.notice-receivedv1

JSON Payload Representation

{
  "pdr": "string",
  "remi": "string",
  "climate_zone_id": "string",
  "pdr_usage_type": "string",
  "meter_group_class": "string",
  "profile_code": "string",
  "annual_consumption": "integer",
  "settlment_treatment": "string",
  "measurement_pressure": "string",
  "meter_serial_number": "string",
  "effective_from": "string"
}

ita_industry.gas.functional-data.notice-received-v2

Event Properties

NameType
requiredpdrstring
requiredremistring
requiredclimate_zone_idstring
requiredpdr_usage_typestring
requiredmeasurement_group_classstring
requiredprofile_codestring
requiredannual_consumptioninteger
requiredsettlment_treatmentstring
requiredmeasurement_pressurestring
requiredmeter_serial_numberstring
requiredeffective_fromstring
requireddistributor_partita_ivastring

Metadata

Event TypePayload Version
ita_industry.gas.functional-data.notice-receivedv2

JSON Payload Representation

{
  "pdr": "string",
  "remi": "string",
  "climate_zone_id": "string",
  "pdr_usage_type": "string",
  "measurement_group_class": "string",
  "profile_code": "string",
  "annual_consumption": "integer",
  "settlment_treatment": "string",
  "measurement_pressure": "string",
  "meter_serial_number": "string",
  "effective_from": "string",
  "distributor_partita_iva": "string"
}

ita_industry.gas.meter-readings.update-v1

Event Properties

NameType
requirednew_readingsobject

Metadata

Event TypePayload Version
ita_industry.gas.meter-readings.updatev1

JSON Payload Representation

{
  "new_readings": "object"
}

ita_industry.gas.self-reading.validation-outcome-received-v1

Event Properties

NameType
requiredpdrstring
requiredcompetence_monthstring
requiredservice_datestring
requiredindustry_request_idstring
requiredtechnical_data_gas-_self_reading_validation_outcome-_TechnicalData
requiredreading_detail_gas-_self_reading_validation_outcome-_ReadingDetail

Metadata

Event TypePayload Version
ita_industry.gas.self-reading.validation-outcome-receivedv1

JSON Payload Representation

{
  "pdr": "string",
  "competence_month": "string",
  "service_date": "string",
  "industry_request_id": "string",
  "technical_data": {
    "treatment": "string",
    "meter_number": "string",
    "converter_number": "string",
    "meter_digits": "integer",
    "converter_digits": "integer",
    "correction_coefficient": "number",
    "reading_frequency": "integer",
    "meter_accessibility": "integer",
    "collection_type": "string",
    "collection_outcome": "string",
    "failed_collection_cause": "integer",
    "alternative_collection_mode": "string",
    "obstructive_cause": "string",
    "compensation_right": "string",
    "next_window_start": "string",
    "next_window_end": "string",
    "substitute_annual_volume": "number",
    "meter_group_class": "string",
    "converter_present": "string",
    "integrated_measurement_group": "string"
  },
  "reading_detail": {
    "reading_type": "string",
    "validation_outcome": "string",
    "notes": "string",
    "attempts": "integer",
    "collection_date": "string",
    "total_withdrawal_reading": "integer",
    "total_converter_reading": "integer",
    "effective_measurement_date": "string",
    "effective_meter_reading": "integer",
    "effective_converter_reading": "integer"
  }
}

ita_industry.gas.social-bonus.outcome-received-v1

Event Properties

NameType
requiredbonus_codestring
requiredoutcomeboolean

Metadata

Event TypePayload Version
ita_industry.gas.social-bonus.outcome-receivedv1

JSON Payload Representation

{
  "bonus_code": "string",
  "outcome": "boolean"
}

ita_industry.gas.social-bonus.received-v1

Event Properties

NameType
requiredbonus_codestring
requiredcommunication_typestring
requirederror_codestring
requiredpdrstring
requiredfiscal_codestring
requiredcompensation_scheme_codestring
requiredvalidity_yearstring
requiredvalid_from_datestring
requiredvalid_to_datestring
requiredtermination_datestring
requiredmessage_idinteger

Metadata

Event TypePayload Version
ita_industry.gas.social-bonus.receivedv1

JSON Payload Representation

{
  "bonus_code": "string",
  "communication_type": "string",
  "error_code": "string",
  "pdr": "string",
  "fiscal_code": "string",
  "compensation_scheme_code": "string",
  "validity_year": "string",
  "valid_from_date": "string",
  "valid_to_date": "string",
  "termination_date": "string",
  "message_id": "integer"
}

ita_industry.gas.switch-in.pre-check.final-outcome-received-v1

Event Properties

NameType
requiredis_admissibleboolean
requirederror_codeinteger
requirederror_reasonstring
requiredis_approvedboolean
requiredfailure_codeinteger
requiredfailure_reasonstring
requiredindustry_request_idstring
requiredkraken_request_idstring
requiredpdrstring
requiredpdr_typeinteger
requiredremistring
requireddistributor_vat_numberstring
requiredcustomer_fiscal_codestring
requiredcustomer_vat_numberstring
requiredis_foreign_fiscal_codeboolean
requiredgiven_namestring
requiredfamily_namestring
requiredcompany_namestring
requiredcommercial_counterparty_company_namestring
requiredcommercial_counterparty_vat_numberstring

Metadata

Event TypePayload Version
ita_industry.gas.switch-in.pre-check.final-outcome-receivedv1

JSON Payload Representation

{
  "is_admissible": "boolean",
  "error_code": "integer",
  "error_reason": "string",
  "is_approved": "boolean",
  "failure_code": "integer",
  "failure_reason": "string",
  "industry_request_id": "string",
  "kraken_request_id": "string",
  "pdr": "string",
  "pdr_type": "integer",
  "remi": "string",
  "distributor_vat_number": "string",
  "customer_fiscal_code": "string",
  "customer_vat_number": "string",
  "is_foreign_fiscal_code": "boolean",
  "given_name": "string",
  "family_name": "string",
  "company_name": "string",
  "commercial_counterparty_company_name": "string",
  "commercial_counterparty_vat_number": "string"
}

ita_industry.gas.switch-in.pre-check.final-outcome-received-v2

Event Properties

NameType
requiredis_admissibleboolean
requirederror_codeinteger
requirederror_reasonstring
requiredis_approvedboolean
requiredfailure_codeinteger
requiredfailure_reasonstring
requiredindustry_request_idstring
requiredkraken_request_idstring
requiredpdrstring
requiredpdr_typeinteger
requiredremistring
requireddistributor_vat_numberstring
requiredcustomer_fiscal_codestring
requiredcustomer_vat_numberstring
requiredis_foreign_fiscal_codeboolean
requiredgiven_namestring
requiredfamily_namestring
requiredcompany_namestring
requiredcommercial_counterparty_company_namestring
requiredcommercial_counterparty_vat_numberstring
requiredpdr_statusstring
requiredpdr_transport_capacityinteger
requiredannual_consumptioninteger
requiredstandard_withdrawal_profilestring
requiredmeasurement_group_classstring
requiredmeter_typestring
requiredis_managed_remotelyboolean
requiredis_volume_converter_presentboolean

Metadata

Event TypePayload Version
ita_industry.gas.switch-in.pre-check.final-outcome-receivedv2

JSON Payload Representation

{
  "is_admissible": "boolean",
  "error_code": "integer",
  "error_reason": "string",
  "is_approved": "boolean",
  "failure_code": "integer",
  "failure_reason": "string",
  "industry_request_id": "string",
  "kraken_request_id": "string",
  "pdr": "string",
  "pdr_type": "integer",
  "remi": "string",
  "distributor_vat_number": "string",
  "customer_fiscal_code": "string",
  "customer_vat_number": "string",
  "is_foreign_fiscal_code": "boolean",
  "given_name": "string",
  "family_name": "string",
  "company_name": "string",
  "commercial_counterparty_company_name": "string",
  "commercial_counterparty_vat_number": "string",
  "pdr_status": "string",
  "pdr_transport_capacity": "integer",
  "annual_consumption": "integer",
  "standard_withdrawal_profile": "string",
  "measurement_group_class": "string",
  "meter_type": "string",
  "is_managed_remotely": "boolean",
  "is_volume_converter_present": "boolean"
}

ita_industry.gas.switch-in.request.admissibility-received-v1

Event Properties

NameType
requiredpdrstring
requiredkraken_request_idstring
requiredindustry_request_idstring
requiredis_admissibleboolean
requirederror_codeinteger
requirederror_motivationstring

Metadata

Event TypePayload Version
ita_industry.gas.switch-in.request.admissibility-receivedv1

JSON Payload Representation

{
  "pdr": "string",
  "kraken_request_id": "string",
  "industry_request_id": "string",
  "is_admissible": "boolean",
  "error_code": "integer",
  "error_motivation": "string"
}

ita_industry.gas.switch-in.request.admissibility-received-v2

Event Properties

NameType
requiredpdrstring
requiredkraken_request_idstring
requiredindustry_request_idstring
requiredis_admissibleboolean
requirederror_codeinteger
requirederror_reasonstring

Metadata

Event TypePayload Version
ita_industry.gas.switch-in.request.admissibility-receivedv2

JSON Payload Representation

{
  "pdr": "string",
  "kraken_request_id": "string",
  "industry_request_id": "string",
  "is_admissible": "boolean",
  "error_code": "integer",
  "error_reason": "string"
}

ita_industry.gas.switch-in.timg.notice-received-v1

Event Properties

NameType
requiredpdrstring
requiredkraken_request_idstring
requiredindustry_request_idstring
is_pdr_closed_due_to_non_paymentboolean
pdr_suspension_requests_dates_last_12_monthsarray[string]
pdr_access_for_substitution_requests_dates_last_12_monthsarray[string]
availability_status_of_the_meterstring
has_ongoing_indemnity_procedureboolean
default_service_activation_datestring
request_to_close_datestring

Metadata

Event TypePayload Version
ita_industry.gas.switch-in.timg.notice-receivedv1

JSON Payload Representation

{
  "pdr": "string",
  "kraken_request_id": "string",
  "industry_request_id": "string",
  "is_pdr_closed_due_to_non_payment": "boolean",
  "pdr_suspension_requests_dates_last_12_months": [
    "string"
  ],
  "pdr_access_for_substitution_requests_dates_last_12_months": [
    "string"
  ],
  "availability_status_of_the_meter": "string",
  "has_ongoing_indemnity_procedure": "boolean",
  "default_service_activation_date": "string",
  "request_to_close_date": "string"
}

ita_industry.gas.switch-out-with-change-of-ownership.notice-received-v1

Event Properties

NameType
requiredpdrstring
requiredswitch_out_datestring
requiredindustry_request_idstring

Metadata

Event TypePayload Version
ita_industry.gas.switch-out-with-change-of-ownership.notice-receivedv1

JSON Payload Representation

{
  "pdr": "string",
  "switch_out_date": "string",
  "industry_request_id": "string"
}

ita_industry.gas.switch-out.notice-received-v1

Event Properties

NameType
requiredpdrstring
requiredswitch_out_datestring
requiredindustry_request_idstring

Metadata

Event TypePayload Version
ita_industry.gas.switch-out.notice-receivedv1

JSON Payload Representation

{
  "pdr": "string",
  "switch_out_date": "string",
  "industry_request_id": "string"
}

ita_industry.messages.cancellation-dl.request.mch-admissibility-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
sending_date_sii_dlstring
eligibility_receiving_datestring
transaction_id_hubstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
COD_CONTR_DISPstring
PIVA_DISTRstring
COD_PRAT_UTENTEstring
COD_PRAT_DISTRstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring
NOTEstring

Metadata

Event TypePayload Version
ita_industry.messages.cancellation-dl.request.mch-admissibility-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "sending_date_sii_dl": "string",
  "eligibility_receiving_date": "string",
  "transaction_id_hub": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "COD_CONTR_DISP": "string",
  "PIVA_DISTR": "string",
  "COD_PRAT_UTENTE": "string",
  "COD_PRAT_DISTR": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string",
  "NOTE": "string"
}

ita_industry.messages.cancellation-dl.request.mch-final-outcome-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
transaction_id_hubstring
channelstring
receiving_date_final_resultstring
reason_final_outcomestring
description_final_outcomestring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
COD_CONTR_DISPstring
PIVA_DISTRstring
COD_PRAT_UTENTEstring
COD_PRAT_DISTRstring
ESITOstring
NOTEstring

Metadata

Event TypePayload Version
ita_industry.messages.cancellation-dl.request.mch-final-outcome-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "channel": "string",
  "receiving_date_final_result": "string",
  "reason_final_outcome": "string",
  "description_final_outcome": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "COD_CONTR_DISP": "string",
  "PIVA_DISTR": "string",
  "COD_PRAT_UTENTE": "string",
  "COD_PRAT_DISTR": "string",
  "ESITO": "string",
  "NOTE": "string"
}

ita_industry.messages.cancellation-dl.request.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.cancellation-dl.request.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.cancellation-dl.request.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.cancellation-dl.request.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.cancellation.request.mch-admissibility-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
sending_date_sii_dlstring
eligibility_receiving_datestring
dispatching_contract_codestring
transaction_id_hubstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
CP_GESTORE_ANNstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring
NOTEstring

Metadata

Event TypePayload Version
ita_industry.messages.cancellation.request.mch-admissibility-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "sending_date_sii_dl": "string",
  "eligibility_receiving_date": "string",
  "dispatching_contract_code": "string",
  "transaction_id_hub": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "CP_GESTORE_ANN": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string",
  "NOTE": "string"
}

ita_industry.messages.cancellation.request.mch-final-outcome-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
dispatching_contract_codestring
transaction_id_hubstring
channelstring
receiving_date_final_outcomestring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
CP_GESTORE_ANNstring
ESITOstring
COD_ESITOstring
DETTAGLIO_ESITOstring
NOTEstring

Metadata

Event TypePayload Version
ita_industry.messages.cancellation.request.mch-final-outcome-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "dispatching_contract_code": "string",
  "transaction_id_hub": "string",
  "channel": "string",
  "receiving_date_final_outcome": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "CP_GESTORE_ANN": "string",
  "ESITO": "string",
  "COD_ESITO": "string",
  "DETTAGLIO_ESITO": "string",
  "NOTE": "string"
}

ita_industry.messages.cancellation.request.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.cancellation.request.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.cancellation.request.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.cancellation.request.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.change-of-ownership.cancellation.mch-admissibility-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
COD_PODstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring

Metadata

Event TypePayload Version
ita_industry.messages.change-of-ownership.cancellation.mch-admissibility-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "COD_POD": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string"
}

ita_industry.messages.change-of-ownership.cancellation.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.change-of-ownership.cancellation.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.change-of-ownership.cancellation.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.change-of-ownership.cancellation.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.change-of-ownership.pre-check.mch-admissibility-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring
COD_PODstring
STATO_PODstring
PMA_PODstring
TENSIONEstring
TOPONIMOstring
VIAstring
CIVstring
CAPstring
ISTATstring
LOCALITAstring
PROVstring
NAZIONEstring
ALTROstring
MERCATO_PROVENIENZAstring
POTCONTRIMPstring
POTDISPstring
CRPP_F1_AAMstring
CRPP_F2_AAMstring
CRPP_F3_AAMstring
CRPP_F1_AAM1string
CRPP_F2_AAM1string
CRPP_F3_AAM1string
DATA_DECORRENZA_SWstring
DATA_DECORRENZA_VT_TIT_IIIstring
DATA_DECORRENZA_VT_TIT_IVstring

Metadata

Event TypePayload Version
ita_industry.messages.change-of-ownership.pre-check.mch-admissibility-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string",
  "COD_POD": "string",
  "STATO_POD": "string",
  "PMA_POD": "string",
  "TENSIONE": "string",
  "TOPONIMO": "string",
  "VIA": "string",
  "CIV": "string",
  "CAP": "string",
  "ISTAT": "string",
  "LOCALITA": "string",
  "PROV": "string",
  "NAZIONE": "string",
  "ALTRO": "string",
  "MERCATO_PROVENIENZA": "string",
  "POTCONTRIMP": "string",
  "POTDISP": "string",
  "CRPP_F1_AAM": "string",
  "CRPP_F2_AAM": "string",
  "CRPP_F3_AAM": "string",
  "CRPP_F1_AAM1": "string",
  "CRPP_F2_AAM1": "string",
  "CRPP_F3_AAM1": "string",
  "DATA_DECORRENZA_SW": "string",
  "DATA_DECORRENZA_VT_TIT_III": "string",
  "DATA_DECORRENZA_VT_TIT_IV": "string"
}

ita_industry.messages.change-of-ownership.pre-check.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.change-of-ownership.pre-check.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.change-of-ownership.pre-check.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.change-of-ownership.pre-check.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.change-of-ownership.request.mch-admissibility-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
COD_PODstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring

Metadata

Event TypePayload Version
ita_industry.messages.change-of-ownership.request.mch-admissibility-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "COD_POD": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string"
}

ita_industry.messages.change-of-ownership.request.mch-final-outcome-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
ESITOstring
COD_ESITOstring
DETTAGLIO_ESITOstring
COD_PODstring
CFstring
PIVAstring
CF_STRANIEROstring
NOMEstring
COGNOMEstring
RAGIONE_SOCIALE_DENOMINAZIONEstring
DATA_DECORRENZAstring

Metadata

Event TypePayload Version
ita_industry.messages.change-of-ownership.request.mch-final-outcome-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "ESITO": "string",
  "COD_ESITO": "string",
  "DETTAGLIO_ESITO": "string",
  "COD_POD": "string",
  "CF": "string",
  "PIVA": "string",
  "CF_STRANIERO": "string",
  "NOME": "string",
  "COGNOME": "string",
  "RAGIONE_SOCIALE_DENOMINAZIONE": "string",
  "DATA_DECORRENZA": "string"
}

ita_industry.messages.change-of-ownership.request.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.change-of-ownership.request.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.change-of-ownership.request.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.change-of-ownership.request.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.compensation.application-incoming-user.mch-notice-received-v1

Event Properties

NameType
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
channelstring
transaction_id_hubstring
receiving_date_final_resultstring
final_outcomeboolean
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_GESTOREstring
SETTOREstring
COD_PODstring
COD_PDRstring
CFstring
PIVAstring
CF_STRANIEROstring
CMORstring
COD_CONTR_DISPstring
PIVA_UTENTE_ENTRANTEstring
PIVA_CC_ENTRANTEstring

Metadata

Event TypePayload Version
ita_industry.messages.compensation.application-incoming-user.mch-notice-receivedv1

JSON Payload Representation

{
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "channel": "string",
  "transaction_id_hub": "string",
  "receiving_date_final_result": "string",
  "final_outcome": "boolean",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_GESTORE": "string",
  "SETTORE": "string",
  "COD_POD": "string",
  "COD_PDR": "string",
  "CF": "string",
  "PIVA": "string",
  "CF_STRANIERO": "string",
  "CMOR": "string",
  "COD_CONTR_DISP": "string",
  "PIVA_UTENTE_ENTRANTE": "string",
  "PIVA_CC_ENTRANTE": "string"
}

ita_industry.messages.compensation.application-outgoing-user.mch-notice-received-v1

Event Properties

NameType
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
channelstring
transaction_id_hubstring
receiving_date_final_resultstring
final_outcomeboolean
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_GESTOREstring
SETTOREstring
COD_PODstring
COD_PDRstring
CFstring
PIVAstring
CF_STRANIEROstring
CMORstring
COD_CONTR_DISPstring
PIVA_UTENTE_USCENTEstring

Metadata

Event TypePayload Version
ita_industry.messages.compensation.application-outgoing-user.mch-notice-receivedv1

JSON Payload Representation

{
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "channel": "string",
  "transaction_id_hub": "string",
  "receiving_date_final_result": "string",
  "final_outcome": "boolean",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_GESTORE": "string",
  "SETTORE": "string",
  "COD_POD": "string",
  "COD_PDR": "string",
  "CF": "string",
  "PIVA": "string",
  "CF_STRANIERO": "string",
  "CMOR": "string",
  "COD_CONTR_DISP": "string",
  "PIVA_UTENTE_USCENTE": "string"
}

ita_industry.messages.compensation.incoming-cancellation-incoming-user.mch-notice-received-v1

Event Properties

NameType
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
channelstring
receiving_date_final_resultstring
transaction_id_hubstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
SETTOREstring
COD_PODstring
COD_PDRstring
CFstring
PIVAstring
CF_STRANIEROstring
COD_PROCEDURAstring
TIPO_ESITOstring
COD_ESITOstring
DETTAGLIO_ESITOstring

Metadata

Event TypePayload Version
ita_industry.messages.compensation.incoming-cancellation-incoming-user.mch-notice-receivedv1

JSON Payload Representation

{
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "channel": "string",
  "receiving_date_final_result": "string",
  "transaction_id_hub": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "SETTORE": "string",
  "COD_POD": "string",
  "COD_PDR": "string",
  "CF": "string",
  "PIVA": "string",
  "CF_STRANIERO": "string",
  "COD_PROCEDURA": "string",
  "TIPO_ESITO": "string",
  "COD_ESITO": "string",
  "DETTAGLIO_ESITO": "string"
}

ita_industry.messages.compensation.incoming-cancellation-outgoing-user.mch-notice-received-v1

Event Properties

NameType
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
channelstring
receiving_date_final_resultstring
final_outcomeboolean
transaction_id_hubstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
SETTOREstring
COD_PODstring
COD_PDRstring
CFstring
PIVAstring
CF_STRANIEROstring
COD_PROCEDURAstring

Metadata

Event TypePayload Version
ita_industry.messages.compensation.incoming-cancellation-outgoing-user.mch-notice-receivedv1

JSON Payload Representation

{
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "channel": "string",
  "receiving_date_final_result": "string",
  "final_outcome": "boolean",
  "transaction_id_hub": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "SETTORE": "string",
  "COD_POD": "string",
  "COD_PDR": "string",
  "CF": "string",
  "PIVA": "string",
  "CF_STRANIERO": "string",
  "COD_PROCEDURA": "string"
}

ita_industry.messages.compensation.incoming-cancellation-withdrawal-incoming-user.mch-notice-received-v1

Event Properties

NameType
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
channelstring
receiving_date_final_resultstring
final_outcomeboolean
transaction_id_hubstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
SETTOREstring
COD_PODstring
COD_PDRstring
COD_CAUSALEstring
DATA_RIATTIVAZIONE_REVOCAstring

Metadata

Event TypePayload Version
ita_industry.messages.compensation.incoming-cancellation-withdrawal-incoming-user.mch-notice-receivedv1

JSON Payload Representation

{
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "channel": "string",
  "receiving_date_final_result": "string",
  "final_outcome": "boolean",
  "transaction_id_hub": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "SETTORE": "string",
  "COD_POD": "string",
  "COD_PDR": "string",
  "COD_CAUSALE": "string",
  "DATA_RIATTIVAZIONE_REVOCA": "string"
}

ita_industry.messages.compensation.incoming-cancellation-withdrawal-outgoing-user.mch-notice-received-v1

Event Properties

NameType
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
channelstring
receiving_date_final_resultstring
final_outcomeboolean
transaction_id_hubstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
SETTOREstring
COD_PODstring
COD_PDRstring

Metadata

Event TypePayload Version
ita_industry.messages.compensation.incoming-cancellation-withdrawal-outgoing-user.mch-notice-receivedv1

JSON Payload Representation

{
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "channel": "string",
  "receiving_date_final_result": "string",
  "final_outcome": "boolean",
  "transaction_id_hub": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "SETTORE": "string",
  "COD_POD": "string",
  "COD_PDR": "string"
}

ita_industry.messages.compensation.incoming-cancellation-withdrawal.mch-admissibility-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
sending_date_sii_dlstring
eligibility_receiving_datestring
transaction_id_hubstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
SETTOREstring
COD_PODstring
COD_PDRstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring

Metadata

Event TypePayload Version
ita_industry.messages.compensation.incoming-cancellation-withdrawal.mch-admissibility-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "sending_date_sii_dl": "string",
  "eligibility_receiving_date": "string",
  "transaction_id_hub": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "SETTORE": "string",
  "COD_POD": "string",
  "COD_PDR": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string"
}

ita_industry.messages.compensation.incoming-cancellation-withdrawal.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.compensation.incoming-cancellation-withdrawal.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.compensation.incoming-cancellation-withdrawal.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.compensation.incoming-cancellation-withdrawal.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.compensation.incoming-cancellation.mch-admissibility-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
sending_date_sii_dlstring
eligibility_receiving_datestring
transaction_id_hubstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
SETTOREstring
COD_PODstring
COD_PDRstring
CFstring
PIVAstring
CF_STRANIEROstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring

Metadata

Event TypePayload Version
ita_industry.messages.compensation.incoming-cancellation.mch-admissibility-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "sending_date_sii_dl": "string",
  "eligibility_receiving_date": "string",
  "transaction_id_hub": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "SETTORE": "string",
  "COD_POD": "string",
  "COD_PDR": "string",
  "CF": "string",
  "PIVA": "string",
  "CF_STRANIERO": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string"
}

ita_industry.messages.compensation.incoming-cancellation.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.compensation.incoming-cancellation.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.compensation.incoming-cancellation.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.compensation.incoming-cancellation.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.compensation.incoming-report.mch-admissibility-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
sending_date_sii_dlstring
eligibility_receiving_datestring
transaction_id_hubstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring

Metadata

Event TypePayload Version
ita_industry.messages.compensation.incoming-report.mch-admissibility-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "sending_date_sii_dl": "string",
  "eligibility_receiving_date": "string",
  "transaction_id_hub": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string"
}

ita_industry.messages.compensation.incoming-report.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.compensation.incoming-report.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.compensation.incoming-report.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.compensation.incoming-report.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.compensation.outgoing-cancellation-incoming-user.mch-notice-received-v1

Event Properties

NameType
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
channelstring
receiving_date_final_resultstring
transaction_id_hubstring
final_outcomeboolean
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
SETTOREstring
COD_PODstring
COD_PDRstring
CFstring
PIVAstring
CF_STRANIEROstring
COD_CAUSALEstring
EROGAZIONE_CSEAstring
STATO_VERSAMENTO_CSEAstring

Metadata

Event TypePayload Version
ita_industry.messages.compensation.outgoing-cancellation-incoming-user.mch-notice-receivedv1

JSON Payload Representation

{
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "channel": "string",
  "receiving_date_final_result": "string",
  "transaction_id_hub": "string",
  "final_outcome": "boolean",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "SETTORE": "string",
  "COD_POD": "string",
  "COD_PDR": "string",
  "CF": "string",
  "PIVA": "string",
  "CF_STRANIERO": "string",
  "COD_CAUSALE": "string",
  "EROGAZIONE_CSEA": "string",
  "STATO_VERSAMENTO_CSEA": "string"
}

ita_industry.messages.compensation.outgoing-cancellation-outgoing-user.mch-notice-received-v1

Event Properties

NameType
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
channelstring
receiving_date_final_resultstring
transaction_id_hubstring
final_outcomeboolean
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
SETTOREstring
COD_PODstring
COD_PDRstring
CFstring
PIVAstring
CF_STRANIEROstring
COD_CAUSALEstring
EROGAZIONE_CSEAstring
STATO_VERSAMENTO_CSEAstring

Metadata

Event TypePayload Version
ita_industry.messages.compensation.outgoing-cancellation-outgoing-user.mch-notice-receivedv1

JSON Payload Representation

{
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "channel": "string",
  "receiving_date_final_result": "string",
  "transaction_id_hub": "string",
  "final_outcome": "boolean",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "SETTORE": "string",
  "COD_POD": "string",
  "COD_PDR": "string",
  "CF": "string",
  "PIVA": "string",
  "CF_STRANIERO": "string",
  "COD_CAUSALE": "string",
  "EROGAZIONE_CSEA": "string",
  "STATO_VERSAMENTO_CSEA": "string"
}

ita_industry.messages.compensation.outgoing-cancellation-return.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.compensation.outgoing-cancellation-return.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.compensation.outgoing-cancellation-return.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.compensation.outgoing-cancellation-return.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.compensation.outgoing-cancellation.mch-admissibility-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
sending_date_sii_dlstring
eligibility_receiving_datestring
transaction_id_hubstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring

Metadata

Event TypePayload Version
ita_industry.messages.compensation.outgoing-cancellation.mch-admissibility-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "sending_date_sii_dl": "string",
  "eligibility_receiving_date": "string",
  "transaction_id_hub": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string"
}

ita_industry.messages.compensation.outgoing-cancellation.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.compensation.outgoing-cancellation.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.compensation.outgoing-cancellation.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.compensation.outgoing-cancellation.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.compensation.request.mch-admissibility-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
sending_date_sii_dlstring
eligibility_receiving_datestring
transaction_id_hubstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
COD_PODstring
COD_PDRstring
SETTOREstring
CFstring
PIVAstring
CF_STRANIEROstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring

Metadata

Event TypePayload Version
ita_industry.messages.compensation.request.mch-admissibility-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "sending_date_sii_dl": "string",
  "eligibility_receiving_date": "string",
  "transaction_id_hub": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "COD_POD": "string",
  "COD_PDR": "string",
  "SETTORE": "string",
  "CF": "string",
  "PIVA": "string",
  "CF_STRANIERO": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string"
}

ita_industry.messages.compensation.request.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.compensation.request.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.compensation.request.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.compensation.request.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.compensation.value-update.mch-notice-received-v1

Event Properties

NameType
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
channelstring
transaction_id_hubstring
receiving_date_final_resultstring
final_outcomeboolean
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
CMORstring
CMOR_STORNATOstring
COD_STORNOstring

Metadata

Event TypePayload Version
ita_industry.messages.compensation.value-update.mch-notice-receivedv1

JSON Payload Representation

{
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "channel": "string",
  "transaction_id_hub": "string",
  "receiving_date_final_result": "string",
  "final_outcome": "boolean",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "CMOR": "string",
  "CMOR_STORNATO": "string",
  "COD_STORNO": "string"
}

ita_industry.messages.contract-termination.request.mch-admissibility-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
sending_date_sii_dlstring
eligibility_receiving_datestring
transaction_id_hubstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
COD_PODstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring

Metadata

Event TypePayload Version
ita_industry.messages.contract-termination.request.mch-admissibility-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "sending_date_sii_dl": "string",
  "eligibility_receiving_date": "string",
  "transaction_id_hub": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "COD_POD": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string"
}

ita_industry.messages.contract-termination.request.mch-final-outcome-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
servicestring
flowstring
user_transaction_codestring
sii_transaction_codestring
transaction_id_hubstring
channelstring
final_outcomestring
check_portafogliostring
cancellation_causalstring
notesstring

Metadata

Event TypePayload Version
ita_industry.messages.contract-termination.request.mch-final-outcome-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "service": "string",
  "flow": "string",
  "user_transaction_code": "string",
  "sii_transaction_code": "string",
  "transaction_id_hub": "string",
  "channel": "string",
  "final_outcome": "string",
  "check_portafoglio": "string",
  "cancellation_causal": "string",
  "notes": "string"
}

ita_industry.messages.contract-termination.request.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.contract-termination.request.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.contract-termination.request.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.contract-termination.request.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.electricity.takeover.request.mch-admissibility-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
COD_CONTR_DISPstring
PIVA_DISTRstring
COD_PRAT_UTENTEstring
COD_PRAT_DISTRstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring
TIPO_SERVIZIOstring
TIPOLOGIA_INTERVENTOstring
SERVIZIO_RICHIEDIBILEstring
CODICE_PODstring
FASE_DISTRstring
TENSIONE_DISTRstring
POTENZA_FRANCHIGIA_DISTRstring
POTENZA_IMPEGNATA_DISTRstring
POTENZA_IMPEGNATA_RICHIESTAstring

Metadata

Event TypePayload Version
ita_industry.messages.electricity.takeover.request.mch-admissibility-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "COD_CONTR_DISP": "string",
  "PIVA_DISTR": "string",
  "COD_PRAT_UTENTE": "string",
  "COD_PRAT_DISTR": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string",
  "TIPO_SERVIZIO": "string",
  "TIPOLOGIA_INTERVENTO": "string",
  "SERVIZIO_RICHIEDIBILE": "string",
  "CODICE_POD": "string",
  "FASE_DISTR": "string",
  "TENSIONE_DISTR": "string",
  "POTENZA_FRANCHIGIA_DISTR": "string",
  "POTENZA_IMPEGNATA_DISTR": "string",
  "POTENZA_IMPEGNATA_RICHIESTA": "string"
}

ita_industry.messages.electricity.takeover.request.mch-final-outcome-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
COD_SERVIZIOstring
COD_FLUSSOstring
TIPO_SERVIZIOstring
PIVA_UTENTEstring
COD_CONTR_DISPstring
PIVA_DISTRstring
COD_PRAT_UTENTEstring
COD_PRAT_DISTRstring
TIPO_RICH_CLI_FINstring
COD_PRAT_RIFstring
COD_PRAT_GESTOREstring
CAUSALE_ANNULLAMENTO_PRESTAZIONEstring
DATA_ANNULLAMENTO_PRESTAZIONEstring
DATA_ULTIMO_CAMBIO_STATOstring
NUMERO_DLstring
ID_ACQUISIZIONE_PRATICAstring
NUOVO_COD_UNI_RINTRstring
NUOVO_COD_UNI_PRESTstring
ESITOstring
DATA_ESECUZIONEstring
COD_PODstring
COGNOMEstring
NOMEstring
RAGIONE_SOCIALE_DENOMINAZIONEstring
CFstring
CF_SOCstring
PIVAstring
TELstring
TELEFONO_CLIENTEstring
TELEFONO_MOBILE_CLIENTEstring
EMAIL_CLIENTEstring
FAX_CLIENTEstring
APP_CLIENTEstring
PRESENZA_CLIENTE_FINALEstring
COGNOME_CEstring
NOME_CEstring
CF_CEstring
RAG_SOC_CEstring
PIVA_CEstring
TOPONIMO_CEstring
VIA_CEstring
CIV_CEstring
CAP_CEstring
ISTAT_CEstring
COMUNE_CEstring
PROV_CEstring
NAZIONE_CEstring
CF_RICHIEDENTEstring
COGNOME_REFstring
NOME_REFstring
TELEFONO_REFstring
EMAIL_REFstring
ALTRE_INFO_REFstring
LETTURA_ATTIVA_F1string
LETTURA_ATTIVA_F2string
LETTURA_ATTIVA_F3string
LETTURA_ATTIVA_F4string
LETTURA_ATTIVA_F5string
LETTURA_ATTIVA_F6string
LETTURA_ATTIVA_NEG_F1string
LETTURA_ATTIVA_NEG_F2string
LETTURA_ATTIVA_NEG_F3string
LETTURA_ATTIVA_NEG_F4string
LETTURA_ATTIVA_NEG_F5string
LETTURA_ATTIVA_NEG_F6string
LETTURA_REATTIVA_F1string
LETTURA_REATTIVA_F2string
LETTURA_REATTIVA_F3string
LETTURA_REATTIVA_F4string
LETTURA_REATTIVA_F5string
LETTURA_REATTIVA_F6string
LETTURA_REATTIVA_IND_NEG_F1string
LETTURA_REATTIVA_IND_NEG_F2string
LETTURA_REATTIVA_IND_NEG_F3string
LETTURA_REATTIVA_IND_NEG_F4string
LETTURA_REATTIVA_IND_NEG_F5string
LETTURA_REATTIVA_IND_NEG_F6string
LETTURA_REATTIVA_CAP_POS_F1string
LETTURA_REATTIVA_CAP_POS_F2string
LETTURA_REATTIVA_CAP_POS_F3string
LETTURA_REATTIVA_CAP_POS_F4string
LETTURA_REATTIVA_CAP_POS_F5string
LETTURA_REATTIVA_CAP_POS_F6string
LETTURA_REATTIVA_CAP_NEG_F1string
LETTURA_REATTIVA_CAP_NEG_F2string
LETTURA_REATTIVA_CAP_NEG_F3string
LETTURA_REATTIVA_CAP_NEG_F4string
LETTURA_REATTIVA_CAP_NEG_F5string
LETTURA_REATTIVA_CAP_NEG_F6string
LETTURA_POTENZA_F1string
LETTURA_POTENZA_F2string
LETTURA_POTENZA_F3string
LETTURA_POTENZA_F4string
LETTURA_POTENZA_F5string
LETTURA_POTENZA_F6string
LETTURA_POTENZA_NEG_F1string
LETTURA_POTENZA_NEG_F2string
LETTURA_POTENZA_NEG_F3string
LETTURA_POTENZA_NEG_F4string
LETTURA_POTENZA_NEG_F5string
LETTURA_POTENZA_NEG_F6string
DIS_LETTURA_ATTIVA_F1string
DIS_LETTURA_ATTIVA_F2string
DIS_LETTURA_ATTIVA_F3string
DIS_LETTURA_ATTIVA_F4string
DIS_LETTURA_ATTIVA_F5string
DIS_LETTURA_ATTIVA_F6string
DIS_LETTURA_ATTIVA_NEG_F1string
DIS_LETTURA_ATTIVA_NEG_F2string
DIS_LETTURA_ATTIVA_NEG_F3string
DIS_LETTURA_ATTIVA_NEG_F4string
DIS_LETTURA_ATTIVA_NEG_F5string
DIS_LETTURA_ATTIVA_NEG_F6string
DIS_LETTURA_REATTIVA_F1string
DIS_LETTURA_REATTIVA_F2string
DIS_LETTURA_REATTIVA_F3string
DIS_LETTURA_REATTIVA_F4string
DIS_LETTURA_REATTIVA_F5string
DIS_LETTURA_REATTIVA_F6string
DIS_LETTURA_REATTIVA_IND_NEG_F1string
DIS_LETTURA_REATTIVA_IND_NEG_F2string
DIS_LETTURA_REATTIVA_IND_NEG_F3string
DIS_LETTURA_REATTIVA_IND_NEG_F4string
DIS_LETTURA_REATTIVA_IND_NEG_F5string
DIS_LETTURA_REATTIVA_IND_NEG_F6string
DIS_LETTURA_REATTIVA_CAP_POS_F1string
DIS_LETTURA_REATTIVA_CAP_POS_F2string
DIS_LETTURA_REATTIVA_CAP_POS_F3string
DIS_LETTURA_REATTIVA_CAP_POS_F4string
DIS_LETTURA_REATTIVA_CAP_POS_F5string
DIS_LETTURA_REATTIVA_CAP_POS_F6string
DIS_LETTURA_REATTIVA_CAP_NEG_F1string
DIS_LETTURA_REATTIVA_CAP_NEG_F2string
DIS_LETTURA_REATTIVA_CAP_NEG_F3string
DIS_LETTURA_REATTIVA_CAP_NEG_F4string
DIS_LETTURA_REATTIVA_CAP_NEG_F5string
DIS_LETTURA_REATTIVA_CAP_NEG_F6string
DIS_LETTURA_POTENZA_F1string
DIS_LETTURA_POTENZA_F2string
DIS_LETTURA_POTENZA_F3string
DIS_LETTURA_POTENZA_F4string
DIS_LETTURA_POTENZA_F5string
DIS_LETTURA_POTENZA_F6string
DIS_LETTURA_POTENZA_NEG_F1string
DIS_LETTURA_POTENZA_NEG_F2string
DIS_LETTURA_POTENZA_NEG_F3string
DIS_LETTURA_POTENZA_NEG_F4string
DIS_LETTURA_POTENZA_NEG_F5string
DIS_LETTURA_POTENZA_NEG_F6string
LETT_ATT_DIFF_F1string
LETT_ATT_DIFF_F2string
LETT_ATT_DIFF_F3string
LETT_REATT_DIFF_F1string
LETT_REATT_DIFF_F2string
LETT_REATT_DIFF_F3string
SOST_MISstring
MISURATORE_ELETTRONICOstring
MATRICOLA_MISURATOREstring
MATR_MIS_ATTIVAstring
MATR_MIS_REATTIVAstring
MATR_MIS_POTENZAstring
TIPOLOGIA_MISstring
COSTANTE_TRASF_ATTIVAstring
COSTANTE_TRASF_REATTIVAstring
COSTANTE_TRASF_POTENZAstring
DIS_MISURATORE_ELETTRONICOstring
DIS_MATR_MIS_ATTIVAstring
DIS_MATR_MIS_REATTIVAstring
DIS_MATR_MIS_POTENZAstring
DIS_TIPOLOGIA_MISstring
DIS_COSTANTE_TRASF_ATTIVAstring
DIS_COSTANTE_TRASF_REATTIVAstring
DIS_COSTANTE_TRASF_POTENZAstring
LETT_CONT_ATT_1string
LETT_CONT_ATT_2string
LETT_CONT_ATT_3string
LETT_CONT_REATT_1string
LETT_CONT_REATT_2string
LETT_CONT_REATT_3string
LETT_CONT_POT_1string
LETT_CONT_POT_2string
LETT_CONT_POT_3string
LETT_CONT_POT_MAXstring
DATA_LETTURE_DISTRstring
LETT_CLI_A1string
LETT_CLI_A2string
LETT_CLI_A3string
LETT_CLI_A4string
LETT_CLI_AMONOstring
LETT_CLI_R1string
LETT_CLI_R2string
LETT_CLI_R3string
LETT_CLI_R4string
LETT_CLI_RMONOstring
LETT_CLI_POT1string
LETT_CLI_POT2string
LETT_CLI_POT3string
LETT_CLI_POT4string
LETT_CLI_POTMONOstring
DATA_LETTURE_CLIENTEstring
LETT_RID_ENER_A1string
LETT_RID_ENER_A2string
LETT_RID_ENER_A3string
LETT_RID_ENER_R1string
LETT_RID_ENER_R2string
LETT_RID_ENER_R3string
LETT_RID_POT1string
LETT_RID_POT2string
LETT_RID_POT3string
TIPOLOGIA_LETT_RIDUZIONEstring
TIPOLOGIA_LETT_CHIUSURAstring
TIPO_NUOVO_MISURATOREstring
LETT_NUOVA_ATT1string
LETT_NUOVA_ATT2string
LETT_NUOVA_ATT3string
LETT_NUOVA_REATT1string
LETT_NUOVA_REATT2string
LETT_NUOVA_REATT3string
LETT_NUOVA_POT1string
LETT_NUOVA_POT2string
LETT_NUOVA_POT3string
COSTANTE_TAstring
COSTANTE_TA_NUOVAstring
COSTANTE_TVstring
COSTANTE_TV_NUOVAstring
COEFFICIENTEKstring
COSTANTEKstring
TIPO_LETTURAstring
CLASSE_CONTATOREstring
DATA_AUTOLETTURAstring
ESITO_VALstring
MESE_COMPETstring
MALFUNZIONAMENTO_MISURATOREstring
ADDEBITO_ONERIstring
DATA_PREVISTA_SOSTITUZIONEstring
NECESSITA_SOSTstring
CONSENSO_SOST_GRU_MISURAstring
IMMEDIATA_SOST_GRU_MISURAstring
ACCERT_VAL_NON_CORRETTIstring
VERIFICA_NON_ESEGUITAstring
POT_IMPstring
POT_DISPstring
POT_FRANCstring
POT_IMP_DISTRstring
POT_FRANC_DISTRstring
POTENZA_CONTRATTUALE_RICHIESTAstring
TENSIONE_FASEstring
FASE_DISTRstring
TENSIONEstring
TENS_ALIM_DISTRstring
CLASSE_TENSIONEstring
TENSIONE_RETEstring
AUMENTO_TENSstring
TIPO_CONTRATTOstring
SETT_MERCEOLOGICOstring
TRATTAMENTO_IVAstring
OPZIONE_TARIFFARIAstring
STAG_RICstring
DATA_INIZIOstring
DATA_FINEstring
NOTEstring
AVANZAMENTO_PRATICAstring
DATA_INSERIMENTO_RICHIESTAstring
INDIRIZZO_PODstring
COD_RINTR_RICHstring
DATA_PUBBLICAZIONEstring
DATA_CAMBIO_MISstring
DATA_RICEZIONE_BONUSstring
DATA_RICEVIMENTO_RICHIESTAstring
CATEGORIAstring
REVOCA_SOSPstring
REVOCA_SOSPENSIONEstring
STATO_PODstring
DATA_INTERVENTOstring
DATA_INTER_PROGRAMstring
DATA_SWITCHstring
FLAG_PRESENTE_MOROSITAstring
TIPO_PODstring
NUOVO_TENTATIVOstring
CONTINUITA_ALIM_FISICAstring
FLAG_SUBENTROstring
DISALIMENTABILEstring
CAT_DISALstring
TIPO_CONTRATTstring
AUTOCERT_ISTANZAstring
MAND_CONNstring
SOLLEV_PERSONEstring
COD_LAV_PREDETstring
DESCRIZIONE_LAVOROstring
STAB_GIA_ENERGIstring
NUOVA_ENEstring
INTTERV_LIM_GRUPPO_MISURAstring
TIPO_LAVOROstring
DATA_STIMA_COMPLETAMENTO_LAVORIstring
NECE_LAV_COMPLstring
ACCETT_LAV_COMPLstring
DATA_ACCETT_LAV_COMPLEstring
CAUSALE_LAVORO_COMPLstring
COSTO_INT_COMPLESSOstring
STIMAstring
CODICE_TIPO_CONNstring
CONN_FUORI_ORARIOstring
NUMERO_PUNTIstring
FABB_DI_POTENZAstring
FABB_COMPL_DI_POTENZAstring
DATA_PREVISTA_RIPRISTINOstring
COD_PREVstring
DATA_TENTATIVOstring
RIF_RESOCONTOstring
CODICE_CAMBIO_TARstring
DATA_SOSP_FORNstring
DATA_RIATT_FORNstring
DATA_RID_FORNstring
STATO_AGEVOLAZIONEstring
DATA_DEC_BONUSstring
DATA_LIMITE_RIC_RETTIFICAstring
DATA_VERIFICA_TRstring
FLAG_CONFERMA_BONUSstring
TIPO_ANOMALIAstring
CAUSALE_IMPLstring
DATA_RIFERIMENTOstring
TIPO_USO_TEMPstring
DATA_DISATTstring
FLAG_TELEGESTITOstring
NUM_TENTATIVIstring
FLAG_RICHIEDIBILEstring
GESTIONE_MANUALEstring
CARATT_UT_FINALEstring
MOTIV_CARATTstring
FLAG_ANN_TRstring
IND_COMUNI_FORNstring

Metadata

Event TypePayload Version
ita_industry.messages.electricity.takeover.request.mch-final-outcome-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "TIPO_SERVIZIO": "string",
  "PIVA_UTENTE": "string",
  "COD_CONTR_DISP": "string",
  "PIVA_DISTR": "string",
  "COD_PRAT_UTENTE": "string",
  "COD_PRAT_DISTR": "string",
  "TIPO_RICH_CLI_FIN": "string",
  "COD_PRAT_RIF": "string",
  "COD_PRAT_GESTORE": "string",
  "CAUSALE_ANNULLAMENTO_PRESTAZIONE": "string",
  "DATA_ANNULLAMENTO_PRESTAZIONE": "string",
  "DATA_ULTIMO_CAMBIO_STATO": "string",
  "NUMERO_DL": "string",
  "ID_ACQUISIZIONE_PRATICA": "string",
  "NUOVO_COD_UNI_RINTR": "string",
  "NUOVO_COD_UNI_PREST": "string",
  "ESITO": "string",
  "DATA_ESECUZIONE": "string",
  "COD_POD": "string",
  "COGNOME": "string",
  "NOME": "string",
  "RAGIONE_SOCIALE_DENOMINAZIONE": "string",
  "CF": "string",
  "CF_SOC": "string",
  "PIVA": "string",
  "TEL": "string",
  "TELEFONO_CLIENTE": "string",
  "TELEFONO_MOBILE_CLIENTE": "string",
  "EMAIL_CLIENTE": "string",
  "FAX_CLIENTE": "string",
  "APP_CLIENTE": "string",
  "PRESENZA_CLIENTE_FINALE": "string",
  "COGNOME_CE": "string",
  "NOME_CE": "string",
  "CF_CE": "string",
  "RAG_SOC_CE": "string",
  "PIVA_CE": "string",
  "TOPONIMO_CE": "string",
  "VIA_CE": "string",
  "CIV_CE": "string",
  "CAP_CE": "string",
  "ISTAT_CE": "string",
  "COMUNE_CE": "string",
  "PROV_CE": "string",
  "NAZIONE_CE": "string",
  "CF_RICHIEDENTE": "string",
  "COGNOME_REF": "string",
  "NOME_REF": "string",
  "TELEFONO_REF": "string",
  "EMAIL_REF": "string",
  "ALTRE_INFO_REF": "string",
  "LETTURA_ATTIVA_F1": "string",
  "LETTURA_ATTIVA_F2": "string",
  "LETTURA_ATTIVA_F3": "string",
  "LETTURA_ATTIVA_F4": "string",
  "LETTURA_ATTIVA_F5": "string",
  "LETTURA_ATTIVA_F6": "string",
  "LETTURA_ATTIVA_NEG_F1": "string",
  "LETTURA_ATTIVA_NEG_F2": "string",
  "LETTURA_ATTIVA_NEG_F3": "string",
  "LETTURA_ATTIVA_NEG_F4": "string",
  "LETTURA_ATTIVA_NEG_F5": "string",
  "LETTURA_ATTIVA_NEG_F6": "string",
  "LETTURA_REATTIVA_F1": "string",
  "LETTURA_REATTIVA_F2": "string",
  "LETTURA_REATTIVA_F3": "string",
  "LETTURA_REATTIVA_F4": "string",
  "LETTURA_REATTIVA_F5": "string",
  "LETTURA_REATTIVA_F6": "string",
  "LETTURA_REATTIVA_IND_NEG_F1": "string",
  "LETTURA_REATTIVA_IND_NEG_F2": "string",
  "LETTURA_REATTIVA_IND_NEG_F3": "string",
  "LETTURA_REATTIVA_IND_NEG_F4": "string",
  "LETTURA_REATTIVA_IND_NEG_F5": "string",
  "LETTURA_REATTIVA_IND_NEG_F6": "string",
  "LETTURA_REATTIVA_CAP_POS_F1": "string",
  "LETTURA_REATTIVA_CAP_POS_F2": "string",
  "LETTURA_REATTIVA_CAP_POS_F3": "string",
  "LETTURA_REATTIVA_CAP_POS_F4": "string",
  "LETTURA_REATTIVA_CAP_POS_F5": "string",
  "LETTURA_REATTIVA_CAP_POS_F6": "string",
  "LETTURA_REATTIVA_CAP_NEG_F1": "string",
  "LETTURA_REATTIVA_CAP_NEG_F2": "string",
  "LETTURA_REATTIVA_CAP_NEG_F3": "string",
  "LETTURA_REATTIVA_CAP_NEG_F4": "string",
  "LETTURA_REATTIVA_CAP_NEG_F5": "string",
  "LETTURA_REATTIVA_CAP_NEG_F6": "string",
  "LETTURA_POTENZA_F1": "string",
  "LETTURA_POTENZA_F2": "string",
  "LETTURA_POTENZA_F3": "string",
  "LETTURA_POTENZA_F4": "string",
  "LETTURA_POTENZA_F5": "string",
  "LETTURA_POTENZA_F6": "string",
  "LETTURA_POTENZA_NEG_F1": "string",
  "LETTURA_POTENZA_NEG_F2": "string",
  "LETTURA_POTENZA_NEG_F3": "string",
  "LETTURA_POTENZA_NEG_F4": "string",
  "LETTURA_POTENZA_NEG_F5": "string",
  "LETTURA_POTENZA_NEG_F6": "string",
  "DIS_LETTURA_ATTIVA_F1": "string",
  "DIS_LETTURA_ATTIVA_F2": "string",
  "DIS_LETTURA_ATTIVA_F3": "string",
  "DIS_LETTURA_ATTIVA_F4": "string",
  "DIS_LETTURA_ATTIVA_F5": "string",
  "DIS_LETTURA_ATTIVA_F6": "string",
  "DIS_LETTURA_ATTIVA_NEG_F1": "string",
  "DIS_LETTURA_ATTIVA_NEG_F2": "string",
  "DIS_LETTURA_ATTIVA_NEG_F3": "string",
  "DIS_LETTURA_ATTIVA_NEG_F4": "string",
  "DIS_LETTURA_ATTIVA_NEG_F5": "string",
  "DIS_LETTURA_ATTIVA_NEG_F6": "string",
  "DIS_LETTURA_REATTIVA_F1": "string",
  "DIS_LETTURA_REATTIVA_F2": "string",
  "DIS_LETTURA_REATTIVA_F3": "string",
  "DIS_LETTURA_REATTIVA_F4": "string",
  "DIS_LETTURA_REATTIVA_F5": "string",
  "DIS_LETTURA_REATTIVA_F6": "string",
  "DIS_LETTURA_REATTIVA_IND_NEG_F1": "string",
  "DIS_LETTURA_REATTIVA_IND_NEG_F2": "string",
  "DIS_LETTURA_REATTIVA_IND_NEG_F3": "string",
  "DIS_LETTURA_REATTIVA_IND_NEG_F4": "string",
  "DIS_LETTURA_REATTIVA_IND_NEG_F5": "string",
  "DIS_LETTURA_REATTIVA_IND_NEG_F6": "string",
  "DIS_LETTURA_REATTIVA_CAP_POS_F1": "string",
  "DIS_LETTURA_REATTIVA_CAP_POS_F2": "string",
  "DIS_LETTURA_REATTIVA_CAP_POS_F3": "string",
  "DIS_LETTURA_REATTIVA_CAP_POS_F4": "string",
  "DIS_LETTURA_REATTIVA_CAP_POS_F5": "string",
  "DIS_LETTURA_REATTIVA_CAP_POS_F6": "string",
  "DIS_LETTURA_REATTIVA_CAP_NEG_F1": "string",
  "DIS_LETTURA_REATTIVA_CAP_NEG_F2": "string",
  "DIS_LETTURA_REATTIVA_CAP_NEG_F3": "string",
  "DIS_LETTURA_REATTIVA_CAP_NEG_F4": "string",
  "DIS_LETTURA_REATTIVA_CAP_NEG_F5": "string",
  "DIS_LETTURA_REATTIVA_CAP_NEG_F6": "string",
  "DIS_LETTURA_POTENZA_F1": "string",
  "DIS_LETTURA_POTENZA_F2": "string",
  "DIS_LETTURA_POTENZA_F3": "string",
  "DIS_LETTURA_POTENZA_F4": "string",
  "DIS_LETTURA_POTENZA_F5": "string",
  "DIS_LETTURA_POTENZA_F6": "string",
  "DIS_LETTURA_POTENZA_NEG_F1": "string",
  "DIS_LETTURA_POTENZA_NEG_F2": "string",
  "DIS_LETTURA_POTENZA_NEG_F3": "string",
  "DIS_LETTURA_POTENZA_NEG_F4": "string",
  "DIS_LETTURA_POTENZA_NEG_F5": "string",
  "DIS_LETTURA_POTENZA_NEG_F6": "string",
  "LETT_ATT_DIFF_F1": "string",
  "LETT_ATT_DIFF_F2": "string",
  "LETT_ATT_DIFF_F3": "string",
  "LETT_REATT_DIFF_F1": "string",
  "LETT_REATT_DIFF_F2": "string",
  "LETT_REATT_DIFF_F3": "string",
  "SOST_MIS": "string",
  "MISURATORE_ELETTRONICO": "string",
  "MATRICOLA_MISURATORE": "string",
  "MATR_MIS_ATTIVA": "string",
  "MATR_MIS_REATTIVA": "string",
  "MATR_MIS_POTENZA": "string",
  "TIPOLOGIA_MIS": "string",
  "COSTANTE_TRASF_ATTIVA": "string",
  "COSTANTE_TRASF_REATTIVA": "string",
  "COSTANTE_TRASF_POTENZA": "string",
  "DIS_MISURATORE_ELETTRONICO": "string",
  "DIS_MATR_MIS_ATTIVA": "string",
  "DIS_MATR_MIS_REATTIVA": "string",
  "DIS_MATR_MIS_POTENZA": "string",
  "DIS_TIPOLOGIA_MIS": "string",
  "DIS_COSTANTE_TRASF_ATTIVA": "string",
  "DIS_COSTANTE_TRASF_REATTIVA": "string",
  "DIS_COSTANTE_TRASF_POTENZA": "string",
  "LETT_CONT_ATT_1": "string",
  "LETT_CONT_ATT_2": "string",
  "LETT_CONT_ATT_3": "string",
  "LETT_CONT_REATT_1": "string",
  "LETT_CONT_REATT_2": "string",
  "LETT_CONT_REATT_3": "string",
  "LETT_CONT_POT_1": "string",
  "LETT_CONT_POT_2": "string",
  "LETT_CONT_POT_3": "string",
  "LETT_CONT_POT_MAX": "string",
  "DATA_LETTURE_DISTR": "string",
  "LETT_CLI_A1": "string",
  "LETT_CLI_A2": "string",
  "LETT_CLI_A3": "string",
  "LETT_CLI_A4": "string",
  "LETT_CLI_AMONO": "string",
  "LETT_CLI_R1": "string",
  "LETT_CLI_R2": "string",
  "LETT_CLI_R3": "string",
  "LETT_CLI_R4": "string",
  "LETT_CLI_RMONO": "string",
  "LETT_CLI_POT1": "string",
  "LETT_CLI_POT2": "string",
  "LETT_CLI_POT3": "string",
  "LETT_CLI_POT4": "string",
  "LETT_CLI_POTMONO": "string",
  "DATA_LETTURE_CLIENTE": "string",
  "LETT_RID_ENER_A1": "string",
  "LETT_RID_ENER_A2": "string",
  "LETT_RID_ENER_A3": "string",
  "LETT_RID_ENER_R1": "string",
  "LETT_RID_ENER_R2": "string",
  "LETT_RID_ENER_R3": "string",
  "LETT_RID_POT1": "string",
  "LETT_RID_POT2": "string",
  "LETT_RID_POT3": "string",
  "TIPOLOGIA_LETT_RIDUZIONE": "string",
  "TIPOLOGIA_LETT_CHIUSURA": "string",
  "TIPO_NUOVO_MISURATORE": "string",
  "LETT_NUOVA_ATT1": "string",
  "LETT_NUOVA_ATT2": "string",
  "LETT_NUOVA_ATT3": "string",
  "LETT_NUOVA_REATT1": "string",
  "LETT_NUOVA_REATT2": "string",
  "LETT_NUOVA_REATT3": "string",
  "LETT_NUOVA_POT1": "string",
  "LETT_NUOVA_POT2": "string",
  "LETT_NUOVA_POT3": "string",
  "COSTANTE_TA": "string",
  "COSTANTE_TA_NUOVA": "string",
  "COSTANTE_TV": "string",
  "COSTANTE_TV_NUOVA": "string",
  "COEFFICIENTEK": "string",
  "COSTANTEK": "string",
  "TIPO_LETTURA": "string",
  "CLASSE_CONTATORE": "string",
  "DATA_AUTOLETTURA": "string",
  "ESITO_VAL": "string",
  "MESE_COMPET": "string",
  "MALFUNZIONAMENTO_MISURATORE": "string",
  "ADDEBITO_ONERI": "string",
  "DATA_PREVISTA_SOSTITUZIONE": "string",
  "NECESSITA_SOST": "string",
  "CONSENSO_SOST_GRU_MISURA": "string",
  "IMMEDIATA_SOST_GRU_MISURA": "string",
  "ACCERT_VAL_NON_CORRETTI": "string",
  "VERIFICA_NON_ESEGUITA": "string",
  "POT_IMP": "string",
  "POT_DISP": "string",
  "POT_FRANC": "string",
  "POT_IMP_DISTR": "string",
  "POT_FRANC_DISTR": "string",
  "POTENZA_CONTRATTUALE_RICHIESTA": "string",
  "TENSIONE_FASE": "string",
  "FASE_DISTR": "string",
  "TENSIONE": "string",
  "TENS_ALIM_DISTR": "string",
  "CLASSE_TENSIONE": "string",
  "TENSIONE_RETE": "string",
  "AUMENTO_TENS": "string",
  "TIPO_CONTRATTO": "string",
  "SETT_MERCEOLOGICO": "string",
  "TRATTAMENTO_IVA": "string",
  "OPZIONE_TARIFFARIA": "string",
  "STAG_RIC": "string",
  "DATA_INIZIO": "string",
  "DATA_FINE": "string",
  "NOTE": "string",
  "AVANZAMENTO_PRATICA": "string",
  "DATA_INSERIMENTO_RICHIESTA": "string",
  "INDIRIZZO_POD": "string",
  "COD_RINTR_RICH": "string",
  "DATA_PUBBLICAZIONE": "string",
  "DATA_CAMBIO_MIS": "string",
  "DATA_RICEZIONE_BONUS": "string",
  "DATA_RICEVIMENTO_RICHIESTA": "string",
  "CATEGORIA": "string",
  "REVOCA_SOSP": "string",
  "REVOCA_SOSPENSIONE": "string",
  "STATO_POD": "string",
  "DATA_INTERVENTO": "string",
  "DATA_INTER_PROGRAM": "string",
  "DATA_SWITCH": "string",
  "FLAG_PRESENTE_MOROSITA": "string",
  "TIPO_POD": "string",
  "NUOVO_TENTATIVO": "string",
  "CONTINUITA_ALIM_FISICA": "string",
  "FLAG_SUBENTRO": "string",
  "DISALIMENTABILE": "string",
  "CAT_DISAL": "string",
  "TIPO_CONTRATT": "string",
  "AUTOCERT_ISTANZA": "string",
  "MAND_CONN": "string",
  "SOLLEV_PERSONE": "string",
  "COD_LAV_PREDET": "string",
  "DESCRIZIONE_LAVORO": "string",
  "STAB_GIA_ENERGI": "string",
  "NUOVA_ENE": "string",
  "INTTERV_LIM_GRUPPO_MISURA": "string",
  "TIPO_LAVORO": "string",
  "DATA_STIMA_COMPLETAMENTO_LAVORI": "string",
  "NECE_LAV_COMPL": "string",
  "ACCETT_LAV_COMPL": "string",
  "DATA_ACCETT_LAV_COMPLE": "string",
  "CAUSALE_LAVORO_COMPL": "string",
  "COSTO_INT_COMPLESSO": "string",
  "STIMA": "string",
  "CODICE_TIPO_CONN": "string",
  "CONN_FUORI_ORARIO": "string",
  "NUMERO_PUNTI": "string",
  "FABB_DI_POTENZA": "string",
  "FABB_COMPL_DI_POTENZA": "string",
  "DATA_PREVISTA_RIPRISTINO": "string",
  "COD_PREV": "string",
  "DATA_TENTATIVO": "string",
  "RIF_RESOCONTO": "string",
  "CODICE_CAMBIO_TAR": "string",
  "DATA_SOSP_FORN": "string",
  "DATA_RIATT_FORN": "string",
  "DATA_RID_FORN": "string",
  "STATO_AGEVOLAZIONE": "string",
  "DATA_DEC_BONUS": "string",
  "DATA_LIMITE_RIC_RETTIFICA": "string",
  "DATA_VERIFICA_TR": "string",
  "FLAG_CONFERMA_BONUS": "string",
  "TIPO_ANOMALIA": "string",
  "CAUSALE_IMPL": "string",
  "DATA_RIFERIMENTO": "string",
  "TIPO_USO_TEMP": "string",
  "DATA_DISATT": "string",
  "FLAG_TELEGESTITO": "string",
  "NUM_TENTATIVI": "string",
  "FLAG_RICHIEDIBILE": "string",
  "GESTIONE_MANUALE": "string",
  "CARATT_UT_FINALE": "string",
  "MOTIV_CARATT": "string",
  "FLAG_ANN_TR": "string",
  "IND_COMUNI_FORN": "string"
}

ita_industry.messages.electricity.takeover.request.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.electricity.takeover.request.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.electricity.takeover.request.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.electricity.takeover.request.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.gas.change-of-ownership.pre-check.mch-admissibility-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
transaction_id_hubstring
sending_date_sii_dlstring
eligibility_receiving_datestring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring
COD_PDRstring
COD_REMIstring
STATO_PDRstring
PIVA_DISTRIBUTOREstring
TOPONIMOstring
VIAstring
CIVstring
CAPstring
ISTATstring
LOCALITAstring
PROVstring
NAZIONEstring
ALTROstring
PREL_ANNUO_PREVstring
COD_PROF_PREL_STDstring
CAP_TRASP_PDRstring
MATR_MISstring
CLASSE_GRUPPO_MISstring
TELEGESTIONEstring
MERCATO_PROVENIENZAstring
DATA_DECORRENZA_SWGstring
DATA_DECORRENZA_VTG_TIT_IIIstring
DATA_DECORRENZA_VTG_TIT_IVstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.change-of-ownership.pre-check.mch-admissibility-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "sending_date_sii_dl": "string",
  "eligibility_receiving_date": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string",
  "COD_PDR": "string",
  "COD_REMI": "string",
  "STATO_PDR": "string",
  "PIVA_DISTRIBUTORE": "string",
  "TOPONIMO": "string",
  "VIA": "string",
  "CIV": "string",
  "CAP": "string",
  "ISTAT": "string",
  "LOCALITA": "string",
  "PROV": "string",
  "NAZIONE": "string",
  "ALTRO": "string",
  "PREL_ANNUO_PREV": "string",
  "COD_PROF_PREL_STD": "string",
  "CAP_TRASP_PDR": "string",
  "MATR_MIS": "string",
  "CLASSE_GRUPPO_MIS": "string",
  "TELEGESTIONE": "string",
  "MERCATO_PROVENIENZA": "string",
  "DATA_DECORRENZA_SWG": "string",
  "DATA_DECORRENZA_VTG_TIT_III": "string",
  "DATA_DECORRENZA_VTG_TIT_IV": "string"
}

ita_industry.messages.gas.change-of-ownership.pre-check.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.change-of-ownership.pre-check.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.gas.change-of-ownership.pre-check.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.change-of-ownership.pre-check.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.gas.change-of-ownership.request.mch-admissibility-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
transaction_id_hubstring
sending_date_sii_dlstring
eligibility_receiving_datestring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
COD_PDRstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.change-of-ownership.request.mch-admissibility-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "sending_date_sii_dl": "string",
  "eligibility_receiving_date": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "COD_PDR": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string"
}

ita_industry.messages.gas.change-of-ownership.request.mch-final-outcome-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
channelstring
transaction_id_hubstring
cancellation_causalstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
COD_PDRstring
ESITOstring
COD_ESITOstring
DETTAGLIO_ESITOstring
CFstring
PIVAstring
CF_STRANIEROstring
NOMEstring
COGNOMEstring
RAGIONE_SOCIALE_DENOMINAZIONEstring
DATA_DECORRENZAstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.change-of-ownership.request.mch-final-outcome-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "channel": "string",
  "transaction_id_hub": "string",
  "cancellation_causal": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "COD_PDR": "string",
  "ESITO": "string",
  "COD_ESITO": "string",
  "DETTAGLIO_ESITO": "string",
  "CF": "string",
  "PIVA": "string",
  "CF_STRANIERO": "string",
  "NOME": "string",
  "COGNOME": "string",
  "RAGIONE_SOCIALE_DENOMINAZIONE": "string",
  "DATA_DECORRENZA": "string"
}

ita_industry.messages.gas.change-of-ownership.request.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.change-of-ownership.request.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.gas.change-of-ownership.request.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.change-of-ownership.request.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.gas.contact-termination.request.mch-notice-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
COD_PDRstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring
CAMstring
COD_REMIstring
COMPR_CAMstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.contact-termination.request.mch-noticev1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "COD_PDR": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string",
  "CAM": "string",
  "COD_REMI": "string",
  "COMPR_CAM": "string"
}

ita_industry.messages.gas.contract-termination.mch-final-outcome-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
servicestring
flowstring
userTransactionCodestring
siiTransactionCodestring
transactionIdHUBstring
channelstring
finalOutcomestring
checkPortafogliostring
cancellationCausalstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.contract-termination.mch-final-outcome-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "service": "string",
  "flow": "string",
  "userTransactionCode": "string",
  "siiTransactionCode": "string",
  "transactionIdHUB": "string",
  "channel": "string",
  "finalOutcome": "string",
  "checkPortafoglio": "string",
  "cancellationCausal": "string"
}

ita_industry.messages.gas.contract-termination.request.mch-admissibility-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
transaction_id_hubstring
sending_date_sii_dlstring
eligibility_receiving_datestring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
COD_PDRstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.contract-termination.request.mch-admissibility-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "sending_date_sii_dl": "string",
  "eligibility_receiving_date": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "COD_PDR": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string"
}

ita_industry.messages.gas.contract-termination.request.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.contract-termination.request.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.gas.deactivation-upon-final-customer-demand.annulment-request.mch-final-outcome-received-v1

Event Properties

NameType
request_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_DISTRstring
COD_PRAT_UTENTEstring
COD_PRAT_DISTRstring
ESITOstring
NOTEstring
VERIFICA_RISPstring
COD_CAUSALEstring
MOTIVAZIONEstring
STATOstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.deactivation-upon-final-customer-demand.annulment-request.mch-final-outcome-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_DISTR": "string",
  "COD_PRAT_UTENTE": "string",
  "COD_PRAT_DISTR": "string",
  "ESITO": "string",
  "NOTE": "string",
  "VERIFICA_RISP": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string",
  "STATO": "string"
}

ita_industry.messages.gas.deactivation-upon-final-customer-demand.annulment-request.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.deactivation-upon-final-customer-demand.annulment-request.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.gas.deactivation-upon-final-customer-demand.annulment-request.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.deactivation-upon-final-customer-demand.annulment-request.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.gas.deactivation-upon-final-customer-demand.request.mch-admissibility-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
transaction_id_hubstring
sending_date_sii_dlstring
eligibility_receiving_datestring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_DISTRstring
COD_PRAT_UTENTEstring
COD_PRAT_DISTRstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring
STATOstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.deactivation-upon-final-customer-demand.request.mch-admissibility-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "sending_date_sii_dl": "string",
  "eligibility_receiving_date": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_DISTR": "string",
  "COD_PRAT_UTENTE": "string",
  "COD_PRAT_DISTR": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string",
  "STATO": "string"
}

ita_industry.messages.gas.deactivation-upon-final-customer-demand.request.mch-appointment-informative-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
transaction_id_hubstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_DISTRstring
COD_PRAT_UTENTEstring
COD_PRAT_DISTRstring
CODICE_APPUNTAMENTOstring
DATA_APPstring
FASCIA_ORARIAstring
STATOstring
DATA_ATTIVITAstring
CAUSALEstring
DESC_CAUSALEstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.deactivation-upon-final-customer-demand.request.mch-appointment-informative-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_DISTR": "string",
  "COD_PRAT_UTENTE": "string",
  "COD_PRAT_DISTR": "string",
  "CODICE_APPUNTAMENTO": "string",
  "DATA_APP": "string",
  "FASCIA_ORARIA": "string",
  "STATO": "string",
  "DATA_ATTIVITA": "string",
  "CAUSALE": "string",
  "DESC_CAUSALE": "string"
}

ita_industry.messages.gas.deactivation-upon-final-customer-demand.request.mch-final-outcome-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
transaction_id_hubstring
channelstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_DISTRstring
COD_PRAT_UTENTEstring
COD_PRAT_DISTRstring
ESITOstring
MATR_MISstring
SEGN_MISstring
COD_PDRstring
SEGN_CONVstring
DATA_DISATTIVAZIONEstring
STATOstring
DATA_ATTIVITAstring
CAUSALEstring
DESC_CAUSALEstring
NOTEstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.deactivation-upon-final-customer-demand.request.mch-final-outcome-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "channel": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_DISTR": "string",
  "COD_PRAT_UTENTE": "string",
  "COD_PRAT_DISTR": "string",
  "ESITO": "string",
  "MATR_MIS": "string",
  "SEGN_MIS": "string",
  "COD_PDR": "string",
  "SEGN_CONV": "string",
  "DATA_DISATTIVAZIONE": "string",
  "STATO": "string",
  "DATA_ATTIVITA": "string",
  "CAUSALE": "string",
  "DESC_CAUSALE": "string",
  "NOTE": "string"
}

ita_industry.messages.gas.deactivation-upon-final-customer-demand.request.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.deactivation-upon-final-customer-demand.request.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.gas.deactivation-upon-final-customer-demand.request.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.deactivation-upon-final-customer-demand.request.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.gas.measurement-group-technical-data-access.annulment-request.mch-final-outcome-received-v1

Event Properties

NameType
request_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_DISTRstring
COD_PRAT_UTENTEstring
COD_PRAT_DISTRstring
ESITOstring
NOTEstring
VERIFICA_RISPstring
COD_CAUSALEstring
MOTIVAZIONEstring
STATOstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.measurement-group-technical-data-access.annulment-request.mch-final-outcome-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_DISTR": "string",
  "COD_PRAT_UTENTE": "string",
  "COD_PRAT_DISTR": "string",
  "ESITO": "string",
  "NOTE": "string",
  "VERIFICA_RISP": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string",
  "STATO": "string"
}

ita_industry.messages.gas.measurement-group-technical-data-access.annulment-request.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.measurement-group-technical-data-access.annulment-request.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.gas.measurement-group-technical-data-access.annulment-request.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.measurement-group-technical-data-access.annulment-request.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.gas.measurement-group-technical-data-access.request.mch-admissibility-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
transaction_id_hubstring
sending_date_sii_dlstring
eligibility_receiving_datestring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_DISTRstring
COD_PRAT_UTENTEstring
COD_PRAT_DISTRstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring
STATOstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.measurement-group-technical-data-access.request.mch-admissibility-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "sending_date_sii_dl": "string",
  "eligibility_receiving_date": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_DISTR": "string",
  "COD_PRAT_UTENTE": "string",
  "COD_PRAT_DISTR": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string",
  "STATO": "string"
}

ita_industry.messages.gas.measurement-group-technical-data-access.request.mch-appointment-informative-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
transaction_id_hubstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_DISTRstring
COD_PRAT_UTENTEstring
COD_PRAT_DISTRstring
CODICE_APPUNTAMENTOstring
DATA_APPstring
FASCIA_ORARIAstring
STATOstring
DATA_ATTIVITAstring
CAUSALEstring
DESC_CAUSALEstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.measurement-group-technical-data-access.request.mch-appointment-informative-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_DISTR": "string",
  "COD_PRAT_UTENTE": "string",
  "COD_PRAT_DISTR": "string",
  "CODICE_APPUNTAMENTO": "string",
  "DATA_APP": "string",
  "FASCIA_ORARIA": "string",
  "STATO": "string",
  "DATA_ATTIVITA": "string",
  "CAUSALE": "string",
  "DESC_CAUSALE": "string"
}

ita_industry.messages.gas.measurement-group-technical-data-access.request.mch-appointment-outcome-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
transaction_id_hubstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_DISTRstring
COD_PRAT_UTENTEstring
COD_PRAT_DISTRstring
CODICE_APPUNTAMENTOstring
ESITO_CONFERMAstring
NOTEstring
STATOstring
ADDRETEstring
DATA_ATTIVITAstring
CAUSALEstring
DESC_CAUSALEstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.measurement-group-technical-data-access.request.mch-appointment-outcome-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_DISTR": "string",
  "COD_PRAT_UTENTE": "string",
  "COD_PRAT_DISTR": "string",
  "CODICE_APPUNTAMENTO": "string",
  "ESITO_CONFERMA": "string",
  "NOTE": "string",
  "STATO": "string",
  "ADDRETE": "string",
  "DATA_ATTIVITA": "string",
  "CAUSALE": "string",
  "DESC_CAUSALE": "string"
}

ita_industry.messages.gas.measurement-group-technical-data-access.request.mch-final-outcome-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
transaction_id_hubstring
channelstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_DISTRstring
COD_PRAT_UTENTEstring
COD_PRAT_DISTRstring
ESITOstring
MATR_MISstring
SEGN_MISstring
MATR_CONVstring
SEGN_CONVstring
DATA_LETTURAstring
MOTIVAZIONEstring
STATOstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.measurement-group-technical-data-access.request.mch-final-outcome-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "channel": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_DISTR": "string",
  "COD_PRAT_UTENTE": "string",
  "COD_PRAT_DISTR": "string",
  "ESITO": "string",
  "MATR_MIS": "string",
  "SEGN_MIS": "string",
  "MATR_CONV": "string",
  "SEGN_CONV": "string",
  "DATA_LETTURA": "string",
  "MOTIVAZIONE": "string",
  "STATO": "string"
}

ita_industry.messages.gas.measurement-group-technical-data-access.request.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.measurement-group-technical-data-access.request.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.gas.measurement-group-technical-data-access.request.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.measurement-group-technical-data-access.request.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.gas.reactivation-after-suspension-for-missed-payments.request.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.reactivation-after-suspension-for-missed-payments.request.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.gas.reactivation-after-suspension-for-missed-payments.request.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.reactivation-after-suspension-for-missed-payments.request.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.gas.reactivation-after-suspension.request.mch-admissibility-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
transaction_id_hubstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_DISTRstring
COD_PRAT_UTENTEstring
COD_PRAT_DISTRstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring
STATOstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.reactivation-after-suspension.request.mch-admissibility-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_DISTR": "string",
  "COD_PRAT_UTENTE": "string",
  "COD_PRAT_DISTR": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string",
  "STATO": "string"
}

ita_industry.messages.gas.reactivation-after-suspension.request.mch-appointment-informative-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
transaction_id_hubstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_DISTRstring
COD_PRAT_UTENTEstring
COD_PRAT_DISTRstring
CODICE_APPUNTAMENTOstring
DATA_APPstring
FASCIA_ORARIAstring
STATOstring
DATA_ATTIVITAstring
CAUSALEstring
DESC_CAUSALEstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.reactivation-after-suspension.request.mch-appointment-informative-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_DISTR": "string",
  "COD_PRAT_UTENTE": "string",
  "COD_PRAT_DISTR": "string",
  "CODICE_APPUNTAMENTO": "string",
  "DATA_APP": "string",
  "FASCIA_ORARIA": "string",
  "STATO": "string",
  "DATA_ATTIVITA": "string",
  "CAUSALE": "string",
  "DESC_CAUSALE": "string"
}

ita_industry.messages.gas.reactivation-after-suspension.request.mch-appointment-outcome-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
transaction_id_hubstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_DISTRstring
COD_PRAT_UTENTEstring
COD_PRAT_DISTRstring
CODICE_APPUNTAMENTOstring
ESITO_CONFERMAstring
NOTEstring
STATOstring
ADDRETEstring
DATA_ATTIVITAstring
CAUSALEstring
DESC_CAUSALEstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.reactivation-after-suspension.request.mch-appointment-outcome-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_DISTR": "string",
  "COD_PRAT_UTENTE": "string",
  "COD_PRAT_DISTR": "string",
  "CODICE_APPUNTAMENTO": "string",
  "ESITO_CONFERMA": "string",
  "NOTE": "string",
  "STATO": "string",
  "ADDRETE": "string",
  "DATA_ATTIVITA": "string",
  "CAUSALE": "string",
  "DESC_CAUSALE": "string"
}

ita_industry.messages.gas.reactivation-after-suspension.request.mch-final-outcome-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
transaction_id_hubstring
channelstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_DISTRstring
COD_PRAT_UTENTEstring
COD_PREV_DISTRstring
COD_PRAT_DISTRstring
ESITOstring
MATR_MISstring
SEGN_MISstring
COD_PDRstring
SEGN_CONVstring
DATA_ATTIVAZIONEstring
STATOstring
DATA_ATTIVITAstring
CAUSALEstring
DESC_CAUSALEstring
NOTEstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.reactivation-after-suspension.request.mch-final-outcome-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "channel": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_DISTR": "string",
  "COD_PRAT_UTENTE": "string",
  "COD_PREV_DISTR": "string",
  "COD_PRAT_DISTR": "string",
  "ESITO": "string",
  "MATR_MIS": "string",
  "SEGN_MIS": "string",
  "COD_PDR": "string",
  "SEGN_CONV": "string",
  "DATA_ATTIVAZIONE": "string",
  "STATO": "string",
  "DATA_ATTIVITA": "string",
  "CAUSALE": "string",
  "DESC_CAUSALE": "string",
  "NOTE": "string"
}

ita_industry.messages.gas.self-reading-transmission.request.mch-final-outcome-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
transaction_id_hubstring
channelstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_DISTRstring
COD_PDRstring
MATR_MISstring
MATR_CONVstring
DATA_COM_AUTOLET_CFstring
LET_TOT_PRELstring
LET_TOT_CONVstring
ESITO_VALstring
NOTEstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.self-reading-transmission.request.mch-final-outcome-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "channel": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_DISTR": "string",
  "COD_PDR": "string",
  "MATR_MIS": "string",
  "MATR_CONV": "string",
  "DATA_COM_AUTOLET_CF": "string",
  "LET_TOT_PREL": "string",
  "LET_TOT_CONV": "string",
  "ESITO_VAL": "string",
  "NOTE": "string"
}

ita_industry.messages.gas.self-reading-transmission.request.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.self-reading-transmission.request.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.gas.self-reading-transmission.request.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.self-reading-transmission.request.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.gas.suspension-for-missed-payment.request.mch-admissibility-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
transaction_id_hubstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_DISTRstring
COD_PRAT_UTENTEstring
COD_PRAT_DISTRstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring
STATOstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.suspension-for-missed-payment.request.mch-admissibility-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_DISTR": "string",
  "COD_PRAT_UTENTE": "string",
  "COD_PRAT_DISTR": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string",
  "STATO": "string"
}

ita_industry.messages.gas.suspension-for-missed-payment.request.mch-final-outcome-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
transaction_id_hubstring
channelstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_DISTRstring
COD_PRAT_UTENTEstring
COD_PRAT_DISTRstring
ESITOstring
COD_CAUSALEstring
NOTEstring
FAT_TECstring
STI_COSTIstring
COD_PDRstring
MATR_MISstring
MATR_CONVstring
SEGN_MISstring
SEGN_CONVstring
COEFF_CORRstring
TIPO_LETTURAstring
DATA_RILstring
NUM_TENstring
STATOstring
DATA_ATTIVITAstring
CAUSALEstring
DESC_CAUSALEstring
DATA_SCADENZAstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.suspension-for-missed-payment.request.mch-final-outcome-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "channel": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_DISTR": "string",
  "COD_PRAT_UTENTE": "string",
  "COD_PRAT_DISTR": "string",
  "ESITO": "string",
  "COD_CAUSALE": "string",
  "NOTE": "string",
  "FAT_TEC": "string",
  "STI_COSTI": "string",
  "COD_PDR": "string",
  "MATR_MIS": "string",
  "MATR_CONV": "string",
  "SEGN_MIS": "string",
  "SEGN_CONV": "string",
  "COEFF_CORR": "string",
  "TIPO_LETTURA": "string",
  "DATA_RIL": "string",
  "NUM_TEN": "string",
  "STATO": "string",
  "DATA_ATTIVITA": "string",
  "CAUSALE": "string",
  "DESC_CAUSALE": "string",
  "DATA_SCADENZA": "string"
}

ita_industry.messages.gas.suspension-for-missed-payment.request.mch-intervention-outcome-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
transaction_id_hubstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_DISTRstring
COD_PRAT_UTENTEstring
COD_PRAT_DISTRstring
CODICE_APPUNTAMENTOstring
ESITO_CONFERMAstring
NOTEstring
STATOstring
ADDRETEstring
DATA_ATTIVITAstring
CAUSALEstring
DESC_CAUSALEstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.suspension-for-missed-payment.request.mch-intervention-outcome-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_DISTR": "string",
  "COD_PRAT_UTENTE": "string",
  "COD_PRAT_DISTR": "string",
  "CODICE_APPUNTAMENTO": "string",
  "ESITO_CONFERMA": "string",
  "NOTE": "string",
  "STATO": "string",
  "ADDRETE": "string",
  "DATA_ATTIVITA": "string",
  "CAUSALE": "string",
  "DESC_CAUSALE": "string"
}

ita_industry.messages.gas.suspension-for-missed-payment.request.mch-weekly-capacity-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
transaction_id_hubstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_DISTRstring
COD_REMIstring
CSSstring
COD_PRAT_UTENTEstring
COD_PRAT_DISTRstring
COMPR_CSSstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.suspension-for-missed-payment.request.mch-weekly-capacity-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_DISTR": "string",
  "COD_REMI": "string",
  "CSS": "string",
  "COD_PRAT_UTENTE": "string",
  "COD_PRAT_DISTR": "string",
  "COMPR_CSS": "string"
}

ita_industry.messages.gas.suspension-for-missed-payment.request.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.suspension-for-missed-payment.request.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.gas.suspension-for-missed-payment.request.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.suspension-for-missed-payment.request.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.gas.switch-in.pre-check.mch-final-outcome-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_VENDITOREstring
PIVA_GESTOREstring
CP_VENDITOREstring
CP_GESTOREstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring
ESITOstring
COD_ESITOstring
DETTAGLIO_ESITOstring
COD_PDRstring
COD_REMIstring
TIPO_PDRstring
PIVA_DISTRIBUTOREstring
CFstring
PIVAstring
CF_STRANIEROstring
NOMEstring
COGNOMEstring
RAGIONE_SOCIALEstring
RAGIONE_SOCIALE_CONTROPARTECOMMERCIALEstring
PIVA_CONTROPARTECOMMERCIALEstring
POSTA_CERTIFICATAstring
STATO_PDRstring
CAP_TRASP_PDRstring
PREL_ANNUO_PREVstring
COD_PROF_PREL_STDstring
CLASSE_GRUPPO_MISstring
TIPO_MISstring
TELEGESTIONEstring
PRE_CONVstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.switch-in.pre-check.mch-final-outcome-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_VENDITORE": "string",
  "PIVA_GESTORE": "string",
  "CP_VENDITORE": "string",
  "CP_GESTORE": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string",
  "ESITO": "string",
  "COD_ESITO": "string",
  "DETTAGLIO_ESITO": "string",
  "COD_PDR": "string",
  "COD_REMI": "string",
  "TIPO_PDR": "string",
  "PIVA_DISTRIBUTORE": "string",
  "CF": "string",
  "PIVA": "string",
  "CF_STRANIERO": "string",
  "NOME": "string",
  "COGNOME": "string",
  "RAGIONE_SOCIALE": "string",
  "RAGIONE_SOCIALE_CONTROPARTECOMMERCIALE": "string",
  "PIVA_CONTROPARTECOMMERCIALE": "string",
  "POSTA_CERTIFICATA": "string",
  "STATO_PDR": "string",
  "CAP_TRASP_PDR": "string",
  "PREL_ANNUO_PREV": "string",
  "COD_PROF_PREL_STD": "string",
  "CLASSE_GRUPPO_MIS": "string",
  "TIPO_MIS": "string",
  "TELEGESTIONE": "string",
  "PRE_CONV": "string"
}

ita_industry.messages.gas.switch-in.pre-check.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.switch-in.pre-check.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.gas.switch-in.pre-check.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.switch-in.pre-check.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.gas.switch-in.request.mch-admissibility-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
COD_PDRstring
CFstring
PIVAstring
CF_STRANIEROstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.switch-in.request.mch-admissibility-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "COD_PDR": "string",
  "CF": "string",
  "PIVA": "string",
  "CF_STRANIERO": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string"
}

ita_industry.messages.gas.switch-in.request.mch-final-outcome-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
servicestring
flowstring
userTransactionCodestring
siiTransactionCodestring
transactionIdHUBstring
channelstring
finalOutcomestring
cancellationCausalstring
checkPortafogliostring

Metadata

Event TypePayload Version
ita_industry.messages.gas.switch-in.request.mch-final-outcome-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "service": "string",
  "flow": "string",
  "userTransactionCode": "string",
  "siiTransactionCode": "string",
  "transactionIdHUB": "string",
  "channel": "string",
  "finalOutcome": "string",
  "cancellationCausal": "string",
  "checkPortafoglio": "string"
}

ita_industry.messages.gas.switch-in.request.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.switch-in.request.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.gas.switch-in.request.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.switch-in.request.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.gas.switch-in.timg.mch-notice-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
transaction_id_hubstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
COD_PDRstring
PDR_CHIUSO_MORstring
DATE_SOSPstring
DATE_SOSTstring
ACC_MISstring
PRESENZA_CMORstring
DATA_ATT_FDDstring
DATA_CHIUSURA_PDRstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.switch-in.timg.mch-notice-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "COD_PDR": "string",
  "PDR_CHIUSO_MOR": "string",
  "DATE_SOSP": "string",
  "DATE_SOST": "string",
  "ACC_MIS": "string",
  "PRESENZA_CMOR": "string",
  "DATA_ATT_FDD": "string",
  "DATA_CHIUSURA_PDR": "string"
}

ita_industry.messages.gas.switch-out-with-change-of-ownership.mch-notice-received-v1

Event Properties

NameType
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
requiredCOD_SERVIZIOstring
requiredCOD_FLUSSOstring
requiredPIVA_UTENTEstring
requiredPIVA_GESTOREstring
requiredCP_GESTOREstring
requiredCOD_PDRstring
requiredCOD_REMIstring
requiredDATA_DECORRENZAstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.switch-out-with-change-of-ownership.mch-notice-receivedv1

JSON Payload Representation

{
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_GESTORE": "string",
  "COD_PDR": "string",
  "COD_REMI": "string",
  "DATA_DECORRENZA": "string"
}

ita_industry.messages.gas.switch-out.mch-final-outcome-received-v1

Event Properties

NameType
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
servicestring
flowstring
siiTransactionCodestring
pdrstring
switchEffectiveFromDatestring
channelstring
finalOutcomestring
cancellationCausalstring
receivingDateFinalResultstring
checkPortafogliostring

Metadata

Event TypePayload Version
ita_industry.messages.gas.switch-out.mch-final-outcome-receivedv1

JSON Payload Representation

{
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "service": "string",
  "flow": "string",
  "siiTransactionCode": "string",
  "pdr": "string",
  "switchEffectiveFromDate": "string",
  "channel": "string",
  "finalOutcome": "string",
  "cancellationCausal": "string",
  "receivingDateFinalResult": "string",
  "checkPortafoglio": "string"
}

ita_industry.messages.gas.switch-out.mch-notice-received-v1

Event Properties

NameType
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
requiredCOD_SERVIZIOstring
requiredCOD_FLUSSOstring
requiredPIVA_UTENTEstring
requiredPIVA_GESTOREstring
requiredCP_GESTOREstring
requiredCOD_PDRstring
CFstring
PIVAstring
CF_STRANIEROstring
requiredDATA_DECORRENZAstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.switch-out.mch-notice-receivedv1

JSON Payload Representation

{
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_GESTORE": "string",
  "COD_PDR": "string",
  "CF": "string",
  "PIVA": "string",
  "CF_STRANIERO": "string",
  "DATA_DECORRENZA": "string"
}

ita_industry.messages.gas.update-on-condition.request.mch-admissibility-received-v1

Event Properties

NameType
requiredstep_outcomeboolean
requiredrequest_correlation_idstring
requiredcode_reason_stepinteger
transaction_id_hubstring
eligibility_receiving_datestring
sending_date_sii_dlstring
COD_SERVIZIOstring
COD_FLUSSOstring
CP_UTENTEstring
CP_GESTOREstring
PIVA_UTENTEstring
PIVA_GESTOREstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring
COD_PDRstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.update-on-condition.request.mch-admissibility-receivedv1

JSON Payload Representation

{
  "step_outcome": "boolean",
  "request_correlation_id": "string",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "eligibility_receiving_date": "string",
  "sending_date_sii_dl": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string",
  "COD_PDR": "string"
}

ita_industry.messages.gas.update-on-condition.request.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.update-on-condition.request.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.gas.update-on-condition.request.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.gas.update-on-condition.request.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.interruption-for-missed-payment.request.mch-admissibility-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
transaction_id_hubstring
sending_date_sii_dlstring
eligibility_receiving_datestring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_DISTRstring
COD_PRAT_UTENTEstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring
SERVIZIO_RICHIEDIBILEstring
COD_PRAT_DISTRstring

Metadata

Event TypePayload Version
ita_industry.messages.interruption-for-missed-payment.request.mch-admissibility-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "sending_date_sii_dl": "string",
  "eligibility_receiving_date": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_DISTR": "string",
  "COD_PRAT_UTENTE": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string",
  "SERVIZIO_RICHIEDIBILE": "string",
  "COD_PRAT_DISTR": "string"
}

ita_industry.messages.interruption-for-missed-payment.request.mch-final-outcome-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
transaction_id_hubstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_DISTRstring
COD_PRAT_UTENTEstring
COD_PRAT_DISTRstring
COD_RINTR_RICHstring
DATA_PUBBLICAZIONEstring
DATA_CAMBIO_MISstring
DATA_RICEZIONE_BONUSstring
ID_ACQUISIZIONE_PRATICAstring
NUOVO_COD_UNI_RINTRstring
NUOVO_COD_UNI_PRESTstring
DATA_RICEVIMENTO_RICHIESTAstring
RICH_UTENTEstring
CATEGORIAstring
TIPO_RICH_CLI_FINstring
COD_PRAT_RIFstring
COD_PRAT_GESTOREstring
DATA_ULTIMO_CAMBIO_STATOstring
CAUSALE_ANNULLAMENTO_PRESTAZIONEstring
DATA_ANNULLAMENTO_PRESTAZIONEstring
NUMERO_DLstring
STATO_PRESTAZIONEstring
ESITO_FINALEstring
REVOCA_SOSPstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring
SERVIZIO_RICHIEDIBILEstring
COD_PODstring
STATO_PODstring
MATR_MIS_1string
MATR_MIS_2string
MATR_MIS_3string
MATR_NUOVO_MIS_1string
MATR_NUOVO_MIS_2string
MATR_NUOVO_MIS_3string
MIS_ELETTRONICOstring
MIS_ELETTRONICO_NUOVOstring
DATA_INTERVENTOstring
DATA_SWITCHstring
LETT_ATT_F1string
LETT_ATT_F2string
LETT_ATT_F3string
LETT_ATT_DIFF_F1string
LETT_ATT_DIFF_F2string
LETT_ATT_DIFF_F3string
LETT_REATT_F1string
LETT_REATT_F2string
LETT_REATT_F3string
LETT_REATT_DIFF_F1string
LETT_REATT_DIFF_F2string
LETT_REATT_DIFF_F3string
LETT_POT_F1string
LETT_POT_F2string
LETT_POT_F3string
POT_IMPstring
TENSIONEstring
POT_DISPstring
COSTANTEKstring
TIPO_LETTURAstring
CLASSE_CONTATOREstring
FLAG_PRESENTE_MOROSITAstring
TIPO_PODstring
TIPO_CONTRATTstring
NUOVO_TENTATIVOstring
FLAG_SOSTITUZIONE_MISURATOREstring
LETT_CONT_ATT_1string
LETT_CONT_ATT_2string
LETT_CONT_ATT_3string
LETT_CONT_REATT_1string
LETT_CONT_REATT_2string
LETT_CONT_REATT_3string
LETT_CONT_POT_1string
LETT_CONT_POT_2string
LETT_CONT_POT_3string
LETT_CONT_POT_MAXstring
DATA_LETTURE_DISTRstring
LETT_CLI_A1string
LETT_CLI_A2string
LETT_CLI_A3string
LETT_CLI_A4string
LETT_CLI_AMONOstring
LETT_CLI_R1string
LETT_CLI_R2string
LETT_CLI_R3string
LETT_CLI_R4string
LETT_CLI_RMONOstring
LETT_CLI_POT1string
LETT_CLI_POT2string
LETT_CLI_POT3string
LETT_CLI_POT4string
LETT_CLI_POTMONOstring
DATA_LETTURE_CLIENTEstring
MALFUNZIONAMENTO_MISURATOREstring
ADDEBITO_ONERIstring
DATA_PREVISTA_SOSTITUZIONEstring
NECESSITA_SOSTstring
CONSENSO_SOST_GRU_MISURAstring
IMMEDIATA_SOST_GRU_MISURAstring
ACCERT_VAL_NON_CORRETTIstring
VERIFICA_NON_ESEGUITAstring
CONTINUITA_ALIM_FISICAstring
FLAG_SUBENTROstring
DISALIMENTABILEstring
CAT_DISALstring
NUOVA_ENEstring
TIPO_UTENZAstring
SETT_MERCEOLOGICOstring
TIPO_MISURATOREstring
AUTOCERT_ISTANZAstring
MAND_CONNstring
SOLLEV_PERSONEstring
AUMENTO_TENSstring
COD_LAV_PREDETstring
DESCRIZIONE_LAVOROstring
STAB_GIA_ENERGIstring
INTTERV_LIM_GRUPPO_MISURAstring
POTENZA_CONTRATTUALE_RICHIESTAstring
TIPO_LAVOROstring
DATA_STIMA_COMPLETAMENTO_LAVORIstring
NECE_LAV_COMPLstring
ACCETT_LAV_COMPLstring
DATA_ACCETT_LAV_COMPLEstring
CAUSALE_LAVORO_COMPLstring
STIMAstring
CODICE_TIPO_CONNstring
CONN_FUORI_ORARIOstring
NUMERO_PUNTIstring
FABB_DI_POTENZAstring
FABB_COMPL_DI_POTENZAstring
OPZ_TARIFFstring
DATA_PREVISTA_RIPRISTINOstring
TENSIONE_FASEstring
POT_FRANCstring
COD_PREVstring
DATA_TENTATIVOstring
RIF_RESOCONTOstring
DATA_ESECUZIONE_POSTstring
CODICE_CAMBIO_TARstring
DATA_SOSP_FORNstring
DATA_RIATT_FORNstring
DATA_RID_FORNstring
LETT_RID_POT1string
LETT_RID_POT2string
LETT_RID_POT3string
LETT_RID_ENER_A1string
LETT_RID_ENER_A2string
LETT_RID_ENER_A3string
LETT_RID_ENER_R1string
LETT_RID_ENER_R2string
LETT_RID_ENER_R3string
STATO_AGEVOLAZIONEstring
DATA_DEC_BONUSstring
DATA_LIMITE_RIC_RETTIFICAstring
DATA_VERIFICA_TRstring
FLAG_CONFERMA_BONUSstring
TIPO_ANOMALIAstring
LETT_NUOVA_ATT1string
LETT_NUOVA_ATT2string
LETT_NUOVA_ATT3string
LETT_NUOVA_REATT1string
LETT_NUOVA_REATT2string
LETT_NUOVA_REATT3string
LETT_NUOVA_POT1string
LETT_NUOVA_POT2string
LETT_NUOVA_POT3string
COSTANTE_TAstring
COSTANTE_TA_NUOVAstring
COSTANTE_TVstring
COSTANTE_TV_NUOVAstring
COEFFICIENTEKstring
DATA_AUTOLETTURAstring
ESITO_VALstring
MESE_COMPETstring
CAUSALE_IMPLstring
FASE_DISTRstring
TENS_ALIM_DISTRstring
POT_IMP_DISTRstring
POT_FRANC_DISTRstring
TIPO_NUOVO_MISURATOREstring
DATA_RIFERIMENTOstring
TIPOLOGIA_LETT_RIDUZIONEstring
TIPOLOGIA_LETT_CHIUSURAstring
TIPO_USO_TEMPstring
DATA_DISATTstring
FLAG_TELEGESTITOstring
NUM_TENTATIVIstring
FLAG_RICHIEDIBILEstring
COSTO_INT_COMPLESSOstring
DATA_INTER_PROGRAMstring
GESTIONE_MANUALEstring
CARATT_UT_FINALEstring
MOTIV_CARATTstring
COGNOMEstring
NOMEstring
RAG_SOCstring
TELstring
CFstring
PIVAstring
NOTE_GENstring
NOTE_OUTstring
CAUSALE_ESITO_POSstring
CAUSALE_ESITO_NEGstring
MOTIVAZIONE_ESITO_NEGstring

Metadata

Event TypePayload Version
ita_industry.messages.interruption-for-missed-payment.request.mch-final-outcome-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_DISTR": "string",
  "COD_PRAT_UTENTE": "string",
  "COD_PRAT_DISTR": "string",
  "COD_RINTR_RICH": "string",
  "DATA_PUBBLICAZIONE": "string",
  "DATA_CAMBIO_MIS": "string",
  "DATA_RICEZIONE_BONUS": "string",
  "ID_ACQUISIZIONE_PRATICA": "string",
  "NUOVO_COD_UNI_RINTR": "string",
  "NUOVO_COD_UNI_PREST": "string",
  "DATA_RICEVIMENTO_RICHIESTA": "string",
  "RICH_UTENTE": "string",
  "CATEGORIA": "string",
  "TIPO_RICH_CLI_FIN": "string",
  "COD_PRAT_RIF": "string",
  "COD_PRAT_GESTORE": "string",
  "DATA_ULTIMO_CAMBIO_STATO": "string",
  "CAUSALE_ANNULLAMENTO_PRESTAZIONE": "string",
  "DATA_ANNULLAMENTO_PRESTAZIONE": "string",
  "NUMERO_DL": "string",
  "STATO_PRESTAZIONE": "string",
  "ESITO_FINALE": "string",
  "REVOCA_SOSP": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string",
  "SERVIZIO_RICHIEDIBILE": "string",
  "COD_POD": "string",
  "STATO_POD": "string",
  "MATR_MIS_1": "string",
  "MATR_MIS_2": "string",
  "MATR_MIS_3": "string",
  "MATR_NUOVO_MIS_1": "string",
  "MATR_NUOVO_MIS_2": "string",
  "MATR_NUOVO_MIS_3": "string",
  "MIS_ELETTRONICO": "string",
  "MIS_ELETTRONICO_NUOVO": "string",
  "DATA_INTERVENTO": "string",
  "DATA_SWITCH": "string",
  "LETT_ATT_F1": "string",
  "LETT_ATT_F2": "string",
  "LETT_ATT_F3": "string",
  "LETT_ATT_DIFF_F1": "string",
  "LETT_ATT_DIFF_F2": "string",
  "LETT_ATT_DIFF_F3": "string",
  "LETT_REATT_F1": "string",
  "LETT_REATT_F2": "string",
  "LETT_REATT_F3": "string",
  "LETT_REATT_DIFF_F1": "string",
  "LETT_REATT_DIFF_F2": "string",
  "LETT_REATT_DIFF_F3": "string",
  "LETT_POT_F1": "string",
  "LETT_POT_F2": "string",
  "LETT_POT_F3": "string",
  "POT_IMP": "string",
  "TENSIONE": "string",
  "POT_DISP": "string",
  "COSTANTEK": "string",
  "TIPO_LETTURA": "string",
  "CLASSE_CONTATORE": "string",
  "FLAG_PRESENTE_MOROSITA": "string",
  "TIPO_POD": "string",
  "TIPO_CONTRATT": "string",
  "NUOVO_TENTATIVO": "string",
  "FLAG_SOSTITUZIONE_MISURATORE": "string",
  "LETT_CONT_ATT_1": "string",
  "LETT_CONT_ATT_2": "string",
  "LETT_CONT_ATT_3": "string",
  "LETT_CONT_REATT_1": "string",
  "LETT_CONT_REATT_2": "string",
  "LETT_CONT_REATT_3": "string",
  "LETT_CONT_POT_1": "string",
  "LETT_CONT_POT_2": "string",
  "LETT_CONT_POT_3": "string",
  "LETT_CONT_POT_MAX": "string",
  "DATA_LETTURE_DISTR": "string",
  "LETT_CLI_A1": "string",
  "LETT_CLI_A2": "string",
  "LETT_CLI_A3": "string",
  "LETT_CLI_A4": "string",
  "LETT_CLI_AMONO": "string",
  "LETT_CLI_R1": "string",
  "LETT_CLI_R2": "string",
  "LETT_CLI_R3": "string",
  "LETT_CLI_R4": "string",
  "LETT_CLI_RMONO": "string",
  "LETT_CLI_POT1": "string",
  "LETT_CLI_POT2": "string",
  "LETT_CLI_POT3": "string",
  "LETT_CLI_POT4": "string",
  "LETT_CLI_POTMONO": "string",
  "DATA_LETTURE_CLIENTE": "string",
  "MALFUNZIONAMENTO_MISURATORE": "string",
  "ADDEBITO_ONERI": "string",
  "DATA_PREVISTA_SOSTITUZIONE": "string",
  "NECESSITA_SOST": "string",
  "CONSENSO_SOST_GRU_MISURA": "string",
  "IMMEDIATA_SOST_GRU_MISURA": "string",
  "ACCERT_VAL_NON_CORRETTI": "string",
  "VERIFICA_NON_ESEGUITA": "string",
  "CONTINUITA_ALIM_FISICA": "string",
  "FLAG_SUBENTRO": "string",
  "DISALIMENTABILE": "string",
  "CAT_DISAL": "string",
  "NUOVA_ENE": "string",
  "TIPO_UTENZA": "string",
  "SETT_MERCEOLOGICO": "string",
  "TIPO_MISURATORE": "string",
  "AUTOCERT_ISTANZA": "string",
  "MAND_CONN": "string",
  "SOLLEV_PERSONE": "string",
  "AUMENTO_TENS": "string",
  "COD_LAV_PREDET": "string",
  "DESCRIZIONE_LAVORO": "string",
  "STAB_GIA_ENERGI": "string",
  "INTTERV_LIM_GRUPPO_MISURA": "string",
  "POTENZA_CONTRATTUALE_RICHIESTA": "string",
  "TIPO_LAVORO": "string",
  "DATA_STIMA_COMPLETAMENTO_LAVORI": "string",
  "NECE_LAV_COMPL": "string",
  "ACCETT_LAV_COMPL": "string",
  "DATA_ACCETT_LAV_COMPLE": "string",
  "CAUSALE_LAVORO_COMPL": "string",
  "STIMA": "string",
  "CODICE_TIPO_CONN": "string",
  "CONN_FUORI_ORARIO": "string",
  "NUMERO_PUNTI": "string",
  "FABB_DI_POTENZA": "string",
  "FABB_COMPL_DI_POTENZA": "string",
  "OPZ_TARIFF": "string",
  "DATA_PREVISTA_RIPRISTINO": "string",
  "TENSIONE_FASE": "string",
  "POT_FRANC": "string",
  "COD_PREV": "string",
  "DATA_TENTATIVO": "string",
  "RIF_RESOCONTO": "string",
  "DATA_ESECUZIONE_POST": "string",
  "CODICE_CAMBIO_TAR": "string",
  "DATA_SOSP_FORN": "string",
  "DATA_RIATT_FORN": "string",
  "DATA_RID_FORN": "string",
  "LETT_RID_POT1": "string",
  "LETT_RID_POT2": "string",
  "LETT_RID_POT3": "string",
  "LETT_RID_ENER_A1": "string",
  "LETT_RID_ENER_A2": "string",
  "LETT_RID_ENER_A3": "string",
  "LETT_RID_ENER_R1": "string",
  "LETT_RID_ENER_R2": "string",
  "LETT_RID_ENER_R3": "string",
  "STATO_AGEVOLAZIONE": "string",
  "DATA_DEC_BONUS": "string",
  "DATA_LIMITE_RIC_RETTIFICA": "string",
  "DATA_VERIFICA_TR": "string",
  "FLAG_CONFERMA_BONUS": "string",
  "TIPO_ANOMALIA": "string",
  "LETT_NUOVA_ATT1": "string",
  "LETT_NUOVA_ATT2": "string",
  "LETT_NUOVA_ATT3": "string",
  "LETT_NUOVA_REATT1": "string",
  "LETT_NUOVA_REATT2": "string",
  "LETT_NUOVA_REATT3": "string",
  "LETT_NUOVA_POT1": "string",
  "LETT_NUOVA_POT2": "string",
  "LETT_NUOVA_POT3": "string",
  "COSTANTE_TA": "string",
  "COSTANTE_TA_NUOVA": "string",
  "COSTANTE_TV": "string",
  "COSTANTE_TV_NUOVA": "string",
  "COEFFICIENTEK": "string",
  "DATA_AUTOLETTURA": "string",
  "ESITO_VAL": "string",
  "MESE_COMPET": "string",
  "CAUSALE_IMPL": "string",
  "FASE_DISTR": "string",
  "TENS_ALIM_DISTR": "string",
  "POT_IMP_DISTR": "string",
  "POT_FRANC_DISTR": "string",
  "TIPO_NUOVO_MISURATORE": "string",
  "DATA_RIFERIMENTO": "string",
  "TIPOLOGIA_LETT_RIDUZIONE": "string",
  "TIPOLOGIA_LETT_CHIUSURA": "string",
  "TIPO_USO_TEMP": "string",
  "DATA_DISATT": "string",
  "FLAG_TELEGESTITO": "string",
  "NUM_TENTATIVI": "string",
  "FLAG_RICHIEDIBILE": "string",
  "COSTO_INT_COMPLESSO": "string",
  "DATA_INTER_PROGRAM": "string",
  "GESTIONE_MANUALE": "string",
  "CARATT_UT_FINALE": "string",
  "MOTIV_CARATT": "string",
  "COGNOME": "string",
  "NOME": "string",
  "RAG_SOC": "string",
  "TEL": "string",
  "CF": "string",
  "PIVA": "string",
  "NOTE_GEN": "string",
  "NOTE_OUT": "string",
  "CAUSALE_ESITO_POS": "string",
  "CAUSALE_ESITO_NEG": "string",
  "MOTIVAZIONE_ESITO_NEG": "string"
}

ita_industry.messages.interruption-for-missed-payment.request.mch-informative-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
transaction_id_hubstring
COD_SERVIZIOstring
COD_FLUSSOstring
CATEGORIAstring
COD_PRAT_DISTRstring
COD_PRAT_GESTOREstring
COD_PRAT_RIFstring
COD_RINTR_RICHstring
CP_UTENTEstring
DATA_CAMBIO_MISstring
DATA_PUBBLICAZIONEstring
DATA_RICEVIMENTO_RICHIESTAstring
DATA_RICEZIONE_BONUSstring
ID_ACQUISIZIONE_PRATICAstring
NUOVO_COD_UNI_PRESTstring
NUOVO_COD_UNI_RINTRstring
PIVA_DISTRstring
PIVA_UTENTEstring
RICH_UTENTEstring
TIPO_RICH_CLI_FINstring
CAUSALE_ANNULLAMENTO_PRESTAZIONEstring
DATA_ANNULLAMENTO_PRESTAZIONEstring
DATA_ULTIMO_CAMBIO_STATOstring
ESITO_FINALEstring
NUMERO_DLstring
REVOCA_SOSPstring
STATO_PRESTAZIONEstring
COD_CAUSALEstring
MOTIVAZIONEstring
SERVIZIO_RICHIEDIBILEstring
VERIFICA_AMMstring
ACCERT_VAL_NON_CORRETTIstring
ACCETT_LAV_COMPLstring
ADDEBITO_ONERIstring
AUMENTO_TENSstring
AUTOCERT_ISTANZAstring
CARATT_UT_FINALEstring
CAT_DISALstring
CAUSALE_IMPLstring
CAUSALE_LAVORO_COMPLstring
CLASSE_CONTATOREstring
COD_LAV_PREDETstring
COD_PODstring
COD_PREVstring
CODICE_CAMBIO_TARstring
CODICE_TIPO_CONNstring
COEFFICIENTEKstring
CONN_FUORI_ORARIOstring
CONSENSO_SOST_GRU_MISURAstring
CONTINUITA_ALIM_FISICAstring
COSTANTE_TAstring
COSTANTE_TA_NUOVAstring
COSTANTE_TVstring
COSTANTE_TV_NUOVAstring
COSTANTEKstring
COSTO_INT_COMPLESSOstring
DATA_ACCETT_LAV_COMPLEstring
DATA_AUTOLETTURAstring
DATA_DEC_BONUSstring
DATA_DISATTstring
DATA_ESECUZIONE_POSTstring
DATA_INTER_PROGRAMstring
DATA_INTERVENTOstring
DATA_LETTURE_CLIENTEstring
DATA_LETTURE_DISTRstring
DATA_LIMITE_RIC_RETTIFICAstring
DATA_PREVISTA_RIPRISTINOstring
DATA_PREVISTA_SOSTITUZIONEstring
DATA_RIATT_FORNstring
DATA_RID_FORNstring
DATA_RIFERIMENTOstring
DATA_SOSP_FORNstring
DATA_STIMA_COMPLETAMENTO_LAVORIstring
DATA_SWITCHstring
DATA_TENTATIVOstring
DATA_VERIFICA_TRstring
DESCRIZIONE_LAVOROstring
DISALIMENTABILEstring
ESITO_VALstring
FABB_COMPL_DI_POTENZAstring
FABB_DI_POTENZAstring
FASE_DISTRstring
FLAG_CONFERMA_BONUSstring
FLAG_PRESENTE_MOROSITAstring
FLAG_RICHIEDIBILEstring
FLAG_SOSTITUZIONE_MISURATOREstring
FLAG_SUBENTROstring
FLAG_TELEGESTITOstring
GESTIONE_MANUALEstring
IMMEDIATA_SOST_GRU_MISURAstring
INTTERV_LIM_GRUPPO_MISURAstring
LETT_ATT_DIFF_F1string
LETT_ATT_DIFF_F2string
LETT_ATT_DIFF_F3string
LETT_ATT_F1string
LETT_ATT_F2string
LETT_ATT_F3string
LETT_CLI_A1string
LETT_CLI_A2string
LETT_CLI_A3string
LETT_CLI_A4string
LETT_CLI_AMONOstring
LETT_CLI_POT1string
LETT_CLI_POT2string
LETT_CLI_POT3string
LETT_CLI_POT4string
LETT_CLI_POTMONOstring
LETT_CLI_R1string
LETT_CLI_R2string
LETT_CLI_R3string
LETT_CLI_R4string
LETT_CLI_RMONOstring
LETT_CONT_ATT_1string
LETT_CONT_ATT_2string
LETT_CONT_ATT_3string
LETT_CONT_POT_1string
LETT_CONT_POT_2string
LETT_CONT_POT_3string
LETT_CONT_POT_MAXstring
LETT_CONT_REATT_1string
LETT_CONT_REATT_2string
LETT_CONT_REATT_3string
LETT_NUOVA_ATT1string
LETT_NUOVA_ATT2string
LETT_NUOVA_ATT3string
LETT_NUOVA_POT1string
LETT_NUOVA_POT2string
LETT_NUOVA_POT3string
LETT_NUOVA_REATT1string
LETT_NUOVA_REATT2string
LETT_NUOVA_REATT3string
LETT_POT_F1string
LETT_POT_F2string
LETT_POT_F3string
LETT_REATT_DIFF_F1string
LETT_REATT_DIFF_F2string
LETT_REATT_DIFF_F3string
LETT_REATT_F1string
LETT_REATT_F2string
LETT_REATT_F3string
LETT_RID_ENER_A1string
LETT_RID_ENER_A2string
LETT_RID_ENER_A3string
LETT_RID_ENER_R1string
LETT_RID_ENER_R2string
LETT_RID_ENER_R3string
LETT_RID_POT1string
LETT_RID_POT2string
LETT_RID_POT3string
MALFUNZIONAMENTO_MISURATOREstring
MAND_CONNstring
MATR_MIS_1string
MATR_MIS_2string
MATR_MIS_3string
MATR_NUOVO_MIS_1string
MATR_NUOVO_MIS_2string
MATR_NUOVO_MIS_3string
MESE_COMPETstring
MIS_ELETTRONICOstring
MIS_ELETTRONICO_NUOVOstring
MOTIV_CARATTstring
NECE_LAV_COMPLstring
NECESSITA_SOSTstring
NUM_TENTATIVIstring
NUMERO_PUNTIstring
NUOVA_ENEstring
NUOVO_TENTATIVOstring
OPZ_TARIFFstring
POT_DISPstring
POT_FRANCstring
POT_FRANC_DISTRstring
POT_IMPstring
POT_IMP_DISTRstring
POTENZA_CONTRATTUALE_RICHIESTAstring
RIF_RESOCONTOstring
SETT_MERCEOLOGICOstring
SOLLEV_PERSONEstring
STAB_GIA_ENERGIstring
STATO_AGEVOLAZIONEstring
STATO_PODstring
STIMAstring
TENS_ALIM_DISTRstring
TENSIONEstring
TENSIONE_FASEstring
TIPO_ANOMALIAstring
TIPO_CONTRATTstring
TIPO_LAVOROstring
TIPO_LETTURAstring
TIPO_MISURATOREstring
TIPO_NUOVO_MISURATOREstring
TIPO_PODstring
TIPO_USO_TEMPstring
TIPO_UTENZAstring
TIPOLOGIA_LETT_CHIUSURAstring
TIPOLOGIA_LETT_RIDUZIONEstring
VERIFICA_NON_ESEGUITAstring
APP_CLIENTEstring
CAP_CEstring
CFstring
CF_BN1string
CF_CEstring
CF_SOCstring
CIV_CEstring
COGNOMEstring
COGNOME_CEstring
COMUNE_CEstring
EMAIL_CLIENTEstring
FAX_CLIENTEstring
ISTAT_CEstring
NAZIONE_CEstring
NOMEstring
NOME_CEstring
PIVAstring
PIVA_CEstring
PRESENZA_CLIENTE_FINALEstring
PROV_CEstring
RAG_SOCstring
RAG_SOC_CEstring
TELstring
TELEFONO_CLIENTEstring
TELEFONO_MOBILE_CLIENTEstring
TOPONIMO_CEstring
VIA_CEstring
CF_RICHIEDENTEstring
FLAG_ANN_TRstring
COD_DISPACCIAMENTOstring
REVOCA_SOSPENSIONEstring

Metadata

Event TypePayload Version
ita_industry.messages.interruption-for-missed-payment.request.mch-informative-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "CATEGORIA": "string",
  "COD_PRAT_DISTR": "string",
  "COD_PRAT_GESTORE": "string",
  "COD_PRAT_RIF": "string",
  "COD_RINTR_RICH": "string",
  "CP_UTENTE": "string",
  "DATA_CAMBIO_MIS": "string",
  "DATA_PUBBLICAZIONE": "string",
  "DATA_RICEVIMENTO_RICHIESTA": "string",
  "DATA_RICEZIONE_BONUS": "string",
  "ID_ACQUISIZIONE_PRATICA": "string",
  "NUOVO_COD_UNI_PREST": "string",
  "NUOVO_COD_UNI_RINTR": "string",
  "PIVA_DISTR": "string",
  "PIVA_UTENTE": "string",
  "RICH_UTENTE": "string",
  "TIPO_RICH_CLI_FIN": "string",
  "CAUSALE_ANNULLAMENTO_PRESTAZIONE": "string",
  "DATA_ANNULLAMENTO_PRESTAZIONE": "string",
  "DATA_ULTIMO_CAMBIO_STATO": "string",
  "ESITO_FINALE": "string",
  "NUMERO_DL": "string",
  "REVOCA_SOSP": "string",
  "STATO_PRESTAZIONE": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string",
  "SERVIZIO_RICHIEDIBILE": "string",
  "VERIFICA_AMM": "string",
  "ACCERT_VAL_NON_CORRETTI": "string",
  "ACCETT_LAV_COMPL": "string",
  "ADDEBITO_ONERI": "string",
  "AUMENTO_TENS": "string",
  "AUTOCERT_ISTANZA": "string",
  "CARATT_UT_FINALE": "string",
  "CAT_DISAL": "string",
  "CAUSALE_IMPL": "string",
  "CAUSALE_LAVORO_COMPL": "string",
  "CLASSE_CONTATORE": "string",
  "COD_LAV_PREDET": "string",
  "COD_POD": "string",
  "COD_PREV": "string",
  "CODICE_CAMBIO_TAR": "string",
  "CODICE_TIPO_CONN": "string",
  "COEFFICIENTEK": "string",
  "CONN_FUORI_ORARIO": "string",
  "CONSENSO_SOST_GRU_MISURA": "string",
  "CONTINUITA_ALIM_FISICA": "string",
  "COSTANTE_TA": "string",
  "COSTANTE_TA_NUOVA": "string",
  "COSTANTE_TV": "string",
  "COSTANTE_TV_NUOVA": "string",
  "COSTANTEK": "string",
  "COSTO_INT_COMPLESSO": "string",
  "DATA_ACCETT_LAV_COMPLE": "string",
  "DATA_AUTOLETTURA": "string",
  "DATA_DEC_BONUS": "string",
  "DATA_DISATT": "string",
  "DATA_ESECUZIONE_POST": "string",
  "DATA_INTER_PROGRAM": "string",
  "DATA_INTERVENTO": "string",
  "DATA_LETTURE_CLIENTE": "string",
  "DATA_LETTURE_DISTR": "string",
  "DATA_LIMITE_RIC_RETTIFICA": "string",
  "DATA_PREVISTA_RIPRISTINO": "string",
  "DATA_PREVISTA_SOSTITUZIONE": "string",
  "DATA_RIATT_FORN": "string",
  "DATA_RID_FORN": "string",
  "DATA_RIFERIMENTO": "string",
  "DATA_SOSP_FORN": "string",
  "DATA_STIMA_COMPLETAMENTO_LAVORI": "string",
  "DATA_SWITCH": "string",
  "DATA_TENTATIVO": "string",
  "DATA_VERIFICA_TR": "string",
  "DESCRIZIONE_LAVORO": "string",
  "DISALIMENTABILE": "string",
  "ESITO_VAL": "string",
  "FABB_COMPL_DI_POTENZA": "string",
  "FABB_DI_POTENZA": "string",
  "FASE_DISTR": "string",
  "FLAG_CONFERMA_BONUS": "string",
  "FLAG_PRESENTE_MOROSITA": "string",
  "FLAG_RICHIEDIBILE": "string",
  "FLAG_SOSTITUZIONE_MISURATORE": "string",
  "FLAG_SUBENTRO": "string",
  "FLAG_TELEGESTITO": "string",
  "GESTIONE_MANUALE": "string",
  "IMMEDIATA_SOST_GRU_MISURA": "string",
  "INTTERV_LIM_GRUPPO_MISURA": "string",
  "LETT_ATT_DIFF_F1": "string",
  "LETT_ATT_DIFF_F2": "string",
  "LETT_ATT_DIFF_F3": "string",
  "LETT_ATT_F1": "string",
  "LETT_ATT_F2": "string",
  "LETT_ATT_F3": "string",
  "LETT_CLI_A1": "string",
  "LETT_CLI_A2": "string",
  "LETT_CLI_A3": "string",
  "LETT_CLI_A4": "string",
  "LETT_CLI_AMONO": "string",
  "LETT_CLI_POT1": "string",
  "LETT_CLI_POT2": "string",
  "LETT_CLI_POT3": "string",
  "LETT_CLI_POT4": "string",
  "LETT_CLI_POTMONO": "string",
  "LETT_CLI_R1": "string",
  "LETT_CLI_R2": "string",
  "LETT_CLI_R3": "string",
  "LETT_CLI_R4": "string",
  "LETT_CLI_RMONO": "string",
  "LETT_CONT_ATT_1": "string",
  "LETT_CONT_ATT_2": "string",
  "LETT_CONT_ATT_3": "string",
  "LETT_CONT_POT_1": "string",
  "LETT_CONT_POT_2": "string",
  "LETT_CONT_POT_3": "string",
  "LETT_CONT_POT_MAX": "string",
  "LETT_CONT_REATT_1": "string",
  "LETT_CONT_REATT_2": "string",
  "LETT_CONT_REATT_3": "string",
  "LETT_NUOVA_ATT1": "string",
  "LETT_NUOVA_ATT2": "string",
  "LETT_NUOVA_ATT3": "string",
  "LETT_NUOVA_POT1": "string",
  "LETT_NUOVA_POT2": "string",
  "LETT_NUOVA_POT3": "string",
  "LETT_NUOVA_REATT1": "string",
  "LETT_NUOVA_REATT2": "string",
  "LETT_NUOVA_REATT3": "string",
  "LETT_POT_F1": "string",
  "LETT_POT_F2": "string",
  "LETT_POT_F3": "string",
  "LETT_REATT_DIFF_F1": "string",
  "LETT_REATT_DIFF_F2": "string",
  "LETT_REATT_DIFF_F3": "string",
  "LETT_REATT_F1": "string",
  "LETT_REATT_F2": "string",
  "LETT_REATT_F3": "string",
  "LETT_RID_ENER_A1": "string",
  "LETT_RID_ENER_A2": "string",
  "LETT_RID_ENER_A3": "string",
  "LETT_RID_ENER_R1": "string",
  "LETT_RID_ENER_R2": "string",
  "LETT_RID_ENER_R3": "string",
  "LETT_RID_POT1": "string",
  "LETT_RID_POT2": "string",
  "LETT_RID_POT3": "string",
  "MALFUNZIONAMENTO_MISURATORE": "string",
  "MAND_CONN": "string",
  "MATR_MIS_1": "string",
  "MATR_MIS_2": "string",
  "MATR_MIS_3": "string",
  "MATR_NUOVO_MIS_1": "string",
  "MATR_NUOVO_MIS_2": "string",
  "MATR_NUOVO_MIS_3": "string",
  "MESE_COMPET": "string",
  "MIS_ELETTRONICO": "string",
  "MIS_ELETTRONICO_NUOVO": "string",
  "MOTIV_CARATT": "string",
  "NECE_LAV_COMPL": "string",
  "NECESSITA_SOST": "string",
  "NUM_TENTATIVI": "string",
  "NUMERO_PUNTI": "string",
  "NUOVA_ENE": "string",
  "NUOVO_TENTATIVO": "string",
  "OPZ_TARIFF": "string",
  "POT_DISP": "string",
  "POT_FRANC": "string",
  "POT_FRANC_DISTR": "string",
  "POT_IMP": "string",
  "POT_IMP_DISTR": "string",
  "POTENZA_CONTRATTUALE_RICHIESTA": "string",
  "RIF_RESOCONTO": "string",
  "SETT_MERCEOLOGICO": "string",
  "SOLLEV_PERSONE": "string",
  "STAB_GIA_ENERGI": "string",
  "STATO_AGEVOLAZIONE": "string",
  "STATO_POD": "string",
  "STIMA": "string",
  "TENS_ALIM_DISTR": "string",
  "TENSIONE": "string",
  "TENSIONE_FASE": "string",
  "TIPO_ANOMALIA": "string",
  "TIPO_CONTRATT": "string",
  "TIPO_LAVORO": "string",
  "TIPO_LETTURA": "string",
  "TIPO_MISURATORE": "string",
  "TIPO_NUOVO_MISURATORE": "string",
  "TIPO_POD": "string",
  "TIPO_USO_TEMP": "string",
  "TIPO_UTENZA": "string",
  "TIPOLOGIA_LETT_CHIUSURA": "string",
  "TIPOLOGIA_LETT_RIDUZIONE": "string",
  "VERIFICA_NON_ESEGUITA": "string",
  "APP_CLIENTE": "string",
  "CAP_CE": "string",
  "CF": "string",
  "CF_BN1": "string",
  "CF_CE": "string",
  "CF_SOC": "string",
  "CIV_CE": "string",
  "COGNOME": "string",
  "COGNOME_CE": "string",
  "COMUNE_CE": "string",
  "EMAIL_CLIENTE": "string",
  "FAX_CLIENTE": "string",
  "ISTAT_CE": "string",
  "NAZIONE_CE": "string",
  "NOME": "string",
  "NOME_CE": "string",
  "PIVA": "string",
  "PIVA_CE": "string",
  "PRESENZA_CLIENTE_FINALE": "string",
  "PROV_CE": "string",
  "RAG_SOC": "string",
  "RAG_SOC_CE": "string",
  "TEL": "string",
  "TELEFONO_CLIENTE": "string",
  "TELEFONO_MOBILE_CLIENTE": "string",
  "TOPONIMO_CE": "string",
  "VIA_CE": "string",
  "CF_RICHIEDENTE": "string",
  "FLAG_ANN_TR": "string",
  "COD_DISPACCIAMENTO": "string",
  "REVOCA_SOSPENSIONE": "string"
}

ita_industry.messages.interruption-for-missed-payment.request.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.interruption-for-missed-payment.request.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.interruption-for-missed-payment.request.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.interruption-for-missed-payment.request.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.passive-cancellation.mch-notice-received-v1

Event Properties

NameType
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
receiving_date_final_resultstring
requiredCOD_SERVIZIOstring
requiredCOD_FLUSSOstring
requiredPIVA_UTENTEstring
requiredPIVA_GESTOREstring
requiredCP_GESTOREstring
requiredCP_GESTORE_ANNstring
CP_UTENTE_ANNstring
requiredSETTOREstring
COD_PODstring
COD_PDRstring
requiredCOD_CAUSALEstring
requiredMOTIVAZIONEstring
NOTEstring

Metadata

Event TypePayload Version
ita_industry.messages.passive-cancellation.mch-notice-receivedv1

JSON Payload Representation

{
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "receiving_date_final_result": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_GESTORE": "string",
  "CP_GESTORE_ANN": "string",
  "CP_UTENTE_ANN": "string",
  "SETTORE": "string",
  "COD_POD": "string",
  "COD_PDR": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string",
  "NOTE": "string"
}

ita_industry.messages.power-variation.request.mch-admissibility-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
COD_PODstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring

Metadata

Event TypePayload Version
ita_industry.messages.power-variation.request.mch-admissibility-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "COD_POD": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string"
}

ita_industry.messages.power-variation.request.mch-final-outcome-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
COD_PODstring
COD_PRESTAZIONEstring
DATA_ESECUZIONE_PRESTAZIONEstring
ESITOstring
COD_CAUSALEstring
MOTIVAZIONEstring
POTCONTRIMPstring
POTDISPstring
TARIFFAstring
TENSIONE_FASEstring
TENSIONEstring

Metadata

Event TypePayload Version
ita_industry.messages.power-variation.request.mch-final-outcome-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "COD_POD": "string",
  "COD_PRESTAZIONE": "string",
  "DATA_ESECUZIONE_PRESTAZIONE": "string",
  "ESITO": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string",
  "POTCONTRIMP": "string",
  "POTDISP": "string",
  "TARIFFA": "string",
  "TENSIONE_FASE": "string",
  "TENSIONE": "string"
}

ita_industry.messages.power-variation.request.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.power-variation.request.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.power-variation.request.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.power-variation.request.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.suspension-for-missed-payment.reactivation.mch-admissibility-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
transaction_id_hubstring
sending_date_sii_dlstring
eligibility_receiving_datestring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
COD_PODstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring

Metadata

Event TypePayload Version
ita_industry.messages.suspension-for-missed-payment.reactivation.mch-admissibility-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "sending_date_sii_dl": "string",
  "eligibility_receiving_date": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "COD_POD": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string"
}

ita_industry.messages.suspension-for-missed-payment.reactivation.mch-final-outcome-received-v1

Event Properties

NameType
request_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
transaction_id_hubstring
channelstring
receiving_date_final_resultstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
COD_PODstring
COD_PRESTAZIONEstring
DATA_ESECUZIONEstring
ESITOstring
COD_CAUSALEstring
MOTIVAZIONEstring

Metadata

Event TypePayload Version
ita_industry.messages.suspension-for-missed-payment.reactivation.mch-final-outcome-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "channel": "string",
  "receiving_date_final_result": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "COD_POD": "string",
  "COD_PRESTAZIONE": "string",
  "DATA_ESECUZIONE": "string",
  "ESITO": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string"
}

ita_industry.messages.suspension-for-missed-payment.reactivation.mch-notice-received-v1

Event Properties

NameType
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
transaction_id_hubstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_GESTOREstring
COD_PODstring
COD_PRESTAZIONEstring
COD_CONTR_DISPstring
CFstring
PIVAstring
CF_STRANIEROstring
TELEFONOstring
EMAILstring

Metadata

Event TypePayload Version
ita_industry.messages.suspension-for-missed-payment.reactivation.mch-notice-receivedv1

JSON Payload Representation

{
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_GESTORE": "string",
  "COD_POD": "string",
  "COD_PRESTAZIONE": "string",
  "COD_CONTR_DISP": "string",
  "CF": "string",
  "PIVA": "string",
  "CF_STRANIERO": "string",
  "TELEFONO": "string",
  "EMAIL": "string"
}

ita_industry.messages.suspension-for-missed-payment.reactivation.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.suspension-for-missed-payment.reactivation.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.suspension-for-missed-payment.reactivation.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.suspension-for-missed-payment.reactivation.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.suspension-for-missed-payment.request.mch-admissibility-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
transaction_id_hubstring
channelstring
sending_date_sii_dlstring
eligibility_receiving_datestring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
COD_PODstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring

Metadata

Event TypePayload Version
ita_industry.messages.suspension-for-missed-payment.request.mch-admissibility-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "channel": "string",
  "sending_date_sii_dl": "string",
  "eligibility_receiving_date": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "COD_POD": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string"
}

ita_industry.messages.suspension-for-missed-payment.request.mch-final-outcome-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
transaction_id_hubstring
channelstring
receiving_date_final_resultstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
COD_PODstring
COD_PRESTAZIONEstring
DATA_ESECUZIONEstring
ESITOstring
COD_CAUSALEstring
MOTIVAZIONEstring
N_TENTATIVIstring
FATTIBILITA_TECNICAstring
COSTOstring

Metadata

Event TypePayload Version
ita_industry.messages.suspension-for-missed-payment.request.mch-final-outcome-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "channel": "string",
  "receiving_date_final_result": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "COD_POD": "string",
  "COD_PRESTAZIONE": "string",
  "DATA_ESECUZIONE": "string",
  "ESITO": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string",
  "N_TENTATIVI": "string",
  "FATTIBILITA_TECNICA": "string",
  "COSTO": "string"
}

ita_industry.messages.suspension-for-missed-payment.request.mch-notice-received-v1

Event Properties

NameType
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
transaction_id_hubstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_GESTOREstring
IDENTIFICATIVO_PRATICAstring
COD_PODstring
COD_CAUSALEstring
DESCRIZIONEstring

Metadata

Event TypePayload Version
ita_industry.messages.suspension-for-missed-payment.request.mch-notice-receivedv1

JSON Payload Representation

{
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "transaction_id_hub": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_GESTORE": "string",
  "IDENTIFICATIVO_PRATICA": "string",
  "COD_POD": "string",
  "COD_CAUSALE": "string",
  "DESCRIZIONE": "string"
}

ita_industry.messages.suspension-for-missed-payment.request.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.suspension-for-missed-payment.request.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.suspension-for-missed-payment.request.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.suspension-for-missed-payment.request.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.switch-in.pre-check.mch-final-outcome-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_VENDITOREstring
PIVA_GESTOREstring
CP_VENDITOREstring
CP_GESTOREstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring
ESITOstring
COD_ESITOstring
DETTAGLIO_ESITOstring
COD_PODstring
CFstring
PIVAstring
CF_STRANIEROstring
DATA_SALVAGUARDIAstring
CRPP_MM_F1string
CRPP_MM_F2string
CRPP_MM_F3string
CRPP_MM1_F1string
CRPP_MM1_F2string
CRPP_MM1_F3string
RISOLUZIONE_CONTRATTUALE_TIMOEstring
PIVA_CONTROPARTE_COMMERCIALEstring
RAG_SOC_CONTR_COMMstring
EMAIL_CONTR_COMMstring
PMA_PODstring

Metadata

Event TypePayload Version
ita_industry.messages.switch-in.pre-check.mch-final-outcome-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_VENDITORE": "string",
  "PIVA_GESTORE": "string",
  "CP_VENDITORE": "string",
  "CP_GESTORE": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string",
  "ESITO": "string",
  "COD_ESITO": "string",
  "DETTAGLIO_ESITO": "string",
  "COD_POD": "string",
  "CF": "string",
  "PIVA": "string",
  "CF_STRANIERO": "string",
  "DATA_SALVAGUARDIA": "string",
  "CRPP_MM_F1": "string",
  "CRPP_MM_F2": "string",
  "CRPP_MM_F3": "string",
  "CRPP_MM1_F1": "string",
  "CRPP_MM1_F2": "string",
  "CRPP_MM1_F3": "string",
  "RISOLUZIONE_CONTRATTUALE_TIMOE": "string",
  "PIVA_CONTROPARTE_COMMERCIALE": "string",
  "RAG_SOC_CONTR_COMM": "string",
  "EMAIL_CONTR_COMM": "string",
  "PMA_POD": "string"
}

ita_industry.messages.switch-in.pre-check.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.switch-in.pre-check.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.switch-in.pre-check.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.switch-in.pre-check.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.switch-in.request.mch-admissibility-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
COD_PODstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring

Metadata

Event TypePayload Version
ita_industry.messages.switch-in.request.mch-admissibility-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "COD_POD": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string"
}

ita_industry.messages.switch-in.request.mch-timoe-notice-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
COD_PODstring
SOSP_MORstring
PRESENZA_CMORstring
MERCATO_PROVENIENZAstring
DATE_SOSPstring
DATE_SWITCHstring
DATA_SALVAGUARDIAstring
DATA_ULTIMA_RICH_SOSPstring
DATA_ULTIMA_SOSPstring

Metadata

Event TypePayload Version
ita_industry.messages.switch-in.request.mch-timoe-notice-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "COD_POD": "string",
  "SOSP_MOR": "string",
  "PRESENZA_CMOR": "string",
  "MERCATO_PROVENIENZA": "string",
  "DATE_SOSP": "string",
  "DATE_SWITCH": "string",
  "DATA_SALVAGUARDIA": "string",
  "DATA_ULTIMA_RICH_SOSP": "string",
  "DATA_ULTIMA_SOSP": "string"
}

ita_industry.messages.switch-in.request.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.switch-in.request.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.switch-in.request.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.switch-in.request.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.switch-out-with-change-of-ownership.mch-notice-received-v1

Event Properties

NameType
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
requiredCOD_SERVIZIOstring
requiredCOD_FLUSSOstring
requiredPIVA_UTENTEstring
requiredPIVA_GESTOREstring
requiredCP_GESTOREstring
requiredCOD_PODstring
requiredDATA_DECORRENZAstring

Metadata

Event TypePayload Version
ita_industry.messages.switch-out-with-change-of-ownership.mch-notice-receivedv1

JSON Payload Representation

{
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_GESTORE": "string",
  "COD_POD": "string",
  "DATA_DECORRENZA": "string"
}

ita_industry.messages.switch-out.mch-notice-received-v1

Event Properties

NameType
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
requiredCOD_SERVIZIOstring
requiredCOD_FLUSSOstring
requiredPIVA_UTENTEstring
requiredPIVA_GESTOREstring
requiredCP_GESTOREstring
requiredCOD_PODstring
requiredDATA_DECORRENZAstring

Metadata

Event TypePayload Version
ita_industry.messages.switch-out.mch-notice-receivedv1

JSON Payload Representation

{
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_GESTORE": "string",
  "COD_POD": "string",
  "DATA_DECORRENZA": "string"
}

ita_industry.messages.update-on-condition.request.mch-admissibility-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
sending_date_sii_dlstring
eligibility_receiving_datestring
transaction_id_hubstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
COD_PODstring
VERIFICA_AMMstring
COD_CAUSALEstring
MOTIVAZIONEstring

Metadata

Event TypePayload Version
ita_industry.messages.update-on-condition.request.mch-admissibility-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "sending_date_sii_dl": "string",
  "eligibility_receiving_date": "string",
  "transaction_id_hub": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "COD_POD": "string",
  "VERIFICA_AMM": "string",
  "COD_CAUSALE": "string",
  "MOTIVAZIONE": "string"
}

ita_industry.messages.update-on-condition.request.mch-final-outcome-received-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredstep_outcomeboolean
requiredcode_reason_stepinteger
channelstring
transactionIdHUBstring
receivingDateFinalResultstring
cancellationCausalstring
notesstring
COD_SERVIZIOstring
COD_FLUSSOstring
PIVA_UTENTEstring
PIVA_GESTOREstring
CP_UTENTEstring
CP_GESTOREstring
COD_PODstring
ESITOstring
COD_ESITOstring
DETTAGLIO_ESITOstring

Metadata

Event TypePayload Version
ita_industry.messages.update-on-condition.request.mch-final-outcome-receivedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "step_outcome": "boolean",
  "code_reason_step": "integer",
  "channel": "string",
  "transactionIdHUB": "string",
  "receivingDateFinalResult": "string",
  "cancellationCausal": "string",
  "notes": "string",
  "COD_SERVIZIO": "string",
  "COD_FLUSSO": "string",
  "PIVA_UTENTE": "string",
  "PIVA_GESTORE": "string",
  "CP_UTENTE": "string",
  "CP_GESTORE": "string",
  "COD_POD": "string",
  "ESITO": "string",
  "COD_ESITO": "string",
  "DETTAGLIO_ESITO": "string"
}

ita_industry.messages.update-on-condition.request.status-updated-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.update-on-condition.request.status-updatedv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.messages.update-on-condition.request.technical-error-occurred-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredoutcomeboolean
error_codeinteger
kraken_request_idstring

Metadata

Event TypePayload Version
ita_industry.messages.update-on-condition.request.technical-error-occurredv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "outcome": "boolean",
  "error_code": "integer",
  "kraken_request_id": "string"
}

ita_industry.outbound-request.created-v1

Event Properties

NameType
requiredrequest_correlation_idstring
requiredflow_typestring
to_be_sentboolean
extra_fieldsobject
requiredcommodity_typestring

Metadata

Event TypePayload Version
ita_industry.outbound-request.createdv1

JSON Payload Representation

{
  "request_correlation_id": "string",
  "flow_type": "string",
  "to_be_sent": "boolean",
  "extra_fields": "object",
  "commodity_type": "string"
}

ita_industry.passive-cancellation.active-cancellation.notice-received-v1

Event Properties

NameType
requirederror_codestring
requiredindustry_id_of_cancellation_requeststring
requiredindustry_id_of_request_to_cancelstring
requiredkraken_id_of_request_to_cancelstring
requiredpodstring

Metadata

Event TypePayload Version
ita_industry.passive-cancellation.active-cancellation.notice-receivedv1

JSON Payload Representation

{
  "error_code": "string",
  "industry_id_of_cancellation_request": "string",
  "industry_id_of_request_to_cancel": "string",
  "kraken_id_of_request_to_cancel": "string",
  "pod": "string"
}

ita_industry.passive-cancellation.change-of-ownership.notice-received-v1

Event Properties

NameType
requirederror_codestring
requiredindustry_id_of_cancellation_requeststring
requiredindustry_id_of_request_to_cancelstring
requiredkraken_id_of_request_to_cancelstring
requiredpodstring

Metadata

Event TypePayload Version
ita_industry.passive-cancellation.change-of-ownership.notice-receivedv1

JSON Payload Representation

{
  "error_code": "string",
  "industry_id_of_cancellation_request": "string",
  "industry_id_of_request_to_cancel": "string",
  "kraken_id_of_request_to_cancel": "string",
  "pod": "string"
}

ita_industry.passive-cancellation.notice-received-v1

Event Properties

NameType
requirederror_codestring
requiredindustry_request_idstring
requiredindustry_request_id_to_cancelstring
requiredkraken_request_id_to_cancelstring
requiredpdrstring
requiredpodstring

Metadata

Event TypePayload Version
ita_industry.passive-cancellation.notice-receivedv1

JSON Payload Representation

{
  "error_code": "string",
  "industry_request_id": "string",
  "industry_request_id_to_cancel": "string",
  "kraken_request_id_to_cancel": "string",
  "pdr": "string",
  "pod": "string"
}

ita_industry.passive-cancellation.power-variation.notice-received-v1

Event Properties

NameType
requirederror_codestring
requiredindustry_id_of_cancellation_requeststring
requiredindustry_id_of_request_to_cancelstring
requiredkraken_id_of_request_to_cancelstring
requiredpodstring

Metadata

Event TypePayload Version
ita_industry.passive-cancellation.power-variation.notice-receivedv1

JSON Payload Representation

{
  "error_code": "string",
  "industry_id_of_cancellation_request": "string",
  "industry_id_of_request_to_cancel": "string",
  "kraken_id_of_request_to_cancel": "string",
  "pod": "string"
}

ita_industry.passive-cancellation.switch-in.notice-received-v1

Event Properties

NameType
requirederror_codestring
requiredindustry_id_of_cancellation_requeststring
requiredindustry_id_of_request_to_cancelstring
requiredkraken_id_of_request_to_cancelstring
requiredpodstring

Metadata

Event TypePayload Version
ita_industry.passive-cancellation.switch-in.notice-receivedv1

JSON Payload Representation

{
  "error_code": "string",
  "industry_id_of_cancellation_request": "string",
  "industry_id_of_request_to_cancel": "string",
  "kraken_id_of_request_to_cancel": "string",
  "pod": "string"
}

ita_industry.passive-cancellation.switch-out.notice-received-v1

Event Properties

NameType
requirederror_codestring
requiredindustry_id_of_cancellation_requeststring
requiredindustry_id_of_request_to_cancelstring
requiredkraken_id_of_request_to_cancelstring
requiredpodstring

Metadata

Event TypePayload Version
ita_industry.passive-cancellation.switch-out.notice-receivedv1

JSON Payload Representation

{
  "error_code": "string",
  "industry_id_of_cancellation_request": "string",
  "industry_id_of_request_to_cancel": "string",
  "kraken_id_of_request_to_cancel": "string",
  "pod": "string"
}

ita_industry.passive-cancellation.update-on-condition.notice-received-v1

Event Properties

NameType
requirederror_codestring
requiredindustry_id_of_cancellation_requeststring
requiredindustry_id_of_request_to_cancelstring
requiredkraken_id_of_request_to_cancelstring
requiredpodstring

Metadata

Event TypePayload Version
ita_industry.passive-cancellation.update-on-condition.notice-receivedv1

JSON Payload Representation

{
  "error_code": "string",
  "industry_id_of_cancellation_request": "string",
  "industry_id_of_request_to_cancel": "string",
  "kraken_id_of_request_to_cancel": "string",
  "pod": "string"
}

ita_industry.passive-cmor.compensation-application-notice-received-v1

Event Properties

NameType
requiredindustry_request_idstring
requiredcommoditystring
requiredpodstring
requiredpdrstring
requiredcustomer_fiscal_codestring
requiredcustomer_vat_numberstring
requiredis_foreign_fiscal_codeinteger
requiredcompensation_amountstring
requireddispatch_contract_codestring
requiredincoming_user_vat_numberstring
requiredincoming_commercial_counterpart_vat_numberstring

Metadata

Event TypePayload Version
ita_industry.passive-cmor.compensation-application-notice-receivedv1

JSON Payload Representation

{
  "industry_request_id": "string",
  "commodity": "string",
  "pod": "string",
  "pdr": "string",
  "customer_fiscal_code": "string",
  "customer_vat_number": "string",
  "is_foreign_fiscal_code": "integer",
  "compensation_amount": "string",
  "dispatch_contract_code": "string",
  "incoming_user_vat_number": "string",
  "incoming_commercial_counterpart_vat_number": "string"
}

ita_industry.passive-cmor.compensation-cancellation-notice-received-v1

Event Properties

NameType
requiredindustry_request_idstring
requiredkraken_request_idstring
requiredcommoditystring
requiredpodstring
requiredpdrstring
requiredcustomer_fiscal_codestring
requiredcustomer_vat_numberstring
requiredis_foreign_fiscal_codeinteger
requiredcancellation_reason_codestring
requiredcsea_disbursement_madestring
requiredcsea_payment_statusstring

Metadata

Event TypePayload Version
ita_industry.passive-cmor.compensation-cancellation-notice-receivedv1

JSON Payload Representation

{
  "industry_request_id": "string",
  "kraken_request_id": "string",
  "commodity": "string",
  "pod": "string",
  "pdr": "string",
  "customer_fiscal_code": "string",
  "customer_vat_number": "string",
  "is_foreign_fiscal_code": "integer",
  "cancellation_reason_code": "string",
  "csea_disbursement_made": "string",
  "csea_payment_status": "string"
}

ita_industry.passive-cmor.compensation-update-notice-received-v1

Event Properties

NameType
requiredindustry_request_idstring
requiredkraken_request_idstring
requiredupdated_compensation_amountstring
requiredcompensation_difference_from_initial_amountstring
requiredcompensation_difference_codestring

Metadata

Event TypePayload Version
ita_industry.passive-cmor.compensation-update-notice-receivedv1

JSON Payload Representation

{
  "industry_request_id": "string",
  "kraken_request_id": "string",
  "updated_compensation_amount": "string",
  "compensation_difference_from_initial_amount": "string",
  "compensation_difference_code": "string"
}

ita_industry.power-variation.admissibility-received-v1

Event Properties

NameType
requiredpodstring
requiredkraken_request_idstring
requiredindustry_request_idstring
requiredis_admissibleboolean
requirederror_codeinteger
requirederror_motivationstring

Metadata

Event TypePayload Version
ita_industry.power-variation.admissibility-receivedv1

JSON Payload Representation

{
  "pod": "string",
  "kraken_request_id": "string",
  "industry_request_id": "string",
  "is_admissible": "boolean",
  "error_code": "integer",
  "error_motivation": "string"
}

ita_industry.power-variation.outcome-received-v1

Event Properties

NameType
requiredindustry_request_idstring
requiredkraken_request_idstring
requiredpodstring
requiredexecution_datestring
requiredis_approvedboolean
requirederror_codeinteger
requirederror_reasonstring
requiredcommitted_power_kwstring
requiredavailable_power_kwstring
requiredtariff_typestring
requiredphase_powerstring
requiredvoltageinteger

Metadata

Event TypePayload Version
ita_industry.power-variation.outcome-receivedv1

JSON Payload Representation

{
  "industry_request_id": "string",
  "kraken_request_id": "string",
  "pod": "string",
  "execution_date": "string",
  "is_approved": "boolean",
  "error_code": "integer",
  "error_reason": "string",
  "committed_power_kw": "string",
  "available_power_kw": "string",
  "tariff_type": "string",
  "phase_power": "string",
  "voltage": "integer"
}

ita_industry.pre-check.integration-response-received-v1

Event Properties

NameType
requiredindustry_request_idstring
requiredkraken_request_idstring
requiredis_admissibleboolean
requirederror_codeinteger
requirederror_reasonstring
requiredis_approvedboolean
requiredfailure_codeinteger
requiredfailure_reasonstring
requiredpodstring
requiredfiscal_codestring
requiredvat_numberstring
requiredis_foreign_fiscal_codeboolean
requiredgiven_namestring
requiredfamily_namestring
requiredcompany_namestring
requiredcrpp_mm_f1number
requiredcrpp_mm_f2number
requiredcrpp_mm_f3number
requiredcrpp_mm1_f1number
requiredcrpp_mm1_f2number
requiredcrpp_mm1_f3number
requiredcontractual_timoe_resolutionboolean
requiredmean_annual_powerstring

Metadata

Event TypePayload Version
ita_industry.pre-check.integration-response-receivedv1

JSON Payload Representation

{
  "industry_request_id": "string",
  "kraken_request_id": "string",
  "is_admissible": "boolean",
  "error_code": "integer",
  "error_reason": "string",
  "is_approved": "boolean",
  "failure_code": "integer",
  "failure_reason": "string",
  "pod": "string",
  "fiscal_code": "string",
  "vat_number": "string",
  "is_foreign_fiscal_code": "boolean",
  "given_name": "string",
  "family_name": "string",
  "company_name": "string",
  "crpp_mm_f1": "number",
  "crpp_mm_f2": "number",
  "crpp_mm_f3": "number",
  "crpp_mm1_f1": "number",
  "crpp_mm1_f2": "number",
  "crpp_mm1_f3": "number",
  "contractual_timoe_resolution": "boolean",
  "mean_annual_power": "string"
}

ita_industry.pre-check.response-received-v1

Event Properties

NameType
requiredis_admissibleboolean
requirederror_codeinteger
requirederror_reasonstring
requiredis_approvedboolean
requiredfailure_codeinteger
requiredfailure_reasonstring
requiredindustry_request_idstring
requiredkraken_request_idstring
requiredpodstring
requiredfiscal_codestring
requiredvat_numberstring
requiredis_foreign_fiscal_codeboolean
requiredsafeguarding_service_activation_datestring
requiredcrpp_mm_f1number
requiredcrpp_mm_f2number
requiredcrpp_mm_f3number
requiredcrpp_mm1_f1number
requiredcrpp_mm1_f2number
requiredcrpp_mm1_f3number
requiredcontractual_timoe_resolutionstring
requiredmean_annual_powerstring

Metadata

Event TypePayload Version
ita_industry.pre-check.response-receivedv1

JSON Payload Representation

{
  "is_admissible": "boolean",
  "error_code": "integer",
  "error_reason": "string",
  "is_approved": "boolean",
  "failure_code": "integer",
  "failure_reason": "string",
  "industry_request_id": "string",
  "kraken_request_id": "string",
  "pod": "string",
  "fiscal_code": "string",
  "vat_number": "string",
  "is_foreign_fiscal_code": "boolean",
  "safeguarding_service_activation_date": "string",
  "crpp_mm_f1": "number",
  "crpp_mm_f2": "number",
  "crpp_mm_f3": "number",
  "crpp_mm1_f1": "number",
  "crpp_mm1_f2": "number",
  "crpp_mm1_f3": "number",
  "contractual_timoe_resolution": "string",
  "mean_annual_power": "string"
}

ita_industry.switch-in.switch-request-admissibility-received-v1

Event Properties

NameType
requiredpodstring
requiredkraken_switch_request_idstring
requiredindustry_switch_request_idstring
requiredis_admissibleboolean
requirederror_codeinteger
requirederror_motivationstring

Metadata

Event TypePayload Version
ita_industry.switch-in.switch-request-admissibility-receivedv1

JSON Payload Representation

{
  "pod": "string",
  "kraken_switch_request_id": "string",
  "industry_switch_request_id": "string",
  "is_admissible": "boolean",
  "error_code": "integer",
  "error_motivation": "string"
}

ita_industry.switch-in.timoe-received-v1

Event Properties

NameType
requiredpodstring
requiredkraken_switch_request_idstring
requiredis_currently_suspended_for_missed_paymentsboolean
requiredhas_debt_with_old_supplierboolean
requiredmarket_typestring
requiredsafeguarding_service_activation_datestring
requiredrecent_suspension_request_datestring
requiredrecent_suspension_datestring
requireddates_of_non_payments_suspensionsarray[string]
requiredrecent_switch_datesarray[string]

Metadata

Event TypePayload Version
ita_industry.switch-in.timoe-receivedv1

JSON Payload Representation

{
  "pod": "string",
  "kraken_switch_request_id": "string",
  "is_currently_suspended_for_missed_payments": "boolean",
  "has_debt_with_old_supplier": "boolean",
  "market_type": "string",
  "safeguarding_service_activation_date": "string",
  "recent_suspension_request_date": "string",
  "recent_suspension_date": "string",
  "dates_of_non_payments_suspensions": [
    "string"
  ],
  "recent_switch_dates": [
    "string"
  ]
}

ita_industry.switch-out.notice-received-v1

Event Properties

NameType
requiredpodstring
requiredswitch_out_datestring
requiredindustry_request_idstring

Metadata

Event TypePayload Version
ita_industry.switch-out.notice-receivedv1

JSON Payload Representation

{
  "pod": "string",
  "switch_out_date": "string",
  "industry_request_id": "string"
}

ita_industry.television-fee-charge-notice.received-v1

Event Properties

NameType
requirednotice_idstring
requiredpodstring
requiredfiscal_codestring
requiredamountstring
requiredaccrual_start_datestring
requiredaccrual_end_datestring
requiredamount_codestring
requiredistat_codestring
requiredtariff_typestring
requiredsupply_start_datestring
requiredinbound_message_idinteger

Metadata

Event TypePayload Version
ita_industry.television-fee-charge-notice.receivedv1

JSON Payload Representation

{
  "notice_id": "string",
  "pod": "string",
  "fiscal_code": "string",
  "amount": "string",
  "accrual_start_date": "string",
  "accrual_end_date": "string",
  "amount_code": "string",
  "istat_code": "string",
  "tariff_type": "string",
  "supply_start_date": "string",
  "inbound_message_id": "integer"
}

ita_industry.update-on-condition.admissibility-received-v1

Event Properties

NameType
requiredpodstring
requiredkraken_request_idstring
requiredindustry_request_idstring
requiredis_admissibleboolean
requirederror_codeinteger
requirederror_motivationstring

Metadata

Event TypePayload Version
ita_industry.update-on-condition.admissibility-receivedv1

JSON Payload Representation

{
  "pod": "string",
  "kraken_request_id": "string",
  "industry_request_id": "string",
  "is_admissible": "boolean",
  "error_code": "integer",
  "error_motivation": "string"
}

ita_industry.update-on-condition.final-outcome-received-v1

Event Properties

NameType
requiredpodstring
requiredkraken_request_idstring
requiredindustry_request_idstring
requiredis_approvedboolean
requirederror_codeinteger
requirederror_motivationstring

Metadata

Event TypePayload Version
ita_industry.update-on-condition.final-outcome-receivedv1

JSON Payload Representation

{
  "pod": "string",
  "kraken_request_id": "string",
  "industry_request_id": "string",
  "is_approved": "boolean",
  "error_code": "integer",
  "error_motivation": "string"
}

late_payment_fee_application_service_completed-v1

Event Properties

NameType
requiredrun_idstring
requiredaccount_numberstring
requiredfees_applied_countinteger
requiredfees_unapplied_countinteger

Metadata

Event TypePayload Version
late_payment_fee_application_service_completedv1

JSON Payload Representation

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

late_payment_fee_application_service_fee_applied-v1

Event Properties

NameType
requiredrun_idstring
requiredaccount_numberstring
requiredfee_amountinteger
requiredfee_datestring
fee_typestring
requiredcharge_idstring

Metadata

Event TypePayload Version
late_payment_fee_application_service_fee_appliedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredrun_idstring
requiredaccount_numberstring

Metadata

Event TypePayload Version
late_payment_fee_application_service_startedv1

JSON Payload Representation

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

late_payment_fee_calculation_service_completed-v1

Event Properties

NameType
requiredrun_idstring
requiredaccount_numberstring
requiredfees_calculated_countinteger

Metadata

Event TypePayload Version
late_payment_fee_calculation_service_completedv1

JSON Payload Representation

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

late_payment_fee_calculation_service_started-v1

Event Properties

NameType
requiredrun_idstring
requiredaccount_numberstring

Metadata

Event TypePayload Version
late_payment_fee_calculation_service_startedv1

JSON Payload Representation

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

late_payment_fee_calculator_completed-v1

Event Properties

NameType
requiredrun_idstring
requiredaccount_numberstring
requiredfees_applied_countinteger
requiredfees_unapplied_countinteger

Metadata

Event TypePayload Version
late_payment_fee_calculator_completedv1

JSON Payload Representation

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

late_payment_fee_calculator_fee_applied-v1

Event Properties

NameType
requiredrun_idstring
requiredaccount_numberstring
requiredcharge_idstring

Metadata

Event TypePayload Version
late_payment_fee_calculator_fee_appliedv1

JSON Payload Representation

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

late_payment_fee_calculator_started-v1

Event Properties

NameType
requiredrun_idstring
requiredaccount_numberstring

Metadata

Event TypePayload Version
late_payment_fee_calculator_startedv1

JSON Payload Representation

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

late_payment_fee_waived-v1

Event Properties

NameType
requiredfee_idinteger
requiredwaived_atstring
requiredsupport_user_idinteger

Metadata

Event TypePayload Version
late_payment_fee_waivedv1

JSON Payload Representation

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

leads.lead.stage-updated-v1

Event Properties

NameType
requiredlead_numberstring
requiredfunnel_codestring
requiredstagestring

Metadata

Event TypePayload Version
leads.lead.stage-updatedv1

JSON Payload Representation

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

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

Event Properties

NameType
requiredopportunity_numberstring
requiredattachment_idinteger
requiredcategorystring

Metadata

Event TypePayload Version
leads.opportunity.document-attached-to-opportunityv1

JSON Payload Representation

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

leads.opportunity.offer-group.created-v2

Event Properties

NameType
requiredopportunity_numberstring
requiredoffer_group_identifierstring

Metadata

Event TypePayload Version
leads.opportunity.offer-group.createdv2

JSON Payload Representation

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

leads.opportunity.stage-updated-v1

Event Properties

NameType
requiredopportunity_numberstring
requiredfunnel_codestring
requiredstagestring
updated_by_user_idinteger

Metadata

Event TypePayload Version
leads.opportunity.stage-updatedv1

JSON Payload Representation

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

lifecycle-enrollment-SupplyPoint

Event Properties

NameType
requiredmarket_namestring
requiredexternal_identifierstring
requiredconfirmed_ssdstring
requiredwas_cancelledboolean

JSON Payload Representation

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

lifecycle-join_supplier-ActivatedSupplyPoint

Event Properties

NameType
requiredexternal_identifierstring
requiredmarket_namestring
requiredconfirmed_supply_start_datestring

JSON Payload Representation

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

lifecycle-join_supplier-ActivationInitiatedSupplyPoint

Event Properties

NameType
requiredexternal_identifierstring
requiredmarket_namestring

JSON Payload Representation

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

lifecycle-join_supplier-Agreement

Event Properties

NameType
requiredidinteger
requiredvalid_fromstring
requiredvalid_tostring
requiredproduct_codestring

JSON Payload Representation

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

lifecycle-join_supplier-ContractReferences

Event Properties

NameType
account_contract_identifierstring
business_contract_identifierstring

JSON Payload Representation

{
  "account_contract_identifier": "string",
  "business_contract_identifier": "string"
}

lifecycle-join_supplier-SupplyPeriodData

Event Properties

NameType
requiredidinteger
requiredsupply_start_atstring
requiredsupply_end_atstring

JSON Payload Representation

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

lifecycle-join_supplier-SupplyPoint

Event Properties

NameType
requiredexternal_identifierstring
requiredmarket_namestring
requiredrequested_supply_start_datestring

JSON Payload Representation

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

lifecycle-leave_supplier-SupplyPoint

Event Properties

NameType
requiredmarket_identifierstring
requiredexternal_identifierstring
requiredmarket_namestring

JSON Payload Representation

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

lifecycle-leave_supplier-TerminatedSupplyPoint

Event Properties

NameType
requiredexternal_identifierstring
requiredmarket_namestring
requiredconfirmed_supply_end_datestring

JSON Payload Representation

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

lifecycle-leave_supplier-TerminationInitiatedSupplyPoint

Event Properties

NameType
requiredexternal_identifierstring
requiredmarket_namestring
requiredrequested_supply_end_datestring

JSON Payload Representation

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

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

Event Properties

NameType
requiredjoin_supplier_process_numberstring
requiredaccount_numberstring
requiredsupply_points_no_longer_coming_on_supply array[lifecycle-enrollment-SupplyPoint]
requiredall_supply_points array[lifecycle-enrollment-SupplyPoint]

Metadata

Event TypePayload Version
lifecycle.enrollment.loyalty-points-qualification-reversedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredjoin_supplier_process_idinteger
requiredjoin_supplier_process_numberstring
requiredaccount_numberstring
requiredsupply_points_past_ssd array[lifecycle-enrollment-SupplyPoint]
requiredall_supply_points array[lifecycle-enrollment-SupplyPoint]

Metadata

Event TypePayload Version
lifecycle.enrollment.supply-status-qualifies-account-for-loyalty-pointv2

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredaccount_numberstring
requiredjoin_supplier_process_numberstring
requiredsubtypestring
requiredactivation_journey_typestring
requiredsupply_pointlifecycle-join_supplier-ActivatedSupplyPoint

Metadata

Event TypePayload Version
lifecycle.join-supplier.activation.completedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredaccount_numberstring
requiredjoin_supplier_process_numberstring
requiredsubtypestring
requiredactivation_journey_typestring
requiredsupply_pointlifecycle-join_supplier-ActivationInitiatedSupplyPoint

Metadata

Event TypePayload Version
lifecycle.join-supplier.activation.initiatedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredaccount_numberstring
requiredjoin_supplier_process_numberstring
requiredsupply_pointlifecycle-join_supplier-ActivatedSupplyPoint
requiredagreements array[lifecycle-join_supplier-Agreement]
requiredcontract_referenceslifecycle-join_supplier-ContractReferences

Metadata

Event TypePayload Version
lifecycle.join-supplier.agreement.createdv1

JSON Payload Representation

{
  "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_references": {
    "account_contract_identifier": "string",
    "business_contract_identifier": "string"
  }
}

lifecycle.join-supplier.await-post-activation-flow-step.initiated-v1

Event Properties

NameType
requiredaccount_numberstring
requiredjoin_supplier_process_numberstring
requiredsubtypestring

Metadata

Event TypePayload Version
lifecycle.join-supplier.await-post-activation-flow-step.initiatedv1

JSON Payload Representation

{
  "account_number": "string",
  "join_supplier_process_number": "string",
  "subtype": "string"
}

lifecycle.join-supplier.await-pre-activation-flow-step.initiated-v1

Event Properties

NameType
requiredaccount_numberstring
requiredjoin_supplier_process_numberstring
requiredsubtypestring

Metadata

Event TypePayload Version
lifecycle.join-supplier.await-pre-activation-flow-step.initiatedv1

JSON Payload Representation

{
  "account_number": "string",
  "join_supplier_process_number": "string",
  "subtype": "string"
}

lifecycle.join-supplier.await-pre-discovery-flow-step.initiated-v1

Event Properties

NameType
requiredaccount_numberstring
requiredjoin_supplier_process_numberstring
requiredsubtypestring

Metadata

Event TypePayload Version
lifecycle.join-supplier.await-pre-discovery-flow-step.initiatedv1

JSON Payload Representation

{
  "account_number": "string",
  "join_supplier_process_number": "string",
  "subtype": "string"
}

lifecycle.join-supplier.cancellation-requested-v1

Event Properties

NameType
requiredaccount_numberstring
requiredjoin_supplier_process_numberstring
requiredsubtypestring
requiredsupply_points array[lifecycle-join_supplier-SupplyPoint]

Metadata

Event TypePayload Version
lifecycle.join-supplier.cancellation-requestedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredaccount_numberstring
requiredjoin_supplier_process_numberstring
requiredsubtypestring
requiredsupply_points array[lifecycle-join_supplier-SupplyPoint]

Metadata

Event TypePayload Version
lifecycle.join-supplier.cancelledv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredaccount_numberstring
requiredjoin_supplier_process_numberstring
requiredsubtypestring
requiredsupply_points array[lifecycle-join_supplier-ActivatedSupplyPoint]

Metadata

Event TypePayload Version
lifecycle.join-supplier.completedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredaccount_numberstring
requiredjoin_supplier_process_numberstring
requiredsubtypestring
requiredsupply_points array[lifecycle-join_supplier-SupplyPoint]
requiredrequested_atstring

Metadata

Event TypePayload Version
lifecycle.join-supplier.requestedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredaccount_numberstring
requiredjoin_supplier_process_numberstring
requiredsubtypestring
requiredsupply_points array[lifecycle-join_supplier-SupplyPoint]

Metadata

Event TypePayload Version
lifecycle.join-supplier.reversal-requestedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredaccount_numberstring
requiredjoin_supplier_process_numberstring
requiredsubtypestring
requiredsupply_points array[lifecycle-join_supplier-SupplyPoint]

Metadata

Event TypePayload Version
lifecycle.join-supplier.reversedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredaccount_numberstring
requiredjoin_supplier_process_numberstring
requiredsupply_pointlifecycle-join_supplier-ActivatedSupplyPoint
requiredsupply_periodlifecycle-join_supplier-SupplyPeriodData
requiredcontract_referenceslifecycle-join_supplier-ContractReferences

Metadata

Event TypePayload Version
lifecycle.join-supplier.supply-period.createdv1

JSON Payload Representation

{
  "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_references": {
    "account_contract_identifier": "string",
    "business_contract_identifier": "string"
  }
}

lifecycle.join-supplier.supply-point-journey-await-post-activation-flow-step.initiated-v1

Event Properties

NameType
requiredaccount_numberstring
requiredjoin_supplier_process_numberstring
requiredsupply_pointlifecycle-join_supplier-ActivatedSupplyPoint
requiredsubtypestring

Metadata

Event TypePayload Version
lifecycle.join-supplier.supply-point-journey-await-post-activation-flow-step.initiatedv1

JSON Payload Representation

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

lifecycle.join-supplier.supply-point-journey-await-pre-activation-flow-step.initiated-v1

Event Properties

NameType
requiredaccount_numberstring
requiredjoin_supplier_process_numberstring
requiredsupply_pointlifecycle-join_supplier-SupplyPoint
requiredsubtypestring

Metadata

Event TypePayload Version
lifecycle.join-supplier.supply-point-journey-await-pre-activation-flow-step.initiatedv1

JSON Payload Representation

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

lifecycle.join_supplier._ensure_payment_instructions.step_completed-v2

Event Properties

NameType
requiredjoin_supplier_process_idinteger
requiredjoin_supplier_process_numberstring
requiredaccount_numberstring

Metadata

Event TypePayload Version
lifecycle.join_supplier._ensure_payment_instructions.step_completedv2

JSON Payload Representation

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

lifecycle.join_supplier._ensure_payment_instructions.step_initiated-v2

Event Properties

NameType
requiredjoin_supplier_process_idinteger
requiredjoin_supplier_process_numberstring
requiredaccount_numberstring

Metadata

Event TypePayload Version
lifecycle.join_supplier._ensure_payment_instructions.step_initiatedv2

JSON Payload Representation

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

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

Event Properties

NameType
requiredjoin_supplier_process_idinteger
requiredjoin_supplier_process_numberstring

Metadata

Event TypePayload Version
lifecycle.join_supplier.terms-and-conditions.acceptedv2

JSON Payload Representation

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

lifecycle.leave-supplier.await-post-deactivation-flow-step.initiated-v1

Event Properties

NameType
requiredaccount_numberstring
requiredleave_supplier_process_numberstring
requiredsubtypestring

Metadata

Event TypePayload Version
lifecycle.leave-supplier.await-post-deactivation-flow-step.initiatedv1

JSON Payload Representation

{
  "account_number": "string",
  "leave_supplier_process_number": "string",
  "subtype": "string"
}

lifecycle.leave-supplier.await-post-termination-flow-step.initiated-v1

Event Properties

NameType
requiredaccount_numberstring
requiredleave_supplier_process_numberstring
requiredsubtypestring

Metadata

Event TypePayload Version
lifecycle.leave-supplier.await-post-termination-flow-step.initiatedv1

JSON Payload Representation

{
  "account_number": "string",
  "leave_supplier_process_number": "string",
  "subtype": "string"
}

lifecycle.leave-supplier.await-pre-termination-flow-step.initiated-v1

Event Properties

NameType
requiredaccount_numberstring
requiredleave_supplier_process_numberstring
requiredsubtypestring

Metadata

Event TypePayload Version
lifecycle.leave-supplier.await-pre-termination-flow-step.initiatedv1

JSON Payload Representation

{
  "account_number": "string",
  "leave_supplier_process_number": "string",
  "subtype": "string"
}

lifecycle.leave-supplier.cancellation-requested-v2

Event Properties

NameType
requiredaccount_numberstring
requiredleave_supplier_process_idinteger
requiredleave_supplier_process_numberstring
requiredsupply_points array[lifecycle-leave_supplier-SupplyPoint]

Metadata

Event TypePayload Version
lifecycle.leave-supplier.cancellation-requestedv2

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredaccount_numberstring
requiredleave_supplier_process_idinteger
requiredleave_supplier_process_numberstring
requiredsupply_points array[lifecycle-leave_supplier-SupplyPoint]

Metadata

Event TypePayload Version
lifecycle.leave-supplier.cancelledv2

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredaccount_numberstring
requiredleave_supplier_process_idinteger
requiredleave_supplier_process_numberstring
requiredleave_supplier_process_subtypestring
requiredsupply_points array[lifecycle-leave_supplier-TerminatedSupplyPoint]

Metadata

Event TypePayload Version
lifecycle.leave-supplier.completedv3

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredaccount_numberstring
requiredleave_supplier_process_idinteger
requiredleave_supplier_process_subtypestring
requiredsupply_points array[lifecycle-leave_supplier-SupplyPoint]
requiredrequested_supply_end_atstring
requiredrequested_supply_end_datestring
requiredrequested_atstring
requiredis_passiveboolean
passive_loss_instigated_supply_point_idinteger

Metadata

Event TypePayload Version
lifecycle.leave-supplier.requestedv2

JSON Payload Representation

{
  "account_number": "string",
  "leave_supplier_process_id": "integer",
  "leave_supplier_process_subtype": "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.requested-v3

Event Properties

NameType
requiredaccount_numberstring
requiredleave_supplier_process_idinteger
requiredleave_supplier_process_numberstring
requiredleave_supplier_process_subtypestring
requiredsupply_points array[lifecycle-leave_supplier-SupplyPoint]
requiredrequested_supply_end_atstring
requiredrequested_supply_end_datestring
requiredrequested_atstring
requiredis_passiveboolean
passive_loss_instigated_supply_point_idinteger

Metadata

Event TypePayload Version
lifecycle.leave-supplier.requestedv3

JSON Payload Representation

{
  "account_number": "string",
  "leave_supplier_process_id": "integer",
  "leave_supplier_process_number": "string",
  "leave_supplier_process_subtype": "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

Event Properties

NameType
requiredaccount_numberstring
requiredleave_supplier_process_idinteger
requiredleave_supplier_process_numberstring
requiredsupply_points array[lifecycle-leave_supplier-SupplyPoint]

Metadata

Event TypePayload Version
lifecycle.leave-supplier.reversal-requestedv2

JSON Payload Representation

{
  "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.supply-point-journey-await-post-termination-flow-step.initiated-v1

Event Properties

NameType
requiredaccount_numberstring
requiredleave_supplier_process_numberstring
requiredsupply_pointlifecycle-leave_supplier-TerminatedSupplyPoint
requiredsubtypestring

Metadata

Event TypePayload Version
lifecycle.leave-supplier.supply-point-journey-await-post-termination-flow-step.initiatedv1

JSON Payload Representation

{
  "account_number": "string",
  "leave_supplier_process_number": "string",
  "supply_point": {
    "external_identifier": "string",
    "market_name": "string",
    "confirmed_supply_end_date": "string"
  },
  "subtype": "string"
}

lifecycle.leave-supplier.supply-point-journey-await-pre-agreement-termination-flow-step.initiated-v1

Event Properties

NameType
requiredaccount_numberstring
requiredleave_supplier_process_numberstring
requiredsupply_pointlifecycle-leave_supplier-SupplyPoint
requiredsubtypestring

Metadata

Event TypePayload Version
lifecycle.leave-supplier.supply-point-journey-await-pre-agreement-termination-flow-step.initiatedv1

JSON Payload Representation

{
  "account_number": "string",
  "leave_supplier_process_number": "string",
  "supply_point": {
    "market_identifier": "string",
    "external_identifier": "string",
    "market_name": "string"
  },
  "subtype": "string"
}

lifecycle.leave-supplier.supply-point-journey-await-pre-termination-flow-step.initiated-v1

Event Properties

NameType
requiredaccount_numberstring
requiredleave_supplier_process_numberstring
requiredsupply_pointlifecycle-leave_supplier-SupplyPoint
requiredsubtypestring

Metadata

Event TypePayload Version
lifecycle.leave-supplier.supply-point-journey-await-pre-termination-flow-step.initiatedv1

JSON Payload Representation

{
  "account_number": "string",
  "leave_supplier_process_number": "string",
  "supply_point": {
    "market_identifier": "string",
    "external_identifier": "string",
    "market_name": "string"
  },
  "subtype": "string"
}

lifecycle.leave-supplier.termination.confirmed-v2

Event Properties

NameType
requiredaccount_numberstring
requiredleave_supplier_process_idinteger
requiredleave_supplier_process_numberstring
requiredleave_supplier_process_subtypestring
requiredsupply_pointlifecycle-leave_supplier-TerminatedSupplyPoint

Metadata

Event TypePayload Version
lifecycle.leave-supplier.termination.confirmedv2

JSON Payload Representation

{
  "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.termination.initiated-v1

Event Properties

NameType
requiredaccount_numberstring
requiredleave_supplier_process_numberstring
requiredleave_supplier_process_subtypestring
requiredsupply_pointlifecycle-leave_supplier-TerminationInitiatedSupplyPoint

Metadata

Event TypePayload Version
lifecycle.leave-supplier.termination.initiatedv1

JSON Payload Representation

{
  "account_number": "string",
  "leave_supplier_process_number": "string",
  "leave_supplier_process_subtype": "string",
  "supply_point": {
    "external_identifier": "string",
    "market_name": "string",
    "requested_supply_end_date": "string"
  }
}

lifecycle.leave-supplier.updated-v2

Event Properties

NameType
requiredaccount_numberstring
requiredleave_supplier_process_idinteger
requiredleave_supplier_process_subtypestring
requiredsupply_points array[lifecycle-leave_supplier-SupplyPoint]
requiredrequested_supply_end_atstring
requiredrequested_supply_end_datestring
requiredupdated_atstring
requiredis_passiveboolean
passive_loss_instigated_supply_point_idinteger

Metadata

Event TypePayload Version
lifecycle.leave-supplier.updatedv2

JSON Payload Representation

{
  "account_number": "string",
  "leave_supplier_process_id": "integer",
  "leave_supplier_process_subtype": "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.leave-supplier.updated-v3

Event Properties

NameType
requiredaccount_numberstring
requiredleave_supplier_process_idinteger
requiredleave_supplier_process_numberstring
requiredleave_supplier_process_subtypestring
requiredsupply_points array[lifecycle-leave_supplier-SupplyPoint]
requiredrequested_supply_end_atstring
requiredrequested_supply_end_datestring
requiredupdated_atstring
requiredis_passiveboolean
passive_loss_instigated_supply_point_idinteger

Metadata

Event TypePayload Version
lifecycle.leave-supplier.updatedv3

JSON Payload Representation

{
  "account_number": "string",
  "leave_supplier_process_id": "integer",
  "leave_supplier_process_number": "string",
  "leave_supplier_process_subtype": "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.status-changed-v1

Event Properties

NameType
requiredprocess_numberstring
requiredaccount_numberstring
requirednew_statusstring
requiredprevious_statusstring

Metadata

Event TypePayload Version
lifecycle.status-changedv1

JSON Payload Representation

{
  "process_number": "string",
  "account_number": "string",
  "new_status": "string",
  "previous_status": "string"
}

lifecycle.support-site.sale-1.0.0

Event Properties

NameType
requiredsupport_user_idstring
requiredsupply_start_datestring
requiredtrigger_actionstring

Metadata

Event TypePayload Version
lifecycle.support-site.sale1.0.0

JSON Payload Representation

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

loyalty-points.user-role-removal-v1

Event Properties

NameType
requireduser_idinteger
requiredaccount_idinteger

Metadata

Event TypePayload Version
loyalty-points.user-role-removalv1

JSON Payload Representation

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

market_supply-products-Product

Event Properties

NameType
requiredcodestring
requiredmarket_namestring
requiredbrand_codestring

JSON Payload Representation

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

messaging.push-notification.token-unregistered-v1

Event Properties

NameType
requiredtokenstring
requiredexternal_providerstring

Metadata

Event TypePayload Version
messaging.push-notification.token-unregisteredv1

JSON Payload Representation

{
  "token": "string",
  "external_provider": "string"
}

meter_data_quality.resolution_cancelled-v1

Event Properties

NameType
requiredissue_idinteger
requiredissue_categorystring
requiredissue_subcategorystring
requiredissue_statusstring
requiredmarket_supply_point_idstring
requiredopened_atstring
requiredperiod_startstring
requiredperiod_endstring
requiredreading_typestring
requiredutilitystring

Metadata

Event TypePayload Version
meter_data_quality.resolution_cancelledv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredissue_idinteger
requiredissue_categorystring
requiredissue_subcategorystring
requiredissue_statusstring
requiredmarket_supply_point_idstring
requiredopened_atstring
requiredperiod_startstring
requiredperiod_endstring
requiredreading_typestring
requiredutilitystring
requiredsourcestring

Metadata

Event TypePayload Version
meter_data_quality.resolution_cancelledv2

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredissue_idinteger
requiredissue_categorystring
requiredissue_subcategorystring
requiredissue_statusstring
requiredmarket_supply_point_idstring
requiredopened_atstring
requiredperiod_startstring
requiredperiod_endstring
requiredreading_typestring
requiredutilitystring

Metadata

Event TypePayload Version
meter_data_quality.resolution_requestedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredserial_numberstring
requiredcurrent_ratinginteger
requiredlocationstring
requiredmake_and_typestring
requiredmeter_asset_provider_mpidstring
requiredmeter_typestring
requiredretrieval_methodstring
requiredretrieval_method_effective_fromstring
requiredmeter_copstring
requiredmeter_cop_dispensationstring
requiredcommunications_addressstring
requiredcommunications_methodstring
requiredvt_ratiostring
requiredinstallation_datestring
requiredtiming_device_idstring
requiredis_tele_switchboolean
requiredct_ratiostring
requiredregisters array[meter_points-meter_details-Register]

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredregister_idstring
requiredregister_typestring
requiredmeasurement_quantitystring
requiredmultiplierstring
requireddigitsinteger
requiredis_mainboolean
requiredassociated_meter_serialstring
requiredassociated_register_idstring

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredserial_numberstring
requireddate_of_removalstring
requiredmeter_asset_provider_mpidstring

JSON Payload Representation

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

meterpoint.elec.cos_gain.registration.requested-v1

Event Properties

NameType
requiredmpanstring
requiredsupply_start_datestring
requiredsupplier_mpidstring
requiredaccount_numberstring
requiredis_internal_transferboolean
requiredis_migratedboolean
requiredis_exportboolean

Metadata

Event TypePayload Version
meterpoint.elec.cos_gain.registration.requestedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredsupplierstring
requiredsupply_start_datestring
requiredmeter_reading_factorstring
requirednomination_shipper_refstring
requiredsupply_end_datestring

Metadata

Event TypePayload Version
meterpoint.gas.api_backfillv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredmam_to_appointstring
requiredforce_appointmentboolean
requiredownerobject
requiredmodelstring
requiredmanufacturerstring
requiredmanufactured_yearinteger
requiredlocationstring
requiredlocation_descriptionstring
requiredstatusstring
requiredmeter_typestring
requiredmeter_mechanismstring

Metadata

Event TypePayload Version
meterpoint.gas.appoint_mam.requestedv1

JSON Payload Representation

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

meterpoint.gas.backfill-v1

Event Properties

NameType
requiredmprnstring
requiredsupplierstring
requiredsupply_start_datestring
requiredsub_building_namestring
requiredbuilding_namestring
requiredbuilding_numberstring
requireddependent_streetstring
requiredprincipal_streetstring
requireddouble_dependent_localitystring
requireddependent_localitystring
requiredpost_townstring
requiredcountystring
requiredpostcodestring
requiredmeter_serial_numberstring
requiredmeter_digitsinteger
requiredmeter_mechanismstring
requiredmeter_is_imperialboolean
requiredmeter_reading_factorstring
requiredlast_readingstring
requiredlast_reading_onstring
requirednomination_shipper_refstring
requiredcohortstring

Metadata

Event TypePayload Version
meterpoint.gas.backfillv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredcohortstring

Metadata

Event TypePayload Version
meterpoint.gas.change_of_cohort.requestedv1

JSON Payload Representation

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

meterpoint.gas.change_of_mam.requested-v1

Event Properties

NameType
requiredmprnstring
requiredmam_to_appointstring
requiredforce_appointmentboolean
requiredownerobject
requiredmodelstring
requiredmanufacturerstring
requiredmanufactured_yearinteger
requiredlocationstring
requiredlocation_descriptionstring
requiredstatusstring
requiredmeter_typestring
requiredmeter_mechanismstring
requiredeffective_from_datestring
requiredcurrent_mamstring

Metadata

Event TypePayload Version
meterpoint.gas.change_of_mam.requestedv1

JSON Payload Representation

{
  "mprn": "string",
  "mam_to_appoint": "string",
  "force_appointment": "boolean",
  "owner": "object",
  "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

Event Properties

NameType
requiredmprnstring
requiredbuilding_namestring
requiredbuilding_numberinteger
requireddependent_streetstring
requiredprinciple_streetstring
requireddependent_localitystring
requiredpost_townstring
requiredcountystring
requiredmeter_serial_numberstring
requiredmeter_digitsinteger
requiredmeter_mechanismstring
requiredmeter_typestring
requiredmeter_is_imperialboolean
requiredmeter_reading_factorinteger
meter_link_codestring
requiredownerstring
requiredmodelstring
requiredmanufacturerstring
requiredmanufactured_yearinteger
requiredlocationstring
requiredlocation_descriptionstring
requiredinstructionsstring
requiredstatusstring
requiredpulse_valuenumber
requiredcorrection_factornumber
requiredbypass_fittedboolean
requiredcollar_fittedboolean
requiredlast_inspection_onstring
requiredlast_readinginteger
requiredlast_reading_onstring

Metadata

Event TypePayload Version
meterpoint.gas.cos_gain.mtd_receivedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredprevious_mamstring
requiredis_domesticboolean
requiredis_igt_mamboolean

Metadata

Event TypePayload Version
meterpoint.gas.cos_gain.registration.confirmedv1

JSON Payload Representation

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

meterpoint.gas.cos_gain.registration.requested-v1

Event Properties

NameType
requiredmprnstring
requiredsupply_start_datestring
requiredsupplier_mpidstring
requiredaccount_numberstring

Metadata

Event TypePayload Version
meterpoint.gas.cos_gain.registration.requestedv1

JSON Payload Representation

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

meterpoint.gas.cos_loss.confirmed-v1

Event Properties

NameType
requiredaccount_idinteger
requiredmprnstring
requiredsupply_end_datestring
requiredmeter_existsboolean
requiredmeter_serial_numberstring
requiredmeter_digitsinteger
requiredmeter_mechanismstring
requiredmeter_imperial_metric_indicatorstring
requiredmeter_reading_factornumber
requirednew_supplierstring

Metadata

Event TypePayload Version
meterpoint.gas.cos_loss.confirmedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredmam_to_deappointstring
requiredeffective_to_datestring
requiredis_cos_lossboolean
requirednew_supplierstring
requiredcurrent_mamstring

Metadata

Event TypePayload Version
meterpoint.gas.deappoint_mam.requestedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredsupplierstring
requiredreference_numberinteger
requiredtransfer_datestring
requiredinitiating_organisationstring
requiredio_contact_namestring
requiredrecipient_organisationstring
requiredro_contact_namestring
requiredmeter_serialstring
requiredmeter_digitsinteger
requiredhouse_name_numberstring
requiredpostcodestring
requireddisputed_readinginteger
requireddisputed_reading_is_actualboolean
requiredproposed_readinginteger
requiredproposed_reading_is_actualboolean
requiredstatus_responsestring
requiredroot_causestring
requiredrejection_acceptance_codestring
requiredcriteriastring
requiredcommentsstring
requiredis_gainboolean

Metadata

Event TypePayload Version
meterpoint.gas.disputed_closing_reading.accepted.by_usv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredsupplierstring
requiredreference_numberinteger
requiredtransfer_datestring
requiredinitiating_organisationstring
requiredio_contact_namestring
requiredrecipient_organisationstring
requiredro_contact_namestring
requiredmeter_serialstring
requiredmeter_digitsinteger
requiredhouse_name_numberstring
requiredpostcodestring
requireddisputed_readinginteger
requireddisputed_reading_is_actualboolean
requiredproposed_readinginteger
requiredproposed_reading_is_actualboolean
requiredstatus_responsestring
requiredroot_causestring
requiredrejection_acceptance_codestring
requiredcriteriastring
requiredcommentsstring
requiredis_gainboolean

Metadata

Event TypePayload Version
meterpoint.gas.disputed_closing_reading.accepted.other_supplierv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredsupplierstring
requiredreference_numberinteger
requiredtransfer_datestring
requiredinitiating_organisationstring
requiredio_contact_namestring
requiredrecipient_organisationstring
requiredro_contact_namestring
requiredmeter_serialstring
requiredmeter_digitsinteger
requiredhouse_name_numberstring
requiredpostcodestring
requireddisputed_readinginteger
requireddisputed_reading_is_actualboolean
requiredproposed_readinginteger
requiredproposed_reading_is_actualboolean
requiredstatus_responsestring
requiredroot_causestring
requiredrejection_acceptance_codestring
requiredcriteriastring
requiredcommentsstring
requiredis_gainboolean

Metadata

Event TypePayload Version
meterpoint.gas.disputed_closing_reading.alternative_proposed.by_usv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredsupplierstring
requiredreference_numberinteger
requiredtransfer_datestring
requiredinitiating_organisationstring
requiredio_contact_namestring
requiredrecipient_organisationstring
requiredro_contact_namestring
requiredmeter_serialstring
requiredmeter_digitsinteger
requiredhouse_name_numberstring
requiredpostcodestring
requireddisputed_readinginteger
requireddisputed_reading_is_actualboolean
requiredproposed_readinginteger
requiredproposed_reading_is_actualboolean
requiredstatus_responsestring
requiredroot_causestring
requiredrejection_acceptance_codestring
requiredcriteriastring
requiredcommentsstring
requiredis_gainboolean

Metadata

Event TypePayload Version
meterpoint.gas.disputed_closing_reading.alternative_proposed.other_supplierv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredsupplierstring
requiredreference_numberinteger
requiredtransfer_datestring
requiredinitiating_organisationstring
requiredio_contact_namestring
requiredrecipient_organisationstring
requiredro_contact_namestring
requiredmeter_serialstring
requiredmeter_digitsinteger
requiredhouse_name_numberstring
requiredpostcodestring
requireddisputed_readinginteger
requireddisputed_reading_is_actualboolean
requiredproposed_readinginteger
requiredproposed_reading_is_actualboolean
requiredstatus_responsestring
requiredroot_causestring
requiredrejection_acceptance_codestring
requiredcriteriastring
requiredcommentsstring
requiredis_gainboolean

Metadata

Event TypePayload Version
meterpoint.gas.disputed_closing_reading.queried.by_usv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredsupplierstring
requiredreference_numberinteger
requiredtransfer_datestring
requiredinitiating_organisationstring
requiredio_contact_namestring
requiredrecipient_organisationstring
requiredro_contact_namestring
requiredmeter_serialstring
requiredmeter_digitsinteger
requiredhouse_name_numberstring
requiredpostcodestring
requireddisputed_readinginteger
requireddisputed_reading_is_actualboolean
requiredproposed_readinginteger
requiredproposed_reading_is_actualboolean
requiredstatus_responsestring
requiredroot_causestring
requiredrejection_acceptance_codestring
requiredcriteriastring
requiredcommentsstring
requiredis_gainboolean

Metadata

Event TypePayload Version
meterpoint.gas.disputed_closing_reading.started.by_usv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredsupplierstring
requiredreference_numberinteger
requiredtransfer_datestring
requiredinitiating_organisationstring
requiredio_contact_namestring
requiredrecipient_organisationstring
requiredro_contact_namestring
requiredmeter_serialstring
requiredmeter_digitsinteger
requiredhouse_name_numberstring
requiredpostcodestring
requireddisputed_readinginteger
requireddisputed_reading_is_actualboolean
requiredproposed_readinginteger
requiredproposed_reading_is_actualboolean
requiredstatus_responsestring
requiredroot_causestring
requiredrejection_acceptance_codestring
requiredcriteriastring
requiredcommentsstring
requiredis_gainboolean

Metadata

Event TypePayload Version
meterpoint.gas.disputed_closing_reading.started.other_supplierv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredsupplierstring
requiredreference_numberinteger
requiredtransfer_datestring
requiredinitiating_organisationstring
requiredio_contact_namestring
requiredrecipient_organisationstring
requiredro_contact_namestring
requiredmeter_serialstring
requiredmeter_digitsinteger
requiredhouse_name_numberstring
requiredpostcodestring
requireddisputed_readinginteger
requireddisputed_reading_is_actualboolean
requiredproposed_readinginteger
requiredproposed_reading_is_actualboolean
requiredstatus_responsestring
requiredroot_causestring
requiredrejection_acceptance_codestring
requiredcriteriastring
requiredcommentsstring
requiredis_gainboolean

Metadata

Event TypePayload Version
meterpoint.gas.disputed_opening_reading.accepted.by_usv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredsupplierstring
requiredreference_numberinteger
requiredtransfer_datestring
requiredinitiating_organisationstring
requiredio_contact_namestring
requiredrecipient_organisationstring
requiredro_contact_namestring
requiredmeter_serialstring
requiredmeter_digitsinteger
requiredhouse_name_numberstring
requiredpostcodestring
requireddisputed_readinginteger
requireddisputed_reading_is_actualboolean
requiredproposed_readinginteger
requiredproposed_reading_is_actualboolean
requiredstatus_responsestring
requiredroot_causestring
requiredrejection_acceptance_codestring
requiredcriteriastring
requiredcommentsstring
requiredis_gainboolean

Metadata

Event TypePayload Version
meterpoint.gas.disputed_opening_reading.accepted.other_supplierv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredsupplierstring
requiredreference_numberinteger
requiredtransfer_datestring
requiredinitiating_organisationstring
requiredio_contact_namestring
requiredrecipient_organisationstring
requiredro_contact_namestring
requiredmeter_serialstring
requiredmeter_digitsinteger
requiredhouse_name_numberstring
requiredpostcodestring
requireddisputed_readinginteger
requireddisputed_reading_is_actualboolean
requiredproposed_readinginteger
requiredproposed_reading_is_actualboolean
requiredstatus_responsestring
requiredroot_causestring
requiredrejection_acceptance_codestring
requiredcriteriastring
requiredcommentsstring
requiredis_gainboolean

Metadata

Event TypePayload Version
meterpoint.gas.disputed_opening_reading.alternative_proposed.by_usv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredsupplierstring
requiredreference_numberinteger
requiredtransfer_datestring
requiredinitiating_organisationstring
requiredio_contact_namestring
requiredrecipient_organisationstring
requiredro_contact_namestring
requiredmeter_serialstring
requiredmeter_digitsinteger
requiredhouse_name_numberstring
requiredpostcodestring
requireddisputed_readinginteger
requireddisputed_reading_is_actualboolean
requiredproposed_readinginteger
requiredproposed_reading_is_actualboolean
requiredstatus_responsestring
requiredroot_causestring
requiredrejection_acceptance_codestring
requiredcriteriastring
requiredcommentsstring
requiredis_gainboolean

Metadata

Event TypePayload Version
meterpoint.gas.disputed_opening_reading.alternative_proposed.other_supplierv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredsupplierstring
requiredreference_numberinteger
requiredtransfer_datestring
requiredinitiating_organisationstring
requiredio_contact_namestring
requiredrecipient_organisationstring
requiredro_contact_namestring
requiredmeter_serialstring
requiredmeter_digitsinteger
requiredhouse_name_numberstring
requiredpostcodestring
requireddisputed_readinginteger
requireddisputed_reading_is_actualboolean
requiredproposed_readinginteger
requiredproposed_reading_is_actualboolean
requiredstatus_responsestring
requiredroot_causestring
requiredrejection_acceptance_codestring
requiredcriteriastring
requiredcommentsstring
requiredis_gainboolean

Metadata

Event TypePayload Version
meterpoint.gas.disputed_opening_reading.queried.by_usv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredsupplierstring
requiredreference_numberinteger
requiredtransfer_datestring
requiredinitiating_organisationstring
requiredio_contact_namestring
requiredrecipient_organisationstring
requiredro_contact_namestring
requiredmeter_serialstring
requiredmeter_digitsinteger
requiredhouse_name_numberstring
requiredpostcodestring
requireddisputed_readinginteger
requireddisputed_reading_is_actualboolean
requiredproposed_readinginteger
requiredproposed_reading_is_actualboolean
requiredstatus_responsestring
requiredroot_causestring
requiredrejection_acceptance_codestring
requiredcriteriastring
requiredcommentsstring
requiredis_gainboolean

Metadata

Event TypePayload Version
meterpoint.gas.disputed_opening_reading.started.by_usv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredsupplierstring
requiredreference_numberinteger
requiredtransfer_datestring
requiredinitiating_organisationstring
requiredio_contact_namestring
requiredrecipient_organisationstring
requiredro_contact_namestring
requiredmeter_serialstring
requiredmeter_digitsinteger
requiredhouse_name_numberstring
requiredpostcodestring
requireddisputed_readinginteger
requireddisputed_reading_is_actualboolean
requiredproposed_readinginteger
requiredproposed_reading_is_actualboolean
requiredstatus_responsestring
requiredroot_causestring
requiredrejection_acceptance_codestring
requiredcriteriastring
requiredcommentsstring
requiredis_gainboolean

Metadata

Event TypePayload Version
meterpoint.gas.disputed_opening_reading.started.other_supplierv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredsupplierstring
requiredreference_numberinteger
requiredtransfer_datestring
requiredsub_building_namestring
requiredbuilding_namestring
requiredbuilding_numberstring
requireddeliver_point_aliasstring
requiredstreet_namestring
requiredpostcodestring
requiredinitial_contact_datestring
requiredinitiating_organisationstring
requiredio_contact_namestring
requiredresponding_organisationstring
requiredro_contact_namestring
requiredstatus_responsestring
requiredrejection_acceptance_codestring
requiredreason_for_returnstring
requiredcommentsstring
requiredcustomer_namestring
requiredother_supplierstring
requiredcontact_namestring

Metadata

Event TypePayload Version
meterpoint.gas.et_gain.accepted.by_other_supplierv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredsupplierstring
requiredreference_numberinteger
requiredtransfer_datestring
requiredsub_building_namestring
requiredbuilding_namestring
requiredbuilding_numberstring
requireddeliver_point_aliasstring
requiredstreet_namestring
requiredpostcodestring
requiredinitial_contact_datestring
requiredinitiating_organisationstring
requiredio_contact_namestring
requiredresponding_organisationstring
requiredro_contact_namestring
requiredstatus_responsestring
requiredrejection_acceptance_codestring
requiredreason_for_returnstring
requiredcommentsstring
requiredcustomer_namestring
requiredother_supplierstring
requiredcontact_namestring

Metadata

Event TypePayload Version
meterpoint.gas.et_gain.accepted.by_usv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredsupplierstring
requiredreference_numberinteger
requiredtransfer_datestring
requiredsub_building_namestring
requiredbuilding_namestring
requiredbuilding_numberstring
requireddeliver_point_aliasstring
requiredstreet_namestring
requiredpostcodestring
requiredinitial_contact_datestring
requiredinitiating_organisationstring
requiredio_contact_namestring
requiredresponding_organisationstring
requiredro_contact_namestring
requiredstatus_responsestring
requiredrejection_acceptance_codestring
requiredreason_for_returnstring
requiredcommentsstring
requiredcustomer_namestring
requiredother_supplierstring
requiredcontact_namestring

Metadata

Event TypePayload Version
meterpoint.gas.et_gain.rejected.by_other_supplierv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredsupplierstring
requiredreference_numberinteger
requiredtransfer_datestring
requiredsub_building_namestring
requiredbuilding_namestring
requiredbuilding_numberstring
requireddeliver_point_aliasstring
requiredstreet_namestring
requiredpostcodestring
requiredinitial_contact_datestring
requiredinitiating_organisationstring
requiredio_contact_namestring
requiredresponding_organisationstring
requiredro_contact_namestring
requiredstatus_responsestring
requiredrejection_acceptance_codestring
requiredreason_for_returnstring
requiredcommentsstring
requiredcustomer_namestring
requiredother_supplierstring
requiredcontact_namestring

Metadata

Event TypePayload Version
meterpoint.gas.et_gain.rejected.by_usv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredsupplierstring
requiredreference_numberinteger
requiredtransfer_datestring
requiredsub_building_namestring
requiredbuilding_namestring
requiredbuilding_numberstring
requireddeliver_point_aliasstring
requiredstreet_namestring
requiredpostcodestring
requiredinitial_contact_datestring
requiredinitiating_organisationstring
requiredio_contact_namestring
requiredresponding_organisationstring
requiredro_contact_namestring
requiredstatus_responsestring
requiredrejection_acceptance_codestring
requiredreason_for_returnstring
requiredcommentsstring
requiredcustomer_namestring
requiredother_supplierstring
requiredcontact_namestring

Metadata

Event TypePayload Version
meterpoint.gas.et_gain.started.by_other_supplierv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredsupplierstring
requiredreference_numberinteger
requiredtransfer_datestring
requiredsub_building_namestring
requiredbuilding_namestring
requiredbuilding_numberstring
requireddeliver_point_aliasstring
requiredstreet_namestring
requiredpostcodestring
requiredinitial_contact_datestring
requiredinitiating_organisationstring
requiredio_contact_namestring
requiredresponding_organisationstring
requiredro_contact_namestring
requiredstatus_responsestring
requiredrejection_acceptance_codestring
requiredreason_for_returnstring
requiredcommentsstring
requiredcustomer_namestring
requiredother_supplierstring
requiredcontact_namestring

Metadata

Event TypePayload Version
meterpoint.gas.et_gain.started.by_usv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredsupplierstring
requiredreference_numberinteger
requiredtransfer_datestring
requiredsub_building_namestring
requiredbuilding_namestring
requiredbuilding_numberstring
requireddeliver_point_aliasstring
requiredstreet_namestring
requiredpostcodestring
requiredinitial_contact_datestring
requiredinitiating_organisationstring
requiredio_contact_namestring
requiredresponding_organisationstring
requiredro_contact_namestring
requiredstatus_responsestring
requiredrejection_acceptance_codestring
requiredreason_for_returnstring
requiredcommentsstring
requiredcustomer_namestring
requiredother_supplierstring
requiredcontact_namestring

Metadata

Event TypePayload Version
meterpoint.gas.et_loss.accepted.by_other_supplierv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredsupplierstring
requiredreference_numberinteger
requiredtransfer_datestring
requiredsub_building_namestring
requiredbuilding_namestring
requiredbuilding_numberstring
requireddeliver_point_aliasstring
requiredstreet_namestring
requiredpostcodestring
requiredinitial_contact_datestring
requiredinitiating_organisationstring
requiredio_contact_namestring
requiredresponding_organisationstring
requiredro_contact_namestring
requiredstatus_responsestring
requiredrejection_acceptance_codestring
requiredreason_for_returnstring
requiredcommentsstring
requiredcustomer_namestring
requiredother_supplierstring
requiredcontact_namestring

Metadata

Event TypePayload Version
meterpoint.gas.et_loss.accepted.by_usv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredsupplierstring
requiredreference_numberinteger
requiredtransfer_datestring
requiredsub_building_namestring
requiredbuilding_namestring
requiredbuilding_numberstring
requireddeliver_point_aliasstring
requiredstreet_namestring
requiredpostcodestring
requiredinitial_contact_datestring
requiredinitiating_organisationstring
requiredio_contact_namestring
requiredresponding_organisationstring
requiredro_contact_namestring
requiredstatus_responsestring
requiredrejection_acceptance_codestring
requiredreason_for_returnstring
requiredcommentsstring
requiredcustomer_namestring
requiredother_supplierstring
requiredcontact_namestring

Metadata

Event TypePayload Version
meterpoint.gas.et_loss.rejected.by_other_supplierv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredsupplierstring
requiredreference_numberinteger
requiredtransfer_datestring
requiredsub_building_namestring
requiredbuilding_namestring
requiredbuilding_numberstring
requireddeliver_point_aliasstring
requiredstreet_namestring
requiredpostcodestring
requiredinitial_contact_datestring
requiredinitiating_organisationstring
requiredio_contact_namestring
requiredresponding_organisationstring
requiredro_contact_namestring
requiredstatus_responsestring
requiredrejection_acceptance_codestring
requiredreason_for_returnstring
requiredcommentsstring
requiredcustomer_namestring
requiredother_supplierstring
requiredcontact_namestring

Metadata

Event TypePayload Version
meterpoint.gas.et_loss.rejected.by_usv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredsupplierstring
requiredreference_numberinteger
requiredtransfer_datestring
requiredsub_building_namestring
requiredbuilding_namestring
requiredbuilding_numberstring
requireddeliver_point_aliasstring
requiredstreet_namestring
requiredpostcodestring
requiredinitial_contact_datestring
requiredinitiating_organisationstring
requiredio_contact_namestring
requiredresponding_organisationstring
requiredro_contact_namestring
requiredstatus_responsestring
requiredrejection_acceptance_codestring
requiredreason_for_returnstring
requiredcommentsstring
requiredcustomer_namestring
requiredother_supplierstring
requiredcontact_namestring

Metadata

Event TypePayload Version
meterpoint.gas.et_loss.started.by_other_supplierv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredsupplierstring
requiredreference_numberinteger
requiredtransfer_datestring
requiredsub_building_namestring
requiredbuilding_namestring
requiredbuilding_numberstring
requireddeliver_point_aliasstring
requiredstreet_namestring
requiredpostcodestring
requiredinitial_contact_datestring
requiredinitiating_organisationstring
requiredio_contact_namestring
requiredresponding_organisationstring
requiredro_contact_namestring
requiredstatus_responsestring
requiredrejection_acceptance_codestring
requiredreason_for_returnstring
requiredcommentsstring
requiredcustomer_namestring
requiredother_supplierstring
requiredcontact_namestring

Metadata

Event TypePayload Version
meterpoint.gas.et_loss.started.by_usv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredtransaction_referencestring
requiredtransaction_statusstring
requiredmarket_sectorstring
requiredtransaction_typestring
requiredmeter_linkstring
requiredaddress_typestring
requiredasset_transaction_typestring
requiredasset_classstring
requirednum_dials_or_digitsinteger
requiredunits_of_measurestring
requiredmeter_typestring
requiredmechanismstring
requiredreading_valuestring
requiredcontract_referencestring
requiredtransaction_commentstring
requiredtransaction_type_reasonstring
requiredcross_ref_other_internal_job_referencestring
requiredcross_ref_other_external_job_referencestring
requiredtransaction_status_change_reasonstring
requireddate_of_noticestring
requiredregistration_bodystring
requiredregistration_referencestring
requiredeffective_from_datestring
requiredeffective_to_datestring
requiredmeter_point_statusstring
requiredmeter_point_data_updatestring
requiredmeter_point_locationstring
requiredmeter_point_location_notesstring
requiredaccess_instructionsstring
requiredmeter_point_conversion_factornumber
requiredlast_inspection_datestring
requiredmetering_pressurenumber
requiredaddress_notesstring
requiredsub_building_name_numberstring
requiredbuilding_name_numberstring
requireddependent_thoroughfarestring
requiredthoroughfarestring
requireddouble_dependent_localitystring
requireddependent_localitystring
requiredpost_townstring
requiredcountystring
requiredpost_codestring
requiredgrid_coord_xinteger
requiredgrid_coord_yinteger
requiredgrid_coord_zinteger
requiredunique_property_reference_numberstring
requiredasset_data_updatestring
requiredproduct_idstring
requiredpayment_methodstring
requiredmodel_codestring
requiredmanufacturer_codestring
requiredyear_of_manufactureinteger
requiredserial_numberstring
requiredasset_locationstring
requiredasset_location_notesstring
requiredasset_statusstring
requiredappointment_date_qualifierstring
requiredappointment_date_fromstring
requiredappointment_date_tostring
requiredappointment_time_qualifierstring
requiredappointment_time_fromstring
requiredappointment_time_tostring
requiredregister_typestring
requiredregister_data_updatestring
requiredmultiplication_factornumber
requiredconverter_data_updatestring
requiredconversion_basisstring
requiredconverter_conversion_factornumber
requiredmeter_data_updatestring
requiredmeasuring_capacitynumber
requiredmeter_usagestring
requiredcollar_statusstring
requiredoami_inspection_datestring
requiredmeter_rolestring
requiredmarket_participant_rolestring
requiredlast_refurbished_datestring
requiredpulse_valuenumber
requiredreading_datestring
requiredround_the_clockinteger

Metadata

Event TypePayload Version
meterpoint.gas.meter-technical-details.update.requestedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmprnstring
requiredmeter_serial_numberstring
requiredmeter_digitsinteger
requiredmeter_mechanismstring
requiredmeter_is_imperialboolean
requiredmeter_reading_factornumber

Metadata

Event TypePayload Version
meterpoint.gas.meter_exchangedv1

JSON Payload Representation

{
  "mprn": "string",
  "meter_serial_number": "string",
  "meter_digits": "integer",
  "meter_mechanism": "string",
  "meter_is_imperial": "boolean",
  "meter_reading_factor": "number"
}

meterpoint.gas.reading-v1

Event Properties

NameType
requiredmprnstring
requiredreadinginteger
requireddatestring
requiredmeter_digitsinteger
requiredmeter_serial_numberstring

Metadata

Event TypePayload Version
meterpoint.gas.readingv1

JSON Payload Representation

{
  "mprn": "string",
  "reading": "integer",
  "date": "string",
  "meter_digits": "integer",
  "meter_serial_number": "string"
}

meterpoint.reading.gap.filled-v1

Event Properties

NameType
requiredmeter_point_identifierstring
requiredstart_atstring
requiredend_atstring
device_idstring
register_idstring
directionstring
supply_typestring
meter_reading_typestring
extrasobject
store_full_seriesboolean

Metadata

Event TypePayload Version
meterpoint.reading.gap.filledv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmeter_point_identifierstring
requiredstart_atstring
requiredend_atstring
device_idstring
register_idstring
directionstring
supply_typestring
meter_reading_typestring
extrasobject
store_full_seriesboolean

Metadata

Event TypePayload Version
meterpoint.reading.gap.filling.failedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmeter_point_identifierstring
requiredstart_atstring
requiredend_atstring
device_idstring
register_idstring
directionstring
supply_typestring
meter_reading_typestring
extrasobject
store_full_seriesboolean

Metadata

Event TypePayload Version
meterpoint.reading.gap.foundv1

JSON Payload Representation

{
  "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.manual_import_requested-v1

Event Properties

NameType
requiredmarket_typestring
requiredreading_typestring
requiredinterval_startstring
requiredinterval_endstring
requiredvaluestring
requiredunitsstring
requireddirectionstring
requiredmarket_supply_point_idstring
device_idstring
register_idstring
qualitystring
requiredsourcestring
marketstring

Metadata

Event TypePayload Version
meterpoint.reading.manual_import_requestedv1

JSON Payload Representation

{
  "market_type": "string",
  "reading_type": "string",
  "interval_start": "string",
  "interval_end": "string",
  "value": "string",
  "units": "string",
  "direction": "string",
  "market_supply_point_id": "string",
  "device_id": "string",
  "register_id": "string",
  "quality": "string",
  "source": "string",
  "market": "string"
}

meterpoint.reading.missing.filled-v1

Event Properties

NameType
requiredmeter_point_identifierstring
requiredstart_atstring
requiredend_atstring
device_idstring
register_idstring
directionstring
supply_typestring
meter_reading_typestring
extrasobject
store_full_seriesboolean

Metadata

Event TypePayload Version
meterpoint.reading.missing.filledv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmeter_point_identifierstring
requiredstart_atstring
requiredend_atstring
device_idstring
register_idstring
directionstring
supply_typestring
meter_reading_typestring
extrasobject
store_full_seriesboolean

Metadata

Event TypePayload Version
meterpoint.reading.missing.filling.failedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredmeter_point_identifierstring
requiredstart_atstring
requiredend_atstring
device_idstring
register_idstring
directionstring
supply_typestring
meter_reading_typestring
extrasobject
store_full_seriesboolean

Metadata

Event TypePayload Version
meterpoint.reading.missing.foundv1

JSON Payload Representation

{
  "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.agent_does_not_match_appointed_agent-v1

Event Properties

NameType
requiredidstring
requiredrequest_idstring
requiredstatusstring
requiredagentstring
requiredkraken_work_categorystring
requiredexternal_job_typestring
requiredappointed_agentstring

Metadata

Event TypePayload Version
on_site_jobs.appointment.agent_does_not_match_appointed_agentv1

JSON Payload Representation

{
  "id": "string",
  "request_id": "string",
  "status": "string",
  "agent": "string",
  "kraken_work_category": "string",
  "external_job_type": "string",
  "appointed_agent": "string"
}

on_site_jobs.appointment.booked-v1

Event Properties

NameType
requiredidstring
requiredrequest_idstring
requiredstatusstring
requiredagentstring
requiredkraken_work_categorystring
requiredexternal_job_typestring
requiredprevious_statusstring

Metadata

Event TypePayload Version
on_site_jobs.appointment.bookedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredidstring
requiredrequest_idstring
requiredstatusstring
requiredagentstring
requiredkraken_work_categorystring
requiredexternal_job_typestring
requiredprevious_statusstring

Metadata

Event TypePayload Version
on_site_jobs.appointment.cancelledv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredidstring
requiredrequest_idstring
requiredstatusstring
requiredagentstring
requiredkraken_work_categorystring
requiredexternal_job_typestring
requiredprevious_statusstring

Metadata

Event TypePayload Version
on_site_jobs.appointment.completedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredidstring
requiredrequest_idstring
requiredstatusstring
requiredagentstring
requiredkraken_work_categorystring
requiredexternal_job_typestring
requiredaffected_job_notes_keysarray[string]

Metadata

Event TypePayload Version
on_site_jobs.appointment.job_notes_updatedv1

JSON Payload Representation

{
  "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.draft_appointment.assigned-v1

Event Properties

NameType
requiredidstring
requiredrequest_idstring
requiredagentstring
requiredkraken_work_categorystring
requiredexternal_job_typestring
requiredresponsible_user_idstring
requiredprevious_responsible_user_idstring
requiredassigned_bystring

Metadata

Event TypePayload Version
on_site_jobs.draft_appointment.assignedv1

JSON Payload Representation

{
  "id": "string",
  "request_id": "string",
  "agent": "string",
  "kraken_work_category": "string",
  "external_job_type": "string",
  "responsible_user_id": "string",
  "previous_responsible_user_id": "string",
  "assigned_by": "string"
}

on_site_jobs.draft_appointment.created-v1

Event Properties

NameType
requiredidstring
requiredrequest_idstring
requiredagentstring
requiredkraken_work_categorystring
requiredexternal_job_typestring

Metadata

Event TypePayload Version
on_site_jobs.draft_appointment.createdv1

JSON Payload Representation

{
  "id": "string",
  "request_id": "string",
  "agent": "string",
  "kraken_work_category": "string",
  "external_job_type": "string"
}

on_site_jobs.draft_appointment.escalated-v1

Event Properties

NameType
requiredidstring
requiredrequest_idstring
requiredagentstring
requiredkraken_work_categorystring
requiredexternal_job_typestring
requiredescalated_bystring

Metadata

Event TypePayload Version
on_site_jobs.draft_appointment.escalatedv1

JSON Payload Representation

{
  "id": "string",
  "request_id": "string",
  "agent": "string",
  "kraken_work_category": "string",
  "external_job_type": "string",
  "escalated_by": "string"
}

on_site_jobs.request.appointment_failed-v1

Event Properties

NameType
requiredidstring
requiredstatusstring
requiredreasonstring
requiredsub_reasonstring
requiredis_emergencyboolean
requiredagentstring
requiredprevious_statusstring

Metadata

Event TypePayload Version
on_site_jobs.request.appointment_failedv1

JSON Payload Representation

{
  "id": "string",
  "status": "string",
  "reason": "string",
  "sub_reason": "string",
  "is_emergency": "boolean",
  "agent": "string",
  "previous_status": "string"
}

on_site_jobs.request.approval_approved-v1

Event Properties

NameType
requiredidstring
requiredstatusstring
requiredreasonstring
requiredsub_reasonstring
requiredis_emergencyboolean
requiredagentstring
requiredprevious_statusstring

Metadata

Event TypePayload Version
on_site_jobs.request.approval_approvedv1

JSON Payload Representation

{
  "id": "string",
  "status": "string",
  "reason": "string",
  "sub_reason": "string",
  "is_emergency": "boolean",
  "agent": "string",
  "previous_status": "string"
}

on_site_jobs.request.approval_rejected-v1

Event Properties

NameType
requiredidstring
requiredstatusstring
requiredreasonstring
requiredsub_reasonstring
requiredis_emergencyboolean
requiredagentstring
requiredprevious_statusstring

Metadata

Event TypePayload Version
on_site_jobs.request.approval_rejectedv1

JSON Payload Representation

{
  "id": "string",
  "status": "string",
  "reason": "string",
  "sub_reason": "string",
  "is_emergency": "boolean",
  "agent": "string",
  "previous_status": "string"
}

on_site_jobs.request.completed-v1

Event Properties

NameType
requiredidstring
requiredstatusstring
requiredreasonstring
requiredsub_reasonstring
requiredis_emergencyboolean
requiredagentstring
requiredprevious_statusstring

Metadata

Event TypePayload Version
on_site_jobs.request.completedv1

JSON Payload Representation

{
  "id": "string",
  "status": "string",
  "reason": "string",
  "sub_reason": "string",
  "is_emergency": "boolean",
  "agent": "string",
  "previous_status": "string"
}

on_site_jobs.request.created-v1

Event Properties

NameType
requiredidstring
requiredstatusstring
requiredreasonstring
requiredsub_reasonstring
requiredis_emergencyboolean
requiredagentstring
requiredprevious_statusstring

Metadata

Event TypePayload Version
on_site_jobs.request.createdv1

JSON Payload Representation

{
  "id": "string",
  "status": "string",
  "reason": "string",
  "sub_reason": "string",
  "is_emergency": "boolean",
  "agent": "string",
  "previous_status": "string"
}

on_site_jobs.vendor_complaint.event_created-v1

Event Properties

NameType
requiredcomplaint_idstring
requiredevent_typestring

Metadata

Event TypePayload Version
on_site_jobs.vendor_complaint.event_createdv1

JSON Payload Representation

{
  "complaint_id": "string",
  "event_type": "string"
}

partner_access.granted-v1

Event Properties

NameType
requiredallocation_idinteger
requiredtarget_referencestring
requiredtarget_typestring
requiredrole_idinteger
requiredstart_atstring
requiredend_atstring
requiredpartner_referencestring

Metadata

Event TypePayload Version
partner_access.grantedv1

JSON Payload Representation

{
  "allocation_id": "integer",
  "target_reference": "string",
  "target_type": "string",
  "role_id": "integer",
  "start_at": "string",
  "end_at": "string",
  "partner_reference": "string"
}

partner_access.revoked-v1

Event Properties

NameType
requiredallocation_idinteger
requiredtarget_referencestring
requiredtarget_typestring
requiredrole_idinteger
requiredstart_atstring
requiredend_atstring
requiredpartner_referencestring

Metadata

Event TypePayload Version
partner_access.revokedv1

JSON Payload Representation

{
  "allocation_id": "integer",
  "target_reference": "string",
  "target_type": "string",
  "role_id": "integer",
  "start_at": "string",
  "end_at": "string",
  "partner_reference": "string"
}

partner_access.updated-v1

Event Properties

NameType
requiredallocation_idinteger
requiredtarget_referencestring
requiredtarget_typestring
requiredrole_idinteger
requiredstart_atstring
requiredend_atstring
requiredpartner_referencestring

Metadata

Event TypePayload Version
partner_access.updatedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredpartner_user_idinteger
requiredpartner_user_numberstring
requiredpartner_user_emailstring
requiredpartner_organisation_numberstring

Metadata

Event TypePayload Version
partner_user.createdv1

JSON Payload Representation

{
  "partner_user_id": "integer",
  "partner_user_number": "string",
  "partner_user_email": "string",
  "partner_organisation_number": "string"
}

partner_user.removed-v1

Event Properties

NameType
requiredpartner_user_idinteger
requiredpartner_user_numberstring
requiredpartner_user_emailstring
requiredpartner_organisation_numberstring

Metadata

Event TypePayload Version
partner_user.removedv1

JSON Payload Representation

{
  "partner_user_id": "integer",
  "partner_user_number": "string",
  "partner_user_email": "string",
  "partner_organisation_number": "string"
}

partner_user.updated-v1

Event Properties

NameType
requiredpartner_user_idinteger
requiredpartner_user_numberstring
requiredpartner_user_emailstring
requiredpartner_organisation_numberstring
requiredchangesobject

Metadata

Event TypePayload Version
partner_user.updatedv1

JSON Payload Representation

{
  "partner_user_id": "integer",
  "partner_user_number": "string",
  "partner_user_email": "string",
  "partner_organisation_number": "string",
  "changes": "object"
}

partner_user_access.granted-v1

Event Properties

NameType
requiredallocation_idinteger
requiredtarget_referencestring
requiredtarget_typestring
requiredrole_idinteger
requiredstart_atstring
requiredend_atstring
requiredpartner_user_referencestring

Metadata

Event TypePayload Version
partner_user_access.grantedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredallocation_idinteger
requiredtarget_referencestring
requiredtarget_typestring
requiredrole_idinteger
requiredstart_atstring
requiredend_atstring
requiredpartner_user_referencestring

Metadata

Event TypePayload Version
partner_user_access.revokedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredidinteger
requiredgroup_referencestring
requiredactioned_atstring

Metadata

Event TypePayload Version
payment-group.actionedv1

JSON Payload Representation

{
  "id": "integer",
  "group_reference": "string",
  "actioned_at": "string"
}

payment-group.closed-v1

Event Properties

NameType
requiredidinteger
requiredgroup_referencestring
requiredpotential_valueinteger
requiredclosed_atstring

Metadata

Event TypePayload Version
payment-group.closedv1

JSON Payload Representation

{
  "id": "integer",
  "group_reference": "string",
  "potential_value": "integer",
  "closed_at": "string"
}

payment-group.completed-v1

Event Properties

NameType
requiredidinteger
requiredgroup_referencestring
requiredpotential_valueinteger
requiredcleared_valueinteger
requiredfailed_valueinteger
requiredcompleted_atstring

Metadata

Event TypePayload Version
payment-group.completedv1

JSON Payload Representation

{
  "id": "integer",
  "group_reference": "string",
  "potential_value": "integer",
  "cleared_value": "integer",
  "failed_value": "integer",
  "completed_at": "string"
}

payment.cancelled-v1

Event Properties

NameType
requiredidinteger
requiredexternal_identifierstring
requiredamountinteger
requiredledgercashflow-_payments-Ledger
requireddescriptionstring
requiredpayment_datestring

Metadata

Event TypePayload Version
payment.cancelledv1

JSON Payload Representation

{
  "id": "integer",
  "external_identifier": "string",
  "amount": "integer",
  "ledger": {
    "account": {
      "number": "string"
    },
    "id": "string"
  },
  "description": "string",
  "payment_date": "string"
}

payment.cleared-v1

Event Properties

NameType
requiredidinteger
requiredamountinteger
requiredledgercashflow-_payments-Ledger
requiredpayment_reasonstring
requiredpayment_typestring

Metadata

Event TypePayload Version
payment.clearedv1

JSON Payload Representation

{
  "id": "integer",
  "amount": "integer",
  "ledger": {
    "account": {
      "number": "string"
    },
    "id": "string"
  },
  "payment_reason": "string",
  "payment_type": "string"
}

payment.failed-v1

Event Properties

NameType
requiredidinteger
requiredamountinteger
requiredledgercashflow-_payments-Ledger
requiredfailure_reasonstring
requireddescriptionstring
requiredpayment_datestring

Metadata

Event TypePayload Version
payment.failedv1

JSON Payload Representation

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

payment.failed_late-v1

Event Properties

NameType
requiredidinteger
requiredamountinteger
requiredledgercashflow-_payments-Ledger
requiredfailure_reasonstring
requireddescriptionstring
requiredpayment_datestring

Metadata

Event TypePayload Version
payment.failed_latev1

JSON Payload Representation

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

payment.pending-v1

Event Properties

NameType
requiredidinteger
requiredamountinteger
requiredledgercashflow-_payments-Ledger

Metadata

Event TypePayload Version
payment.pendingv1

JSON Payload Representation

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

payment.re_presented-v1

Event Properties

NameType
requiredfailed_paymentcashflow-_payments-Payment
requirednew_paymentcashflow-_payments-Payment
requiredledgercashflow-_payments-Ledger

Metadata

Event TypePayload Version
payment.re_presentedv1

JSON Payload Representation

{
  "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.requested-v1

Event Properties

NameType
requiredidinteger
requireduuidstring
requiredamountinteger
requiredledgercashflow-_payments-Ledger

Metadata

Event TypePayload Version
payment.requestedv1

JSON Payload Representation

{
  "id": "integer",
  "uuid": "string",
  "amount": "integer",
  "ledger": {
    "account": {
      "number": "string"
    },
    "id": "string"
  }
}

payment.scheduled-v1

Event Properties

NameType
requiredidinteger
requiredamountinteger
requiredledgercashflow-_payments-Ledger

Metadata

Event TypePayload Version
payment.scheduledv1

JSON Payload Representation

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

payment_obligation.overdue-v1

Event Properties

NameType
requiredaccount_numberstring
requiredsupplementary_ledger_idinteger
requiredsupplementary_ledger_numberstring
requiredamountinteger
requiredamount_outstandinginteger
requiredpayment_obligation_idinteger
requireddue_datestring

Metadata

Event TypePayload Version
payment_obligation.overduev1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredaccount_numberstring
requiredpayment_plan_idinteger
requiredold_statusstring
requirednew_statusstring

Metadata

Event TypePayload Version
payment_plan.status_changedv1

JSON Payload Representation

{
  "account_number": "string",
  "payment_plan_id": "integer",
  "old_status": "string",
  "new_status": "string"
}

payment_promise.broken-v1

Event Properties

NameType
requiredaccount_numberstring
requiredaccount_payment_idinteger

Metadata

Event TypePayload Version
payment_promise.brokenv1

JSON Payload Representation

{
  "account_number": "string",
  "account_payment_id": "integer"
}

payment_promise.completed-v1

Event Properties

NameType
requiredaccount_numberstring
requiredaccount_payment_idinteger
requiredamountinteger
requiredpromise_datestring

Metadata

Event TypePayload Version
payment_promise.completedv1

JSON Payload Representation

{
  "account_number": "string",
  "account_payment_id": "integer",
  "amount": "integer",
  "promise_date": "string"
}

payment_promise.created-v1

Event Properties

NameType
requiredaccount_numberstring
requiredaccount_payment_idinteger
requiredamountinteger
requiredpromise_datestring

Metadata

Event TypePayload Version
payment_promise.createdv1

JSON Payload Representation

{
  "account_number": "string",
  "account_payment_id": "integer",
  "amount": "integer",
  "promise_date": "string"
}

payments-repayments-Account

Event Properties

NameType
requirednumberstring

JSON Payload Representation

{
  "number": "string"
}

payments-repayments-Agent

Event Properties

NameType
requiredactor_typestring
requiredidstring

JSON Payload Representation

{
  "actor_type": "string",
  "id": "string"
}

payments-repayments-Ledger

Event Properties

NameType
idstring
requiredaccountpayments-repayments-Account

JSON Payload Representation

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

payments-repayments-Payment

Event Properties

NameType
requiredidinteger
requiredamountinteger
requiredpayment_datestring

JSON Payload Representation

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

payments.payment-preferences.manual-payments-activated-v1

Event Properties

NameType
requiredledger_numbersarray[string]
requiredfrom_datetimestring

Metadata

Event TypePayload Version
payments.payment-preferences.manual-payments-activatedv1

JSON Payload Representation

{
  "ledger_numbers": [
    "string"
  ],
  "from_datetime": "string"
}

payments.payment-preferences.preferred-method-set-for-automatic-payments-v1

Event Properties

NameType
requiredledger_numbersarray[string]
requiredfrom_datetimestring
requiredpayment_method_idstring

Metadata

Event TypePayload Version
payments.payment-preferences.preferred-method-set-for-automatic-paymentsv1

JSON Payload Representation

{
  "ledger_numbers": [
    "string"
  ],
  "from_datetime": "string",
  "payment_method_id": "string"
}

payments.payment-schedule-preference-mismatch-detected-v1

Event Properties

NameType
requiredaccount_numberstring
requiredledger_numberstring
requiredschedule_idinteger
requiredschedule_typestring
requiredpayment_preferencestring

Metadata

Event TypePayload Version
payments.payment-schedule-preference-mismatch-detectedv1

JSON Payload Representation

{
  "account_number": "string",
  "ledger_number": "string",
  "schedule_id": "integer",
  "schedule_type": "string",
  "payment_preference": "string"
}

payments.payment_adequacy.review_wont_be_applied-v1

Event Properties

NameType
requiredaccount_numberstring
requiredledger_numberstring
requiredreasonstring

Metadata

Event TypePayload Version
payments.payment_adequacy.review_wont_be_appliedv1

JSON Payload Representation

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

payments.payment_method.account_user_matching.failed-v1

Event Properties

NameType
requiredinstruction_idstring

Metadata

Event TypePayload Version
payments.payment_method.account_user_matching.failedv1

JSON Payload Representation

{
  "instruction_id": "string"
}

payments.payment_method.new-v1

Event Properties

NameType
requiredaccount_numberstring
requiredledger_identifierstring
requiredusable_fromstring
requiredpayment_instruction_idstring
requiredusable_tostring

Metadata

Event TypePayload Version
payments.payment_method.newv1

JSON Payload Representation

{
  "account_number": "string",
  "ledger_identifier": "string",
  "usable_from": "string",
  "payment_instruction_id": "string",
  "usable_to": "string"
}

payments.payment_method.removed-v1

Event Properties

NameType
requiredaccount_numberstring
requiredledger_identifierstring
requiredusable_fromstring
requiredpayment_instruction_idstring
requiredusable_tostring

Metadata

Event TypePayload Version
payments.payment_method.removedv1

JSON Payload Representation

{
  "account_number": "string",
  "ledger_identifier": "string",
  "usable_from": "string",
  "payment_instruction_id": "string",
  "usable_to": "string"
}

payments.payment_schedule.new-v1

Event Properties

NameType
requiredaccount_numberstring
requiredledger_identifierstring
requiredpayment_schedule_idstring
requiredpayment_schedule_typestring
requiredusable_fromstring
requiredusable_tostring
requiredis_variable_payment_amountboolean

Metadata

Event TypePayload Version
payments.payment_schedule.newv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredaccount_numberstring
requiredledger_identifierstring
requiredpayment_schedule_idstring
requiredpreceding_schedule_idstring
requiredpayment_frequencystring
requiredpayment_frequency_multiplierinteger
requiredvalid_fromstring
requiredis_variable_payment_amountboolean
requiredis_exempt_from_payment_adequacyboolean

Metadata

Event TypePayload Version
payments.payment_schedule.removedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredaccount_numberstring
requiredledger_identifierstring
requiredpayment_schedule_idstring
requiredchangesobject

Metadata

Event TypePayload Version
payments.payment_schedule.updatedv1

JSON Payload Representation

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

product-switch.completed-v1

Event Properties

NameType
requiredaccount_numberstring
requiredsupply_point_idinteger
requiredprevious_agreement_idinteger
requirednew_agreement_idinteger
requirednew_productmarket_supply-products-Product

Metadata

Event TypePayload Version
product-switch.completedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredproduct_switch_process_idinteger

Metadata

Event TypePayload Version
product-switch.initiatedv1

JSON Payload Representation

{
  "product_switch_process_id": "integer"
}

property.move-in.cancelled-v1

Event Properties

NameType
requiredaccountaccounts-house_move-Account
requiredproperty_idinteger

Metadata

Event TypePayload Version
property.move-in.cancelledv1

JSON Payload Representation

{
  "account": {
    "number": "string",
    "external_reference": "string"
  },
  "property_id": "integer"
}

property.move-in.date-updated-v1

Event Properties

NameType
requiredaccountaccounts-house_move-Account
requiredproperty_idinteger
requiredupdated_move_in_datestring

Metadata

Event TypePayload Version
property.move-in.date-updatedv1

JSON Payload Representation

{
  "account": {
    "number": "string",
    "external_reference": "string"
  },
  "property_id": "integer",
  "updated_move_in_date": "string"
}

property.move-in.market-supply.requested-v1

Event Properties

NameType
requiredaccountaccounts-house_move-Account
requiredproperty_idinteger
requiredsupply_point_idsarray[integer]
requiredmove_in_datestring
requiredhas_structured_billing_addressboolean

Metadata

Event TypePayload Version
property.move-in.market-supply.requestedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredaccountaccounts-house_move-Account
requiredproperty_idinteger
requiredsupply_points array[accounts-house_move-SupplyPoint]
requiredmove_in_datestring

Metadata

Event TypePayload Version
property.move-in.requestedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredaccountaccounts-house_move-Account
requiredproperty_idsarray[integer]
requiredsupply_points array[accounts-house_move-SupplyPoint]
requiredmove_in_datestring

Metadata

Event TypePayload Version
property.move-in.requestedv2

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredaccountaccounts-house_move-Account
requiredproperty_idinteger
requiredsupply_points array[accounts-house_move-SupplyPoint]
requiredcancelled_move_out_datestring

Metadata

Event TypePayload Version
property.move-out.cancelledv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredaccountaccounts-house_move-Account
requiredproperty_idinteger
requiredsupply_points array[accounts-house_move-SupplyPoint]
requiredupdated_move_out_datestring

Metadata

Event TypePayload Version
property.move-out.date-updatedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredaccountaccounts-house_move-Account
requiredproperty_idinteger
requiredsupply_points array[accounts-house_move-SupplyPoint]
requiredmove_out_datestring

Metadata

Event TypePayload Version
property.move-out.requestedv1

JSON Payload Representation

{
  "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.power-limit-updated-v1

Event Properties

NameType
requiredproperty_idinteger
requiredupdated_attributestring

Metadata

Event TypePayload Version
property.power-limit-updatedv1

JSON Payload Representation

{
  "property_id": "integer",
  "updated_attribute": "string"
}

property.retrospective-move-out.completed-v1

Event Properties

NameType
requiredaccountaccounts-house_move-Account
requiredsupply_point_idinteger
requiredmove_out_datestring

Metadata

Event TypePayload Version
property.retrospective-move-out.completedv1

JSON Payload Representation

{
  "account": {
    "number": "string",
    "external_reference": "string"
  },
  "supply_point_id": "integer",
  "move_out_date": "string"
}

property.updated-v1

Event Properties

NameType
requiredproperty_idinteger
requiredaccount_numberstring
requiredchangesobject

Metadata

Event TypePayload Version
property.updatedv1

JSON Payload Representation

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

property_metadata.created-v1

Event Properties

NameType
requiredproperty_idinteger
requiredkeystring
requiredvaluestring

Metadata

Event TypePayload Version
property_metadata.createdv1

JSON Payload Representation

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

property_metadata.removed-v1

Event Properties

NameType
requiredproperty_idinteger
requiredkeystring
requiredvaluestring

Metadata

Event TypePayload Version
property_metadata.removedv1

JSON Payload Representation

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

property_metadata.updated-v1

Event Properties

NameType
requiredproperty_idinteger
requiredchangesobject

Metadata

Event TypePayload Version
property_metadata.updatedv1

JSON Payload Representation

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

quoting.offer-accepted-v1

Event Properties

NameType
quote_configuration_numberstring
opportunity_numberstring

Metadata

Event TypePayload Version
quoting.offer-acceptedv1

JSON Payload Representation

{
  "quote_configuration_number": "string",
  "opportunity_number": "string"
}

quoting.rates-requested-v1

Event Properties

NameType
requiredquote_configurationsarray[string]

Metadata

Event TypePayload Version
quoting.rates-requestedv1

JSON Payload Representation

{
  "quote_configurations": [
    "string"
  ]
}

quoting.rates-requested-v2

Event Properties

NameType
requiredquote_configurationsarray[string]
requiredrequest_identifierstring

Metadata

Event TypePayload Version
quoting.rates-requestedv2

JSON Payload Representation

{
  "quote_configurations": [
    "string"
  ],
  "request_identifier": "string"
}

reading.accumulation.created-v1

Event Properties

NameType
requiredmarket_supply_point_idstring
requiredinterval_endstring
requireddevice_idstring
requiredregister_idstring
requiredqualitystring
requiredmarket_namestring

Metadata

Event TypePayload Version
reading.accumulation.createdv1

JSON Payload Representation

{
  "market_supply_point_id": "string",
  "interval_end": "string",
  "device_id": "string",
  "register_id": "string",
  "quality": "string",
  "market_name": "string"
}

referrals.referral-created-v1

Event Properties

NameType
requiredreferred_account_numberstring
requiredreferring_account_numberstring
requiredreferral_idinteger
requiredreferral_scheme_codestring

Metadata

Event TypePayload Version
referrals.referral-createdv1

JSON Payload Representation

{
  "referred_account_number": "string",
  "referring_account_number": "string",
  "referral_id": "integer",
  "referral_scheme_code": "string"
}

referrals.referral-paid-v1

Event Properties

NameType
requiredaccount_numberstring
requiredreferral_idinteger
requiredreferral_scheme_codestring
requiredis_referring_accountboolean

Metadata

Event TypePayload Version
referrals.referral-paidv1

JSON Payload Representation

{
  "account_number": "string",
  "referral_id": "integer",
  "referral_scheme_code": "string",
  "is_referring_account": "boolean"
}

referrals.reward-created-v1

Event Properties

NameType
requiredreferred_account_numberstring
requiredreferral_idinteger
requiredreferral_scheme_codestring

Metadata

Event TypePayload Version
referrals.reward-createdv1

JSON Payload Representation

{
  "referred_account_number": "string",
  "referral_id": "integer",
  "referral_scheme_code": "string"
}

refund.requested-v1

Event Properties

NameType
requiredidinteger
requiredamountinteger
requiredledgerpayments-repayments-Ledger
requiredreasonstring
requiredpaymentpayments-repayments-Payment
requiredrequested_bypayments-repayments-Agent

Metadata

Event TypePayload Version
refund.requestedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredreminder_idinteger
requiredaccount_numberstring
requiredreminder_typestring
requiredreminder_paramsobject

Metadata

Event TypePayload Version
reminder.cancelledv1

JSON Payload Representation

{
  "reminder_id": "integer",
  "account_number": "string",
  "reminder_type": "string",
  "reminder_params": "object"
}

reminder.cancelled-v2

Event Properties

NameType
requiredreminder_idinteger
requiredaccount_numberstring
requiredreminder_typestring
requiredreminder_paramsobject

Metadata

Event TypePayload Version
reminder.cancelledv2

JSON Payload Representation

{
  "reminder_id": "integer",
  "account_number": "string",
  "reminder_type": "string",
  "reminder_params": "object"
}

reminder.completed-v1

Event Properties

NameType
requiredreminder_idinteger
requiredaccount_numberstring
requiredreminder_typestring
requiredreminder_paramsobject

Metadata

Event TypePayload Version
reminder.completedv1

JSON Payload Representation

{
  "reminder_id": "integer",
  "account_number": "string",
  "reminder_type": "string",
  "reminder_params": "object"
}

reminder.completed-v2

Event Properties

NameType
requiredreminder_idinteger
requiredaccount_numberstring
requiredreminder_typestring
requiredreminder_paramsobject

Metadata

Event TypePayload Version
reminder.completedv2

JSON Payload Representation

{
  "reminder_id": "integer",
  "account_number": "string",
  "reminder_type": "string",
  "reminder_params": "object"
}

repayment-group.actioned-v1

Event Properties

NameType
requiredidinteger
requiredgroup_referencestring
requiredactioned_atstring

Metadata

Event TypePayload Version
repayment-group.actionedv1

JSON Payload Representation

{
  "id": "integer",
  "group_reference": "string",
  "actioned_at": "string"
}

repayment-group.closed-v1

Event Properties

NameType
requiredidinteger
requiredgroup_referencestring
requiredclosed_atstring

Metadata

Event TypePayload Version
repayment-group.closedv1

JSON Payload Representation

{
  "id": "integer",
  "group_reference": "string",
  "closed_at": "string"
}

repayment-group.completed-v1

Event Properties

NameType
requiredidinteger
requiredgroup_referencestring
requiredcompleted_atstring

Metadata

Event TypePayload Version
repayment-group.completedv1

JSON Payload Representation

{
  "id": "integer",
  "group_reference": "string",
  "completed_at": "string"
}

repayment.approved-v1

Event Properties

NameType
requiredidinteger
requiredamountinteger
requiredledgerpayments-repayments-Ledger
requiredapproved_bypayments-repayments-Agent
requirednotestring

Metadata

Event TypePayload Version
repayment.approvedv1

JSON Payload Representation

{
  "id": "integer",
  "amount": "integer",
  "ledger": {
    "id": "string",
    "account": {
      "number": "string"
    }
  },
  "approved_by": {
    "actor_type": "string",
    "id": "string"
  },
  "note": "string"
}

repayment.audited-v1

Event Properties

NameType
requiredidinteger
requiredamountinteger
requiredledgerpayments-repayments-Ledger
requiredaudited_bypayments-repayments-Agent

Metadata

Event TypePayload Version
repayment.auditedv1

JSON Payload Representation

{
  "id": "integer",
  "amount": "integer",
  "ledger": {
    "id": "string",
    "account": {
      "number": "string"
    }
  },
  "audited_by": {
    "actor_type": "string",
    "id": "string"
  }
}

repayment.created-v1

Event Properties

NameType
requiredidinteger
requiredamountinteger
requiredledgerpayments-repayments-Ledger
requiredreasonstring
requiredrequested_bypayments-repayments-Agent

Metadata

Event TypePayload Version
repayment.createdv1

JSON Payload Representation

{
  "id": "integer",
  "amount": "integer",
  "ledger": {
    "id": "string",
    "account": {
      "number": "string"
    }
  },
  "reason": "string",
  "requested_by": {
    "actor_type": "string",
    "id": "string"
  }
}

repayment.deleted-v1

Event Properties

NameType
requiredidinteger
requiredamountinteger
requiredledgerpayments-repayments-Ledger
requireddeletion_reasonstring
requireddeleted_bypayments-repayments-Agent

Metadata

Event TypePayload Version
repayment.deletedv1

JSON Payload Representation

{
  "id": "integer",
  "amount": "integer",
  "ledger": {
    "id": "string",
    "account": {
      "number": "string"
    }
  },
  "deletion_reason": "string",
  "deleted_by": {
    "actor_type": "string",
    "id": "string"
  }
}

repayment.edited-v1

Event Properties

NameType
requiredidinteger
requiredamountinteger
requiredpayment_datestring
requiredledgerpayments-repayments-Ledger
requiredreasonstring
requirededited_bypayments-repayments-Agent

Metadata

Event TypePayload Version
repayment.editedv1

JSON Payload Representation

{
  "id": "integer",
  "amount": "integer",
  "payment_date": "string",
  "ledger": {
    "id": "string",
    "account": {
      "number": "string"
    }
  },
  "reason": "string",
  "edited_by": {
    "actor_type": "string",
    "id": "string"
  }
}

repayment.failed-v1

Event Properties

NameType
requiredidinteger
requiredamountinteger
requiredledgerpayments-repayments-Ledger
requiredfailure_reasonstring

Metadata

Event TypePayload Version
repayment.failedv1

JSON Payload Representation

{
  "id": "integer",
  "amount": "integer",
  "ledger": {
    "id": "string",
    "account": {
      "number": "string"
    }
  },
  "failure_reason": "string"
}

repayment.failed-v2

Event Properties

NameType
requiredidinteger
requiredamountinteger
requiredledgerpayments-repayments-Ledger
requiredfailure_reasonstring
requirednotestring

Metadata

Event TypePayload Version
repayment.failedv2

JSON Payload Representation

{
  "id": "integer",
  "amount": "integer",
  "ledger": {
    "id": "string",
    "account": {
      "number": "string"
    }
  },
  "failure_reason": "string",
  "note": "string"
}

repayment.failed_late-v1

Event Properties

NameType
requiredidinteger
requiredamountinteger
requiredledgerpayments-repayments-Ledger
requirednotestring
requiredfailure_reasonstring

Metadata

Event TypePayload Version
repayment.failed_latev1

JSON Payload Representation

{
  "id": "integer",
  "amount": "integer",
  "ledger": {
    "id": "string",
    "account": {
      "number": "string"
    }
  },
  "note": "string",
  "failure_reason": "string"
}

repayment.paid-v1

Event Properties

NameType
requiredidinteger
requiredamountinteger
requiredledgerpayments-repayments-Ledger
requiredmarked_bypayments-repayments-Agent
requirednotestring

Metadata

Event TypePayload Version
repayment.paidv1

JSON Payload Representation

{
  "id": "integer",
  "amount": "integer",
  "ledger": {
    "id": "string",
    "account": {
      "number": "string"
    }
  },
  "marked_by": {
    "actor_type": "string",
    "id": "string"
  },
  "note": "string"
}

repayment.requested-v1

Event Properties

NameType
requiredidinteger
requiredamountinteger
requiredledgerpayments-repayments-Ledger
requiredreasonstring
requiredrequested_bypayments-repayments-Agent

Metadata

Event TypePayload Version
repayment.requestedv1

JSON Payload Representation

{
  "id": "integer",
  "amount": "integer",
  "ledger": {
    "id": "string",
    "account": {
      "number": "string"
    }
  },
  "reason": "string",
  "requested_by": {
    "actor_type": "string",
    "id": "string"
  }
}

repayment.submittable-v1

Event Properties

NameType
requiredidinteger
requiredamountinteger
requiredledgerpayments-repayments-Ledger
requiredmarked_bypayments-repayments-Agent

Metadata

Event TypePayload Version
repayment.submittablev1

JSON Payload Representation

{
  "id": "integer",
  "amount": "integer",
  "ledger": {
    "id": "string",
    "account": {
      "number": "string"
    }
  },
  "marked_by": {
    "actor_type": "string",
    "id": "string"
  }
}

repayment.submitted-v1

Event Properties

NameType
requiredidinteger
requiredamountinteger
requiredledgerpayments-repayments-Ledger
requiredsubmitted_bypayments-repayments-Agent
requirednotestring

Metadata

Event TypePayload Version
repayment.submittedv1

JSON Payload Representation

{
  "id": "integer",
  "amount": "integer",
  "ledger": {
    "id": "string",
    "account": {
      "number": "string"
    }
  },
  "submitted_by": {
    "actor_type": "string",
    "id": "string"
  },
  "note": "string"
}

risk_assessment_completed-v1

Event Properties

NameType
account_numberstring
requiredrisk_assessment_idstring
requiredassessment_riskstring
run_eventstring
requiredrisk_identified_assessorsarray[string]
requiredrisk_absent_assessorsarray[string]
requiredrisk_indeterminate_assessorsarray[string]
requiredrisk_non_applicable_assessorsarray[string]

Metadata

Event TypePayload Version
risk_assessment_completedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
account_numberstring
requiredrisk_assessment_idstring
run_eventstring

Metadata

Event TypePayload Version
risk_assessment_startedv1

JSON Payload Representation

{
  "account_number": "string",
  "risk_assessment_id": "string",
  "run_event": "string"
}

security.account_user.denied_access-v1

Event Properties

NameType
requiredaccount_user_idinteger
requiredaccount_user_numberstring
requireddelegates_logged_outboolean

Metadata

Event TypePayload Version
security.account_user.denied_accessv1

JSON Payload Representation

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

security.account_user.forcibly_logged_out-v1

Event Properties

NameType
requiredaccount_user_idinteger
requiredaccount_user_numberstring
requireddelegates_logged_outboolean

Metadata

Event TypePayload Version
security.account_user.forcibly_logged_outv1

JSON Payload Representation

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

supply-point.gain.completed-v1

Event Properties

NameType
requiredmarketstring
requiredmarket_identifierstring
requiredmarket_identifier_namestring
requiredaccount_numberstring
requiredsupply_start_atstring

Metadata

Event TypePayload Version
supply-point.gain.completedv1

JSON Payload Representation

{
  "market": "string",
  "market_identifier": "string",
  "market_identifier_name": "string",
  "account_number": "string",
  "supply_start_at": "string"
}

supply-point.termination.completed-v1

Event Properties

NameType
requiredmarketstring
requiredmarket_identifierstring
requiredmarket_identifier_namestring
requiredaccount_numberstring
requiredsupply_end_atstring

Metadata

Event TypePayload Version
supply-point.termination.completedv1

JSON Payload Representation

{
  "market": "string",
  "market_identifier": "string",
  "market_identifier_name": "string",
  "account_number": "string",
  "supply_end_at": "string"
}

supplypoint.gbr_electricity.gain.meter-details-received-v1

Event Properties

NameType
requiredmpanstring
requiredmtd_effective_fromstring
requiredmeasurement_classstring
requiredis_energisedboolean
requiredstandard_settlement_configurationstring
requiredssc_effective_fromstring
requirednon_settlement_function_codestring
requirednsfc_effective_fromstring
requiredmeters array[meter_points-meter_details-Meter]
requiredremoved_meters array[meter_points-meter_details-RemovedMeter]

Metadata

Event TypePayload Version
supplypoint.gbr_electricity.gain.meter-details-receivedv1

JSON Payload Representation

{
  "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.workflow.cancelled.v1-v1

Event Properties

NameType
requiredworkflow_idinteger
requiredworkflow_namestring
requiredprevious_statusstring
requiredreasonstring
requireddirectionstring

Metadata

Event TypePayload Version
tech.kraken.workflow.cancelled.v1v1

JSON Payload Representation

{
  "workflow_id": "integer",
  "workflow_name": "string",
  "previous_status": "string",
  "reason": "string",
  "direction": "string"
}

tech.kraken.workflow.completed.v1-v1

Event Properties

NameType
requiredworkflow_idinteger
requiredworkflow_namestring
requiredprevious_statusstring
requiredreasonstring
requireddirectionstring

Metadata

Event TypePayload Version
tech.kraken.workflow.completed.v1v1

JSON Payload Representation

{
  "workflow_id": "integer",
  "workflow_name": "string",
  "previous_status": "string",
  "reason": "string",
  "direction": "string"
}

tech.kraken.workflow.created.v1-v1

Event Properties

NameType
requiredworkflow_idinteger
requiredworkflow_namestring
requiredprevious_statusstring
requiredreasonstring
requireddirectionstring

Metadata

Event TypePayload Version
tech.kraken.workflow.created.v1v1

JSON Payload Representation

{
  "workflow_id": "integer",
  "workflow_name": "string",
  "previous_status": "string",
  "reason": "string",
  "direction": "string"
}

tech.kraken.workflow.errored.v1-v1

Event Properties

NameType
requiredworkflow_idinteger
requiredworkflow_namestring
requiredprevious_statusstring
requiredreasonstring
requireddirectionstring

Metadata

Event TypePayload Version
tech.kraken.workflow.errored.v1v1

JSON Payload Representation

{
  "workflow_id": "integer",
  "workflow_name": "string",
  "previous_status": "string",
  "reason": "string",
  "direction": "string"
}

tech.kraken.workflow.failed.v1-v1

Event Properties

NameType
requiredworkflow_idinteger
requiredworkflow_namestring
requiredprevious_statusstring
requiredreasonstring
requireddirectionstring

Metadata

Event TypePayload Version
tech.kraken.workflow.failed.v1v1

JSON Payload Representation

{
  "workflow_id": "integer",
  "workflow_name": "string",
  "previous_status": "string",
  "reason": "string",
  "direction": "string"
}

tech.kraken.workflow.skipped.v1-v1

Event Properties

NameType
requiredworkflow_idinteger
requiredworkflow_namestring
requiredprevious_statusstring
requiredreasonstring
requireddirectionstring

Metadata

Event TypePayload Version
tech.kraken.workflow.skipped.v1v1

JSON Payload Representation

{
  "workflow_id": "integer",
  "workflow_name": "string",
  "previous_status": "string",
  "reason": "string",
  "direction": "string"
}

tech.kraken.workflow.stalled.v1-v1

Event Properties

NameType
requiredworkflow_idinteger
requiredworkflow_namestring
requiredprevious_statusstring
requiredreasonstring
requireddirectionstring

Metadata

Event TypePayload Version
tech.kraken.workflow.stalled.v1v1

JSON Payload Representation

{
  "workflow_id": "integer",
  "workflow_name": "string",
  "previous_status": "string",
  "reason": "string",
  "direction": "string"
}

tech.kraken.workflow.started.v1-v1

Event Properties

NameType
requiredworkflow_idinteger
requiredworkflow_namestring
requiredprevious_statusstring
requiredreasonstring
requireddirectionstring

Metadata

Event TypePayload Version
tech.kraken.workflow.started.v1v1

JSON Payload Representation

{
  "workflow_id": "integer",
  "workflow_name": "string",
  "previous_status": "string",
  "reason": "string",
  "direction": "string"
}

tech.kraken.workflow.step.cancelled.v1-v1

Event Properties

NameType
requiredworkflow_idinteger
requiredworkflow_namestring
requiredstep_idinteger
requiredstep_namestring
requiredstep_slugstring
requiredprevious_statusstring
requiredreasonstring
requireddirectionstring

Metadata

Event TypePayload Version
tech.kraken.workflow.step.cancelled.v1v1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredworkflow_idinteger
requiredworkflow_namestring
requiredstep_idinteger
requiredstep_namestring
requiredstep_slugstring
requiredprevious_statusstring
requiredreasonstring
requireddirectionstring

Metadata

Event TypePayload Version
tech.kraken.workflow.step.completed.v1v1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredworkflow_idinteger
requiredworkflow_namestring
requiredstep_idinteger
requiredstep_namestring
requiredstep_slugstring
requiredprevious_statusstring
requiredreasonstring
requireddirectionstring

Metadata

Event TypePayload Version
tech.kraken.workflow.step.created.v1v1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredworkflow_idinteger
requiredworkflow_namestring
requiredstep_idinteger
requiredstep_namestring
requiredstep_slugstring
requiredprevious_statusstring
requiredreasonstring
requireddirectionstring

Metadata

Event TypePayload Version
tech.kraken.workflow.step.errored.v1v1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredworkflow_idinteger
requiredworkflow_namestring
requiredstep_idinteger
requiredstep_namestring
requiredstep_slugstring
requiredprevious_statusstring
requiredreasonstring
requireddirectionstring

Metadata

Event TypePayload Version
tech.kraken.workflow.step.failed.v1v1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredworkflow_idinteger
requiredworkflow_namestring
requiredstep_idinteger
requiredstep_namestring
requiredstep_slugstring
requiredprevious_statusstring
requiredreasonstring
requireddirectionstring

Metadata

Event TypePayload Version
tech.kraken.workflow.step.skipped.v1v1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredworkflow_idinteger
requiredworkflow_namestring
requiredstep_idinteger
requiredstep_namestring
requiredstep_slugstring
requiredprevious_statusstring
requiredreasonstring
requireddirectionstring

Metadata

Event TypePayload Version
tech.kraken.workflow.step.stalled.v1v1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredworkflow_idinteger
requiredworkflow_namestring
requiredstep_idinteger
requiredstep_namestring
requiredstep_slugstring
requiredprevious_statusstring
requiredreasonstring
requireddirectionstring

Metadata

Event TypePayload Version
tech.kraken.workflow.step.started.v1v1

JSON Payload Representation

{
  "workflow_id": "integer",
  "workflow_name": "string",
  "step_id": "integer",
  "step_name": "string",
  "step_slug": "string",
  "previous_status": "string",
  "reason": "string",
  "direction": "string"
}

tranches.request.submitted-v1

Event Properties

NameType
requiredidentifierstring
requiredversioninteger
requiredamountstring
requiredunitstring
requiredtrade_datestring
requiredperiod_startstring
requiredperiod_endstring
requiredtarget_market_namestring
requiredtarget_external_identifierstring
requiredtarget_typestring
requiredprice_in_minor_unitsstring
requiredfee_in_minor_unitsstring
requiredprice_unitstring
requireddirectionstring

Metadata

Event TypePayload Version
tranches.request.submittedv1

JSON Payload Representation

{
  "identifier": "string",
  "version": "integer",
  "amount": "string",
  "unit": "string",
  "trade_date": "string",
  "period_start": "string",
  "period_end": "string",
  "target_market_name": "string",
  "target_external_identifier": "string",
  "target_type": "string",
  "price_in_minor_units": "string",
  "fee_in_minor_units": "string",
  "price_unit": "string",
  "direction": "string"
}

transactional-messaging.message.dispatched-v1

Event Properties

NameType
requiredtrigger_type_codestring
requiredtrigger_idstring

Metadata

Event TypePayload Version
transactional-messaging.message.dispatchedv1

JSON Payload Representation

{
  "trigger_type_code": "string",
  "trigger_id": "string"
}

transactional-messaging.trigger.failed-message-processed-v1

Event Properties

Metadata

Event TypePayload Version
transactional-messaging.trigger.failed-message-processedv1

JSON Payload Representation

{
  "trigger_type_code": "string",
  "trigger_id": "string",
  "message": {
    "id": "string",
    "channel": "string"
  },
  "event": {
    "event_type": "string"
  }
}

transactional-messaging.trigger.failed-message-processing-failed-v1

Event Properties

Metadata

Event TypePayload Version
transactional-messaging.trigger.failed-message-processing-failedv1

JSON Payload Representation

{
  "trigger_type_code": "string",
  "trigger_id": "string",
  "message": {
    "id": "string",
    "channel": "string"
  },
  "event": {
    "event_type": "string"
  }
}

transactional-messaging.trigger.processed-v2

Event Properties

NameType
requiredtrigger_type_codestring
requiredtrigger_idstring
requiredtransactional_message_idsarray[string]

Metadata

Event TypePayload Version
transactional-messaging.trigger.processedv2

JSON Payload Representation

{
  "trigger_type_code": "string",
  "trigger_id": "string",
  "transactional_message_ids": [
    "string"
  ]
}

transactional-messaging.trigger.processing-failed-v1

Event Properties

NameType
requiredtrigger_type_codestring
requiredtrigger_idstring

Metadata

Event TypePayload Version
transactional-messaging.trigger.processing-failedv1

JSON Payload Representation

{
  "trigger_type_code": "string",
  "trigger_id": "string"
}

transactional_messaging-process_trigger-_MessageEvent

Event Properties

NameType
requiredevent_typestring

JSON Payload Representation

{
  "event_type": "string"
}

transactional_messaging-process_trigger-_TransactionalMessage

Event Properties

NameType
requiredidstring
requiredchannelstring

JSON Payload Representation

{
  "id": "string",
  "channel": "string"
}

translation_management.CLIENT_MANAGED_TRANSLATION_SOURCE_DELETED-v1

Event Properties

NameType
requiredtranslation_keystring
requiredinternal_lang_codesarray[string]

Metadata

Event TypePayload Version
translation_management.CLIENT_MANAGED_TRANSLATION_SOURCE_DELETEDv1

JSON Payload Representation

{
  "translation_key": "string",
  "internal_lang_codes": [
    "string"
  ]
}

translation_management.CLIENT_MANAGED_TRANSLATION_SOURCE_EDITED-v1

Event Properties

NameType
requiredtranslation_keystring
requiredinternal_lang_codesarray[string]

Metadata

Event TypePayload Version
translation_management.CLIENT_MANAGED_TRANSLATION_SOURCE_EDITEDv1

JSON Payload Representation

{
  "translation_key": "string",
  "internal_lang_codes": [
    "string"
  ]
}

user_access.granted-v1

Event Properties

NameType
requiredallocation_idinteger
requireduser_idinteger
requiredtarget_idinteger
requiredtarget_typestring
requiredrole_idinteger
requiredstart_atstring
requiredend_atstring

Metadata

Event TypePayload Version
user_access.grantedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredallocation_idinteger
requireduser_idinteger
requiredtarget_idinteger
requiredtarget_typestring
requiredrole_idinteger
requiredstart_atstring
requiredend_atstring

Metadata

Event TypePayload Version
user_access.revokedv1

JSON Payload Representation

{
  "allocation_id": "integer",
  "user_id": "integer",
  "target_id": "integer",
  "target_type": "string",
  "role_id": "integer",
  "start_at": "string",
  "end_at": "string"
}

voice-call_completed-_CallParticipant

Event Properties

NameType
requiredcall_participant_idinteger
call_participant_typestring
requiredsupport_user_idinteger
durationinteger

JSON Payload Representation

{
  "call_participant_id": "integer",
  "call_participant_type": "string",
  "support_user_id": "integer",
  "duration": "integer"
}

voice-call_participants-_CallParticipantIdentity

Event Properties

NameType
requiredentity_idinteger
requiredtypestring

JSON Payload Representation

{
  "entity_id": "integer",
  "type": "string"
}

voice-transcriptions-_Call

Event Properties

NameType
requiredidinteger
requiredcreated_atstring
requireddirectionstring
requiredparticipant_workers array[voice-transcriptions-_CallParticipantWorker]
requiredtags array[voice-transcriptions-_CallTag]

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredsupport_user_idinteger
requiredjoined_atstring
requiredleft_atstring

JSON Payload Representation

{
  "support_user_id": "integer",
  "joined_at": "string",
  "left_at": "string"
}

voice-transcriptions-_CallRecordingV1

Event Properties

NameType
requiredidinteger
requireds3_bucketstring
requireds3_keystring

JSON Payload Representation

{
  "id": "integer",
  "s3_bucket": "string",
  "s3_key": "string"
}

voice-transcriptions-_CallRecordingV2

Event Properties

NameType
requiredidinteger
requireds3_bucketstring
requireds3_keystring
requiredduration_secondsinteger

JSON Payload Representation

{
  "id": "integer",
  "s3_bucket": "string",
  "s3_key": "string",
  "duration_seconds": "integer"
}

voice-transcriptions-_CallTag

Event Properties

NameType
requiredidinteger

JSON Payload Representation

{
  "id": "integer"
}

voice-transcriptions-_TranscriptionFile

Event Properties

NameType
requireds3_bucketstring
requireds3_keystring
requiredtypestring

JSON Payload Representation

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

voice-wrap_up_call-_CallParticipants

Event Properties

NameType
requiredidinteger
requiredaccount_idinteger
requiredaccount_numberstring
requiredaccount_user_idinteger
requiredaccount_user_numberstring
requiredinferred_account_user_numberstring
requiredsupport_user_idinteger
requiredjoined_atstring
requiredleft_atstring

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredidinteger

JSON Payload Representation

{
  "id": "integer"
}

voice-wrap_up_call-_Note

Event Properties

NameType
requiredidinteger

JSON Payload Representation

{
  "id": "integer"
}

voice.call-participant.identity-updated-v1

Event Properties

NameType
requiredcall_idinteger
requiredcall_participant_idinteger
requiredupdated_identities array[voice-call_participants-_CallParticipantIdentity]
requirednew_account_numberstring

Metadata

Event TypePayload Version
voice.call-participant.identity-updatedv1

JSON Payload Representation

{
  "call_id": "integer",
  "call_participant_id": "integer",
  "updated_identities": [
    {
      "entity_id": "integer",
      "type": "string"
    }
  ],
  "new_account_number": "string"
}

voice.call.completed-v1

Event Properties

NameType
requiredcall_idinteger
requiredcontained_by_ai_agentboolean
requiredcall_participants array[voice-call_completed-_CallParticipant]

Metadata

Event TypePayload Version
voice.call.completedv1

JSON Payload Representation

{
  "call_id": "integer",
  "contained_by_ai_agent": "boolean",
  "call_participants": [
    {
      "call_participant_id": "integer",
      "call_participant_type": "string",
      "support_user_id": "integer",
      "duration": "integer"
    }
  ]
}

voice.call.wrapped-v1

Event Properties

NameType
requiredidinteger
requiredcreated_atstring
requireddirectionstring
requiredtags array[voice-wrap_up_call-_CallTag]
requirednotes array[voice-wrap_up_call-_Note]
requiredparticipants array[voice-wrap_up_call-_CallParticipants]

Metadata

Event TypePayload Version
voice.call.wrappedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredcampaign_item_idinteger
requiredcampaign_idinteger
requiredstatusstring
requiredaccount_idinteger
requiredphone_numberstring

Metadata

Event TypePayload Version
voice.campaign.update-itemv1

JSON Payload Representation

{
  "campaign_item_id": "integer",
  "campaign_id": "integer",
  "status": "string",
  "account_id": "integer",
  "phone_number": "string"
}

voice.emergency_call.placed-v1

Event Properties

NameType
requiredsupport_user_idinteger
requiredemergency_session_idinteger
requiredcall_idinteger
requiredaddressstring
requiredcountrystring
requiredlatitudestring
requiredlongitudestring
requiredlocation_detailsstring
requireddialled_phone_numberstring
requiredpool_phone_numberstring
requiredoccurred_atstring
requiredis_outside_configured_territoryboolean

Metadata

Event TypePayload Version
voice.emergency_call.placedv1

JSON Payload Representation

{
  "support_user_id": "integer",
  "emergency_session_id": "integer",
  "call_id": "integer",
  "address": "string",
  "country": "string",
  "latitude": "string",
  "longitude": "string",
  "location_details": "string",
  "dialled_phone_number": "string",
  "pool_phone_number": "string",
  "occurred_at": "string",
  "is_outside_configured_territory": "boolean"
}

voice.transcription.failed-v1

Event Properties

NameType
requiredaccount_numberstring
requiredcallvoice-transcriptions-_Call
requiredcall_recordingvoice-transcriptions-_CallRecordingV2
requirederrorstring

Metadata

Event TypePayload Version
voice.transcription.failedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredcall_idinteger
requiredaccount_numberstring
requiredtranscription_files array[voice-transcriptions-_TranscriptionFile]
requiredcall_recordingvoice-transcriptions-_CallRecordingV1

Metadata

Event TypePayload Version
voice.transcription.processedv1

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredaccount_numberstring
requiredcallvoice-transcriptions-_Call
requiredcall_recordingvoice-transcriptions-_CallRecordingV2
requiredtranscription_files array[voice-transcriptions-_TranscriptionFile]

Metadata

Event TypePayload Version
voice.transcription.processedv2

JSON Payload Representation

{
  "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

Event Properties

NameType
requiredvoucher_purchase_idsarray[integer]

Metadata

Event TypePayload Version
voucher.multiple_purchasedv1

JSON Payload Representation

{
  "voucher_purchase_ids": [
    "integer"
  ]
}

voucher.multiple_refunded-v1

Event Properties

NameType
requiredvoucher_purchase_idsarray[integer]

Metadata

Event TypePayload Version
voucher.multiple_refundedv1

JSON Payload Representation

{
  "voucher_purchase_ids": [
    "integer"
  ]
}

voucher.purchased-v1

Event Properties

NameType
requiredvoucher_purchase_idinteger

Metadata

Event TypePayload Version
voucher.purchasedv1

JSON Payload Representation

{
  "voucher_purchase_id": "integer"
}

voucher.redeemed-v1

Event Properties

NameType
requiredvoucher_purchase_idinteger

Metadata

Event TypePayload Version
voucher.redeemedv1

JSON Payload Representation

{
  "voucher_purchase_id": "integer"
}

voucher.refunded-v1

Event Properties

NameType
requiredvoucher_purchase_idinteger

Metadata

Event TypePayload Version
voucher.refundedv1

JSON Payload Representation

{
  "voucher_purchase_id": "integer"
}

voucher.transferred-v1

Event Properties

NameType
requiredvoucher_purchase_idinteger
requiredfrom_account_numberstring
requiredto_account_numberstring
requiredtransferred_atstring
transfer_notestring

Metadata

Event TypePayload Version
voucher.transferredv1

JSON Payload Representation

{
  "voucher_purchase_id": "integer",
  "from_account_number": "string",
  "to_account_number": "string",
  "transferred_at": "string",
  "transfer_note": "string"
}