About Events
External Events are OpenAPI-spec payloads emitted by kraken to AWS Eventbridge.
_core-_amend_subject-AmendedSubject
Event Properties
| Name | Type | |
|---|---|---|
| required | type | string |
| required | identifier | string |
| required | effective_from | string |
| required | effective_to | string |
JSON Payload Representation
{
"type": "string",
"identifier": "string",
"effective_from": "string",
"effective_to": "string"
}_electricity-_change_of_ownership_not_udd_response-BillingAddress
Event Properties
| Name | Type | |
|---|---|---|
| required | street_type | string |
| required | street_name | string |
| required | street_number | string |
| required | postcode | string |
| required | istat_code | string |
| required | city | string |
| required | province | string |
| required | country | string |
| required | additional_info | string |
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
| Name | Type | |
|---|---|---|
| required | street_type | string |
| required | street_name | string |
| required | street_number | string |
| required | postcode | string |
| required | istat_code | string |
| required | city | string |
| required | province | string |
| required | country | string |
| required | additional_info | string |
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
| Name | Type | |
|---|---|---|
| required | reading_type | string |
| required | validation_outcome | string |
| required | notes | string |
| required | attempts | integer |
| required | collection_date | string |
| required | total_withdrawal_reading | integer |
| required | total_converter_reading | integer |
| required | effective_measurement_date | string |
| required | effective_meter_reading | integer |
| required | effective_converter_reading | integer |
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
| Name | Type | |
|---|---|---|
| required | treatment | string |
| required | meter_number | string |
| required | converter_number | string |
| required | meter_digits | integer |
| required | converter_digits | integer |
| required | correction_coefficient | number |
| required | reading_frequency | integer |
| required | meter_accessibility | integer |
| required | collection_type | string |
| required | collection_outcome | string |
| required | failed_collection_cause | integer |
| required | alternative_collection_mode | string |
| required | obstructive_cause | string |
| required | compensation_right | string |
| required | next_window_start | string |
| required | next_window_end | string |
| required | substitute_annual_volume | number |
| required | meter_group_class | string |
| required | converter_present | string |
| required | integrated_measurement_group | string |
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
| Name | Type | |
|---|---|---|
| required | number | string |
| required | type | string |
| required | requested_at | string |
JSON Payload Representation
{
"number": "string",
"type": "string",
"requested_at": "string"
}_journeys-_common-SubjectContractJourney
Event Properties
| Name | Type | |
|---|---|---|
| required | number | string |
| required | subject_number | string |
JSON Payload Representation
{
"number": "string",
"subject_number": "string"
}account.communications_preferences_updated-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | changes | accounts-accounts-AccountCommsPreferencesChanges |
Metadata
| Event Type | Payload Version | account.communications_preferences_updated | v1 |
|---|
JSON Payload Representation
{
"account_number": "string",
"changes": {
"requires_postal_comms": [
"boolean"
],
"preferred_language_for_comms": [
"string"
],
"document_accessibility": [
"string"
]
}
}account.created-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | account_user_emails | array[string] |
| is_imported | boolean |
Metadata
| Event Type | Payload Version | account.created | v1 |
|---|
JSON Payload Representation
{
"account_number": "string",
"account_user_emails": [
"string"
],
"is_imported": "boolean"
}account.occupied-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
Metadata
| Event Type | Payload Version | account.occupied | v1 |
|---|
JSON Payload Representation
{
"account_number": "string"
}account.reactivated-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | previous_status | string |
| required | reactivation_source | string |
Metadata
| Event Type | Payload Version | account.reactivated | v1 |
|---|
JSON Payload Representation
{
"account_number": "string",
"previous_status": "string",
"reactivation_source": "string"
}account.smart-meter-read-permission-changed-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | old_permission | string |
| required | new_permission | string |
| required | effective_from | string |
| required | changed_by_id | string |
| required | changed_by_type | string |
Metadata
| Event Type | Payload Version | account.smart-meter-read-permission-changed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | account_user_emails | array[string] |
| required | changes | object |
| is_override | boolean |
Metadata
| Event Type | Payload Version | account.updated | v1 |
|---|
JSON Payload Representation
{
"account_number": "string",
"account_user_emails": [
"string"
],
"changes": "object",
"is_override": "boolean"
}account_metadata.created-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | key | string |
| required | value | string |
Metadata
| Event Type | Payload Version | account_metadata.created | v1 |
|---|
JSON Payload Representation
{
"account_number": "string",
"key": "string",
"value": "string"
}account_metadata.removed-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | key | string |
| required | value | string |
Metadata
| Event Type | Payload Version | account_metadata.removed | v1 |
|---|
JSON Payload Representation
{
"account_number": "string",
"key": "string",
"value": "string"
}account_metadata.updated-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | changes | object |
Metadata
| Event Type | Payload Version | account_metadata.updated | v1 |
|---|
JSON Payload Representation
{
"account_number": "string",
"changes": "object"
}account_property_effective_period_metadata.created-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_property_effective_period_id | integer |
| required | key | string |
| required | value | string |
Metadata
| Event Type | Payload Version | account_property_effective_period_metadata.created | v1 |
|---|
JSON Payload Representation
{
"account_property_effective_period_id": "integer",
"key": "string",
"value": "string"
}account_property_effective_period_metadata.removed-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_property_effective_period_id | integer |
| required | key | string |
| required | value | string |
Metadata
| Event Type | Payload Version | account_property_effective_period_metadata.removed | v1 |
|---|
JSON Payload Representation
{
"account_property_effective_period_id": "integer",
"key": "string",
"value": "string"
}account_property_effective_period_metadata.updated-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_property_effective_period_id | integer |
| required | changes | object |
Metadata
| Event Type | Payload Version | account_property_effective_period_metadata.updated | v1 |
|---|
JSON Payload Representation
{
"account_property_effective_period_id": "integer",
"changes": "object"
}account_user.created-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | user_id | integer |
| required | user_email | string |
| required | user_number | string |
| required | linked_accounts | array |
| user_identifiers | object | |
| initiator_type | string | |
| is_customer_initiated | boolean |
Metadata
| Event Type | Payload Version | account_user.created | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | user_id | integer |
Metadata
| Event Type | Payload Version | account_user.password_changed | v1 |
|---|
JSON Payload Representation
{
"user_id": "integer"
}account_user.password_reset_requested-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_user_id | integer |
| required | account_user_number | string |
Metadata
| Event Type | Payload Version | account_user.password_reset_requested | v1 |
|---|
JSON Payload Representation
{
"account_user_id": "integer",
"account_user_number": "string"
}account_user.psr_records_updated-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | user_id | integer |
| required | created_records | array[accounts-account_user-_PsrRecord] |
| required | updated_records | array[accounts-account_user-_PsrRecord] |
| required | deleted_records | array[accounts-account_user-_PsrRecord] |
Metadata
| Event Type | Payload Version | account_user.psr_records_updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | user_id | integer |
| required | user_email | string |
| required | user_number | string |
| required | linked_accounts | array |
| user_identifiers | object | |
| initiator_type | string | |
| is_customer_initiated | boolean |
Metadata
| Event Type | Payload Version | account_user.removed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | user_id | integer |
| required | user_email | string |
| required | user_number | string |
| required | linked_accounts | array |
| user_identifiers | object | |
| initiator_type | string | |
| is_customer_initiated | boolean | |
| required | changes | object |
| is_override | boolean |
Metadata
| Event Type | Payload Version | account_user.updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | user_number | string |
| required | verification_id | integer |
| required | verification_type | string |
Metadata
| Event Type | Payload Version | account_user.verification_completed | v1 |
|---|
JSON Payload Representation
{
"user_number": "string",
"verification_id": "integer",
"verification_type": "string"
}account_user.verification_started-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | user_number | string |
| required | verification_id | integer |
| required | verification_type | string |
Metadata
| Event Type | Payload Version | account_user.verification_started | v1 |
|---|
JSON Payload Representation
{
"user_number": "string",
"verification_id": "integer",
"verification_type": "string"
}account_user_metadata.created-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | user_id | integer |
| required | key | string |
| required | value | string |
Metadata
| Event Type | Payload Version | account_user_metadata.created | v1 |
|---|
JSON Payload Representation
{
"user_id": "integer",
"key": "string",
"value": "string"
}account_user_metadata.removed-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | user_id | integer |
| required | key | string |
| required | value | string |
Metadata
| Event Type | Payload Version | account_user_metadata.removed | v1 |
|---|
JSON Payload Representation
{
"user_id": "integer",
"key": "string",
"value": "string"
}account_user_metadata.updated-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | user_id | integer |
| required | changes | object |
Metadata
| Event Type | Payload Version | account_user_metadata.updated | v1 |
|---|
JSON Payload Representation
{
"user_id": "integer",
"changes": "object"
}accounts-account_user-_PsrRecord
Event Properties
| Name | Type | |
|---|---|---|
| required | description | string |
| required | electricity_industry_code | string |
| required | gas_industry_code | string |
JSON Payload Representation
{
"description": "string",
"electricity_industry_code": "string",
"gas_industry_code": "string"
}accounts-accounts-AccountCommsPreferencesChanges
Event Properties
| Name | Type | |
|---|---|---|
| requires_postal_comms | array[boolean] | |
| preferred_language_for_comms | array[string] | |
| document_accessibility | array[string] |
JSON Payload Representation
{
"requires_postal_comms": [
"boolean"
],
"preferred_language_for_comms": [
"string"
],
"document_accessibility": [
"string"
]
}accounts-house_move-Account
Event Properties
| Name | Type | |
|---|---|---|
| required | number | string |
| required | external_reference | string |
JSON Payload Representation
{
"number": "string",
"external_reference": "string"
}accounts-house_move-SupplyPoint
Event Properties
| Name | Type | |
|---|---|---|
| required | id | string |
| industry | string | |
| tariff_code | string | |
| tariff_payment_method | string |
JSON Payload Representation
{
"id": "string",
"industry": "string",
"tariff_code": "string",
"tariff_payment_method": "string"
}affiliates.affiliate-account-contract-created-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | affiliate_account_contract_id | integer |
| required | affiliate_contract_id | integer |
| required | account_number | string |
| required | fuel | string |
Metadata
| Event Type | Payload Version | affiliates.affiliate-account-contract-created | v1 |
|---|
JSON Payload Representation
{
"affiliate_account_contract_id": "integer",
"affiliate_contract_id": "integer",
"account_number": "string",
"fuel": "string"
}agreement.created-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | agreement_id | integer |
| required | account_number | string |
| required | valid_from | string |
| required | product_code | string |
| account_contract_identifier | string | |
| business_contract_identifier | string |
Metadata
| Event Type | Payload Version | agreement.created | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | agreement_id | integer |
Metadata
| Event Type | Payload Version | agreement.revoked | v1 |
|---|
JSON Payload Representation
{
"agreement_id": "integer"
}agreement.revoked-v2
Event Properties
| Name | Type | |
|---|---|---|
| required | agreement_id | integer |
| required | account_number | string |
Metadata
| Event Type | Payload Version | agreement.revoked | v2 |
|---|
JSON Payload Representation
{
"agreement_id": "integer",
"account_number": "string"
}agreement.rollover.completed-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | supply_point_id | string |
| required | expiring_agreement_id | integer |
| required | rolled_on_to_agreement_id | integer |
| required | new_product | market_supply-products-Product |
| required | rolled_on_to_agreement_valid_from | string |
| required | rolled_on_to_agreement_valid_to | string |
Metadata
| Event Type | Payload Version | agreement.rollover.completed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | agreement_id | integer |
Metadata
| Event Type | Payload Version | agreement.terminated | v1 |
|---|
JSON Payload Representation
{
"agreement_id": "integer"
}agreement.terminated-v2
Event Properties
| Name | Type | |
|---|---|---|
| required | agreement_id | integer |
| required | account_number | string |
Metadata
| Event Type | Payload Version | agreement.terminated | v2 |
|---|
JSON Payload Representation
{
"agreement_id": "integer",
"account_number": "string"
}agreement.updated-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | agreement_id | integer |
| required | changes | object |
| is_override | boolean |
Metadata
| Event Type | Payload Version | agreement.updated | v1 |
|---|
JSON Payload Representation
{
"agreement_id": "integer",
"changes": "object",
"is_override": "boolean"
}agreement.updated-v2
Event Properties
| Name | Type | |
|---|---|---|
| required | agreement_id | integer |
| required | changes | object |
| is_override | boolean | |
| required | account_number | string |
Metadata
| Event Type | Payload Version | agreement.updated | v2 |
|---|
JSON Payload Representation
{
"agreement_id": "integer",
"changes": "object",
"is_override": "boolean",
"account_number": "string"
}approvals.approval.approved-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | approval_id | string |
| required | process_type | string |
| required | process_data | object |
| required | approved_at | string |
Metadata
| Event Type | Payload Version | approvals.approval.approved | v1 |
|---|
JSON Payload Representation
{
"approval_id": "string",
"process_type": "string",
"process_data": "object",
"approved_at": "string"
}approvals.approval.created-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | approval_id | string |
| required | process_type | string |
| required | requested_at | string |
| required | assigned_to_id | integer |
| required | requested_by_id | integer |
Metadata
| Event Type | Payload Version | approvals.approval.created | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | approval_id | string |
| required | process_type | string |
| required | process_data | object |
| required | rejected_at | string |
Metadata
| Event Type | Payload Version | approvals.approval.rejected | v1 |
|---|
JSON Payload Representation
{
"approval_id": "string",
"process_type": "string",
"process_data": "object",
"rejected_at": "string"
}approvals.approval_request.approved-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | approval_id | string |
| required | process_type | string |
| required | request_id | string |
| required | approved_by_id | integer |
| required | approved_at | string |
| required | approval_reason | string |
Metadata
| Event Type | Payload Version | approvals.approval_request.approved | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | approval_id | string |
| required | process_type | string |
| required | request_id | string |
| required | assigned_to_id | integer |
| required | assigned_at | string |
Metadata
| Event Type | Payload Version | approvals.approval_request.assigned | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | approval_id | string |
| required | process_type | string |
| required | request_id | string |
| required | rejected_by_id | integer |
| required | rejection_reason | string |
| required | rejected_at | string |
Metadata
| Event Type | Payload Version | approvals.approval_request.rejected | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | delegate | string |
| required | viewer | string |
| required | viewer_id | integer |
Metadata
| Event Type | Payload Version | auth-server.access-token.issued | v1 |
|---|
JSON Payload Representation
{
"delegate": "string",
"viewer": "string",
"viewer_id": "integer"
}auth_server.account_user.generate_mfa_challenge_error-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_user_id | integer |
| required | account_user_number | string |
| required | device | string |
Metadata
| Event Type | Payload Version | auth_server.account_user.generate_mfa_challenge_error | v1 |
|---|
JSON Payload Representation
{
"account_user_id": "integer",
"account_user_number": "string",
"device": "string"
}auth_server.account_user.logged_in-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_user_id | integer |
| required | account_user_number | string |
| required | login_method | string |
| required | mfa_device_type | string |
Metadata
| Event Type | Payload Version | auth_server.account_user.logged_in | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_user_id | integer |
| required | account_user_number | string |
| required | enforced_security_rule_ids | array[integer] |
Metadata
| Event Type | Payload Version | auth_server.account_user.login_denied | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_user_id | integer |
| required | account_user_number | string |
| required | step | string |
| required | failure_reason | string |
| required | brand | string |
| required | user_brands | array[string] |
Metadata
| Event Type | Payload Version | auth_server.account_user.login_failed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_user_id | integer |
| required | account_user_number | string |
| required | step | string |
| required | mfa_device_type | string |
Metadata
| Event Type | Payload Version | auth_server.account_user.login_step_completed | v1 |
|---|
JSON Payload Representation
{
"account_user_id": "integer",
"account_user_number": "string",
"step": "string",
"mfa_device_type": "string"
}billing-_billing-Account
Event Properties
| Name | Type | |
|---|---|---|
| required | number | string |
JSON Payload Representation
{
"number": "string"
}billing-_billing-Ledger
Event Properties
| Name | Type | |
|---|---|---|
| required | account | billing-_billing-Account |
| required | number | string |
| id | string |
JSON Payload Representation
{
"account": {
"number": "string"
},
"number": "string",
"id": "string"
}billing-_billing-LedgerEntry
Event Properties
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | is_charge | boolean |
| required | is_credit | boolean |
| required | is_payment | boolean |
| required | is_repayment | boolean |
| required | is_reversal | boolean |
| required | is_reversed | boolean |
| source_id | integer | |
| source_type | string |
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
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | amount | integer |
| required | is_charge | boolean |
| required | is_credit | boolean |
| required | is_payment | boolean |
| required | is_repayment | boolean |
| required | is_reversal | boolean |
| required | is_reversed | boolean |
| required | source_reason | string |
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
| Name | Type | |
|---|---|---|
| required | start_at | string |
| required | end_at | string |
JSON Payload Representation
{
"start_at": "string",
"end_at": "string"
}billing.billing_document.held-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | document_type | string |
| required | document_id | integer |
| required | document_identifier | string |
| required | document_uuid | string |
| required | hold_code | string |
| required | is_strict | boolean |
| required | held_at | string |
| required | held_by_id | integer |
Metadata
| Event Type | Payload Version | billing.billing_document.held | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | billing_document_id | integer |
| required | billing_document_identifier | string |
Metadata
| Event Type | Payload Version | billing.billing_document.issued | v1 |
|---|
JSON Payload Representation
{
"account_number": "string",
"billing_document_id": "integer",
"billing_document_identifier": "string"
}billing.billing_document.issued-v2
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | billing_document_id | integer |
| required | billing_document_identifier | string |
| required | billing_document_uuid | string |
Metadata
| Event Type | Payload Version | billing.billing_document.issued | v2 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | billing_document_id | integer |
| required | billing_document_identifier | string |
Metadata
| Event Type | Payload Version | billing.billing_document_representation.dispatched | v1 |
|---|
JSON Payload Representation
{
"account_number": "string",
"billing_document_id": "integer",
"billing_document_identifier": "string"
}billing.billing_document_representation.dispatched-v2
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | billing_document_id | integer |
| required | billing_document_identifier | string |
| required | billing_document_representation_dispatch_id | integer |
| required | billing_document_representations_id | array[integer] |
Metadata
| Event Type | Payload Version | billing.billing_document_representation.dispatched | v2 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | billing_document_id | integer |
| required | billing_document_identifier | string |
| required | billing_document_representation_dispatch_id | integer |
| required | billing_document_representations_id | array[integer] |
| required | support_user_id | integer |
Metadata
| Event Type | Payload Version | billing.billing_document_representation.dispatched | v3 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | previous_billing_options_id | integer |
| required | new_billing_options_id | integer |
| required | support_user_id | integer |
Metadata
| Event Type | Payload Version | billing.billing_options.updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | ledger_number | string |
| required | agreement_id | integer |
| required | assigned_at | string |
Metadata
| Event Type | Payload Version | billing.charging-ledger.assigned-to-agreement | v1 |
|---|
JSON Payload Representation
{
"ledger_number": "string",
"agreement_id": "integer",
"assigned_at": "string"
}billing.charging.supply-point.triggered-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | supply_point_id | integer |
| required | charge_period | billing-_billing-_ChargePeriod |
Metadata
| Event Type | Payload Version | billing.charging.supply-point.triggered | v1 |
|---|
JSON Payload Representation
{
"supply_point_id": "integer",
"charge_period": {
"start_at": "string",
"end_at": "string"
}
}billing.duos_invoice.cancel-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | invoice_event_id | integer |
Metadata
| Event Type | Payload Version | billing.duos_invoice.cancel | v1 |
|---|
JSON Payload Representation
{
"invoice_event_id": "integer"
}billing.duos_invoice.new-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | invoice_event_id | integer |
Metadata
| Event Type | Payload Version | billing.duos_invoice.new | v1 |
|---|
JSON Payload Representation
{
"invoice_event_id": "integer"
}billing.duos_invoice.replace-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | invoice_event_id | integer |
Metadata
| Event Type | Payload Version | billing.duos_invoice.replace | v1 |
|---|
JSON Payload Representation
{
"invoice_event_id": "integer"
}billing.final_bill-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | account_user_emails | array[string] |
| required | statement_id | integer |
Metadata
| Event Type | Payload Version | billing.final_bill | v1 |
|---|
JSON Payload Representation
{
"account_number": "string",
"account_user_emails": [
"string"
],
"statement_id": "integer"
}billing.issuance.external_status.created-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | billing_document_identifier | string |
| required | status | string |
| required | status_code | string |
| required | external_status_id | integer |
Metadata
| Event Type | Payload Version | billing.issuance.external_status.created | v1 |
|---|
JSON Payload Representation
{
"billing_document_identifier": "string",
"status": "string",
"status_code": "string",
"external_status_id": "integer"
}billing.issued_bill-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | statement_id | integer |
Metadata
| Event Type | Payload Version | billing.issued_bill | v1 |
|---|
JSON Payload Representation
{
"account_number": "string",
"statement_id": "integer"
}billing.ledger.entry_posted-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | ledger | billing-_billing-Ledger |
Metadata
| Event Type | Payload Version | billing.ledger.entry_posted | v1 |
|---|
JSON Payload Representation
{
"ledger": {
"account": {
"number": "string"
},
"number": "string",
"id": "string"
}
}billing.ledger.entry_posted-v2
Event Properties
| Name | Type | |
|---|---|---|
| required | ledger | billing-_billing-Ledger |
| required | entry | billing-_billing-LedgerEntry |
Metadata
| Event Type | Payload Version | billing.ledger.entry_posted | v2 |
|---|
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
| Name | Type | |
|---|---|---|
| required | ledger | billing-_billing-Ledger |
Metadata
| Event Type | Payload Version | billing.ledger.entry_removed | v1 |
|---|
JSON Payload Representation
{
"ledger": {
"account": {
"number": "string"
},
"number": "string",
"id": "string"
}
}billing.ledger.entry_removed-v2
Event Properties
| Name | Type | |
|---|---|---|
| required | ledger | billing-_billing-Ledger |
| required | entry | billing-_billing-LedgerEntryRemoval |
Metadata
| Event Type | Payload Version | billing.ledger.entry_removed | v2 |
|---|
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
| Name | Type | |
|---|---|---|
| required | pathway_id | string |
| required | traversal_attempt_id | integer |
| required | traversal_attempt_context | object |
| required | trigger_id | integer |
| required | failed_action_name | string |
| required | failed_action_error | string |
| required | failed_at | string |
Metadata
| Event Type | Payload Version | billing.pathway_traversal.failed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | pathway_id | string |
| required | traversal_attempt_id | integer |
| required | trigger_id | integer |
| required | succeeded_at | string |
Metadata
| Event Type | Payload Version | billing.pathway_traversal.succeeded | v1 |
|---|
JSON Payload Representation
{
"pathway_id": "string",
"traversal_attempt_id": "integer",
"trigger_id": "integer",
"succeeded_at": "string"
}billing.rebate.accepted-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | rebate_period_id | integer |
| required | rebate_type | string |
| required | effective_from | string |
| required | effective_to | string |
Metadata
| Event Type | Payload Version | billing.rebate.accepted | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | rebate_period_id | integer |
| required | rebate_type | string |
| required | effective_from | string |
| required | effective_to | string |
| required | is_application_accepted | boolean |
Metadata
| Event Type | Payload Version | billing.rebate.created | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | rebate_period_id | integer |
| required | rebate_type | string |
| required | effective_from | string |
| required | effective_to | string |
| required | decline_reason | string |
Metadata
| Event Type | Payload Version | billing.rebate.declined | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | rebate_period_id | integer |
| required | rebate_type | string |
| required | effective_from | string |
| required | effective_to | string |
| required | is_application_accepted | boolean |
Metadata
| Event Type | Payload Version | billing.rebate.updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | id | integer |
Metadata
| Event Type | Payload Version | business.created | v1 |
|---|
JSON Payload Representation
{
"id": "integer"
}business.updated-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | changes | object |
Metadata
| Event Type | Payload Version | business.updated | v1 |
|---|
JSON Payload Representation
{
"id": "integer",
"changes": "object"
}business_operations_team.updated-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | operations_team_id | integer |
Metadata
| Event Type | Payload Version | business_operations_team.updated | v1 |
|---|
JSON Payload Representation
{
"id": "integer",
"operations_team_id": "integer"
}campaign_account.added-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | campaign_name | string |
| campaign_slug | string | |
| campaign_expiry_date | string | |
| campaign_account_expiry_date | string |
Metadata
| Event Type | Payload Version | campaign_account.added | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | campaign_name | string |
| campaign_slug | string |
Metadata
| Event Type | Payload Version | campaign_account.removed | v1 |
|---|
JSON Payload Representation
{
"account_number": "string",
"campaign_name": "string",
"campaign_slug": "string"
}campaign_account.updated-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | campaign_name | string |
| campaign_slug | string | |
| required | changes | object |
Metadata
| Event Type | Payload Version | campaign_account.updated | v1 |
|---|
JSON Payload Representation
{
"account_number": "string",
"campaign_name": "string",
"campaign_slug": "string",
"changes": "object"
}cashflow-_payments-Account
Event Properties
| Name | Type | |
|---|---|---|
| required | number | string |
JSON Payload Representation
{
"number": "string"
}cashflow-_payments-Ledger
Event Properties
| Name | Type | |
|---|---|---|
| required | account | cashflow-_payments-Account |
| id | string |
JSON Payload Representation
{
"account": {
"number": "string"
},
"id": "string"
}cashflow-_payments-Payment
Event Properties
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | amount | integer |
| required | payment_date | string |
| required | description | string |
| failure_reason | string |
JSON Payload Representation
{
"id": "integer",
"amount": "integer",
"payment_date": "string",
"description": "string",
"failure_reason": "string"
}charging.priming.errored-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | errors | array[string] |
| required | supply_point_id | string |
| required | period_start | string |
| required | period_end | string |
Metadata
| Event Type | Payload Version | charging.priming.errored | v1 |
|---|
JSON Payload Representation
{
"errors": [
"string"
],
"supply_point_id": "string",
"period_start": "string",
"period_end": "string"
}collection_proceeding.created-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | account_number | string |
| amount | integer | |
| campaign | string | |
| required | is_white_label | boolean |
| required | agency_code | string |
Metadata
| Event Type | Payload Version | collection_proceeding.created | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | number | string |
| required | account_number | string |
| required | leave_supplier_process_number | string |
Metadata
| Event Type | Payload Version | collection_process.leave_supplier_instigated | v1 |
|---|
JSON Payload Representation
{
"number": "string",
"account_number": "string",
"leave_supplier_process_number": "string"
}collection_process.paused-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | number | string |
| required | account_number | string |
| required | source | string |
| required | active_pause_reasons | array[string] |
Metadata
| Event Type | Payload Version | collection_process.paused | v1 |
|---|
JSON Payload Representation
{
"number": "string",
"account_number": "string",
"source": "string",
"active_pause_reasons": [
"string"
]
}collection_process.raised-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | number | string |
| required | account_number | string |
| ledger | string | |
| billing_document | string | |
| required | config_code | string |
Metadata
| Event Type | Payload Version | collection_process.raised | v1 |
|---|
JSON Payload Representation
{
"number": "string",
"account_number": "string",
"ledger": "string",
"billing_document": "string",
"config_code": "string"
}collection_process.reactivated-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | number | string |
Metadata
| Event Type | Payload Version | collection_process.reactivated | v1 |
|---|
JSON Payload Representation
{
"number": "string"
}collection_process.run_termination_requested-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | number | string |
Metadata
| Event Type | Payload Version | collection_process.run_termination_requested | v1 |
|---|
JSON Payload Representation
{
"number": "string"
}collection_process.unpaused-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | number | string |
| required | account_number | string |
| required | source | string |
Metadata
| Event Type | Payload Version | collection_process.unpaused | v1 |
|---|
JSON Payload Representation
{
"number": "string",
"account_number": "string",
"source": "string"
}collection_process.withdrawn-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | number | string |
| required | account_number | string |
| required | external_reference | string |
Metadata
| Event Type | Payload Version | collection_process.withdrawn | v1 |
|---|
JSON Payload Representation
{
"number": "string",
"account_number": "string",
"external_reference": "string"
}collection_process.withdrawn-v2
Event Properties
| Name | Type | |
|---|---|---|
| required | number | string |
| required | account_number | string |
Metadata
| Event Type | Payload Version | collection_process.withdrawn | v2 |
|---|
JSON Payload Representation
{
"number": "string",
"account_number": "string"
}comms.account-call.updated-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | call_id | integer |
| required | call_key | string |
| required | transcript_key | string |
| required | redacted_transcript_key | string |
| required | bucket | string |
| required | changes | object |
Metadata
| Event Type | Payload Version | comms.account-call.updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | user_id | integer |
| required | message_id | integer |
| required | template_code | string |
| required | bounced_at | string |
Metadata
| Event Type | Payload Version | comms.customer_email_bounced | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | push_notification_binding_id | integer |
Metadata
| Event Type | Payload Version | comms.push-notification.received-unregistered-or-expired-token | v1 |
|---|
JSON Payload Representation
{
"push_notification_binding_id": "integer"
}comms.transcription.created-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | call_id | integer |
| required | call_key | string |
| required | transcript_key | string |
| required | redacted_transcript_key | string |
| required | bucket | string |
Metadata
| Event Type | Payload Version | comms.transcription.created | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | quote_configuration_number | string |
| required | succeeded | boolean |
| required | triggered_by_id | integer |
Metadata
| Event Type | Payload Version | complex_quoting.cost_calculation_finished | v1 |
|---|
JSON Payload Representation
{
"quote_configuration_number": "string",
"succeeded": "boolean",
"triggered_by_id": "integer"
}consents-consents-_Consent
Event Properties
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | consent_type_code | string |
| required | value | string |
| required | signed_at | string |
JSON Payload Representation
{
"id": "integer",
"consent_type_code": "string",
"value": "string",
"signed_at": "string"
}consents-consents-_SigningIdentity
Event Properties
| Name | Type | |
|---|---|---|
| required | identity_type | string |
| required | identity | string |
JSON Payload Representation
{
"identity_type": "string",
"identity": "string"
}consents.consent.created-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | signing_identity | consents-consents-_SigningIdentity |
| required | consent | consents-consents-_Consent |
Metadata
| Event Type | Payload Version | consents.consent.created | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | signing_identity | consents-consents-_SigningIdentity |
| required | consent | consents-consents-_Consent |
Metadata
| Event Type | Payload Version | consents.consent.updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | contract_group_identifier | string |
| required | group_type | string |
| required | valid_from | string |
| valid_to | string | |
| managing_party_identifier | string | |
| external_identifier | string | |
| name | string | |
| required | memberships | array[groups-_create-_Membership] |
| required | traits | array[groups-_create-_Trait] |
Metadata
| Event Type | Payload Version | contract-groups.created | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | contract_group_identifier | string |
| required | effective_at | string |
| required | memberships_started | array[groups-_memberships-_Membership] |
| required | memberships_ended | array[groups-_memberships-_Membership] |
Metadata
| Event Type | Payload Version | contract-groups.memberships-changed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | contract_group_identifier | string |
| required | effective_period | groups-_versions-_Period |
| required | superseded_versions | array[groups-_versions-_Version] |
| required | created_versions | array[groups-_versions-_Version] |
Metadata
| Event Type | Payload Version | contract-groups.version-created | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | contract_identifier | string |
| required | version_reference | integer |
| required | occurred_at | string |
| required | for_subjects | array[string] |
Metadata
| Event Type | Payload Version | contracts.actualized | v1 |
|---|
JSON Payload Representation
{
"contract_identifier": "string",
"version_reference": "integer",
"occurred_at": "string",
"for_subjects": [
"string"
]
}contracts.created-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | contract_identifier | string |
| required | occurred_at | string |
| sales_record_identifier | string |
Metadata
| Event Type | Payload Version | contracts.created | v1 |
|---|
JSON Payload Representation
{
"contract_identifier": "string",
"occurred_at": "string",
"sales_record_identifier": "string"
}contracts.expired-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | contract_identifier | string |
| required | occurred_at | string |
| required | valid_to | string |
Metadata
| Event Type | Payload Version | contracts.expired | v1 |
|---|
JSON Payload Representation
{
"contract_identifier": "string",
"occurred_at": "string",
"valid_to": "string"
}contracts.expiry-approaching-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | contract_identifier | string |
| required | occurred_at | string |
| required | days_before_expiry | integer |
Metadata
| Event Type | Payload Version | contracts.expiry-approaching | v1 |
|---|
JSON Payload Representation
{
"contract_identifier": "string",
"occurred_at": "string",
"days_before_expiry": "integer"
}contracts.journeys.creation.started-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | contract_journey | _journeys-_common-ContractJourney |
| required | contract_identifier | string |
| required | occurred_at | string |
| required | subject_contract_journeys | array[_journeys-_common-SubjectContractJourney] |
Metadata
| Event Type | Payload Version | contracts.journeys.creation.started | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | contract_journey | _journeys-_common-ContractJourney |
| required | contract_identifier | string |
| required | occurred_at | string |
| required | subject_contract_journeys | array[_journeys-_common-SubjectContractJourney] |
Metadata
| Event Type | Payload Version | contracts.journeys.termination.started | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | contract_journey | _journeys-_common-ContractJourney |
| required | contract_identifier | string |
| required | occurred_at | string |
Metadata
| Event Type | Payload Version | contracts.journeys.variation.started | v1 |
|---|
JSON Payload Representation
{
"contract_journey": {
"number": "string",
"type": "string",
"requested_at": "string"
},
"contract_identifier": "string",
"occurred_at": "string"
}contracts.rescinded-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | contract_identifier | string |
| required | occurred_at | string |
Metadata
| Event Type | Payload Version | contracts.rescinded | v1 |
|---|
JSON Payload Representation
{
"contract_identifier": "string",
"occurred_at": "string"
}contracts.revoked-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | contract_identifier | string |
| required | occurred_at | string |
Metadata
| Event Type | Payload Version | contracts.revoked | v1 |
|---|
JSON Payload Representation
{
"contract_identifier": "string",
"occurred_at": "string"
}contracts.subject-amended-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | contract_identifier | string |
| required | occurred_at | string |
| required | added | array[_core-_amend_subject-AmendedSubject] |
| required | updated | array[_core-_amend_subject-AmendedSubject] |
| required | removed | array[_core-_amend_subject-AmendedSubject] |
Metadata
| Event Type | Payload Version | contracts.subject-amended | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | contract_identifier | string |
| required | occurred_at | string |
Metadata
| Event Type | Payload Version | contracts.terminated | v1 |
|---|
JSON Payload Representation
{
"contract_identifier": "string",
"occurred_at": "string"
}contracts.terms-varied-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | contract_identifier | string |
| required | occurred_at | string |
Metadata
| Event Type | Payload Version | contracts.terms-varied | v1 |
|---|
JSON Payload Representation
{
"contract_identifier": "string",
"occurred_at": "string"
}customer_access.partner_roles.created-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | code | string |
| required | permissions | array[string] |
Metadata
| Event Type | Payload Version | customer_access.partner_roles.created | v1 |
|---|
JSON Payload Representation
{
"code": "string",
"permissions": [
"string"
]
}customer_access.partner_roles.updated-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | code | string |
| display_name | string | |
| description | string | |
| permissions | array[string] |
Metadata
| Event Type | Payload Version | customer_access.partner_roles.updated | v1 |
|---|
JSON Payload Representation
{
"code": "string",
"display_name": "string",
"description": "string",
"permissions": [
"string"
]
}customer_access.partner_user_roles.created-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | code | string |
| required | permissions | array[string] |
Metadata
| Event Type | Payload Version | customer_access.partner_user_roles.created | v1 |
|---|
JSON Payload Representation
{
"code": "string",
"permissions": [
"string"
]
}customer_access.partner_user_roles.updated-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | code | string |
| display_name | string | |
| description | string | |
| permissions | array[string] |
Metadata
| Event Type | Payload Version | customer_access.partner_user_roles.updated | v1 |
|---|
JSON Payload Representation
{
"code": "string",
"display_name": "string",
"description": "string",
"permissions": [
"string"
]
}customer_access.user_roles.created-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | code | string |
| required | permissions | array[string] |
| required | name | string |
Metadata
| Event Type | Payload Version | customer_access.user_roles.created | v1 |
|---|
JSON Payload Representation
{
"code": "string",
"permissions": [
"string"
],
"name": "string"
}customer_access.user_roles.updated-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | code | string |
| display_name | string | |
| description | string | |
| permissions | array[string] |
Metadata
| Event Type | Payload Version | customer_access.user_roles.updated | v1 |
|---|
JSON Payload Representation
{
"code": "string",
"display_name": "string",
"description": "string",
"permissions": [
"string"
]
}darwin-device-DispatchPayload
Event Properties
| Name | Type | |
|---|---|---|
| required | begin | string |
| required | end | string |
| required | power | integer |
JSON Payload Representation
{
"begin": "string",
"end": "string",
"power": "integer"
}darwin-device-FlexDeviceDisconnectedPayload
Event Properties
| Name | Type | |
|---|---|---|
| required | cause | string |
| required | disconnected_soc | integer |
JSON Payload Representation
{
"cause": "string",
"disconnected_soc": "integer"
}darwin-device-FlexDeviceOptimisationCreatedPayload
Event Properties
| Name | Type | |
|---|---|---|
| required | dispatches | array[darwin-device-DispatchPayload] |
| required | achievable_target_soc | integer |
| required | energy_capacity | integer |
| required | start_soc | integer |
| required | user_target_soc | integer |
| required | optimization_begin | string |
| required | optimization_end | string |
| required | is_reoptimization | boolean |
| required | force_v1g_charging | boolean |
| required | fleet_id | string |
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
| Name | Type | |
|---|---|---|
| required | resource_type | string |
| required | external_identifier | string |
| required | expiry_window_end | string |
Metadata
| Event Type | Payload Version | data_import.import_process.cancelled | v1 |
|---|
JSON Payload Representation
{
"resource_type": "string",
"external_identifier": "string",
"expiry_window_end": "string"
}data_import.import_process.complete-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | resource_type | string |
| required | external_identifier | string |
| required | identifier | string |
Metadata
| Event Type | Payload Version | data_import.import_process.complete | v1 |
|---|
JSON Payload Representation
{
"resource_type": "string",
"external_identifier": "string",
"identifier": "string"
}data_import.import_process.dry_run_complete-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | resource_type | string |
| required | external_identifier | string |
Metadata
| Event Type | Payload Version | data_import.import_process.dry_run_complete | v1 |
|---|
JSON Payload Representation
{
"resource_type": "string",
"external_identifier": "string"
}data_import.import_process.dry_run_error-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | resource_type | string |
| required | external_identifier | string |
| required | error_code | string |
| required | error_detail | string |
Metadata
| Event Type | Payload Version | data_import.import_process.dry_run_error | v1 |
|---|
JSON Payload Representation
{
"resource_type": "string",
"external_identifier": "string",
"error_code": "string",
"error_detail": "string"
}data_import.import_process.error-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | resource_type | string |
| required | external_identifier | string |
| required | error_code | string |
| required | error_detail | string |
Metadata
| Event Type | Payload Version | data_import.import_process.error | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | resource_type | string |
| required | import_process_resource_type | string |
| required | import_process_external_identifier | string |
| required | identifier | string |
Metadata
| Event Type | Payload Version | data_import.import_process.post_import.completed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | resource_type | string |
| required | import_process_resource_type | string |
| required | import_process_external_identifier | string |
| required | error_code | string |
| required | error_detail | string |
Metadata
| Event Type | Payload Version | data_import.import_process.post_import.error | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | external_order_id | string |
| required | expiry_window_end | string |
Metadata
| Event Type | Payload Version | data_import.order_process.cancelled | v1 |
|---|
JSON Payload Representation
{
"external_order_id": "string",
"expiry_window_end": "string"
}data_import.order_process.complete-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | external_order_id | string |
| required | process_id | string |
Metadata
| Event Type | Payload Version | data_import.order_process.complete | v1 |
|---|
JSON Payload Representation
{
"external_order_id": "string",
"process_id": "string"
}data_import.order_process.error-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | external_order_id | string |
| required | error_code | string |
| required | error_detail | string |
Metadata
| Event Type | Payload Version | data_import.order_process.error | v1 |
|---|
JSON Payload Representation
{
"external_order_id": "string",
"error_code": "string",
"error_detail": "string"
}debt.actioning.automated_debt_write_back.completed-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | ledger_number | string |
| required | account_number | string |
| required | amount | integer |
Metadata
| Event Type | Payload Version | debt.actioning.automated_debt_write_back.completed | v1 |
|---|
JSON Payload Representation
{
"ledger_number": "string",
"account_number": "string",
"amount": "integer"
}debt.actioning.automated_debt_write_back.failed-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | ledger_number | string |
| required | account_number | string |
| required | reason | string |
| required | exception | string |
Metadata
| Event Type | Payload Version | debt.actioning.automated_debt_write_back.failed | v1 |
|---|
JSON Payload Representation
{
"ledger_number": "string",
"account_number": "string",
"reason": "string",
"exception": "string"
}debt.actioning.automated_debt_write_back.skipped-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | ledger_number | string |
| required | account_number | string |
| required | reason | string |
Metadata
| Event Type | Payload Version | debt.actioning.automated_debt_write_back.skipped | v1 |
|---|
JSON Payload Representation
{
"ledger_number": "string",
"account_number": "string",
"reason": "string"
}delinquent_debt.position_changed-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | ledger_number | string |
| required | changed_on | string |
| required | previous_value | integer |
| required | new_value | integer |
Metadata
| Event Type | Payload Version | delinquent_debt.position_changed | v1 |
|---|
JSON Payload Representation
{
"ledger_number": "string",
"changed_on": "string",
"previous_value": "integer",
"new_value": "integer"
}delinquent_debt.position_changed-v2
Event Properties
| Name | Type | |
|---|---|---|
| required | ledger_number | string |
| required | changed_on | string |
| required | previous_value | integer |
| required | new_value | integer |
| required | account_number | string |
Metadata
| Event Type | Payload Version | delinquent_debt.position_changed | v2 |
|---|
JSON Payload Representation
{
"ledger_number": "string",
"changed_on": "string",
"previous_value": "integer",
"new_value": "integer",
"account_number": "string"
}deposit_agreement.accepted-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | deposit_key | string |
| required | reason | string |
| required | amount | integer |
| required | account_number | string |
| required | ledger_identifier | string |
| required | accepted_at | string |
Metadata
| Event Type | Payload Version | deposit_agreement.accepted | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | deposit_key | string |
| required | reason | string |
| required | amount | integer |
| required | account_number | string |
| required | ledger_identifier | string |
| required | fulfilled_at | string |
Metadata
| Event Type | Payload Version | deposit_agreement.fulfilled | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | deposit_key | string |
| required | reason | string |
| required | amount | integer |
| required | account_number | string |
| required | ledger_identifier | string |
| required | returned_amount | integer |
| required | returned_at | string |
Metadata
| Event Type | Payload Version | deposit_agreement.instalment_returned | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | deposit_key | string |
| required | reason | string |
| required | amount | integer |
| required | account_number | string |
| required | ledger_identifier | string |
| required | returned_at | string |
Metadata
| Event Type | Payload Version | deposit_agreement.returned | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | deposit_key | string |
| required | reason | string |
| required | amount | integer |
| required | account_number | string |
| required | ledger_identifier | string |
| required | withdrawn_at | string |
Metadata
| Event Type | Payload Version | deposit_agreement.withdrawn | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | dunning_path_name | string |
| required | dunning_process_id | string |
| required | pause_start_date | string |
| required | pause_end_date | string |
| required | created_note | string |
Metadata
| Event Type | Payload Version | dunning_path_paused | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | dunning_path_name | string |
| required | dunning_process_id | string |
| required | account_number | string |
| required | created_note | string |
| required | start_date | string |
Metadata
| Event Type | Payload Version | dunning_path_started | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | dunning_path_name | string |
| required | dunning_process_id | string |
Metadata
| Event Type | Payload Version | dunning_path_unpaused | v1 |
|---|
JSON Payload Representation
{
"account_number": "string",
"dunning_path_name": "string",
"dunning_process_id": "string"
}dunning_path_withdrawn-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | dunning_path_name | string |
| required | dunning_process_id | string |
| required | withdrawn_date | string |
| required | withdrawn_note | string |
Metadata
| Event Type | Payload Version | dunning_path_withdrawn | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | file_reference | string |
Metadata
| Event Type | Payload Version | external_messaging.uploaded_file.safe | v1 |
|---|
JSON Payload Representation
{
"file_reference": "string"
}external_messaging.uploaded_file.unsafe-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | file_reference | string |
Metadata
| Event Type | Payload Version | external_messaging.uploaded_file.unsafe | v1 |
|---|
JSON Payload Representation
{
"file_reference": "string"
}flex_device.deauthenticated-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | property_id | integer |
| required | device_id | string |
| required | site_id | string |
| required | device_type | string |
| payload | object |
Metadata
| Event Type | Payload Version | flex_device.deauthenticated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | property_id | integer |
| required | device_id | string |
| required | site_id | string |
| required | device_type | string |
| required | payload | darwin-device-FlexDeviceDisconnectedPayload |
Metadata
| Event Type | Payload Version | flex_device.disconnected | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | property_id | integer |
| required | device_id | string |
| required | site_id | string |
| required | device_type | string |
| required | payload | darwin-device-FlexDeviceOptimisationCreatedPayload |
Metadata
| Event Type | Payload Version | flex_device.optimisation_created | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | property_id | integer |
| required | device_id | string |
| required | site_id | string |
| required | device_type | string |
| payload | object |
Metadata
| Event Type | Payload Version | flex_device.registered | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | purchase_id | integer |
| required | account_id | integer |
| support_user_id | integer |
Metadata
| Event Type | Payload Version | goods.purchase-created | v1 |
|---|
JSON Payload Representation
{
"purchase_id": "integer",
"account_id": "integer",
"support_user_id": "integer"
}goods.quote.created-for-account-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | market_name | string |
| required | quote_id | integer |
| required | client_params | object |
| required | lead_id | integer |
Metadata
| Event Type | Payload Version | goods.quote.created-for-account | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | market_name | string |
| required | quote_id | integer |
| required | contact_info | object |
| required | client_params | object |
| required | lead_id | integer |
Metadata
| Event Type | Payload Version | goods.quote.created-without-account | v1 |
|---|
JSON Payload Representation
{
"market_name": "string",
"quote_id": "integer",
"contact_info": "object",
"client_params": "object",
"lead_id": "integer"
}groups-_create-_Membership
Event Properties
| Name | Type | |
|---|---|---|
| required | contract_identifier | string |
| required | valid_from | string |
| valid_to | string |
JSON Payload Representation
{
"contract_identifier": "string",
"valid_from": "string",
"valid_to": "string"
}groups-_create-_Trait
Event Properties
| Name | Type | |
|---|---|---|
| required | identifier | string |
| required | type | string |
| required | data | object |
JSON Payload Representation
{
"identifier": "string",
"type": "string",
"data": "object"
}groups-_memberships-_Membership
Event Properties
| Name | Type | |
|---|---|---|
| required | contract_identifier | string |
| required | valid_from | string |
| required | valid_to | string |
JSON Payload Representation
{
"contract_identifier": "string",
"valid_from": "string",
"valid_to": "string"
}groups-_versions-_Period
Event Properties
| Name | Type | |
|---|---|---|
| required | start | string |
| required | end | string |
JSON Payload Representation
{
"start": "string",
"end": "string"
}groups-_versions-_Trait
Event Properties
| Name | Type | |
|---|---|---|
| required | identifier | string |
| required | type | string |
| required | data | object |
JSON Payload Representation
{
"identifier": "string",
"type": "string",
"data": "object"
}groups-_versions-_Version
Event Properties
| Name | Type | |
|---|---|---|
| required | identifier | string |
| required | effective_period | groups-_versions-_Period |
| required | system_period | groups-_versions-_Period |
| required | traits | 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
| Name | Type | |
|---|---|---|
| required | mpan | string |
| required | energisation_status | string |
| required | effective_from | string |
Metadata
| Event Type | Payload Version | industry.electricity.change_of_energisation.unsolicited_message | v1 |
|---|
JSON Payload Representation
{
"mpan": "string",
"energisation_status": "string",
"effective_from": "string"
}industry.electricity.change_of_service.meter_deactivated-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | mpan | string |
| required | serial_number | string |
| required | effective_from | string |
Metadata
| Event Type | Payload Version | industry.electricity.change_of_service.meter_deactivated | v1 |
|---|
JSON Payload Representation
{
"mpan": "string",
"serial_number": "string",
"effective_from": "string"
}industry.electricity.change_of_supply.gain.initiated-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | meter_point_identifier | string |
Metadata
| Event Type | Payload Version | industry.electricity.change_of_supply.gain.initiated | v1 |
|---|
JSON Payload Representation
{
"meter_point_identifier": "string"
}industry.electricity.change_of_supply.loss.complete-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | mpan | string |
| required | supply_end_date | string |
| required | new_supplier_id | string |
Metadata
| Event Type | Payload Version | industry.electricity.change_of_supply.loss.complete | v1 |
|---|
JSON Payload Representation
{
"account_number": "string",
"mpan": "string",
"supply_end_date": "string",
"new_supplier_id": "string"
}industry.electricity.export_installation.validated-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | import_mpan | string |
| required | account_number | string |
| required | product_code | string |
| required | manual_declared_net_capacity | string |
| required | manual_technology_type | string |
| required | valid_mcs_installations | array[object] |
| required | journey_identifier | string |
Metadata
| Event Type | Payload Version | industry.electricity.export_installation.validated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | import_mpan | string |
| required | export_mpan | string |
| required | account_number | string |
| required | product_code | string |
| required | manual_declared_net_capacity | string |
| required | manual_technology_type | string |
| required | valid_mcs_installations | array[object] |
| required | journey_identifier | string |
Metadata
| Event Type | Payload Version | industry.electricity.export_installation.validated | v2 |
|---|
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
| Name | Type | |
|---|---|---|
| required | meter_point_identifier | string |
Metadata
| Event Type | Payload Version | industry.gas.change_of_supply.gain.initiated | v1 |
|---|
JSON Payload Representation
{
"meter_point_identifier": "string"
}industry.gas.change_of_supply.loss.complete-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | mprn | string |
| required | supply_end_date | string |
| required | new_supplier_id | string |
Metadata
| Event Type | Payload Version | industry.gas.change_of_supply.loss.complete | v1 |
|---|
JSON Payload Representation
{
"account_number": "string",
"mprn": "string",
"supply_end_date": "string",
"new_supplier_id": "string"
}ink-_actions-_InkAction
Event Properties
| Name | Type | |
|---|---|---|
| required | code | string |
| required | succeeded | boolean |
| required | stop_further_evaluation | boolean |
JSON Payload Representation
{
"code": "string",
"succeeded": "boolean",
"stop_further_evaluation": "boolean"
}ink-_content-_InkContent
Event Properties
| Name | Type | |
|---|---|---|
| from_address | string | |
| subject | string | |
| to_addresses | array[string] | |
| required | tags | array[string] |
JSON Payload Representation
{
"from_address": "string",
"subject": "string",
"to_addresses": [
"string"
],
"tags": [
"string"
]
}ink-_content-_InkMessageContent
Event Properties
| Name | Type | |
|---|---|---|
| required | message_id | integer |
| required | occurred_at | string |
| required | channel | string |
| required | content | ink-_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
| Name | Type | |
|---|---|---|
| required | conversation_relay_id | string |
| required | account_number | string |
| required | message | ink-_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
| Name | Type | |
|---|---|---|
| required | type | string |
| required | reason | string |
| required | occurred_at | string |
JSON Payload Representation
{
"type": "string",
"reason": "string",
"occurred_at": "string"
}ink-_messages-_InkMessage
Event Properties
| Name | Type | |
|---|---|---|
| required | relay_id | string |
| required | vendor_id | string |
| required | channel | string |
| required | occurred_at | string |
JSON Payload Representation
{
"relay_id": "string",
"vendor_id": "string",
"channel": "string",
"occurred_at": "string"
}ink-_messages-_InkMessageWithVendor
Event Properties
| Name | Type | |
|---|---|---|
| required | relay_id | string |
| required | vendor | string |
| required | vendor_id | string |
| required | channel | string |
| required | occurred_at | string |
JSON Payload Representation
{
"relay_id": "string",
"vendor": "string",
"vendor_id": "string",
"channel": "string",
"occurred_at": "string"
}ink.actions.run-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | conversation_relay_id | string |
| required | message_relay_id | string |
| required | actions_results | array[ink-_actions-_InkAction] |
Metadata
| Event Type | Payload Version | ink.actions.run | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | conversation_id | integer |
| required | conversation_relay_id | string |
| required | account_number | string |
| required | message | ink-_content-_InkMessageContent |
Metadata
| Event Type | Payload Version | ink.content.inbound-message-tagged | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | conversation_relay_id | string |
| required | bucket_relay_id | string |
| required | support_user_id | integer |
| required | organisation_id | integer |
| required | actor_type | string |
| required | actor_id | integer |
Metadata
| Event Type | Payload Version | ink.conversation.assigned_to_bucket | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | conversation_relay_id | string |
| required | timeline_relay_id | string |
| required | support_user_id | integer |
Metadata
| Event Type | Payload Version | ink.conversation.assigned_to_timeline | v1 |
|---|
JSON Payload Representation
{
"conversation_relay_id": "string",
"timeline_relay_id": "string",
"support_user_id": "integer"
}ink.conversation.await_customer_reply-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | conversation_id | integer |
| required | conversation_relay_id | string |
| required | account_number | string |
| required | latest_contacted_account_user_number | string |
| required | support_user_id | integer |
| required | actor_type | string |
| required | actor_id | integer |
| required | organisation_id | integer |
Metadata
| Event Type | Payload Version | ink.conversation.await_customer_reply | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | conversation_id | integer |
| required | conversation_relay_id | string |
| required | account_number | string |
| required | latest_contacted_account_user_number | string |
| required | support_user_id | integer |
| required | actor_type | string |
| required | actor_id | integer |
| required | organisation_id | integer |
| required | closed_at | string |
| required | reason | string |
Metadata
| Event Type | Payload Version | ink.conversation.closed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | conversation_id | integer |
| required | conversation_relay_id | string |
| required | account_number | string |
| required | latest_contacted_account_user_number | string |
| required | support_user_id | integer |
| required | actor_type | string |
| required | actor_id | integer |
| required | organisation_id | integer |
| required | new_status | string |
| required | previous_status | string |
Metadata
| Event Type | Payload Version | ink.conversation.open_status_changed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | conversation_id | integer |
| required | conversation_relay_id | string |
| required | account_number | string |
| required | latest_contacted_account_user_number | string |
| required | support_user_id | integer |
| required | actor_type | string |
| required | actor_id | integer |
| required | organisation_id | integer |
Metadata
| Event Type | Payload Version | ink.conversation.opened | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | conversation_id | integer |
| required | conversation_relay_id | string |
| required | old_priority | number |
| required | new_priority | number |
| required | prioritized_at | string |
| required | message_id | integer |
| required | message_relay_id | string |
| required | account_number | string |
| required | latest_contacted_account_user_number | string |
| required | support_user_id | integer |
| required | organisation_id | integer |
Metadata
| Event Type | Payload Version | ink.conversation.priority.changed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | conversation_id | integer |
| required | conversation_relay_id | string |
| required | account_number | string |
| required | latest_contacted_account_user_number | string |
| required | support_user_id | integer |
| required | actor_type | string |
| required | actor_id | integer |
| required | organisation_id | integer |
| required | snoozed_to | string |
| required | ink_note_relay_id | string |
Metadata
| Event Type | Payload Version | ink.conversation.snoozed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | conversation_relay_id | string |
| required | bucket_relay_id | string |
| required | support_user_id | integer |
| required | organisation_id | integer |
| required | actor_type | string |
| required | actor_id | integer |
Metadata
| Event Type | Payload Version | ink.conversation.unassigned_from_bucket | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | conversation_relay_id | string |
| required | timeline_relay_id | string |
| required | support_user_id | integer |
Metadata
| Event Type | Payload Version | ink.conversation.unassigned_from_timeline | v1 |
|---|
JSON Payload Representation
{
"conversation_relay_id": "string",
"timeline_relay_id": "string",
"support_user_id": "integer"
}ink.live-chat.closed-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | live_chat_conversation_relay_id | string |
| required | close_reason | string |
| account_number | string |
Metadata
| Event Type | Payload Version | ink.live-chat.closed | v1 |
|---|
JSON Payload Representation
{
"live_chat_conversation_relay_id": "string",
"close_reason": "string",
"account_number": "string"
}ink.live-chat.initiated-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | live_chat_conversation | ink-_messages-InkConversation |
Metadata
| Event Type | Payload Version | ink.live-chat.initiated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | live_chat_conversation | ink-_messages-InkConversation |
Metadata
| Event Type | Payload Version | ink.live-chat.messages.outbound-message-created | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | filename | string |
| required | s3_key | string |
| required | s3_bucket | string |
| required | size_in_bytes | integer |
Metadata
| Event Type | Payload Version | ink.message_attachment.safe | v1 |
|---|
JSON Payload Representation
{
"filename": "string",
"s3_key": "string",
"s3_bucket": "string",
"size_in_bytes": "integer"
}ink.message_attachment.unsafe-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | filename | string |
| required | s3_key | string |
| required | s3_bucket | string |
| required | size_in_bytes | integer |
Metadata
| Event Type | Payload Version | ink.message_attachment.unsafe | v1 |
|---|
JSON Payload Representation
{
"filename": "string",
"s3_key": "string",
"s3_bucket": "string",
"size_in_bytes": "integer"
}ink.messages.inbound-email-migration-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | message_id | string |
| required | s3_key | string |
| required | s3_bucket | string |
Metadata
| Event Type | Payload Version | ink.messages.inbound-email-migration | v1 |
|---|
JSON Payload Representation
{
"message_id": "string",
"s3_key": "string",
"s3_bucket": "string"
}ink.messages.inbound-message-created-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | conversation_relay_id | string |
| required | account_number | string |
| required | message | ink-_messages-_InkMessage |
Metadata
| Event Type | Payload Version | ink.messages.inbound-message-created | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | channel | string |
| required | vendor | string |
| required | vendor_id | string |
| required | message_relay_id | string |
Metadata
| Event Type | Payload Version | ink.messages.inbound-message-ingested | v1 |
|---|
JSON Payload Representation
{
"channel": "string",
"vendor": "string",
"vendor_id": "string",
"message_relay_id": "string"
}ink.messages.outbound-message-created-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | conversation_relay_id | string |
| required | account_number | string |
| required | message | ink-_messages-_InkMessage |
Metadata
| Event Type | Payload Version | ink.messages.outbound-message-created | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | conversation_relay_id | string |
| required | message | ink-_messages-_InkMessageWithVendor |
| required | failure | ink-_messages-_InkFailureData |
Metadata
| Event Type | Payload Version | ink.messages.outbound-message-failed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | conversation_relay_id | string |
| required | account_number | string |
| required | message | ink-_messages-_InkMessage |
Metadata
| Event Type | Payload Version | ink.messages.phishing-report-dismissed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | conversation_relay_id | string |
| required | account_number | string |
| required | message | ink-_messages-_InkMessage |
Metadata
| Event Type | Payload Version | ink.messages.reported-phishing | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | conversation_relay_id | string |
| required | account_number | string |
| required | message | ink-_messages-_InkMessage |
Metadata
| Event Type | Payload Version | ink.messages.reported-spam | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | conversation_relay_id | string |
| required | account_number | string |
| required | message | ink-_messages-_InkMessage |
Metadata
| Event Type | Payload Version | ink.messages.spam-report-dismissed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | id | string |
| required | actor | object |
| required | displayable_number | string |
| required | name | string |
| required | primary_registration_number | string |
| required | secondary_registration_number | string |
| required | primary_tax_identifier_number | string |
| required | legal_address | object |
Metadata
| Event Type | Payload Version | internal_company.created | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | supply_point_external_identifier | string |
| required | reference_date | string |
| required | market | string |
Metadata
| Event Type | Payload Version | ita.supply_point_registry.active_supply_point_missing_from_rcu | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | supply_point_external_identifier | string |
| required | reference_date | string |
| required | system_params | object |
| required | external_params | object |
Metadata
| Event Type | Payload Version | ita.supply_point_registry.supply_point_update.new_entry_for_found_inconsistency | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | supply_point_external_identifier | string |
| required | reference_date | string |
Metadata
| Event Type | Payload Version | ita.supply_point_registry.supply_point_update.new_entry_for_missing_config_period | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | supply_point_external_identifier | string |
| required | reference_date | string |
Metadata
| Event Type | Payload Version | ita.supply_point_registry.supply_point_update.new_entry_for_supply_point_not_on_supply | v1 |
|---|
JSON Payload Representation
{
"supply_point_external_identifier": "string",
"reference_date": "string"
}ita_industry.active-cancellation.admissibility-received-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | industry_request_id | string |
| required | is_admissible | boolean |
| required | reason_code | integer |
Metadata
| Event Type | Payload Version | ita_industry.active-cancellation.admissibility-received | v1 |
|---|
JSON Payload Representation
{
"industry_request_id": "string",
"is_admissible": "boolean",
"reason_code": "integer"
}ita_industry.active-cancellation.admissibility-received-v2
Event Properties
| Name | Type | |
|---|---|---|
| required | industry_request_id | string |
| required | cancellation_industry_request_id | string |
| required | cancellation_kraken_request_id | string |
| required | is_admissible | boolean |
| required | reason_code | integer |
Metadata
| Event Type | Payload Version | ita_industry.active-cancellation.admissibility-received | v2 |
|---|
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
| Name | Type | |
|---|---|---|
| required | industry_request_id | string |
| required | is_cancelled | boolean |
| required | reason_code | integer |
Metadata
| Event Type | Payload Version | ita_industry.active-cancellation.outcome-received | v1 |
|---|
JSON Payload Representation
{
"industry_request_id": "string",
"is_cancelled": "boolean",
"reason_code": "integer"
}ita_industry.active-cancellation.outcome-received-v2
Event Properties
| Name | Type | |
|---|---|---|
| required | industry_request_id | string |
| required | cancellation_industry_request_id | string |
| required | cancellation_kraken_request_id | string |
| required | is_cancelled | boolean |
| required | reason_code | integer |
Metadata
| Event Type | Payload Version | ita_industry.active-cancellation.outcome-received | v2 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | sent_at | string |
Metadata
| Event Type | Payload Version | ita_industry.cancellation-request.sent | v1 |
|---|
JSON Payload Representation
{
"request_correlation_id": "string",
"sent_at": "string"
}ita_industry.change-of-ownership-pre-check.response-received-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | is_admissible | boolean |
| required | error_code | integer |
| required | error_motivation | string |
| required | industry_request_id | string |
| required | kraken_request_id | string |
| required | pod | string |
| required | pod_status | boolean |
| required | mean_annual_power | string |
| required | voltage | integer |
| required | address | object |
| required | market_type | string |
| required | committed_power | number |
| required | available_power | number |
| required | crpp_f1_aam | number |
| required | crpp_f2_aam | number |
| required | crpp_f3_aam | number |
| required | crpp_f1_aam1 | number |
| required | crpp_f2_aam1 | number |
| required | crpp_f3_aam1 | number |
Metadata
| Event Type | Payload Version | ita_industry.change-of-ownership-pre-check.response-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | is_admissible | boolean |
| required | error_code | integer |
| required | error_motivation | string |
| required | industry_request_id | string |
| required | kraken_request_id | string |
| required | pod | string |
| required | pod_status | boolean |
| required | mean_annual_power | string |
| required | voltage | integer |
| required | address | object |
| required | market_type | string |
| required | committed_power | number |
| required | available_power | number |
| required | crpp_f1_aam | number |
| required | crpp_f2_aam | number |
| required | crpp_f3_aam | number |
| required | crpp_f1_aam1 | number |
| required | crpp_f2_aam1 | number |
| required | crpp_f3_aam1 | number |
| required | recent_switch_dates | array[string] |
| required | recent_voltura_tit_iii_dates | array[string] |
| required | recent_voltura_tit_iv_dates | array[string] |
Metadata
| Event Type | Payload Version | ita_industry.change-of-ownership-pre-check.response-received | v2 |
|---|
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
| Name | Type | |
|---|---|---|
| required | pod | string |
| required | switch_out_date | string |
| required | industry_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.change-of-ownership-switch-out.notice-received | v1 |
|---|
JSON Payload Representation
{
"pod": "string",
"switch_out_date": "string",
"industry_request_id": "string"
}ita_industry.change-of-ownership.admissibility-received-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | is_admissible | boolean |
| required | error_code | integer |
| required | error_motivation | string |
| required | pod | string |
| required | industry_request_id | string |
| required | kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.change-of-ownership.admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | is_admissible | boolean |
| required | error_code | integer |
| required | error_motivation | string |
| required | industry_request_id | string |
| required | kraken_request_id | string |
| required | pod | string |
Metadata
| Event Type | Payload Version | ita_industry.change-of-ownership.cancellation-admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | pod | string |
| required | industry_request_id | string |
| required | fiscal_code | string |
| required | vat_number | string |
| required | is_foreign_fiscal_code | boolean |
| required | given_name | string |
| required | family_name | string |
| required | company_name | string |
| required | string | |
| required | telephone | string |
| required | billing_address | _electricity-_change_of_ownership_not_udd_response-BillingAddress |
| required | residence_address | _electricity-_change_of_ownership_not_udd_response-ResidenceAddress |
| required | change_of_ownership_type | string |
| required | contract_type | string |
| required | customer_type | string |
| required | start_date | string |
| required | start_date_recovery | string |
| required | vat | integer |
| required | excise | number |
| required | provincial_surtax | number |
| required | municipal_surtax | number |
| required | other_tax_information | string |
| required | market_type | string |
| required | office_code | string |
| required | payment_vat | string |
| required | merchandise_code | string |
| required | offer_code | string |
| required | self_certification | boolean |
Metadata
| Event Type | Payload Version | ita_industry.change-of-ownership.non-udd-contract-activation-response-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | industry_request_id | string |
| required | kraken_request_id | string |
| required | is_approved | boolean |
| required | error_code | integer |
| required | error_motivation | string |
| required | pod | string |
| required | fiscal_code | string |
| required | vat_number | string |
| required | is_foreign_fiscal_code | boolean |
| required | name | string |
| required | surname | string |
| required | company_name | string |
| required | start_date | string |
Metadata
| Event Type | Payload Version | ita_industry.change-of-ownership.response-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | pod | string |
| required | effective_from | string |
| required | industry_request_id | string |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.functional-data.received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | pod | string |
| required | effective_from | string |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.functional-data.received | v2 |
|---|
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
| Name | Type | |
|---|---|---|
| required | company_name | string |
| required | error_code | integer |
| required | error_reason | string |
| required | fiscal_code | string |
| required | industry_request_id | string |
| required | is_approved | boolean |
| required | is_foreign_fiscal_code | boolean |
| required | kraken_request_id | string |
| required | name | string |
| required | pdr | string |
| required | start_date | string |
| required | surname | string |
| required | vat_number | string |
Metadata
| Event Type | Payload Version | ita_industry.gas.change-of-ownership.final-outcome-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | is_admissible | boolean |
| required | error_code | integer |
| required | error_reason | string |
| required | kraken_request_id | string |
| required | industry_request_id | string |
| required | pdr | string |
| required | remi | string |
| required | pdr_status | string |
| required | distributor_vat_number | string |
| required | street_type | string |
| required | street_name | string |
| required | street_number | string |
| required | city | string |
| required | province_code | string |
| required | postcode | string |
| required | istat_code | string |
| required | country | string |
| required | address_other_info | string |
| required | annual_consumption | integer |
| required | standard_withdrawal_profile | string |
| required | pdr_transport_capacity | integer |
| required | meter_serial_number | string |
| required | measurement_group_class | string |
| required | is_managed_remotely | boolean |
| required | market_of_origin | string |
| required | recent_switch_dates | array[string] |
| required | recent_voltura_tit_iii_dates | array[string] |
| required | recent_voltura_tit_iv_dates | array[string] |
Metadata
| Event Type | Payload Version | ita_industry.gas.change-of-ownership.pre-check.admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | pdr | string |
| required | kraken_request_id | string |
| required | industry_request_id | string |
| required | is_admissible | boolean |
| required | error_code | integer |
| required | error_reason | string |
Metadata
| Event Type | Payload Version | ita_industry.gas.change-of-ownership.request.admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | pdr | string |
| required | remi | string |
| required | climate_zone_id | string |
| required | pdr_usage_type | string |
| required | meter_group_class | string |
| required | profile_code | string |
| required | annual_consumption | integer |
| required | settlment_treatment | string |
| required | measurement_pressure | string |
| required | meter_serial_number | string |
| required | effective_from | string |
Metadata
| Event Type | Payload Version | ita_industry.gas.functional-data.notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | pdr | string |
| required | remi | string |
| required | climate_zone_id | string |
| required | pdr_usage_type | string |
| required | measurement_group_class | string |
| required | profile_code | string |
| required | annual_consumption | integer |
| required | settlment_treatment | string |
| required | measurement_pressure | string |
| required | meter_serial_number | string |
| required | effective_from | string |
| required | distributor_partita_iva | string |
Metadata
| Event Type | Payload Version | ita_industry.gas.functional-data.notice-received | v2 |
|---|
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
| Name | Type | |
|---|---|---|
| required | new_readings | object |
Metadata
| Event Type | Payload Version | ita_industry.gas.meter-readings.update | v1 |
|---|
JSON Payload Representation
{
"new_readings": "object"
}ita_industry.gas.self-reading.validation-outcome-received-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | pdr | string |
| required | competence_month | string |
| required | service_date | string |
| required | industry_request_id | string |
| required | technical_data | _gas-_self_reading_validation_outcome-_TechnicalData |
| required | reading_detail | _gas-_self_reading_validation_outcome-_ReadingDetail |
Metadata
| Event Type | Payload Version | ita_industry.gas.self-reading.validation-outcome-received | v1 |
|---|
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.switch-in.pre-check.final-outcome-received-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | is_admissible | boolean |
| required | error_code | integer |
| required | error_reason | string |
| required | is_approved | boolean |
| required | failure_code | integer |
| required | failure_reason | string |
| required | industry_request_id | string |
| required | kraken_request_id | string |
| required | pdr | string |
| required | pdr_type | integer |
| required | remi | string |
| required | distributor_vat_number | string |
| required | customer_fiscal_code | string |
| required | customer_vat_number | string |
| required | is_foreign_fiscal_code | boolean |
| required | given_name | string |
| required | family_name | string |
| required | company_name | string |
| required | commercial_counterparty_company_name | string |
| required | commercial_counterparty_vat_number | string |
Metadata
| Event Type | Payload Version | ita_industry.gas.switch-in.pre-check.final-outcome-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | is_admissible | boolean |
| required | error_code | integer |
| required | error_reason | string |
| required | is_approved | boolean |
| required | failure_code | integer |
| required | failure_reason | string |
| required | industry_request_id | string |
| required | kraken_request_id | string |
| required | pdr | string |
| required | pdr_type | integer |
| required | remi | string |
| required | distributor_vat_number | string |
| required | customer_fiscal_code | string |
| required | customer_vat_number | string |
| required | is_foreign_fiscal_code | boolean |
| required | given_name | string |
| required | family_name | string |
| required | company_name | string |
| required | commercial_counterparty_company_name | string |
| required | commercial_counterparty_vat_number | string |
| required | pdr_status | string |
| required | pdr_transport_capacity | integer |
| required | annual_consumption | integer |
| required | standard_withdrawal_profile | string |
| required | measurement_group_class | string |
| required | meter_type | string |
| required | is_managed_remotely | boolean |
| required | is_volume_converter_present | boolean |
Metadata
| Event Type | Payload Version | ita_industry.gas.switch-in.pre-check.final-outcome-received | v2 |
|---|
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
| Name | Type | |
|---|---|---|
| required | pdr | string |
| required | kraken_request_id | string |
| required | industry_request_id | string |
| required | is_admissible | boolean |
| required | error_code | integer |
| required | error_motivation | string |
Metadata
| Event Type | Payload Version | ita_industry.gas.switch-in.request.admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | pdr | string |
| required | kraken_request_id | string |
| required | industry_request_id | string |
| required | is_admissible | boolean |
| required | error_code | integer |
| required | error_reason | string |
Metadata
| Event Type | Payload Version | ita_industry.gas.switch-in.request.admissibility-received | v2 |
|---|
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
| Name | Type | |
|---|---|---|
| required | pdr | string |
| required | kraken_request_id | string |
| required | industry_request_id | string |
| is_pdr_closed_due_to_non_payment | boolean | |
| pdr_suspension_requests_dates_last_12_months | array[string] | |
| pdr_access_for_substitution_requests_dates_last_12_months | array[string] | |
| availability_status_of_the_meter | string | |
| has_ongoing_indemnity_procedure | boolean | |
| default_service_activation_date | string | |
| request_to_close_date | string |
Metadata
| Event Type | Payload Version | ita_industry.gas.switch-in.timg.notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | pdr | string |
| required | switch_out_date | string |
| required | industry_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.gas.switch-out-with-change-of-ownership.notice-received | v1 |
|---|
JSON Payload Representation
{
"pdr": "string",
"switch_out_date": "string",
"industry_request_id": "string"
}ita_industry.gas.switch-out.notice-received-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | pdr | string |
| required | switch_out_date | string |
| required | industry_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.gas.switch-out.notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.cancellation-dl.request.mch-admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.cancellation-dl.request.mch-final-outcome-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.cancellation-dl.request.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.cancellation-dl.request.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.cancellation.request.mch-admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.cancellation.request.mch-final-outcome-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.cancellation.request.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.cancellation.request.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.change-of-ownership.cancellation.mch-admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.change-of-ownership.cancellation.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.change-of-ownership.cancellation.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.change-of-ownership.pre-check.mch-admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.change-of-ownership.pre-check.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.change-of-ownership.pre-check.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.change-of-ownership.request.mch-admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.change-of-ownership.request.mch-final-outcome-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.change-of-ownership.request.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.change-of-ownership.request.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.compensation.application-incoming-user.mch-notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.compensation.application-outgoing-user.mch-notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.compensation.incoming-cancellation-incoming-user.mch-notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.compensation.incoming-cancellation-outgoing-user.mch-notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.compensation.incoming-cancellation-withdrawal-incoming-user.mch-notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.compensation.incoming-cancellation-withdrawal-outgoing-user.mch-notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.compensation.incoming-cancellation-withdrawal.mch-admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.compensation.incoming-cancellation-withdrawal.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.compensation.incoming-cancellation-withdrawal.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.compensation.incoming-cancellation.mch-admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.compensation.incoming-cancellation.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.compensation.incoming-cancellation.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.compensation.incoming-report.mch-admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.compensation.incoming-report.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.compensation.incoming-report.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.compensation.outgoing-cancellation-incoming-user.mch-notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.compensation.outgoing-cancellation-outgoing-user.mch-notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.compensation.outgoing-cancellation-return.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.compensation.outgoing-cancellation-return.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.compensation.outgoing-cancellation.mch-admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.compensation.outgoing-cancellation.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.compensation.outgoing-cancellation.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.compensation.request.mch-admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.compensation.request.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.compensation.request.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.compensation.value-update.mch-notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.contract-termination.request.mch-admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.contract-termination.request.mch-final-outcome-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.contract-termination.request.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.contract-termination.request.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.electricity.takeover.request.mch-admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.electricity.takeover.request.mch-final-outcome-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.electricity.takeover.request.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.electricity.takeover.request.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.change-of-ownership.pre-check.mch-admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.change-of-ownership.pre-check.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.change-of-ownership.pre-check.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.change-of-ownership.request.mch-admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.change-of-ownership.request.mch-final-outcome-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.change-of-ownership.request.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.change-of-ownership.request.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.contact-termination.request.mch-notice | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | code_reason_step | integer |
| service | string | |
| flow | string | |
| userTransactionCode | string | |
| siiTransactionCode | string | |
| transactionIdHUB | string | |
| channel | string | |
| finalOutcome | string | |
| checkPortafoglio | string | |
| cancellationCausal | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.contract-termination.mch-final-outcome-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.contract-termination.request.mch-admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.contract-termination.request.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| request_correlation_id | string | |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.deactivation-upon-final-customer-demand.annulment-request.mch-final-outcome-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.deactivation-upon-final-customer-demand.annulment-request.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.deactivation-upon-final-customer-demand.annulment-request.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.deactivation-upon-final-customer-demand.request.mch-admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.deactivation-upon-final-customer-demand.request.mch-appointment-informative-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.deactivation-upon-final-customer-demand.request.mch-final-outcome-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.deactivation-upon-final-customer-demand.request.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.deactivation-upon-final-customer-demand.request.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| request_correlation_id | string | |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.measurement-group-technical-data-access.annulment-request.mch-final-outcome-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.measurement-group-technical-data-access.annulment-request.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.measurement-group-technical-data-access.annulment-request.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.measurement-group-technical-data-access.request.mch-admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.measurement-group-technical-data-access.request.mch-appointment-informative-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.measurement-group-technical-data-access.request.mch-appointment-outcome-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.measurement-group-technical-data-access.request.mch-final-outcome-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.measurement-group-technical-data-access.request.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.measurement-group-technical-data-access.request.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.reactivation-after-suspension-for-missed-payments.request.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.reactivation-after-suspension-for-missed-payments.request.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.reactivation-after-suspension.request.mch-admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.reactivation-after-suspension.request.mch-appointment-informative-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.reactivation-after-suspension.request.mch-appointment-outcome-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.reactivation-after-suspension.request.mch-final-outcome-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.self-reading-transmission.request.mch-final-outcome-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.self-reading-transmission.request.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.self-reading-transmission.request.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.suspension-for-missed-payment.request.mch-admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.suspension-for-missed-payment.request.mch-final-outcome-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.suspension-for-missed-payment.request.mch-intervention-outcome-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.suspension-for-missed-payment.request.mch-weekly-capacity-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.suspension-for-missed-payment.request.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.suspension-for-missed-payment.request.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.switch-in.pre-check.mch-final-outcome-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.switch-in.pre-check.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.switch-in.pre-check.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.switch-in.request.mch-admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | code_reason_step | integer |
| service | string | |
| flow | string | |
| userTransactionCode | string | |
| siiTransactionCode | string | |
| transactionIdHUB | string | |
| channel | string | |
| finalOutcome | string | |
| cancellationCausal | string | |
| checkPortafoglio | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.switch-in.request.mch-final-outcome-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.switch-in.request.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.switch-in.request.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.switch-in.timg.mch-notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | step_outcome | boolean |
| required | code_reason_step | integer |
| required | COD_SERVIZIO | string |
| required | COD_FLUSSO | string |
| required | PIVA_UTENTE | string |
| required | PIVA_GESTORE | string |
| required | CP_GESTORE | string |
| required | COD_PDR | string |
| required | COD_REMI | string |
| required | DATA_DECORRENZA | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.switch-out-with-change-of-ownership.mch-notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | step_outcome | boolean |
| required | code_reason_step | integer |
| service | string | |
| flow | string | |
| siiTransactionCode | string | |
| pdr | string | |
| switchEffectiveFromDate | string | |
| channel | string | |
| finalOutcome | string | |
| cancellationCausal | string | |
| receivingDateFinalResult | string | |
| checkPortafoglio | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.switch-out.mch-final-outcome-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | step_outcome | boolean |
| required | code_reason_step | integer |
| required | COD_SERVIZIO | string |
| required | COD_FLUSSO | string |
| required | PIVA_UTENTE | string |
| required | PIVA_GESTORE | string |
| required | CP_GESTORE | string |
| required | COD_PDR | string |
| CF | string | |
| PIVA | string | |
| CF_STRANIERO | string | |
| required | DATA_DECORRENZA | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.switch-out.mch-notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | step_outcome | boolean |
| required | request_correlation_id | string |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.update-on-condition.request.mch-admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.update-on-condition.request.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.gas.update-on-condition.request.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.interruption-for-missed-payment.request.mch-admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.interruption-for-missed-payment.request.mch-final-outcome-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.interruption-for-missed-payment.request.mch-informative-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.interruption-for-missed-payment.request.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.interruption-for-missed-payment.request.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | step_outcome | boolean |
| required | code_reason_step | integer |
| receiving_date_final_result | string | |
| required | COD_SERVIZIO | string |
| required | COD_FLUSSO | string |
| required | PIVA_UTENTE | string |
| required | PIVA_GESTORE | string |
| required | CP_GESTORE | string |
| required | CP_GESTORE_ANN | string |
| CP_UTENTE_ANN | string | |
| required | SETTORE | string |
| COD_POD | string | |
| COD_PDR | string | |
| required | COD_CAUSALE | string |
| required | MOTIVAZIONE | string |
| NOTE | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.passive-cancellation.mch-notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.power-variation.request.mch-admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.power-variation.request.mch-final-outcome-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.power-variation.request.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.power-variation.request.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.suspension-for-missed-payment.reactivation.mch-admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| request_correlation_id | string | |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.suspension-for-missed-payment.reactivation.mch-final-outcome-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | step_outcome | boolean |
| required | 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 | |
string |
Metadata
| Event Type | Payload Version | ita_industry.messages.suspension-for-missed-payment.reactivation.mch-notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.suspension-for-missed-payment.reactivation.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.suspension-for-missed-payment.reactivation.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.suspension-for-missed-payment.request.mch-admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.suspension-for-missed-payment.request.mch-final-outcome-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.suspension-for-missed-payment.request.mch-notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.suspension-for-missed-payment.request.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.suspension-for-missed-payment.request.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.switch-in.pre-check.mch-final-outcome-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.switch-in.pre-check.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.switch-in.pre-check.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.switch-in.request.mch-admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.switch-in.request.mch-timoe-notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.switch-in.request.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.switch-in.request.technical-error-occurred | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | step_outcome | boolean |
| required | code_reason_step | integer |
| required | COD_SERVIZIO | string |
| required | COD_FLUSSO | string |
| required | PIVA_UTENTE | string |
| required | PIVA_GESTORE | string |
| required | CP_GESTORE | string |
| required | COD_POD | string |
| required | DATA_DECORRENZA | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.switch-out-with-change-of-ownership.mch-notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | step_outcome | boolean |
| required | code_reason_step | integer |
| required | COD_SERVIZIO | string |
| required | COD_FLUSSO | string |
| required | PIVA_UTENTE | string |
| required | PIVA_GESTORE | string |
| required | CP_GESTORE | string |
| required | COD_POD | string |
| required | DATA_DECORRENZA | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.switch-out.mch-notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.update-on-condition.request.mch-admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | step_outcome | boolean |
| required | 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 |
Metadata
| Event Type | Payload Version | ita_industry.messages.update-on-condition.request.mch-final-outcome-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.update-on-condition.request.status-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | outcome | boolean |
| error_code | integer | |
| kraken_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.messages.update-on-condition.request.technical-error-occurred | v1 |
|---|
JSON Payload Representation
{
"request_correlation_id": "string",
"outcome": "boolean",
"error_code": "integer",
"kraken_request_id": "string"
}ita_industry.outbound-request.created-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | request_correlation_id | string |
| required | flow_type | string |
| to_be_sent | boolean | |
| extra_fields | object | |
| required | commodity_type | string |
Metadata
| Event Type | Payload Version | ita_industry.outbound-request.created | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | error_code | string |
| required | industry_id_of_cancellation_request | string |
| required | industry_id_of_request_to_cancel | string |
| required | kraken_id_of_request_to_cancel | string |
| required | pod | string |
Metadata
| Event Type | Payload Version | ita_industry.passive-cancellation.active-cancellation.notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | error_code | string |
| required | industry_id_of_cancellation_request | string |
| required | industry_id_of_request_to_cancel | string |
| required | kraken_id_of_request_to_cancel | string |
| required | pod | string |
Metadata
| Event Type | Payload Version | ita_industry.passive-cancellation.change-of-ownership.notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | error_code | string |
| required | industry_request_id | string |
| required | industry_request_id_to_cancel | string |
| required | kraken_request_id_to_cancel | string |
| required | pdr | string |
| required | pod | string |
Metadata
| Event Type | Payload Version | ita_industry.passive-cancellation.notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | error_code | string |
| required | industry_id_of_cancellation_request | string |
| required | industry_id_of_request_to_cancel | string |
| required | kraken_id_of_request_to_cancel | string |
| required | pod | string |
Metadata
| Event Type | Payload Version | ita_industry.passive-cancellation.power-variation.notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | error_code | string |
| required | industry_id_of_cancellation_request | string |
| required | industry_id_of_request_to_cancel | string |
| required | kraken_id_of_request_to_cancel | string |
| required | pod | string |
Metadata
| Event Type | Payload Version | ita_industry.passive-cancellation.switch-in.notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | error_code | string |
| required | industry_id_of_cancellation_request | string |
| required | industry_id_of_request_to_cancel | string |
| required | kraken_id_of_request_to_cancel | string |
| required | pod | string |
Metadata
| Event Type | Payload Version | ita_industry.passive-cancellation.switch-out.notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | error_code | string |
| required | industry_id_of_cancellation_request | string |
| required | industry_id_of_request_to_cancel | string |
| required | kraken_id_of_request_to_cancel | string |
| required | pod | string |
Metadata
| Event Type | Payload Version | ita_industry.passive-cancellation.update-on-condition.notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | industry_request_id | string |
| required | commodity | string |
| required | pod | string |
| required | pdr | string |
| required | customer_fiscal_code | string |
| required | customer_vat_number | string |
| required | is_foreign_fiscal_code | integer |
| required | compensation_amount | string |
| required | dispatch_contract_code | string |
| required | incoming_user_vat_number | string |
| required | incoming_commercial_counterpart_vat_number | string |
Metadata
| Event Type | Payload Version | ita_industry.passive-cmor.compensation-application-notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | industry_request_id | string |
| required | kraken_request_id | string |
| required | commodity | string |
| required | pod | string |
| required | pdr | string |
| required | customer_fiscal_code | string |
| required | customer_vat_number | string |
| required | is_foreign_fiscal_code | integer |
| required | cancellation_reason_code | string |
| required | csea_disbursement_made | string |
| required | csea_payment_status | string |
Metadata
| Event Type | Payload Version | ita_industry.passive-cmor.compensation-cancellation-notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | industry_request_id | string |
| required | kraken_request_id | string |
| required | updated_compensation_amount | string |
| required | compensation_difference_from_initial_amount | string |
| required | compensation_difference_code | string |
Metadata
| Event Type | Payload Version | ita_industry.passive-cmor.compensation-update-notice-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | pod | string |
| required | kraken_request_id | string |
| required | industry_request_id | string |
| required | is_admissible | boolean |
| required | error_code | integer |
| required | error_motivation | string |
Metadata
| Event Type | Payload Version | ita_industry.power-variation.admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | industry_request_id | string |
| required | kraken_request_id | string |
| required | pod | string |
| required | execution_date | string |
| required | is_approved | boolean |
| required | error_code | integer |
| required | error_reason | string |
| required | committed_power_kw | string |
| required | available_power_kw | string |
| required | tariff_type | string |
| required | phase_power | string |
| required | voltage | integer |
Metadata
| Event Type | Payload Version | ita_industry.power-variation.outcome-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | industry_request_id | string |
| required | kraken_request_id | string |
| required | is_admissible | boolean |
| required | error_code | integer |
| required | error_reason | string |
| required | is_approved | boolean |
| required | failure_code | integer |
| required | failure_reason | string |
| required | pod | string |
| required | fiscal_code | string |
| required | vat_number | string |
| required | is_foreign_fiscal_code | boolean |
| required | given_name | string |
| required | family_name | string |
| required | company_name | string |
| required | crpp_mm_f1 | number |
| required | crpp_mm_f2 | number |
| required | crpp_mm_f3 | number |
| required | crpp_mm1_f1 | number |
| required | crpp_mm1_f2 | number |
| required | crpp_mm1_f3 | number |
| required | contractual_timoe_resolution | boolean |
| required | mean_annual_power | string |
Metadata
| Event Type | Payload Version | ita_industry.pre-check.integration-response-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | is_admissible | boolean |
| required | error_code | integer |
| required | error_reason | string |
| required | is_approved | boolean |
| required | failure_code | integer |
| required | failure_reason | string |
| required | industry_request_id | string |
| required | kraken_request_id | string |
| required | pod | string |
| required | fiscal_code | string |
| required | vat_number | string |
| required | is_foreign_fiscal_code | boolean |
| required | safeguarding_service_activation_date | string |
| required | crpp_mm_f1 | number |
| required | crpp_mm_f2 | number |
| required | crpp_mm_f3 | number |
| required | crpp_mm1_f1 | number |
| required | crpp_mm1_f2 | number |
| required | crpp_mm1_f3 | number |
| required | contractual_timoe_resolution | string |
| required | mean_annual_power | string |
Metadata
| Event Type | Payload Version | ita_industry.pre-check.response-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | pod | string |
| required | kraken_switch_request_id | string |
| required | industry_switch_request_id | string |
| required | is_admissible | boolean |
| required | error_code | integer |
| required | error_motivation | string |
Metadata
| Event Type | Payload Version | ita_industry.switch-in.switch-request-admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | pod | string |
| required | kraken_switch_request_id | string |
| required | is_currently_suspended_for_missed_payments | boolean |
| required | has_debt_with_old_supplier | boolean |
| required | market_type | string |
| required | safeguarding_service_activation_date | string |
| required | recent_suspension_request_date | string |
| required | recent_suspension_date | string |
| required | dates_of_non_payments_suspensions | array[string] |
| required | recent_switch_dates | array[string] |
Metadata
| Event Type | Payload Version | ita_industry.switch-in.timoe-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | pod | string |
| required | switch_out_date | string |
| required | industry_request_id | string |
Metadata
| Event Type | Payload Version | ita_industry.switch-out.notice-received | v1 |
|---|
JSON Payload Representation
{
"pod": "string",
"switch_out_date": "string",
"industry_request_id": "string"
}ita_industry.television-fee-charge-notice.received-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | notice_id | string |
| required | pod | string |
| required | fiscal_code | string |
| required | amount | string |
| required | accrual_start_date | string |
| required | accrual_end_date | string |
| required | amount_code | string |
| required | istat_code | string |
| required | tariff_type | string |
| required | supply_start_date | string |
| required | inbound_message_id | integer |
Metadata
| Event Type | Payload Version | ita_industry.television-fee-charge-notice.received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | pod | string |
| required | kraken_request_id | string |
| required | industry_request_id | string |
| required | is_admissible | boolean |
| required | error_code | integer |
| required | error_motivation | string |
Metadata
| Event Type | Payload Version | ita_industry.update-on-condition.admissibility-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | pod | string |
| required | kraken_request_id | string |
| required | industry_request_id | string |
| required | is_approved | boolean |
| required | error_code | integer |
| required | error_motivation | string |
Metadata
| Event Type | Payload Version | ita_industry.update-on-condition.final-outcome-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | run_id | string |
| required | account_number | string |
| required | fees_applied_count | integer |
| required | fees_unapplied_count | integer |
Metadata
| Event Type | Payload Version | late_payment_fee_application_service_completed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | run_id | string |
| required | account_number | string |
| required | fee_amount | integer |
| required | fee_date | string |
| fee_type | string | |
| required | charge_id | string |
Metadata
| Event Type | Payload Version | late_payment_fee_application_service_fee_applied | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | run_id | string |
| required | account_number | string |
Metadata
| Event Type | Payload Version | late_payment_fee_application_service_started | v1 |
|---|
JSON Payload Representation
{
"run_id": "string",
"account_number": "string"
}late_payment_fee_calculation_service_completed-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | run_id | string |
| required | account_number | string |
| required | fees_calculated_count | integer |
Metadata
| Event Type | Payload Version | late_payment_fee_calculation_service_completed | v1 |
|---|
JSON Payload Representation
{
"run_id": "string",
"account_number": "string",
"fees_calculated_count": "integer"
}late_payment_fee_calculation_service_started-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | run_id | string |
| required | account_number | string |
Metadata
| Event Type | Payload Version | late_payment_fee_calculation_service_started | v1 |
|---|
JSON Payload Representation
{
"run_id": "string",
"account_number": "string"
}late_payment_fee_calculator_completed-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | run_id | string |
| required | account_number | string |
| required | fees_applied_count | integer |
| required | fees_unapplied_count | integer |
Metadata
| Event Type | Payload Version | late_payment_fee_calculator_completed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | run_id | string |
| required | account_number | string |
| required | charge_id | string |
Metadata
| Event Type | Payload Version | late_payment_fee_calculator_fee_applied | v1 |
|---|
JSON Payload Representation
{
"run_id": "string",
"account_number": "string",
"charge_id": "string"
}late_payment_fee_calculator_started-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | run_id | string |
| required | account_number | string |
Metadata
| Event Type | Payload Version | late_payment_fee_calculator_started | v1 |
|---|
JSON Payload Representation
{
"run_id": "string",
"account_number": "string"
}late_payment_fee_waived-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | fee_id | integer |
| required | waived_at | string |
| required | support_user_id | integer |
Metadata
| Event Type | Payload Version | late_payment_fee_waived | v1 |
|---|
JSON Payload Representation
{
"fee_id": "integer",
"waived_at": "string",
"support_user_id": "integer"
}leads.lead.stage-updated-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | lead_number | string |
| required | funnel_code | string |
| required | stage | string |
Metadata
| Event Type | Payload Version | leads.lead.stage-updated | v1 |
|---|
JSON Payload Representation
{
"lead_number": "string",
"funnel_code": "string",
"stage": "string"
}leads.opportunity.document-attached-to-opportunity-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | opportunity_number | string |
| required | attachment_id | integer |
| required | category | string |
Metadata
| Event Type | Payload Version | leads.opportunity.document-attached-to-opportunity | v1 |
|---|
JSON Payload Representation
{
"opportunity_number": "string",
"attachment_id": "integer",
"category": "string"
}leads.opportunity.offer-group.created-v2
Event Properties
| Name | Type | |
|---|---|---|
| required | opportunity_number | string |
| required | offer_group_identifier | string |
Metadata
| Event Type | Payload Version | leads.opportunity.offer-group.created | v2 |
|---|
JSON Payload Representation
{
"opportunity_number": "string",
"offer_group_identifier": "string"
}leads.opportunity.stage-updated-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | opportunity_number | string |
| required | funnel_code | string |
| required | stage | string |
| updated_by_user_id | integer |
Metadata
| Event Type | Payload Version | leads.opportunity.stage-updated | v1 |
|---|
JSON Payload Representation
{
"opportunity_number": "string",
"funnel_code": "string",
"stage": "string",
"updated_by_user_id": "integer"
}lifecycle-enrollment-SupplyPoint
Event Properties
| Name | Type | |
|---|---|---|
| required | market_name | string |
| required | external_identifier | string |
| required | confirmed_ssd | string |
| required | was_cancelled | boolean |
JSON Payload Representation
{
"market_name": "string",
"external_identifier": "string",
"confirmed_ssd": "string",
"was_cancelled": "boolean"
}lifecycle-join_supplier-ActivatedSupplyPoint
Event Properties
| Name | Type | |
|---|---|---|
| required | external_identifier | string |
| required | market_name | string |
| required | confirmed_supply_start_date | string |
JSON Payload Representation
{
"external_identifier": "string",
"market_name": "string",
"confirmed_supply_start_date": "string"
}lifecycle-join_supplier-ActivationInitiatedSupplyPoint
Event Properties
| Name | Type | |
|---|---|---|
| required | external_identifier | string |
| required | market_name | string |
JSON Payload Representation
{
"external_identifier": "string",
"market_name": "string"
}lifecycle-join_supplier-Agreement
Event Properties
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | valid_from | string |
| required | valid_to | string |
| required | product_code | string |
JSON Payload Representation
{
"id": "integer",
"valid_from": "string",
"valid_to": "string",
"product_code": "string"
}lifecycle-join_supplier-ContractReferences
Event Properties
| Name | Type | |
|---|---|---|
| account_contract_identifier | string | |
| business_contract_identifier | string |
JSON Payload Representation
{
"account_contract_identifier": "string",
"business_contract_identifier": "string"
}lifecycle-join_supplier-SupplyPeriodData
Event Properties
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | supply_start_at | string |
| required | supply_end_at | string |
JSON Payload Representation
{
"id": "integer",
"supply_start_at": "string",
"supply_end_at": "string"
}lifecycle-join_supplier-SupplyPoint
Event Properties
| Name | Type | |
|---|---|---|
| required | external_identifier | string |
| required | market_name | string |
| required | requested_supply_start_date | string |
JSON Payload Representation
{
"external_identifier": "string",
"market_name": "string",
"requested_supply_start_date": "string"
}lifecycle-leave_supplier-SupplyPoint
Event Properties
| Name | Type | |
|---|---|---|
| required | market_identifier | string |
| required | external_identifier | string |
| required | market_name | string |
JSON Payload Representation
{
"market_identifier": "string",
"external_identifier": "string",
"market_name": "string"
}lifecycle-leave_supplier-TerminatedSupplyPoint
Event Properties
| Name | Type | |
|---|---|---|
| required | external_identifier | string |
| required | market_name | string |
| required | confirmed_supply_end_date | string |
JSON Payload Representation
{
"external_identifier": "string",
"market_name": "string",
"confirmed_supply_end_date": "string"
}lifecycle-leave_supplier-TerminationInitiatedSupplyPoint
Event Properties
| Name | Type | |
|---|---|---|
| required | external_identifier | string |
| required | market_name | string |
| required | requested_supply_end_date | string |
JSON Payload Representation
{
"external_identifier": "string",
"market_name": "string",
"requested_supply_end_date": "string"
}lifecycle.enrollment.loyalty-points-qualification-reversed-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | join_supplier_process_number | string |
| required | account_number | string |
| required | supply_points_no_longer_coming_on_supply | array[lifecycle-enrollment-SupplyPoint] |
| required | all_supply_points | array[lifecycle-enrollment-SupplyPoint] |
Metadata
| Event Type | Payload Version | lifecycle.enrollment.loyalty-points-qualification-reversed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | join_supplier_process_id | integer |
| required | join_supplier_process_number | string |
| required | account_number | string |
| required | supply_points_past_ssd | array[lifecycle-enrollment-SupplyPoint] |
| required | all_supply_points | array[lifecycle-enrollment-SupplyPoint] |
Metadata
| Event Type | Payload Version | lifecycle.enrollment.supply-status-qualifies-account-for-loyalty-point | v2 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | join_supplier_process_number | string |
| required | subtype | string |
| required | activation_journey_type | string |
| required | supply_point | lifecycle-join_supplier-ActivatedSupplyPoint |
Metadata
| Event Type | Payload Version | lifecycle.join-supplier.activation.completed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | join_supplier_process_number | string |
| required | subtype | string |
| required | activation_journey_type | string |
| required | supply_point | lifecycle-join_supplier-ActivationInitiatedSupplyPoint |
Metadata
| Event Type | Payload Version | lifecycle.join-supplier.activation.initiated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | join_supplier_process_number | string |
| required | supply_point | lifecycle-join_supplier-ActivatedSupplyPoint |
| required | agreements | array[lifecycle-join_supplier-Agreement] |
| required | contract_references | lifecycle-join_supplier-ContractReferences |
Metadata
| Event Type | Payload Version | lifecycle.join-supplier.agreement.created | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | join_supplier_process_number | string |
| required | subtype | string |
Metadata
| Event Type | Payload Version | lifecycle.join-supplier.await-post-activation-flow-step.initiated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | join_supplier_process_number | string |
| required | subtype | string |
Metadata
| Event Type | Payload Version | lifecycle.join-supplier.await-pre-activation-flow-step.initiated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | join_supplier_process_number | string |
| required | subtype | string |
Metadata
| Event Type | Payload Version | lifecycle.join-supplier.await-pre-discovery-flow-step.initiated | v1 |
|---|
JSON Payload Representation
{
"account_number": "string",
"join_supplier_process_number": "string",
"subtype": "string"
}lifecycle.join-supplier.cancellation-requested-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | join_supplier_process_number | string |
| required | subtype | string |
| required | supply_points | array[lifecycle-join_supplier-SupplyPoint] |
Metadata
| Event Type | Payload Version | lifecycle.join-supplier.cancellation-requested | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | join_supplier_process_number | string |
| required | subtype | string |
| required | supply_points | array[lifecycle-join_supplier-SupplyPoint] |
Metadata
| Event Type | Payload Version | lifecycle.join-supplier.cancelled | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | join_supplier_process_number | string |
| required | subtype | string |
| required | supply_points | array[lifecycle-join_supplier-ActivatedSupplyPoint] |
Metadata
| Event Type | Payload Version | lifecycle.join-supplier.completed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | join_supplier_process_number | string |
| required | subtype | string |
| required | supply_points | array[lifecycle-join_supplier-SupplyPoint] |
| required | requested_at | string |
Metadata
| Event Type | Payload Version | lifecycle.join-supplier.requested | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | join_supplier_process_number | string |
| required | subtype | string |
| required | supply_points | array[lifecycle-join_supplier-SupplyPoint] |
Metadata
| Event Type | Payload Version | lifecycle.join-supplier.reversal-requested | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | join_supplier_process_number | string |
| required | subtype | string |
| required | supply_points | array[lifecycle-join_supplier-SupplyPoint] |
Metadata
| Event Type | Payload Version | lifecycle.join-supplier.reversed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | join_supplier_process_number | string |
| required | supply_point | lifecycle-join_supplier-ActivatedSupplyPoint |
| required | supply_period | lifecycle-join_supplier-SupplyPeriodData |
| required | contract_references | lifecycle-join_supplier-ContractReferences |
Metadata
| Event Type | Payload Version | lifecycle.join-supplier.supply-period.created | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | join_supplier_process_number | string |
| required | supply_point | lifecycle-join_supplier-ActivatedSupplyPoint |
| required | subtype | string |
Metadata
| Event Type | Payload Version | lifecycle.join-supplier.supply-point-journey-await-post-activation-flow-step.initiated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | join_supplier_process_number | string |
| required | supply_point | lifecycle-join_supplier-SupplyPoint |
| required | subtype | string |
Metadata
| Event Type | Payload Version | lifecycle.join-supplier.supply-point-journey-await-pre-activation-flow-step.initiated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | join_supplier_process_id | integer |
| required | join_supplier_process_number | string |
| required | account_number | string |
Metadata
| Event Type | Payload Version | lifecycle.join_supplier._ensure_payment_instructions.step_completed | v2 |
|---|
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
| Name | Type | |
|---|---|---|
| required | join_supplier_process_id | integer |
| required | join_supplier_process_number | string |
| required | account_number | string |
Metadata
| Event Type | Payload Version | lifecycle.join_supplier._ensure_payment_instructions.step_initiated | v2 |
|---|
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
| Name | Type | |
|---|---|---|
| required | join_supplier_process_id | integer |
| required | join_supplier_process_number | string |
Metadata
| Event Type | Payload Version | lifecycle.join_supplier.terms-and-conditions.accepted | v2 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | leave_supplier_process_number | string |
| required | subtype | string |
Metadata
| Event Type | Payload Version | lifecycle.leave-supplier.await-post-deactivation-flow-step.initiated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | leave_supplier_process_number | string |
| required | subtype | string |
Metadata
| Event Type | Payload Version | lifecycle.leave-supplier.await-post-termination-flow-step.initiated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | leave_supplier_process_number | string |
| required | subtype | string |
Metadata
| Event Type | Payload Version | lifecycle.leave-supplier.await-pre-termination-flow-step.initiated | v1 |
|---|
JSON Payload Representation
{
"account_number": "string",
"leave_supplier_process_number": "string",
"subtype": "string"
}lifecycle.leave-supplier.cancellation-requested-v2
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | leave_supplier_process_id | integer |
| required | leave_supplier_process_number | string |
| required | supply_points | array[lifecycle-leave_supplier-SupplyPoint] |
Metadata
| Event Type | Payload Version | lifecycle.leave-supplier.cancellation-requested | v2 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | leave_supplier_process_id | integer |
| required | leave_supplier_process_number | string |
| required | supply_points | array[lifecycle-leave_supplier-SupplyPoint] |
Metadata
| Event Type | Payload Version | lifecycle.leave-supplier.cancelled | v2 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | leave_supplier_process_id | integer |
| required | leave_supplier_process_number | string |
| required | leave_supplier_process_subtype | string |
| required | supply_points | array[lifecycle-leave_supplier-TerminatedSupplyPoint] |
Metadata
| Event Type | Payload Version | lifecycle.leave-supplier.completed | v3 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | leave_supplier_process_id | integer |
| required | leave_supplier_process_subtype | string |
| required | supply_points | array[lifecycle-leave_supplier-SupplyPoint] |
| required | requested_supply_end_at | string |
| required | requested_supply_end_date | string |
| required | requested_at | string |
| required | is_passive | boolean |
| passive_loss_instigated_supply_point_id | integer |
Metadata
| Event Type | Payload Version | lifecycle.leave-supplier.requested | v2 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | leave_supplier_process_id | integer |
| required | leave_supplier_process_number | string |
| required | leave_supplier_process_subtype | string |
| required | supply_points | array[lifecycle-leave_supplier-SupplyPoint] |
| required | requested_supply_end_at | string |
| required | requested_supply_end_date | string |
| required | requested_at | string |
| required | is_passive | boolean |
| passive_loss_instigated_supply_point_id | integer |
Metadata
| Event Type | Payload Version | lifecycle.leave-supplier.requested | v3 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | leave_supplier_process_id | integer |
| required | leave_supplier_process_number | string |
| required | supply_points | array[lifecycle-leave_supplier-SupplyPoint] |
Metadata
| Event Type | Payload Version | lifecycle.leave-supplier.reversal-requested | v2 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | leave_supplier_process_number | string |
| required | supply_point | lifecycle-leave_supplier-TerminatedSupplyPoint |
| required | subtype | string |
Metadata
| Event Type | Payload Version | lifecycle.leave-supplier.supply-point-journey-await-post-termination-flow-step.initiated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | leave_supplier_process_number | string |
| required | supply_point | lifecycle-leave_supplier-SupplyPoint |
| required | subtype | string |
Metadata
| Event Type | Payload Version | lifecycle.leave-supplier.supply-point-journey-await-pre-agreement-termination-flow-step.initiated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | leave_supplier_process_number | string |
| required | supply_point | lifecycle-leave_supplier-SupplyPoint |
| required | subtype | string |
Metadata
| Event Type | Payload Version | lifecycle.leave-supplier.supply-point-journey-await-pre-termination-flow-step.initiated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | leave_supplier_process_id | integer |
| required | leave_supplier_process_number | string |
| required | leave_supplier_process_subtype | string |
| required | supply_point | lifecycle-leave_supplier-TerminatedSupplyPoint |
Metadata
| Event Type | Payload Version | lifecycle.leave-supplier.termination.confirmed | v2 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | leave_supplier_process_number | string |
| required | leave_supplier_process_subtype | string |
| required | supply_point | lifecycle-leave_supplier-TerminationInitiatedSupplyPoint |
Metadata
| Event Type | Payload Version | lifecycle.leave-supplier.termination.initiated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | leave_supplier_process_id | integer |
| required | leave_supplier_process_subtype | string |
| required | supply_points | array[lifecycle-leave_supplier-SupplyPoint] |
| required | requested_supply_end_at | string |
| required | requested_supply_end_date | string |
| required | updated_at | string |
| required | is_passive | boolean |
| passive_loss_instigated_supply_point_id | integer |
Metadata
| Event Type | Payload Version | lifecycle.leave-supplier.updated | v2 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | leave_supplier_process_id | integer |
| required | leave_supplier_process_number | string |
| required | leave_supplier_process_subtype | string |
| required | supply_points | array[lifecycle-leave_supplier-SupplyPoint] |
| required | requested_supply_end_at | string |
| required | requested_supply_end_date | string |
| required | updated_at | string |
| required | is_passive | boolean |
| passive_loss_instigated_supply_point_id | integer |
Metadata
| Event Type | Payload Version | lifecycle.leave-supplier.updated | v3 |
|---|
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
| Name | Type | |
|---|---|---|
| required | process_number | string |
| required | account_number | string |
| required | new_status | string |
| required | previous_status | string |
Metadata
| Event Type | Payload Version | lifecycle.status-changed | v1 |
|---|
JSON Payload Representation
{
"process_number": "string",
"account_number": "string",
"new_status": "string",
"previous_status": "string"
}lifecycle.support-site.sale-1.0.0
Event Properties
| Name | Type | |
|---|---|---|
| required | support_user_id | string |
| required | supply_start_date | string |
| required | trigger_action | string |
Metadata
| Event Type | Payload Version | lifecycle.support-site.sale | 1.0.0 |
|---|
JSON Payload Representation
{
"support_user_id": "string",
"supply_start_date": "string",
"trigger_action": "string"
}loyalty-points.user-role-removal-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | user_id | integer |
| required | account_id | integer |
Metadata
| Event Type | Payload Version | loyalty-points.user-role-removal | v1 |
|---|
JSON Payload Representation
{
"user_id": "integer",
"account_id": "integer"
}market_supply-products-Product
Event Properties
| Name | Type | |
|---|---|---|
| required | code | string |
| required | market_name | string |
| required | brand_code | string |
JSON Payload Representation
{
"code": "string",
"market_name": "string",
"brand_code": "string"
}messaging.push-notification.token-unregistered-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | token | string |
| required | external_provider | string |
Metadata
| Event Type | Payload Version | messaging.push-notification.token-unregistered | v1 |
|---|
JSON Payload Representation
{
"token": "string",
"external_provider": "string"
}meter_data_quality.resolution_cancelled-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | issue_id | integer |
| required | issue_category | string |
| required | issue_subcategory | string |
| required | issue_status | string |
| required | market_supply_point_id | string |
| required | opened_at | string |
| required | period_start | string |
| required | period_end | string |
| required | reading_type | string |
| required | utility | string |
Metadata
| Event Type | Payload Version | meter_data_quality.resolution_cancelled | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | issue_id | integer |
| required | issue_category | string |
| required | issue_subcategory | string |
| required | issue_status | string |
| required | market_supply_point_id | string |
| required | opened_at | string |
| required | period_start | string |
| required | period_end | string |
| required | reading_type | string |
| required | utility | string |
| required | source | string |
Metadata
| Event Type | Payload Version | meter_data_quality.resolution_cancelled | v2 |
|---|
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
| Name | Type | |
|---|---|---|
| required | issue_id | integer |
| required | issue_category | string |
| required | issue_subcategory | string |
| required | issue_status | string |
| required | market_supply_point_id | string |
| required | opened_at | string |
| required | period_start | string |
| required | period_end | string |
| required | reading_type | string |
| required | utility | string |
Metadata
| Event Type | Payload Version | meter_data_quality.resolution_requested | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | serial_number | string |
| required | current_rating | integer |
| required | location | string |
| required | make_and_type | string |
| required | meter_asset_provider_mpid | string |
| required | meter_type | string |
| required | retrieval_method | string |
| required | retrieval_method_effective_from | string |
| required | meter_cop | string |
| required | meter_cop_dispensation | string |
| required | communications_address | string |
| required | communications_method | string |
| required | vt_ratio | string |
| required | installation_date | string |
| required | timing_device_id | string |
| required | is_tele_switch | boolean |
| required | ct_ratio | string |
| required | registers | array[meter_points-meter_details-Register] |
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
| Name | Type | |
|---|---|---|
| required | register_id | string |
| required | register_type | string |
| required | measurement_quantity | string |
| required | multiplier | string |
| required | digits | integer |
| required | is_main | boolean |
| required | associated_meter_serial | string |
| required | associated_register_id | string |
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
| Name | Type | |
|---|---|---|
| required | serial_number | string |
| required | date_of_removal | string |
| required | meter_asset_provider_mpid | string |
JSON Payload Representation
{
"serial_number": "string",
"date_of_removal": "string",
"meter_asset_provider_mpid": "string"
}meterpoint.elec.cos_gain.registration.requested-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | mpan | string |
| required | supply_start_date | string |
| required | supplier_mpid | string |
| required | account_number | string |
| required | is_internal_transfer | boolean |
| required | is_migrated | boolean |
| required | is_export | boolean |
Metadata
| Event Type | Payload Version | meterpoint.elec.cos_gain.registration.requested | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | supplier | string |
| required | supply_start_date | string |
| required | meter_reading_factor | string |
| required | nomination_shipper_ref | string |
| required | supply_end_date | string |
Metadata
| Event Type | Payload Version | meterpoint.gas.api_backfill | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | mam_to_appoint | string |
| required | force_appointment | boolean |
| required | owner | object |
| required | model | string |
| required | manufacturer | string |
| required | manufactured_year | integer |
| required | location | string |
| required | location_description | string |
| required | status | string |
| required | meter_type | string |
| required | meter_mechanism | string |
Metadata
| Event Type | Payload Version | meterpoint.gas.appoint_mam.requested | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | supplier | string |
| required | supply_start_date | string |
| required | sub_building_name | string |
| required | building_name | string |
| required | building_number | string |
| required | dependent_street | string |
| required | principal_street | string |
| required | double_dependent_locality | string |
| required | dependent_locality | string |
| required | post_town | string |
| required | county | string |
| required | postcode | string |
| required | meter_serial_number | string |
| required | meter_digits | integer |
| required | meter_mechanism | string |
| required | meter_is_imperial | boolean |
| required | meter_reading_factor | string |
| required | last_reading | string |
| required | last_reading_on | string |
| required | nomination_shipper_ref | string |
| required | cohort | string |
Metadata
| Event Type | Payload Version | meterpoint.gas.backfill | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | cohort | string |
Metadata
| Event Type | Payload Version | meterpoint.gas.change_of_cohort.requested | v1 |
|---|
JSON Payload Representation
{
"mprn": "string",
"cohort": "string"
}meterpoint.gas.change_of_mam.requested-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | mam_to_appoint | string |
| required | force_appointment | boolean |
| required | owner | object |
| required | model | string |
| required | manufacturer | string |
| required | manufactured_year | integer |
| required | location | string |
| required | location_description | string |
| required | status | string |
| required | meter_type | string |
| required | meter_mechanism | string |
| required | effective_from_date | string |
| required | current_mam | string |
Metadata
| Event Type | Payload Version | meterpoint.gas.change_of_mam.requested | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | building_name | string |
| required | building_number | integer |
| required | dependent_street | string |
| required | principle_street | string |
| required | dependent_locality | string |
| required | post_town | string |
| required | county | string |
| required | meter_serial_number | string |
| required | meter_digits | integer |
| required | meter_mechanism | string |
| required | meter_type | string |
| required | meter_is_imperial | boolean |
| required | meter_reading_factor | integer |
| meter_link_code | string | |
| required | owner | string |
| required | model | string |
| required | manufacturer | string |
| required | manufactured_year | integer |
| required | location | string |
| required | location_description | string |
| required | instructions | string |
| required | status | string |
| required | pulse_value | number |
| required | correction_factor | number |
| required | bypass_fitted | boolean |
| required | collar_fitted | boolean |
| required | last_inspection_on | string |
| required | last_reading | integer |
| required | last_reading_on | string |
Metadata
| Event Type | Payload Version | meterpoint.gas.cos_gain.mtd_received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | previous_mam | string |
| required | is_domestic | boolean |
| required | is_igt_mam | boolean |
Metadata
| Event Type | Payload Version | meterpoint.gas.cos_gain.registration.confirmed | v1 |
|---|
JSON Payload Representation
{
"mprn": "string",
"previous_mam": "string",
"is_domestic": "boolean",
"is_igt_mam": "boolean"
}meterpoint.gas.cos_gain.registration.requested-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | supply_start_date | string |
| required | supplier_mpid | string |
| required | account_number | string |
Metadata
| Event Type | Payload Version | meterpoint.gas.cos_gain.registration.requested | v1 |
|---|
JSON Payload Representation
{
"mprn": "string",
"supply_start_date": "string",
"supplier_mpid": "string",
"account_number": "string"
}meterpoint.gas.cos_loss.confirmed-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_id | integer |
| required | mprn | string |
| required | supply_end_date | string |
| required | meter_exists | boolean |
| required | meter_serial_number | string |
| required | meter_digits | integer |
| required | meter_mechanism | string |
| required | meter_imperial_metric_indicator | string |
| required | meter_reading_factor | number |
| required | new_supplier | string |
Metadata
| Event Type | Payload Version | meterpoint.gas.cos_loss.confirmed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | mam_to_deappoint | string |
| required | effective_to_date | string |
| required | is_cos_loss | boolean |
| required | new_supplier | string |
| required | current_mam | string |
Metadata
| Event Type | Payload Version | meterpoint.gas.deappoint_mam.requested | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | supplier | string |
| required | reference_number | integer |
| required | transfer_date | string |
| required | initiating_organisation | string |
| required | io_contact_name | string |
| required | recipient_organisation | string |
| required | ro_contact_name | string |
| required | meter_serial | string |
| required | meter_digits | integer |
| required | house_name_number | string |
| required | postcode | string |
| required | disputed_reading | integer |
| required | disputed_reading_is_actual | boolean |
| required | proposed_reading | integer |
| required | proposed_reading_is_actual | boolean |
| required | status_response | string |
| required | root_cause | string |
| required | rejection_acceptance_code | string |
| required | criteria | string |
| required | comments | string |
| required | is_gain | boolean |
Metadata
| Event Type | Payload Version | meterpoint.gas.disputed_closing_reading.accepted.by_us | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | supplier | string |
| required | reference_number | integer |
| required | transfer_date | string |
| required | initiating_organisation | string |
| required | io_contact_name | string |
| required | recipient_organisation | string |
| required | ro_contact_name | string |
| required | meter_serial | string |
| required | meter_digits | integer |
| required | house_name_number | string |
| required | postcode | string |
| required | disputed_reading | integer |
| required | disputed_reading_is_actual | boolean |
| required | proposed_reading | integer |
| required | proposed_reading_is_actual | boolean |
| required | status_response | string |
| required | root_cause | string |
| required | rejection_acceptance_code | string |
| required | criteria | string |
| required | comments | string |
| required | is_gain | boolean |
Metadata
| Event Type | Payload Version | meterpoint.gas.disputed_closing_reading.accepted.other_supplier | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | supplier | string |
| required | reference_number | integer |
| required | transfer_date | string |
| required | initiating_organisation | string |
| required | io_contact_name | string |
| required | recipient_organisation | string |
| required | ro_contact_name | string |
| required | meter_serial | string |
| required | meter_digits | integer |
| required | house_name_number | string |
| required | postcode | string |
| required | disputed_reading | integer |
| required | disputed_reading_is_actual | boolean |
| required | proposed_reading | integer |
| required | proposed_reading_is_actual | boolean |
| required | status_response | string |
| required | root_cause | string |
| required | rejection_acceptance_code | string |
| required | criteria | string |
| required | comments | string |
| required | is_gain | boolean |
Metadata
| Event Type | Payload Version | meterpoint.gas.disputed_closing_reading.alternative_proposed.by_us | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | supplier | string |
| required | reference_number | integer |
| required | transfer_date | string |
| required | initiating_organisation | string |
| required | io_contact_name | string |
| required | recipient_organisation | string |
| required | ro_contact_name | string |
| required | meter_serial | string |
| required | meter_digits | integer |
| required | house_name_number | string |
| required | postcode | string |
| required | disputed_reading | integer |
| required | disputed_reading_is_actual | boolean |
| required | proposed_reading | integer |
| required | proposed_reading_is_actual | boolean |
| required | status_response | string |
| required | root_cause | string |
| required | rejection_acceptance_code | string |
| required | criteria | string |
| required | comments | string |
| required | is_gain | boolean |
Metadata
| Event Type | Payload Version | meterpoint.gas.disputed_closing_reading.alternative_proposed.other_supplier | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | supplier | string |
| required | reference_number | integer |
| required | transfer_date | string |
| required | initiating_organisation | string |
| required | io_contact_name | string |
| required | recipient_organisation | string |
| required | ro_contact_name | string |
| required | meter_serial | string |
| required | meter_digits | integer |
| required | house_name_number | string |
| required | postcode | string |
| required | disputed_reading | integer |
| required | disputed_reading_is_actual | boolean |
| required | proposed_reading | integer |
| required | proposed_reading_is_actual | boolean |
| required | status_response | string |
| required | root_cause | string |
| required | rejection_acceptance_code | string |
| required | criteria | string |
| required | comments | string |
| required | is_gain | boolean |
Metadata
| Event Type | Payload Version | meterpoint.gas.disputed_closing_reading.queried.by_us | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | supplier | string |
| required | reference_number | integer |
| required | transfer_date | string |
| required | initiating_organisation | string |
| required | io_contact_name | string |
| required | recipient_organisation | string |
| required | ro_contact_name | string |
| required | meter_serial | string |
| required | meter_digits | integer |
| required | house_name_number | string |
| required | postcode | string |
| required | disputed_reading | integer |
| required | disputed_reading_is_actual | boolean |
| required | proposed_reading | integer |
| required | proposed_reading_is_actual | boolean |
| required | status_response | string |
| required | root_cause | string |
| required | rejection_acceptance_code | string |
| required | criteria | string |
| required | comments | string |
| required | is_gain | boolean |
Metadata
| Event Type | Payload Version | meterpoint.gas.disputed_closing_reading.started.by_us | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | supplier | string |
| required | reference_number | integer |
| required | transfer_date | string |
| required | initiating_organisation | string |
| required | io_contact_name | string |
| required | recipient_organisation | string |
| required | ro_contact_name | string |
| required | meter_serial | string |
| required | meter_digits | integer |
| required | house_name_number | string |
| required | postcode | string |
| required | disputed_reading | integer |
| required | disputed_reading_is_actual | boolean |
| required | proposed_reading | integer |
| required | proposed_reading_is_actual | boolean |
| required | status_response | string |
| required | root_cause | string |
| required | rejection_acceptance_code | string |
| required | criteria | string |
| required | comments | string |
| required | is_gain | boolean |
Metadata
| Event Type | Payload Version | meterpoint.gas.disputed_closing_reading.started.other_supplier | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | supplier | string |
| required | reference_number | integer |
| required | transfer_date | string |
| required | initiating_organisation | string |
| required | io_contact_name | string |
| required | recipient_organisation | string |
| required | ro_contact_name | string |
| required | meter_serial | string |
| required | meter_digits | integer |
| required | house_name_number | string |
| required | postcode | string |
| required | disputed_reading | integer |
| required | disputed_reading_is_actual | boolean |
| required | proposed_reading | integer |
| required | proposed_reading_is_actual | boolean |
| required | status_response | string |
| required | root_cause | string |
| required | rejection_acceptance_code | string |
| required | criteria | string |
| required | comments | string |
| required | is_gain | boolean |
Metadata
| Event Type | Payload Version | meterpoint.gas.disputed_opening_reading.accepted.by_us | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | supplier | string |
| required | reference_number | integer |
| required | transfer_date | string |
| required | initiating_organisation | string |
| required | io_contact_name | string |
| required | recipient_organisation | string |
| required | ro_contact_name | string |
| required | meter_serial | string |
| required | meter_digits | integer |
| required | house_name_number | string |
| required | postcode | string |
| required | disputed_reading | integer |
| required | disputed_reading_is_actual | boolean |
| required | proposed_reading | integer |
| required | proposed_reading_is_actual | boolean |
| required | status_response | string |
| required | root_cause | string |
| required | rejection_acceptance_code | string |
| required | criteria | string |
| required | comments | string |
| required | is_gain | boolean |
Metadata
| Event Type | Payload Version | meterpoint.gas.disputed_opening_reading.accepted.other_supplier | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | supplier | string |
| required | reference_number | integer |
| required | transfer_date | string |
| required | initiating_organisation | string |
| required | io_contact_name | string |
| required | recipient_organisation | string |
| required | ro_contact_name | string |
| required | meter_serial | string |
| required | meter_digits | integer |
| required | house_name_number | string |
| required | postcode | string |
| required | disputed_reading | integer |
| required | disputed_reading_is_actual | boolean |
| required | proposed_reading | integer |
| required | proposed_reading_is_actual | boolean |
| required | status_response | string |
| required | root_cause | string |
| required | rejection_acceptance_code | string |
| required | criteria | string |
| required | comments | string |
| required | is_gain | boolean |
Metadata
| Event Type | Payload Version | meterpoint.gas.disputed_opening_reading.alternative_proposed.by_us | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | supplier | string |
| required | reference_number | integer |
| required | transfer_date | string |
| required | initiating_organisation | string |
| required | io_contact_name | string |
| required | recipient_organisation | string |
| required | ro_contact_name | string |
| required | meter_serial | string |
| required | meter_digits | integer |
| required | house_name_number | string |
| required | postcode | string |
| required | disputed_reading | integer |
| required | disputed_reading_is_actual | boolean |
| required | proposed_reading | integer |
| required | proposed_reading_is_actual | boolean |
| required | status_response | string |
| required | root_cause | string |
| required | rejection_acceptance_code | string |
| required | criteria | string |
| required | comments | string |
| required | is_gain | boolean |
Metadata
| Event Type | Payload Version | meterpoint.gas.disputed_opening_reading.alternative_proposed.other_supplier | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | supplier | string |
| required | reference_number | integer |
| required | transfer_date | string |
| required | initiating_organisation | string |
| required | io_contact_name | string |
| required | recipient_organisation | string |
| required | ro_contact_name | string |
| required | meter_serial | string |
| required | meter_digits | integer |
| required | house_name_number | string |
| required | postcode | string |
| required | disputed_reading | integer |
| required | disputed_reading_is_actual | boolean |
| required | proposed_reading | integer |
| required | proposed_reading_is_actual | boolean |
| required | status_response | string |
| required | root_cause | string |
| required | rejection_acceptance_code | string |
| required | criteria | string |
| required | comments | string |
| required | is_gain | boolean |
Metadata
| Event Type | Payload Version | meterpoint.gas.disputed_opening_reading.queried.by_us | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | supplier | string |
| required | reference_number | integer |
| required | transfer_date | string |
| required | initiating_organisation | string |
| required | io_contact_name | string |
| required | recipient_organisation | string |
| required | ro_contact_name | string |
| required | meter_serial | string |
| required | meter_digits | integer |
| required | house_name_number | string |
| required | postcode | string |
| required | disputed_reading | integer |
| required | disputed_reading_is_actual | boolean |
| required | proposed_reading | integer |
| required | proposed_reading_is_actual | boolean |
| required | status_response | string |
| required | root_cause | string |
| required | rejection_acceptance_code | string |
| required | criteria | string |
| required | comments | string |
| required | is_gain | boolean |
Metadata
| Event Type | Payload Version | meterpoint.gas.disputed_opening_reading.started.by_us | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | supplier | string |
| required | reference_number | integer |
| required | transfer_date | string |
| required | initiating_organisation | string |
| required | io_contact_name | string |
| required | recipient_organisation | string |
| required | ro_contact_name | string |
| required | meter_serial | string |
| required | meter_digits | integer |
| required | house_name_number | string |
| required | postcode | string |
| required | disputed_reading | integer |
| required | disputed_reading_is_actual | boolean |
| required | proposed_reading | integer |
| required | proposed_reading_is_actual | boolean |
| required | status_response | string |
| required | root_cause | string |
| required | rejection_acceptance_code | string |
| required | criteria | string |
| required | comments | string |
| required | is_gain | boolean |
Metadata
| Event Type | Payload Version | meterpoint.gas.disputed_opening_reading.started.other_supplier | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | supplier | string |
| required | reference_number | integer |
| required | transfer_date | string |
| required | sub_building_name | string |
| required | building_name | string |
| required | building_number | string |
| required | deliver_point_alias | string |
| required | street_name | string |
| required | postcode | string |
| required | initial_contact_date | string |
| required | initiating_organisation | string |
| required | io_contact_name | string |
| required | responding_organisation | string |
| required | ro_contact_name | string |
| required | status_response | string |
| required | rejection_acceptance_code | string |
| required | reason_for_return | string |
| required | comments | string |
| required | customer_name | string |
| required | other_supplier | string |
| required | contact_name | string |
Metadata
| Event Type | Payload Version | meterpoint.gas.et_gain.accepted.by_other_supplier | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | supplier | string |
| required | reference_number | integer |
| required | transfer_date | string |
| required | sub_building_name | string |
| required | building_name | string |
| required | building_number | string |
| required | deliver_point_alias | string |
| required | street_name | string |
| required | postcode | string |
| required | initial_contact_date | string |
| required | initiating_organisation | string |
| required | io_contact_name | string |
| required | responding_organisation | string |
| required | ro_contact_name | string |
| required | status_response | string |
| required | rejection_acceptance_code | string |
| required | reason_for_return | string |
| required | comments | string |
| required | customer_name | string |
| required | other_supplier | string |
| required | contact_name | string |
Metadata
| Event Type | Payload Version | meterpoint.gas.et_gain.accepted.by_us | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | supplier | string |
| required | reference_number | integer |
| required | transfer_date | string |
| required | sub_building_name | string |
| required | building_name | string |
| required | building_number | string |
| required | deliver_point_alias | string |
| required | street_name | string |
| required | postcode | string |
| required | initial_contact_date | string |
| required | initiating_organisation | string |
| required | io_contact_name | string |
| required | responding_organisation | string |
| required | ro_contact_name | string |
| required | status_response | string |
| required | rejection_acceptance_code | string |
| required | reason_for_return | string |
| required | comments | string |
| required | customer_name | string |
| required | other_supplier | string |
| required | contact_name | string |
Metadata
| Event Type | Payload Version | meterpoint.gas.et_gain.rejected.by_other_supplier | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | supplier | string |
| required | reference_number | integer |
| required | transfer_date | string |
| required | sub_building_name | string |
| required | building_name | string |
| required | building_number | string |
| required | deliver_point_alias | string |
| required | street_name | string |
| required | postcode | string |
| required | initial_contact_date | string |
| required | initiating_organisation | string |
| required | io_contact_name | string |
| required | responding_organisation | string |
| required | ro_contact_name | string |
| required | status_response | string |
| required | rejection_acceptance_code | string |
| required | reason_for_return | string |
| required | comments | string |
| required | customer_name | string |
| required | other_supplier | string |
| required | contact_name | string |
Metadata
| Event Type | Payload Version | meterpoint.gas.et_gain.rejected.by_us | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | supplier | string |
| required | reference_number | integer |
| required | transfer_date | string |
| required | sub_building_name | string |
| required | building_name | string |
| required | building_number | string |
| required | deliver_point_alias | string |
| required | street_name | string |
| required | postcode | string |
| required | initial_contact_date | string |
| required | initiating_organisation | string |
| required | io_contact_name | string |
| required | responding_organisation | string |
| required | ro_contact_name | string |
| required | status_response | string |
| required | rejection_acceptance_code | string |
| required | reason_for_return | string |
| required | comments | string |
| required | customer_name | string |
| required | other_supplier | string |
| required | contact_name | string |
Metadata
| Event Type | Payload Version | meterpoint.gas.et_gain.started.by_other_supplier | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | supplier | string |
| required | reference_number | integer |
| required | transfer_date | string |
| required | sub_building_name | string |
| required | building_name | string |
| required | building_number | string |
| required | deliver_point_alias | string |
| required | street_name | string |
| required | postcode | string |
| required | initial_contact_date | string |
| required | initiating_organisation | string |
| required | io_contact_name | string |
| required | responding_organisation | string |
| required | ro_contact_name | string |
| required | status_response | string |
| required | rejection_acceptance_code | string |
| required | reason_for_return | string |
| required | comments | string |
| required | customer_name | string |
| required | other_supplier | string |
| required | contact_name | string |
Metadata
| Event Type | Payload Version | meterpoint.gas.et_gain.started.by_us | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | supplier | string |
| required | reference_number | integer |
| required | transfer_date | string |
| required | sub_building_name | string |
| required | building_name | string |
| required | building_number | string |
| required | deliver_point_alias | string |
| required | street_name | string |
| required | postcode | string |
| required | initial_contact_date | string |
| required | initiating_organisation | string |
| required | io_contact_name | string |
| required | responding_organisation | string |
| required | ro_contact_name | string |
| required | status_response | string |
| required | rejection_acceptance_code | string |
| required | reason_for_return | string |
| required | comments | string |
| required | customer_name | string |
| required | other_supplier | string |
| required | contact_name | string |
Metadata
| Event Type | Payload Version | meterpoint.gas.et_loss.accepted.by_other_supplier | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | supplier | string |
| required | reference_number | integer |
| required | transfer_date | string |
| required | sub_building_name | string |
| required | building_name | string |
| required | building_number | string |
| required | deliver_point_alias | string |
| required | street_name | string |
| required | postcode | string |
| required | initial_contact_date | string |
| required | initiating_organisation | string |
| required | io_contact_name | string |
| required | responding_organisation | string |
| required | ro_contact_name | string |
| required | status_response | string |
| required | rejection_acceptance_code | string |
| required | reason_for_return | string |
| required | comments | string |
| required | customer_name | string |
| required | other_supplier | string |
| required | contact_name | string |
Metadata
| Event Type | Payload Version | meterpoint.gas.et_loss.accepted.by_us | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | supplier | string |
| required | reference_number | integer |
| required | transfer_date | string |
| required | sub_building_name | string |
| required | building_name | string |
| required | building_number | string |
| required | deliver_point_alias | string |
| required | street_name | string |
| required | postcode | string |
| required | initial_contact_date | string |
| required | initiating_organisation | string |
| required | io_contact_name | string |
| required | responding_organisation | string |
| required | ro_contact_name | string |
| required | status_response | string |
| required | rejection_acceptance_code | string |
| required | reason_for_return | string |
| required | comments | string |
| required | customer_name | string |
| required | other_supplier | string |
| required | contact_name | string |
Metadata
| Event Type | Payload Version | meterpoint.gas.et_loss.rejected.by_other_supplier | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | supplier | string |
| required | reference_number | integer |
| required | transfer_date | string |
| required | sub_building_name | string |
| required | building_name | string |
| required | building_number | string |
| required | deliver_point_alias | string |
| required | street_name | string |
| required | postcode | string |
| required | initial_contact_date | string |
| required | initiating_organisation | string |
| required | io_contact_name | string |
| required | responding_organisation | string |
| required | ro_contact_name | string |
| required | status_response | string |
| required | rejection_acceptance_code | string |
| required | reason_for_return | string |
| required | comments | string |
| required | customer_name | string |
| required | other_supplier | string |
| required | contact_name | string |
Metadata
| Event Type | Payload Version | meterpoint.gas.et_loss.rejected.by_us | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | supplier | string |
| required | reference_number | integer |
| required | transfer_date | string |
| required | sub_building_name | string |
| required | building_name | string |
| required | building_number | string |
| required | deliver_point_alias | string |
| required | street_name | string |
| required | postcode | string |
| required | initial_contact_date | string |
| required | initiating_organisation | string |
| required | io_contact_name | string |
| required | responding_organisation | string |
| required | ro_contact_name | string |
| required | status_response | string |
| required | rejection_acceptance_code | string |
| required | reason_for_return | string |
| required | comments | string |
| required | customer_name | string |
| required | other_supplier | string |
| required | contact_name | string |
Metadata
| Event Type | Payload Version | meterpoint.gas.et_loss.started.by_other_supplier | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | supplier | string |
| required | reference_number | integer |
| required | transfer_date | string |
| required | sub_building_name | string |
| required | building_name | string |
| required | building_number | string |
| required | deliver_point_alias | string |
| required | street_name | string |
| required | postcode | string |
| required | initial_contact_date | string |
| required | initiating_organisation | string |
| required | io_contact_name | string |
| required | responding_organisation | string |
| required | ro_contact_name | string |
| required | status_response | string |
| required | rejection_acceptance_code | string |
| required | reason_for_return | string |
| required | comments | string |
| required | customer_name | string |
| required | other_supplier | string |
| required | contact_name | string |
Metadata
| Event Type | Payload Version | meterpoint.gas.et_loss.started.by_us | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | transaction_reference | string |
| required | transaction_status | string |
| required | market_sector | string |
| required | transaction_type | string |
| required | meter_link | string |
| required | address_type | string |
| required | asset_transaction_type | string |
| required | asset_class | string |
| required | num_dials_or_digits | integer |
| required | units_of_measure | string |
| required | meter_type | string |
| required | mechanism | string |
| required | reading_value | string |
| required | contract_reference | string |
| required | transaction_comment | string |
| required | transaction_type_reason | string |
| required | cross_ref_other_internal_job_reference | string |
| required | cross_ref_other_external_job_reference | string |
| required | transaction_status_change_reason | string |
| required | date_of_notice | string |
| required | registration_body | string |
| required | registration_reference | string |
| required | effective_from_date | string |
| required | effective_to_date | string |
| required | meter_point_status | string |
| required | meter_point_data_update | string |
| required | meter_point_location | string |
| required | meter_point_location_notes | string |
| required | access_instructions | string |
| required | meter_point_conversion_factor | number |
| required | last_inspection_date | string |
| required | metering_pressure | number |
| required | address_notes | string |
| required | sub_building_name_number | string |
| required | building_name_number | string |
| required | dependent_thoroughfare | string |
| required | thoroughfare | string |
| required | double_dependent_locality | string |
| required | dependent_locality | string |
| required | post_town | string |
| required | county | string |
| required | post_code | string |
| required | grid_coord_x | integer |
| required | grid_coord_y | integer |
| required | grid_coord_z | integer |
| required | unique_property_reference_number | string |
| required | asset_data_update | string |
| required | product_id | string |
| required | payment_method | string |
| required | model_code | string |
| required | manufacturer_code | string |
| required | year_of_manufacture | integer |
| required | serial_number | string |
| required | asset_location | string |
| required | asset_location_notes | string |
| required | asset_status | string |
| required | appointment_date_qualifier | string |
| required | appointment_date_from | string |
| required | appointment_date_to | string |
| required | appointment_time_qualifier | string |
| required | appointment_time_from | string |
| required | appointment_time_to | string |
| required | register_type | string |
| required | register_data_update | string |
| required | multiplication_factor | number |
| required | converter_data_update | string |
| required | conversion_basis | string |
| required | converter_conversion_factor | number |
| required | meter_data_update | string |
| required | measuring_capacity | number |
| required | meter_usage | string |
| required | collar_status | string |
| required | oami_inspection_date | string |
| required | meter_role | string |
| required | market_participant_role | string |
| required | last_refurbished_date | string |
| required | pulse_value | number |
| required | reading_date | string |
| required | round_the_clock | integer |
Metadata
| Event Type | Payload Version | meterpoint.gas.meter-technical-details.update.requested | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | meter_serial_number | string |
| required | meter_digits | integer |
| required | meter_mechanism | string |
| required | meter_is_imperial | boolean |
| required | meter_reading_factor | number |
Metadata
| Event Type | Payload Version | meterpoint.gas.meter_exchanged | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mprn | string |
| required | reading | integer |
| required | date | string |
| required | meter_digits | integer |
| required | meter_serial_number | string |
Metadata
| Event Type | Payload Version | meterpoint.gas.reading | v1 |
|---|
JSON Payload Representation
{
"mprn": "string",
"reading": "integer",
"date": "string",
"meter_digits": "integer",
"meter_serial_number": "string"
}meterpoint.reading.gap.filled-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | meter_point_identifier | string |
| required | start_at | string |
| required | end_at | string |
| device_id | string | |
| register_id | string | |
| direction | string | |
| supply_type | string | |
| meter_reading_type | string | |
| extras | object | |
| store_full_series | boolean |
Metadata
| Event Type | Payload Version | meterpoint.reading.gap.filled | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | meter_point_identifier | string |
| required | start_at | string |
| required | end_at | string |
| device_id | string | |
| register_id | string | |
| direction | string | |
| supply_type | string | |
| meter_reading_type | string | |
| extras | object | |
| store_full_series | boolean |
Metadata
| Event Type | Payload Version | meterpoint.reading.gap.filling.failed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | meter_point_identifier | string |
| required | start_at | string |
| required | end_at | string |
| device_id | string | |
| register_id | string | |
| direction | string | |
| supply_type | string | |
| meter_reading_type | string | |
| extras | object | |
| store_full_series | boolean |
Metadata
| Event Type | Payload Version | meterpoint.reading.gap.found | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | market_type | string |
| required | reading_type | string |
| required | interval_start | string |
| required | interval_end | string |
| required | value | string |
| required | units | string |
| required | direction | string |
| required | market_supply_point_id | string |
| device_id | string | |
| register_id | string | |
| quality | string | |
| required | source | string |
| market | string |
Metadata
| Event Type | Payload Version | meterpoint.reading.manual_import_requested | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | meter_point_identifier | string |
| required | start_at | string |
| required | end_at | string |
| device_id | string | |
| register_id | string | |
| direction | string | |
| supply_type | string | |
| meter_reading_type | string | |
| extras | object | |
| store_full_series | boolean |
Metadata
| Event Type | Payload Version | meterpoint.reading.missing.filled | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | meter_point_identifier | string |
| required | start_at | string |
| required | end_at | string |
| device_id | string | |
| register_id | string | |
| direction | string | |
| supply_type | string | |
| meter_reading_type | string | |
| extras | object | |
| store_full_series | boolean |
Metadata
| Event Type | Payload Version | meterpoint.reading.missing.filling.failed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | meter_point_identifier | string |
| required | start_at | string |
| required | end_at | string |
| device_id | string | |
| register_id | string | |
| direction | string | |
| supply_type | string | |
| meter_reading_type | string | |
| extras | object | |
| store_full_series | boolean |
Metadata
| Event Type | Payload Version | meterpoint.reading.missing.found | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | id | string |
| required | request_id | string |
| required | status | string |
| required | agent | string |
| required | kraken_work_category | string |
| required | external_job_type | string |
| required | appointed_agent | string |
Metadata
| Event Type | Payload Version | on_site_jobs.appointment.agent_does_not_match_appointed_agent | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | id | string |
| required | request_id | string |
| required | status | string |
| required | agent | string |
| required | kraken_work_category | string |
| required | external_job_type | string |
| required | previous_status | string |
Metadata
| Event Type | Payload Version | on_site_jobs.appointment.booked | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | id | string |
| required | request_id | string |
| required | status | string |
| required | agent | string |
| required | kraken_work_category | string |
| required | external_job_type | string |
| required | previous_status | string |
Metadata
| Event Type | Payload Version | on_site_jobs.appointment.cancelled | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | id | string |
| required | request_id | string |
| required | status | string |
| required | agent | string |
| required | kraken_work_category | string |
| required | external_job_type | string |
| required | previous_status | string |
Metadata
| Event Type | Payload Version | on_site_jobs.appointment.completed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | id | string |
| required | request_id | string |
| required | status | string |
| required | agent | string |
| required | kraken_work_category | string |
| required | external_job_type | string |
| required | affected_job_notes_keys | array[string] |
Metadata
| Event Type | Payload Version | on_site_jobs.appointment.job_notes_updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | id | string |
| required | request_id | string |
| required | agent | string |
| required | kraken_work_category | string |
| required | external_job_type | string |
| required | responsible_user_id | string |
| required | previous_responsible_user_id | string |
| required | assigned_by | string |
Metadata
| Event Type | Payload Version | on_site_jobs.draft_appointment.assigned | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | id | string |
| required | request_id | string |
| required | agent | string |
| required | kraken_work_category | string |
| required | external_job_type | string |
Metadata
| Event Type | Payload Version | on_site_jobs.draft_appointment.created | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | id | string |
| required | request_id | string |
| required | agent | string |
| required | kraken_work_category | string |
| required | external_job_type | string |
| required | escalated_by | string |
Metadata
| Event Type | Payload Version | on_site_jobs.draft_appointment.escalated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | id | string |
| required | status | string |
| required | reason | string |
| required | sub_reason | string |
| required | is_emergency | boolean |
| required | agent | string |
| required | previous_status | string |
Metadata
| Event Type | Payload Version | on_site_jobs.request.appointment_failed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | id | string |
| required | status | string |
| required | reason | string |
| required | sub_reason | string |
| required | is_emergency | boolean |
| required | agent | string |
| required | previous_status | string |
Metadata
| Event Type | Payload Version | on_site_jobs.request.approval_approved | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | id | string |
| required | status | string |
| required | reason | string |
| required | sub_reason | string |
| required | is_emergency | boolean |
| required | agent | string |
| required | previous_status | string |
Metadata
| Event Type | Payload Version | on_site_jobs.request.approval_rejected | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | id | string |
| required | status | string |
| required | reason | string |
| required | sub_reason | string |
| required | is_emergency | boolean |
| required | agent | string |
| required | previous_status | string |
Metadata
| Event Type | Payload Version | on_site_jobs.request.completed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | id | string |
| required | status | string |
| required | reason | string |
| required | sub_reason | string |
| required | is_emergency | boolean |
| required | agent | string |
| required | previous_status | string |
Metadata
| Event Type | Payload Version | on_site_jobs.request.created | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | complaint_id | string |
| required | event_type | string |
Metadata
| Event Type | Payload Version | on_site_jobs.vendor_complaint.event_created | v1 |
|---|
JSON Payload Representation
{
"complaint_id": "string",
"event_type": "string"
}partner_access.granted-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | allocation_id | integer |
| required | target_reference | string |
| required | target_type | string |
| required | role_id | integer |
| required | start_at | string |
| required | end_at | string |
| required | partner_reference | string |
Metadata
| Event Type | Payload Version | partner_access.granted | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | allocation_id | integer |
| required | target_reference | string |
| required | target_type | string |
| required | role_id | integer |
| required | start_at | string |
| required | end_at | string |
| required | partner_reference | string |
Metadata
| Event Type | Payload Version | partner_access.revoked | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | allocation_id | integer |
| required | target_reference | string |
| required | target_type | string |
| required | role_id | integer |
| required | start_at | string |
| required | end_at | string |
| required | partner_reference | string |
Metadata
| Event Type | Payload Version | partner_access.updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | partner_user_id | integer |
| required | partner_user_number | string |
| required | partner_user_email | string |
| required | partner_organisation_number | string |
Metadata
| Event Type | Payload Version | partner_user.created | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | partner_user_id | integer |
| required | partner_user_number | string |
| required | partner_user_email | string |
| required | partner_organisation_number | string |
Metadata
| Event Type | Payload Version | partner_user.removed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | partner_user_id | integer |
| required | partner_user_number | string |
| required | partner_user_email | string |
| required | partner_organisation_number | string |
| required | changes | object |
Metadata
| Event Type | Payload Version | partner_user.updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | allocation_id | integer |
| required | target_reference | string |
| required | target_type | string |
| required | role_id | integer |
| required | start_at | string |
| required | end_at | string |
| required | partner_user_reference | string |
Metadata
| Event Type | Payload Version | partner_user_access.granted | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | allocation_id | integer |
| required | target_reference | string |
| required | target_type | string |
| required | role_id | integer |
| required | start_at | string |
| required | end_at | string |
| required | partner_user_reference | string |
Metadata
| Event Type | Payload Version | partner_user_access.revoked | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | group_reference | string |
| required | actioned_at | string |
Metadata
| Event Type | Payload Version | payment-group.actioned | v1 |
|---|
JSON Payload Representation
{
"id": "integer",
"group_reference": "string",
"actioned_at": "string"
}payment-group.closed-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | group_reference | string |
| required | potential_value | integer |
| required | closed_at | string |
Metadata
| Event Type | Payload Version | payment-group.closed | v1 |
|---|
JSON Payload Representation
{
"id": "integer",
"group_reference": "string",
"potential_value": "integer",
"closed_at": "string"
}payment-group.completed-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | group_reference | string |
| required | potential_value | integer |
| required | cleared_value | integer |
| required | failed_value | integer |
| required | completed_at | string |
Metadata
| Event Type | Payload Version | payment-group.completed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | external_identifier | string |
| required | amount | integer |
| required | ledger | cashflow-_payments-Ledger |
| required | description | string |
| required | payment_date | string |
Metadata
| Event Type | Payload Version | payment.cancelled | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | amount | integer |
| required | ledger | cashflow-_payments-Ledger |
| required | payment_reason | string |
| required | payment_type | string |
Metadata
| Event Type | Payload Version | payment.cleared | v1 |
|---|
JSON Payload Representation
{
"id": "integer",
"amount": "integer",
"ledger": {
"account": {
"number": "string"
},
"id": "string"
},
"payment_reason": "string",
"payment_type": "string"
}payment.failed-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | amount | integer |
| required | ledger | cashflow-_payments-Ledger |
| required | failure_reason | string |
| required | description | string |
| required | payment_date | string |
Metadata
| Event Type | Payload Version | payment.failed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | amount | integer |
| required | ledger | cashflow-_payments-Ledger |
| required | failure_reason | string |
| required | description | string |
| required | payment_date | string |
Metadata
| Event Type | Payload Version | payment.failed_late | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | amount | integer |
| required | ledger | cashflow-_payments-Ledger |
Metadata
| Event Type | Payload Version | payment.pending | v1 |
|---|
JSON Payload Representation
{
"id": "integer",
"amount": "integer",
"ledger": {
"account": {
"number": "string"
},
"id": "string"
}
}payment.re_presented-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | failed_payment | cashflow-_payments-Payment |
| required | new_payment | cashflow-_payments-Payment |
| required | ledger | cashflow-_payments-Ledger |
Metadata
| Event Type | Payload Version | payment.re_presented | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | uuid | string |
| required | amount | integer |
| required | ledger | cashflow-_payments-Ledger |
Metadata
| Event Type | Payload Version | payment.requested | v1 |
|---|
JSON Payload Representation
{
"id": "integer",
"uuid": "string",
"amount": "integer",
"ledger": {
"account": {
"number": "string"
},
"id": "string"
}
}payment.scheduled-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | amount | integer |
| required | ledger | cashflow-_payments-Ledger |
Metadata
| Event Type | Payload Version | payment.scheduled | v1 |
|---|
JSON Payload Representation
{
"id": "integer",
"amount": "integer",
"ledger": {
"account": {
"number": "string"
},
"id": "string"
}
}payment_obligation.overdue-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | supplementary_ledger_id | integer |
| required | supplementary_ledger_number | string |
| required | amount | integer |
| required | amount_outstanding | integer |
| required | payment_obligation_id | integer |
| required | due_date | string |
Metadata
| Event Type | Payload Version | payment_obligation.overdue | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | payment_plan_id | integer |
| required | old_status | string |
| required | new_status | string |
Metadata
| Event Type | Payload Version | payment_plan.status_changed | v1 |
|---|
JSON Payload Representation
{
"account_number": "string",
"payment_plan_id": "integer",
"old_status": "string",
"new_status": "string"
}payment_promise.broken-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | account_payment_id | integer |
Metadata
| Event Type | Payload Version | payment_promise.broken | v1 |
|---|
JSON Payload Representation
{
"account_number": "string",
"account_payment_id": "integer"
}payment_promise.completed-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | account_payment_id | integer |
| required | amount | integer |
| required | promise_date | string |
Metadata
| Event Type | Payload Version | payment_promise.completed | v1 |
|---|
JSON Payload Representation
{
"account_number": "string",
"account_payment_id": "integer",
"amount": "integer",
"promise_date": "string"
}payment_promise.created-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | account_payment_id | integer |
| required | amount | integer |
| required | promise_date | string |
Metadata
| Event Type | Payload Version | payment_promise.created | v1 |
|---|
JSON Payload Representation
{
"account_number": "string",
"account_payment_id": "integer",
"amount": "integer",
"promise_date": "string"
}payments-repayments-Account
Event Properties
| Name | Type | |
|---|---|---|
| required | number | string |
JSON Payload Representation
{
"number": "string"
}payments-repayments-Agent
Event Properties
| Name | Type | |
|---|---|---|
| required | actor_type | string |
| required | id | string |
JSON Payload Representation
{
"actor_type": "string",
"id": "string"
}payments-repayments-Ledger
Event Properties
| Name | Type | |
|---|---|---|
| id | string | |
| required | account | payments-repayments-Account |
JSON Payload Representation
{
"id": "string",
"account": {
"number": "string"
}
}payments-repayments-Payment
Event Properties
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | amount | integer |
| required | payment_date | string |
JSON Payload Representation
{
"id": "integer",
"amount": "integer",
"payment_date": "string"
}payments.payment-preferences.manual-payments-activated-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | ledger_numbers | array[string] |
| required | from_datetime | string |
Metadata
| Event Type | Payload Version | payments.payment-preferences.manual-payments-activated | v1 |
|---|
JSON Payload Representation
{
"ledger_numbers": [
"string"
],
"from_datetime": "string"
}payments.payment-preferences.preferred-method-set-for-automatic-payments-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | ledger_numbers | array[string] |
| required | from_datetime | string |
| required | payment_method_id | string |
Metadata
| Event Type | Payload Version | payments.payment-preferences.preferred-method-set-for-automatic-payments | v1 |
|---|
JSON Payload Representation
{
"ledger_numbers": [
"string"
],
"from_datetime": "string",
"payment_method_id": "string"
}payments.payment-schedule-preference-mismatch-detected-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | ledger_number | string |
| required | schedule_id | integer |
| required | schedule_type | string |
| required | payment_preference | string |
Metadata
| Event Type | Payload Version | payments.payment-schedule-preference-mismatch-detected | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | ledger_number | string |
| required | reason | string |
Metadata
| Event Type | Payload Version | payments.payment_adequacy.review_wont_be_applied | v1 |
|---|
JSON Payload Representation
{
"account_number": "string",
"ledger_number": "string",
"reason": "string"
}payments.payment_method.account_user_matching.failed-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | instruction_id | string |
Metadata
| Event Type | Payload Version | payments.payment_method.account_user_matching.failed | v1 |
|---|
JSON Payload Representation
{
"instruction_id": "string"
}payments.payment_method.new-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | ledger_identifier | string |
| required | usable_from | string |
| required | payment_instruction_id | string |
| required | usable_to | string |
Metadata
| Event Type | Payload Version | payments.payment_method.new | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | ledger_identifier | string |
| required | usable_from | string |
| required | payment_instruction_id | string |
| required | usable_to | string |
Metadata
| Event Type | Payload Version | payments.payment_method.removed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | ledger_identifier | string |
| required | payment_schedule_id | string |
| required | payment_schedule_type | string |
| required | usable_from | string |
| required | usable_to | string |
| required | is_variable_payment_amount | boolean |
Metadata
| Event Type | Payload Version | payments.payment_schedule.new | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | ledger_identifier | string |
| required | payment_schedule_id | string |
| required | preceding_schedule_id | string |
| required | payment_frequency | string |
| required | payment_frequency_multiplier | integer |
| required | valid_from | string |
| required | is_variable_payment_amount | boolean |
| required | is_exempt_from_payment_adequacy | boolean |
Metadata
| Event Type | Payload Version | payments.payment_schedule.removed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | ledger_identifier | string |
| required | payment_schedule_id | string |
| required | changes | object |
Metadata
| Event Type | Payload Version | payments.payment_schedule.updated | v1 |
|---|
JSON Payload Representation
{
"account_number": "string",
"ledger_identifier": "string",
"payment_schedule_id": "string",
"changes": "object"
}product-switch.completed-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | supply_point_id | integer |
| required | previous_agreement_id | integer |
| required | new_agreement_id | integer |
| required | new_product | market_supply-products-Product |
Metadata
| Event Type | Payload Version | product-switch.completed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | product_switch_process_id | integer |
Metadata
| Event Type | Payload Version | product-switch.initiated | v1 |
|---|
JSON Payload Representation
{
"product_switch_process_id": "integer"
}property.move-in.cancelled-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account | accounts-house_move-Account |
| required | property_id | integer |
Metadata
| Event Type | Payload Version | property.move-in.cancelled | v1 |
|---|
JSON Payload Representation
{
"account": {
"number": "string",
"external_reference": "string"
},
"property_id": "integer"
}property.move-in.date-updated-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account | accounts-house_move-Account |
| required | property_id | integer |
| required | updated_move_in_date | string |
Metadata
| Event Type | Payload Version | property.move-in.date-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account | accounts-house_move-Account |
| required | property_id | integer |
| required | supply_point_ids | array[integer] |
| required | move_in_date | string |
| required | has_structured_billing_address | boolean |
Metadata
| Event Type | Payload Version | property.move-in.market-supply.requested | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account | accounts-house_move-Account |
| required | property_id | integer |
| required | supply_points | array[accounts-house_move-SupplyPoint] |
| required | move_in_date | string |
Metadata
| Event Type | Payload Version | property.move-in.requested | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account | accounts-house_move-Account |
| required | property_ids | array[integer] |
| required | supply_points | array[accounts-house_move-SupplyPoint] |
| required | move_in_date | string |
Metadata
| Event Type | Payload Version | property.move-in.requested | v2 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account | accounts-house_move-Account |
| required | property_id | integer |
| required | supply_points | array[accounts-house_move-SupplyPoint] |
| required | cancelled_move_out_date | string |
Metadata
| Event Type | Payload Version | property.move-out.cancelled | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account | accounts-house_move-Account |
| required | property_id | integer |
| required | supply_points | array[accounts-house_move-SupplyPoint] |
| required | updated_move_out_date | string |
Metadata
| Event Type | Payload Version | property.move-out.date-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account | accounts-house_move-Account |
| required | property_id | integer |
| required | supply_points | array[accounts-house_move-SupplyPoint] |
| required | move_out_date | string |
Metadata
| Event Type | Payload Version | property.move-out.requested | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | property_id | integer |
| required | updated_attribute | string |
Metadata
| Event Type | Payload Version | property.power-limit-updated | v1 |
|---|
JSON Payload Representation
{
"property_id": "integer",
"updated_attribute": "string"
}property.retrospective-move-out.completed-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account | accounts-house_move-Account |
| required | supply_point_id | integer |
| required | move_out_date | string |
Metadata
| Event Type | Payload Version | property.retrospective-move-out.completed | v1 |
|---|
JSON Payload Representation
{
"account": {
"number": "string",
"external_reference": "string"
},
"supply_point_id": "integer",
"move_out_date": "string"
}property.updated-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | property_id | integer |
| required | account_number | string |
| required | changes | object |
Metadata
| Event Type | Payload Version | property.updated | v1 |
|---|
JSON Payload Representation
{
"property_id": "integer",
"account_number": "string",
"changes": "object"
}property_metadata.created-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | property_id | integer |
| required | key | string |
| required | value | string |
Metadata
| Event Type | Payload Version | property_metadata.created | v1 |
|---|
JSON Payload Representation
{
"property_id": "integer",
"key": "string",
"value": "string"
}property_metadata.removed-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | property_id | integer |
| required | key | string |
| required | value | string |
Metadata
| Event Type | Payload Version | property_metadata.removed | v1 |
|---|
JSON Payload Representation
{
"property_id": "integer",
"key": "string",
"value": "string"
}property_metadata.updated-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | property_id | integer |
| required | changes | object |
Metadata
| Event Type | Payload Version | property_metadata.updated | v1 |
|---|
JSON Payload Representation
{
"property_id": "integer",
"changes": "object"
}quoting.offer-accepted-v1
Event Properties
| Name | Type | |
|---|---|---|
| quote_configuration_number | string | |
| opportunity_number | string |
Metadata
| Event Type | Payload Version | quoting.offer-accepted | v1 |
|---|
JSON Payload Representation
{
"quote_configuration_number": "string",
"opportunity_number": "string"
}quoting.rates-requested-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | quote_configurations | array[string] |
Metadata
| Event Type | Payload Version | quoting.rates-requested | v1 |
|---|
JSON Payload Representation
{
"quote_configurations": [
"string"
]
}quoting.rates-requested-v2
Event Properties
| Name | Type | |
|---|---|---|
| required | quote_configurations | array[string] |
| required | request_identifier | string |
Metadata
| Event Type | Payload Version | quoting.rates-requested | v2 |
|---|
JSON Payload Representation
{
"quote_configurations": [
"string"
],
"request_identifier": "string"
}reading.accumulation.created-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | market_supply_point_id | string |
| required | interval_end | string |
| required | device_id | string |
| required | register_id | string |
| required | quality | string |
| required | market_name | string |
Metadata
| Event Type | Payload Version | reading.accumulation.created | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | referred_account_number | string |
| required | referring_account_number | string |
| required | referral_id | integer |
| required | referral_scheme_code | string |
Metadata
| Event Type | Payload Version | referrals.referral-created | v1 |
|---|
JSON Payload Representation
{
"referred_account_number": "string",
"referring_account_number": "string",
"referral_id": "integer",
"referral_scheme_code": "string"
}referrals.referral-paid-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | referral_id | integer |
| required | referral_scheme_code | string |
| required | is_referring_account | boolean |
Metadata
| Event Type | Payload Version | referrals.referral-paid | v1 |
|---|
JSON Payload Representation
{
"account_number": "string",
"referral_id": "integer",
"referral_scheme_code": "string",
"is_referring_account": "boolean"
}referrals.reward-created-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | referred_account_number | string |
| required | referral_id | integer |
| required | referral_scheme_code | string |
Metadata
| Event Type | Payload Version | referrals.reward-created | v1 |
|---|
JSON Payload Representation
{
"referred_account_number": "string",
"referral_id": "integer",
"referral_scheme_code": "string"
}refund.requested-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | amount | integer |
| required | ledger | payments-repayments-Ledger |
| required | reason | string |
| required | payment | payments-repayments-Payment |
| required | requested_by | payments-repayments-Agent |
Metadata
| Event Type | Payload Version | refund.requested | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | reminder_id | integer |
| required | account_number | string |
| required | reminder_type | string |
| required | reminder_params | object |
Metadata
| Event Type | Payload Version | reminder.cancelled | v1 |
|---|
JSON Payload Representation
{
"reminder_id": "integer",
"account_number": "string",
"reminder_type": "string",
"reminder_params": "object"
}reminder.cancelled-v2
Event Properties
| Name | Type | |
|---|---|---|
| required | reminder_id | integer |
| required | account_number | string |
| required | reminder_type | string |
| required | reminder_params | object |
Metadata
| Event Type | Payload Version | reminder.cancelled | v2 |
|---|
JSON Payload Representation
{
"reminder_id": "integer",
"account_number": "string",
"reminder_type": "string",
"reminder_params": "object"
}reminder.completed-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | reminder_id | integer |
| required | account_number | string |
| required | reminder_type | string |
| required | reminder_params | object |
Metadata
| Event Type | Payload Version | reminder.completed | v1 |
|---|
JSON Payload Representation
{
"reminder_id": "integer",
"account_number": "string",
"reminder_type": "string",
"reminder_params": "object"
}reminder.completed-v2
Event Properties
| Name | Type | |
|---|---|---|
| required | reminder_id | integer |
| required | account_number | string |
| required | reminder_type | string |
| required | reminder_params | object |
Metadata
| Event Type | Payload Version | reminder.completed | v2 |
|---|
JSON Payload Representation
{
"reminder_id": "integer",
"account_number": "string",
"reminder_type": "string",
"reminder_params": "object"
}repayment-group.actioned-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | group_reference | string |
| required | actioned_at | string |
Metadata
| Event Type | Payload Version | repayment-group.actioned | v1 |
|---|
JSON Payload Representation
{
"id": "integer",
"group_reference": "string",
"actioned_at": "string"
}repayment-group.closed-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | group_reference | string |
| required | closed_at | string |
Metadata
| Event Type | Payload Version | repayment-group.closed | v1 |
|---|
JSON Payload Representation
{
"id": "integer",
"group_reference": "string",
"closed_at": "string"
}repayment-group.completed-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | group_reference | string |
| required | completed_at | string |
Metadata
| Event Type | Payload Version | repayment-group.completed | v1 |
|---|
JSON Payload Representation
{
"id": "integer",
"group_reference": "string",
"completed_at": "string"
}repayment.approved-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | amount | integer |
| required | ledger | payments-repayments-Ledger |
| required | approved_by | payments-repayments-Agent |
| required | note | string |
Metadata
| Event Type | Payload Version | repayment.approved | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | amount | integer |
| required | ledger | payments-repayments-Ledger |
| required | audited_by | payments-repayments-Agent |
Metadata
| Event Type | Payload Version | repayment.audited | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | amount | integer |
| required | ledger | payments-repayments-Ledger |
| required | reason | string |
| required | requested_by | payments-repayments-Agent |
Metadata
| Event Type | Payload Version | repayment.created | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | amount | integer |
| required | ledger | payments-repayments-Ledger |
| required | deletion_reason | string |
| required | deleted_by | payments-repayments-Agent |
Metadata
| Event Type | Payload Version | repayment.deleted | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | amount | integer |
| required | payment_date | string |
| required | ledger | payments-repayments-Ledger |
| required | reason | string |
| required | edited_by | payments-repayments-Agent |
Metadata
| Event Type | Payload Version | repayment.edited | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | amount | integer |
| required | ledger | payments-repayments-Ledger |
| required | failure_reason | string |
Metadata
| Event Type | Payload Version | repayment.failed | v1 |
|---|
JSON Payload Representation
{
"id": "integer",
"amount": "integer",
"ledger": {
"id": "string",
"account": {
"number": "string"
}
},
"failure_reason": "string"
}repayment.failed-v2
Event Properties
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | amount | integer |
| required | ledger | payments-repayments-Ledger |
| required | failure_reason | string |
| required | note | string |
Metadata
| Event Type | Payload Version | repayment.failed | v2 |
|---|
JSON Payload Representation
{
"id": "integer",
"amount": "integer",
"ledger": {
"id": "string",
"account": {
"number": "string"
}
},
"failure_reason": "string",
"note": "string"
}repayment.failed_late-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | amount | integer |
| required | ledger | payments-repayments-Ledger |
| required | note | string |
| required | failure_reason | string |
Metadata
| Event Type | Payload Version | repayment.failed_late | v1 |
|---|
JSON Payload Representation
{
"id": "integer",
"amount": "integer",
"ledger": {
"id": "string",
"account": {
"number": "string"
}
},
"note": "string",
"failure_reason": "string"
}repayment.paid-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | amount | integer |
| required | ledger | payments-repayments-Ledger |
| required | marked_by | payments-repayments-Agent |
| required | note | string |
Metadata
| Event Type | Payload Version | repayment.paid | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | amount | integer |
| required | ledger | payments-repayments-Ledger |
| required | reason | string |
| required | requested_by | payments-repayments-Agent |
Metadata
| Event Type | Payload Version | repayment.requested | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | amount | integer |
| required | ledger | payments-repayments-Ledger |
| required | marked_by | payments-repayments-Agent |
Metadata
| Event Type | Payload Version | repayment.submittable | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | amount | integer |
| required | ledger | payments-repayments-Ledger |
| required | submitted_by | payments-repayments-Agent |
| required | note | string |
Metadata
| Event Type | Payload Version | repayment.submitted | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| account_number | string | |
| required | risk_assessment_id | string |
| required | assessment_risk | string |
| run_event | string | |
| required | risk_identified_assessors | array[string] |
| required | risk_absent_assessors | array[string] |
| required | risk_indeterminate_assessors | array[string] |
| required | risk_non_applicable_assessors | array[string] |
Metadata
| Event Type | Payload Version | risk_assessment_completed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| account_number | string | |
| required | risk_assessment_id | string |
| run_event | string |
Metadata
| Event Type | Payload Version | risk_assessment_started | v1 |
|---|
JSON Payload Representation
{
"account_number": "string",
"risk_assessment_id": "string",
"run_event": "string"
}security.account_user.denied_access-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_user_id | integer |
| required | account_user_number | string |
| required | delegates_logged_out | boolean |
Metadata
| Event Type | Payload Version | security.account_user.denied_access | v1 |
|---|
JSON Payload Representation
{
"account_user_id": "integer",
"account_user_number": "string",
"delegates_logged_out": "boolean"
}security.account_user.forcibly_logged_out-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | account_user_id | integer |
| required | account_user_number | string |
| required | delegates_logged_out | boolean |
Metadata
| Event Type | Payload Version | security.account_user.forcibly_logged_out | v1 |
|---|
JSON Payload Representation
{
"account_user_id": "integer",
"account_user_number": "string",
"delegates_logged_out": "boolean"
}supply-point.gain.completed-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | market | string |
| required | market_identifier | string |
| required | market_identifier_name | string |
| required | account_number | string |
| required | supply_start_at | string |
Metadata
| Event Type | Payload Version | supply-point.gain.completed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | market | string |
| required | market_identifier | string |
| required | market_identifier_name | string |
| required | account_number | string |
| required | supply_end_at | string |
Metadata
| Event Type | Payload Version | supply-point.termination.completed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | mpan | string |
| required | mtd_effective_from | string |
| required | measurement_class | string |
| required | is_energised | boolean |
| required | standard_settlement_configuration | string |
| required | ssc_effective_from | string |
| required | non_settlement_function_code | string |
| required | nsfc_effective_from | string |
| required | meters | array[meter_points-meter_details-Meter] |
| required | removed_meters | array[meter_points-meter_details-RemovedMeter] |
Metadata
| Event Type | Payload Version | supplypoint.gbr_electricity.gain.meter-details-received | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
Metadata
| Event Type | Payload Version | tech.kraken.workflow.cancelled.v1 | v1 |
|---|
JSON Payload Representation
{
"workflow_id": "integer",
"workflow_name": "string",
"previous_status": "string",
"reason": "string",
"direction": "string"
}tech.kraken.workflow.completed.v1-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
Metadata
| Event Type | Payload Version | tech.kraken.workflow.completed.v1 | v1 |
|---|
JSON Payload Representation
{
"workflow_id": "integer",
"workflow_name": "string",
"previous_status": "string",
"reason": "string",
"direction": "string"
}tech.kraken.workflow.created.v1-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
Metadata
| Event Type | Payload Version | tech.kraken.workflow.created.v1 | v1 |
|---|
JSON Payload Representation
{
"workflow_id": "integer",
"workflow_name": "string",
"previous_status": "string",
"reason": "string",
"direction": "string"
}tech.kraken.workflow.errored.v1-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
Metadata
| Event Type | Payload Version | tech.kraken.workflow.errored.v1 | v1 |
|---|
JSON Payload Representation
{
"workflow_id": "integer",
"workflow_name": "string",
"previous_status": "string",
"reason": "string",
"direction": "string"
}tech.kraken.workflow.failed.v1-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
Metadata
| Event Type | Payload Version | tech.kraken.workflow.failed.v1 | v1 |
|---|
JSON Payload Representation
{
"workflow_id": "integer",
"workflow_name": "string",
"previous_status": "string",
"reason": "string",
"direction": "string"
}tech.kraken.workflow.skipped.v1-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
Metadata
| Event Type | Payload Version | tech.kraken.workflow.skipped.v1 | v1 |
|---|
JSON Payload Representation
{
"workflow_id": "integer",
"workflow_name": "string",
"previous_status": "string",
"reason": "string",
"direction": "string"
}tech.kraken.workflow.stalled.v1-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
Metadata
| Event Type | Payload Version | tech.kraken.workflow.stalled.v1 | v1 |
|---|
JSON Payload Representation
{
"workflow_id": "integer",
"workflow_name": "string",
"previous_status": "string",
"reason": "string",
"direction": "string"
}tech.kraken.workflow.started.v1-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
Metadata
| Event Type | Payload Version | tech.kraken.workflow.started.v1 | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | step_id | integer |
| required | step_name | string |
| required | step_slug | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
Metadata
| Event Type | Payload Version | tech.kraken.workflow.step.cancelled.v1 | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | step_id | integer |
| required | step_name | string |
| required | step_slug | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
Metadata
| Event Type | Payload Version | tech.kraken.workflow.step.completed.v1 | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | step_id | integer |
| required | step_name | string |
| required | step_slug | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
Metadata
| Event Type | Payload Version | tech.kraken.workflow.step.created.v1 | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | step_id | integer |
| required | step_name | string |
| required | step_slug | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
Metadata
| Event Type | Payload Version | tech.kraken.workflow.step.errored.v1 | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | step_id | integer |
| required | step_name | string |
| required | step_slug | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
Metadata
| Event Type | Payload Version | tech.kraken.workflow.step.failed.v1 | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | step_id | integer |
| required | step_name | string |
| required | step_slug | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
Metadata
| Event Type | Payload Version | tech.kraken.workflow.step.skipped.v1 | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | step_id | integer |
| required | step_name | string |
| required | step_slug | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
Metadata
| Event Type | Payload Version | tech.kraken.workflow.step.stalled.v1 | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | workflow_id | integer |
| required | workflow_name | string |
| required | step_id | integer |
| required | step_name | string |
| required | step_slug | string |
| required | previous_status | string |
| required | reason | string |
| required | direction | string |
Metadata
| Event Type | Payload Version | tech.kraken.workflow.step.started.v1 | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | identifier | string |
| required | version | integer |
| required | amount | string |
| required | unit | string |
| required | trade_date | string |
| required | period_start | string |
| required | period_end | string |
| required | target_market_name | string |
| required | target_external_identifier | string |
| required | target_type | string |
| required | price_in_minor_units | string |
| required | fee_in_minor_units | string |
| required | price_unit | string |
| required | direction | string |
Metadata
| Event Type | Payload Version | tranches.request.submitted | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | trigger_type_code | string |
| required | trigger_id | string |
Metadata
| Event Type | Payload Version | transactional-messaging.message.dispatched | v1 |
|---|
JSON Payload Representation
{
"trigger_type_code": "string",
"trigger_id": "string"
}transactional-messaging.trigger.failed-message-processed-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | trigger_type_code | string |
| required | trigger_id | string |
| message | transactional_messaging-process_trigger-_TransactionalMessage | |
| event | transactional_messaging-process_trigger-_MessageEvent |
Metadata
| Event Type | Payload Version | transactional-messaging.trigger.failed-message-processed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | trigger_type_code | string |
| required | trigger_id | string |
| message | transactional_messaging-process_trigger-_TransactionalMessage | |
| event | transactional_messaging-process_trigger-_MessageEvent |
Metadata
| Event Type | Payload Version | transactional-messaging.trigger.failed-message-processing-failed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | trigger_type_code | string |
| required | trigger_id | string |
| required | transactional_message_ids | array[string] |
Metadata
| Event Type | Payload Version | transactional-messaging.trigger.processed | v2 |
|---|
JSON Payload Representation
{
"trigger_type_code": "string",
"trigger_id": "string",
"transactional_message_ids": [
"string"
]
}transactional-messaging.trigger.processing-failed-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | trigger_type_code | string |
| required | trigger_id | string |
Metadata
| Event Type | Payload Version | transactional-messaging.trigger.processing-failed | v1 |
|---|
JSON Payload Representation
{
"trigger_type_code": "string",
"trigger_id": "string"
}transactional_messaging-process_trigger-_MessageEvent
Event Properties
| Name | Type | |
|---|---|---|
| required | event_type | string |
JSON Payload Representation
{
"event_type": "string"
}transactional_messaging-process_trigger-_TransactionalMessage
Event Properties
| Name | Type | |
|---|---|---|
| required | id | string |
| required | channel | string |
JSON Payload Representation
{
"id": "string",
"channel": "string"
}translation_management.CLIENT_MANAGED_TRANSLATION_SOURCE_DELETED-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | translation_key | string |
| required | internal_lang_codes | array[string] |
Metadata
| Event Type | Payload Version | translation_management.CLIENT_MANAGED_TRANSLATION_SOURCE_DELETED | v1 |
|---|
JSON Payload Representation
{
"translation_key": "string",
"internal_lang_codes": [
"string"
]
}translation_management.CLIENT_MANAGED_TRANSLATION_SOURCE_EDITED-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | translation_key | string |
| required | internal_lang_codes | array[string] |
Metadata
| Event Type | Payload Version | translation_management.CLIENT_MANAGED_TRANSLATION_SOURCE_EDITED | v1 |
|---|
JSON Payload Representation
{
"translation_key": "string",
"internal_lang_codes": [
"string"
]
}user_access.granted-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | allocation_id | integer |
| required | user_id | integer |
| required | target_id | integer |
| required | target_type | string |
| required | role_id | integer |
| required | start_at | string |
| required | end_at | string |
Metadata
| Event Type | Payload Version | user_access.granted | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | allocation_id | integer |
| required | user_id | integer |
| required | target_id | integer |
| required | target_type | string |
| required | role_id | integer |
| required | start_at | string |
| required | end_at | string |
Metadata
| Event Type | Payload Version | user_access.revoked | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | call_participant_id | integer |
| call_participant_type | string | |
| required | support_user_id | integer |
| duration | integer |
JSON Payload Representation
{
"call_participant_id": "integer",
"call_participant_type": "string",
"support_user_id": "integer",
"duration": "integer"
}voice-call_participants-_CallParticipantIdentity
Event Properties
| Name | Type | |
|---|---|---|
| required | entity_id | integer |
| required | type | string |
JSON Payload Representation
{
"entity_id": "integer",
"type": "string"
}voice-transcriptions-_Call
Event Properties
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | created_at | string |
| required | direction | string |
| required | participant_workers | array[voice-transcriptions-_CallParticipantWorker] |
| required | tags | array[voice-transcriptions-_CallTag] |
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
| Name | Type | |
|---|---|---|
| required | support_user_id | integer |
| required | joined_at | string |
| required | left_at | string |
JSON Payload Representation
{
"support_user_id": "integer",
"joined_at": "string",
"left_at": "string"
}voice-transcriptions-_CallRecordingV1
Event Properties
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | s3_bucket | string |
| required | s3_key | string |
JSON Payload Representation
{
"id": "integer",
"s3_bucket": "string",
"s3_key": "string"
}voice-transcriptions-_CallRecordingV2
Event Properties
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | s3_bucket | string |
| required | s3_key | string |
| required | duration_seconds | integer |
JSON Payload Representation
{
"id": "integer",
"s3_bucket": "string",
"s3_key": "string",
"duration_seconds": "integer"
}voice-transcriptions-_CallTag
Event Properties
| Name | Type | |
|---|---|---|
| required | id | integer |
JSON Payload Representation
{
"id": "integer"
}voice-transcriptions-_TranscriptionFile
Event Properties
| Name | Type | |
|---|---|---|
| required | s3_bucket | string |
| required | s3_key | string |
| required | type | string |
JSON Payload Representation
{
"s3_bucket": "string",
"s3_key": "string",
"type": "string"
}voice-wrap_up_call-_CallParticipants
Event Properties
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | account_id | integer |
| required | account_number | string |
| required | account_user_id | integer |
| required | account_user_number | string |
| required | inferred_account_user_number | string |
| required | support_user_id | integer |
| required | joined_at | string |
| required | left_at | string |
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
| Name | Type | |
|---|---|---|
| required | id | integer |
JSON Payload Representation
{
"id": "integer"
}voice-wrap_up_call-_Note
Event Properties
| Name | Type | |
|---|---|---|
| required | id | integer |
JSON Payload Representation
{
"id": "integer"
}voice.call-participant.identity-updated-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | call_id | integer |
| required | call_participant_id | integer |
| required | updated_identities | array[voice-call_participants-_CallParticipantIdentity] |
| required | new_account_number | string |
Metadata
| Event Type | Payload Version | voice.call-participant.identity-updated | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | call_id | integer |
| required | contained_by_ai_agent | boolean |
| required | call_participants | array[voice-call_completed-_CallParticipant] |
Metadata
| Event Type | Payload Version | voice.call.completed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | id | integer |
| required | created_at | string |
| required | direction | string |
| required | tags | array[voice-wrap_up_call-_CallTag] |
| required | notes | array[voice-wrap_up_call-_Note] |
| required | participants | array[voice-wrap_up_call-_CallParticipants] |
Metadata
| Event Type | Payload Version | voice.call.wrapped | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | campaign_item_id | integer |
| required | campaign_id | integer |
| required | status | string |
| required | account_id | integer |
| required | phone_number | string |
Metadata
| Event Type | Payload Version | voice.campaign.update-item | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | support_user_id | integer |
| required | emergency_session_id | integer |
| required | call_id | integer |
| required | address | string |
| required | country | string |
| required | latitude | string |
| required | longitude | string |
| required | location_details | string |
| required | dialled_phone_number | string |
| required | pool_phone_number | string |
| required | occurred_at | string |
| required | is_outside_configured_territory | boolean |
Metadata
| Event Type | Payload Version | voice.emergency_call.placed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | call | voice-transcriptions-_Call |
| required | call_recording | voice-transcriptions-_CallRecordingV2 |
| required | error | string |
Metadata
| Event Type | Payload Version | voice.transcription.failed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | call_id | integer |
| required | account_number | string |
| required | transcription_files | array[voice-transcriptions-_TranscriptionFile] |
| required | call_recording | voice-transcriptions-_CallRecordingV1 |
Metadata
| Event Type | Payload Version | voice.transcription.processed | v1 |
|---|
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
| Name | Type | |
|---|---|---|
| required | account_number | string |
| required | call | voice-transcriptions-_Call |
| required | call_recording | voice-transcriptions-_CallRecordingV2 |
| required | transcription_files | array[voice-transcriptions-_TranscriptionFile] |
Metadata
| Event Type | Payload Version | voice.transcription.processed | v2 |
|---|
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
| Name | Type | |
|---|---|---|
| required | voucher_purchase_ids | array[integer] |
Metadata
| Event Type | Payload Version | voucher.multiple_purchased | v1 |
|---|
JSON Payload Representation
{
"voucher_purchase_ids": [
"integer"
]
}voucher.multiple_refunded-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | voucher_purchase_ids | array[integer] |
Metadata
| Event Type | Payload Version | voucher.multiple_refunded | v1 |
|---|
JSON Payload Representation
{
"voucher_purchase_ids": [
"integer"
]
}voucher.purchased-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | voucher_purchase_id | integer |
Metadata
| Event Type | Payload Version | voucher.purchased | v1 |
|---|
JSON Payload Representation
{
"voucher_purchase_id": "integer"
}voucher.redeemed-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | voucher_purchase_id | integer |
Metadata
| Event Type | Payload Version | voucher.redeemed | v1 |
|---|
JSON Payload Representation
{
"voucher_purchase_id": "integer"
}voucher.refunded-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | voucher_purchase_id | integer |
Metadata
| Event Type | Payload Version | voucher.refunded | v1 |
|---|
JSON Payload Representation
{
"voucher_purchase_id": "integer"
}voucher.transferred-v1
Event Properties
| Name | Type | |
|---|---|---|
| required | voucher_purchase_id | integer |
| required | from_account_number | string |
| required | to_account_number | string |
| required | transferred_at | string |
| transfer_note | string |
Metadata
| Event Type | Payload Version | voucher.transferred | v1 |
|---|
JSON Payload Representation
{
"voucher_purchase_id": "integer",
"from_account_number": "string",
"to_account_number": "string",
"transferred_at": "string",
"transfer_note": "string"
}