Data Import REST API Changelog

{
    "x-validators": [
        {
            "name": "Validate that each child has a unique combination of values for the <code>\u2068payment_date, payment_type\u2069</code> fields",
            "description": "Validate that each child has a unique combination of values for the <code>\u2068payment_date, payment_type\u2069</code> fields.",
            "possible_errors": [
                "children_with_duplicate_values"
            ]
        }
    ]
}

{
    "x-validators": [
        {
            "name": "Validate that each child has unique values for the <code>\u2068payment_date\u2069</code> field",
            "description": "Validate that each child has unique values for the <code>\u2068payment_date\u2069</code> field.",
            "possible_errors": [
                "children_with_duplicate_values"
            ]
        }
    ]
}

{
    "x-enum-descriptions": {
        "NEE19": "NEE19"
    }
}

{
    "x-enum-descriptions": {}
}

[
    {
        "name": "Validate account type is valid",
        "description": "Validate that only one account type is specified in the payload.",
        "possible_errors": [
            "multiple_account_types_selected"
        ]
    },
    {
        "name": "Derive occupier billing address from supply address",
        "description": "When an occupier account has no explicit billing address and exactly one supply address is provided, copy the supply address into the billing address fields.",
        "possible_errors": []
    },
    {
        "name": "Validate billing address fields",
        "description": "If a legacy billing address is provided, validate that it is in the correct format.",
        "possible_errors": [
            "invalid_address"
        ]
    },
    {
        "name": "Validate life support contact user email",
        "description": "Validates that life support contact user email matches with customers email. When life support <code>preferred_contact_method</code> is <code>EMAIL_ADDRESS</code>, it requires customer with email. When it is <code>PHONE</code>, it requires customer with mobile or landline.",
        "possible_errors": [
            "missing_contact_user_email_or_phone"
        ]
    },
    {
        "name": "Validate metadata",
        "description": "Validate that metadata, which is a list of key value pairs, does not contain duplicate keys.",
        "possible_errors": [
            "metadata_has_duplicate_keys"
        ]
    },
    {
        "name": "Validate unique property external identifiers",
        "description": "Ensures that <code>property_external_identifier</code> is not repeated across <code>supply_addresses</code> and <code>properties</code>.",
        "possible_errors": [
            "duplicate_property_external_identifiers"
        ]
    },
    {
        "name": "Validate managed account type is allowed",
        "description": "Validate that this instance of Kraken allows managed account types.",
        "possible_errors": [
            "managed_accounts_are_not_allowed"
        ]
    },
    {
        "name": "Validate only portfolio lead has portfolio setting",
        "description": "Validates that if portfolio settings are provided, then the account is marked as the portfolio lead.",
        "possible_errors": [
            "portfolio_settings_included_when_not_lead"
        ]
    },
    {
        "name": "Validate no customers for unknown occupier",
        "description": "Validate that no customers are provided for an unknown occupier.",
        "possible_errors": [
            "customer_with_unknown_occupier"
        ]
    },
    {
        "name": "Validate that a customer given name is provided for business accounts",
        "description": "Validate that a given name is provided for all customers on a business account. Note that this validation only applies if Kraken is configured to send registration flows for this import supplier.",
        "possible_errors": [
            "customer_given_name_required"
        ]
    },
    {
        "name": "Validate portfolio reference provided correctly",
        "description": "Validate that a portfolio reference is provided if portfolio settings have been provided and that a portfolio reference is not provided if the import supplier is set to create new portfolios.",
        "possible_errors": [
            "portfolio_references_missing",
            "portfolio_references_provided"
        ]
    },
    {
        "name": "Validate billing address style",
        "description": "Validate that a legacy billing address (<code>billing_address1</code> etc.) and new-style billing address (<code>billing_address</code> object) are not both provided.",
        "possible_errors": [
            "billing_address_new_style_and_legacy"
        ]
    },
    {
        "name": "Validate agreements are consecutive per supply point",
        "description": "Validate that the agreements provided in the payload are consecutive per supply point i.e. there are no gaps or overlaps. The exception to this is for agreements provided before the current supply period for the supply point. Agreements provided before the <code>supply_start_date</code> are allowed gaps since they represent historic periods of supply and cannot be used for billing in Kraken.",
        "possible_errors": [
            "gaps_or_overlaps_in_agreement_dates"
        ]
    },
    {
        "name": "Validate supply charge line items covered by a single agreement",
        "description": "Validate each supply charge has a single agreement with matching product code that covers the period defined by it's line items minimum <code>start_date</code> to maximum <code>end_date</code>.",
        "possible_errors": [
            "supply_charge_line_items_not_covered_by_single_agreement"
        ]
    },
    {
        "name": "Validate that Kraken can calculate when to start billing the account",
        "description": "Validate that Kraken can calculate when to start billing the account. This is determined based on the existence of last billed to date, last statement closing date, and agreements.",
        "possible_errors": [
            "cannot_determine_responsible_for_billing_from_date"
        ]
    },
    {
        "name": "Validate historical statement period end must not be in the future",
        "description": "Ensures that the historical statement period end date (last_statement_closing_date or latest transaction_date) is not set in the future.",
        "possible_errors": [
            "historical_statement_period_end_in_future"
        ]
    },
    {
        "name": "Validate that terms with supply type matches a supply point supply type",
        "description": "Validate that for terms containing a <code>supply_type</code> field that there is a supply point in the payload with a matching <code>supply_type</code>.",
        "possible_errors": [
            "term_supply_type_mismatch"
        ]
    },
    {
        "name": "Validate that supply addresses and supply points are provided if account contracts are provided",
        "description": "Validate that if <code>account_contracts</code> have been provided that a supply address with supply points has been provided under <code>supply_addresses</code>",
        "possible_errors": [
            "account_contracts_without_supply_points"
        ]
    },
    {
        "name": "Validate historical statement billing document identifier presence",
        "description": "Ensure that billing document identifiers are only provided for historical statement transactions and only when the relevant feature flag is enabled.",
        "possible_errors": [
            "historical_statement_billing_document_identifier_missing",
            "historical_statement_billing_document_identifier_not_allowed_when_feature_flag_disabled"
        ]
    },
    {
        "name": "Validate current statement transactions do not provide <code>billing_document_identifier</code>",
        "description": "Validate that none of the current statement transactions include a <code>billing_document_identifier</code>, as this field is only applicable to historical statement transactions.",
        "possible_errors": [
            "billing_document_identifier_not_allowed_for_current_statement_transactions"
        ]
    },
    {
        "name": "Validate historical statement transaction billing document identifier",
        "description": "Ensure that the billing document identifier is the same for all historical statement transactions.",
        "possible_errors": [
            "historical_statement_billing_document_identifier_mismatch"
        ]
    },
    {
        "name": "Validate that contract terms' product codes are part of supply agreements",
        "description": "Ensure that any contract terms with product references have corresponding products in supply addresses.",
        "possible_errors": [
            "contract_term_product_code_not_in_agreements"
        ]
    },
    {
        "name": "Validate that business is provided if enforcing business contracts",
        "description": "Validate that the business field is provided if <code>enforce_business_contracts_exist</code> is set to True on the import supplier configuration.",
        "possible_errors": [
            "business_field_required"
        ]
    },
    {
        "name": "Validate agreement business contract identifier is declared",
        "description": "Validates that an agreement's <code>business_contract_identifier</code>, if provided, is one of the account's declared <code>business_contract_identifiers</code>.",
        "possible_errors": [
            "agreement_business_contract_identifier_not_declared"
        ]
    },
    {
        "name": "Validate that the sum of ledger balances equals the transfer balance",
        "description": "Validate that the sum of all <code>ledger_balance</code> provided for each ledger in <code>ledgers</code> equals the account-level <code>transfer_balance</code>.",
        "possible_errors": [
            "ledger_balances_not_equal_to_transfer_balance"
        ]
    },
    {
        "name": "Validate business user info against customer info",
        "description": "Validates that business user information matches the corresponding customer information for basic fields.",
        "possible_errors": [
            "customer_details_and_user_details_both_provided"
        ]
    },
    {
        "name": "Validate payment preference <code>ledger_identifier</code>",
        "description": "Ensure that the <code>ledger_identifier</code> provided has an equivalent <code>ledger</code> object with the same <code>ledger_identifier</code> .",
        "possible_errors": [
            "invalid_payment_preference_ledger_identifier"
        ]
    },
    {
        "name": "Validate that referenced ledgers are unique in payment preferences",
        "description": "Ensure that each ledger is referenced in at most one payment preference.",
        "possible_errors": [
            "duplicate_ledger_in_payment_preferences"
        ]
    },
    {
        "name": "Validate that valid instruction_identifier provided for <code>ACTIVE_NEW</code> payment preference",
        "description": "Ensure that <code>ACTIVE_NEW</code> payment preference has instruction_identifier from </code>payment_instructions</code> object.",
        "possible_errors": [
            "active_new_payment_preference_invalid_instruction_identifier"
        ]
    },
    {
        "name": "Validate that the transactions for a voucher do not exceed its value",
        "description": "Validate that the sum of all transaction values for a voucher is not greater than the value of the voucher.",
        "possible_errors": [
            "voucher_transactions_sum_greater_than_voucher_value"
        ]
    },
    {
        "name": "Validate that each voucher charge transaction id has a matching transaction id within a transaction of type CHARGE",
        "description": "Validate that each <code>voucher</code> <code>charge_transaction_id</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CHARGE in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
        "possible_errors": [
            "voucher_charge_transaction_id_not_found"
        ]
    },
    {
        "name": "Validate that each voucher redemption credit transaction id has a matching transaction id within a transaction of type CREDIT",
        "description": "Validate that every <code>credit_transaction_id</code> in all <code>voucher_redemptions</code> in every <code>voucher</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CREDIT in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
        "possible_errors": [
            "voucher_redemption_credit_transaction_id_not_found"
        ]
    },
    {
        "name": "Validate parent property references exist",
        "description": "Validates that all <code>parent_property_reference</code> values in <code>supply_addresses</code> and <code>properties</code> correspond to a <code>property_external_identifier</code> in the payload. This ensures the property hierarchy is valid.",
        "possible_errors": [
            "parent_property_reference_not_found"
        ]
    },
    {
        "name": "Validate that a portfolio lead account has no supply address since it makes no sense for it to have one",
        "description": "Validate that a portfolio lead account has no supply address.",
        "possible_errors": [
            "portfolio_lead_has_a_supply_address"
        ]
    },
    {
        "name": "Validate that a system account has no supply address",
        "description": "Validate that a system account has no supply address",
        "possible_errors": [
            "system_account_has_a_supply_address"
        ]
    },
    {
        "name": "Validate auto allocation of operations team",
        "description": "Validate that operations_team_name is provided if auto allocation is not configured.",
        "possible_errors": [
            "operations_team_provided_when_using_auto_allocation",
            "operations_team_should_be_provided"
        ]
    },
    {
        "name": "Validate ledger identifiers are known",
        "description": "Validate ledger identifiers are among supply point identifiers.",
        "possible_errors": [
            "unknown_ledger_identifiers"
        ]
    },
    {
        "name": "Validate identifiers are unique in ledgers",
        "description": "Validate identifier is not declared twice in ledgers.",
        "possible_errors": [
            "duplicate_identifiers_entries_found"
        ]
    },
    {
        "name": "Validate agreements cover last statement closing date",
        "description": "Validate that there is an agreement for each supply point covering each ledger's <code>last_statement_closing_date</code>.",
        "possible_errors": [
            "no_agreement_covering_last_statement_closing_date"
        ]
    },
    {
        "name": "Validate no unbilled period on former supply addresses",
        "description": "Validate that if a customer is no longer at the given supply address they have been fully billed. This check is performed if we are importing supply address history.",
        "possible_errors": [
            "unbilled_former_supply_address"
        ]
    },
    {
        "name": "Validate at least one billable meter point is provided",
        "description": "Validate that account must have at least one billable meter point unless import config skip_meter_point_creation is ON or account is a portfolio lead, or account is an unmetered service, or account is an inactive account.",
        "possible_errors": [
            "no_supply_point_on_supply"
        ]
    },
    {
        "name": "Validate billing address style",
        "description": "Validate that a legacy billing address (<code>billing_address1</code> etc.) and new-style billing address (<code>billing_address</code> object) are not both provided.",
        "possible_errors": [
            "billing_address_new_style_and_legacy"
        ]
    },
    {
        "name": "Validate business type not provided for domestic accounts",
        "description": "Validate that a business type is not provided for domestic accounts.",
        "possible_errors": [
            "business_fields_provided_for_domestic_accounts"
        ]
    },
    {
        "name": "Validate that blackhole email addresses are paired with 'online' communication prefernence",
        "description": "Validate that the communication preference 'online' when a blackhole email address is provided.",
        "possible_errors": [
            "blackhole_email_with_online_comms"
        ]
    },
    {
        "name": "Validate customer family name",
        "description": "Validate the family name is provided for all customers on a domestic account.",
        "possible_errors": [
            "customer_family_name_required"
        ]
    },
    {
        "name": "Validate portfolio lead communication preference",
        "description": "Validates that portfolio lead is using ONLINE communication preference.",
        "possible_errors": [
            "invalid_portfolio_lead_communication_preference"
        ]
    },
    {
        "name": "Validate all billable meter points are covered by agreements in the payload",
        "description": "Validate that agreements have been provided for all billable meter points and vice versa for the period covered by Kraken from a billing perspective. A billable meter point is one that has an open-ended or future dated supply end date.",
        "possible_errors": [
            "meter_point_with_no_agreement",
            "meterpoint_with_agreement_not_on_supply"
        ]
    },
    {
        "name": "Validate transfer readings exist on active gas meters",
        "description": "Validate that each active gas meter has a single transfer reading provided.",
        "possible_errors": [
            "active_gas_meter_with_multiple_transfer_readings",
            "active_gas_meter_without_transfer_reading",
            "reading_meter_fully_billed"
        ]
    },
    {
        "name": "Validate transfer readings exist on active electricity registers",
        "description": "Validate that each active electricity meter register has a single transfer reading provided.",
        "possible_errors": [
            "missing_transfer_reading_for_register",
            "multiple_transfer_readings_for_register"
        ]
    },
    {
        "name": "Validate concession card and concession credids paid current year",
        "description": "Validates that only one customer with concession card and concession credids paid current year provided; customer with concession card needs to match with customer with concession credits paid current year.",
        "possible_errors": [
            "concession_cards_too_many_users",
            "concession_credits_and_cards_too_many_users",
            "concession_credits_paid_too_many_users"
        ]
    },
    {
        "name": "Validate payment terms apply to portfolio",
        "description": "Validate that portfolio lead account must have <code>apply_to_portfolio</code> set to true and only portfolio lead account can set <code>apply_to_portfolio</code> to true.",
        "possible_errors": [
            "invalid_apply_to_portfolio"
        ]
    },
    {
        "name": "Validate manually defined eligibility periods",
        "description": "Validates that manually defined rebate periods cannot be added without a primary address and some manually defined rebate periods need a concession card as well.",
        "possible_errors": [
            "manually_defined_eligibility_periods_without_concession_card",
            "manually_defined_rebate_periods_without_primary_address"
        ]
    },
    {
        "name": "Validate primary place of residence without concession card or credits paid or manually defined eligibility periods",
        "description": "Validates that only customer with concession card, credits paid or manually defined eligibility periods can have a primary place of residence.",
        "possible_errors": [
            "primary_place_of_residence_without_concession_card_or_credits_paid_or_rebate"
        ]
    },
    {
        "name": "Validate concession cards or credits paid without primary place of residence",
        "description": "Validates that concession cards cannot be loaded without a primary address and concession credits paid for the year cannot be recorded without a primary address except it is proprietor account.",
        "possible_errors": [
            "concession_cards_or_credits_paid_without_primary_place_of_residence"
        ]
    }
]

[
    {
        "name": "Validate account type is valid",
        "description": "Validate that only one account type is specified in the payload.",
        "possible_errors": [
            "multiple_account_types_selected"
        ]
    },
    {
        "name": "Derive occupier billing address from supply address",
        "description": "When an occupier account has no explicit billing address and exactly one supply address is provided, copy the supply address into the billing address fields.",
        "possible_errors": []
    },
    {
        "name": "Validate billing address fields",
        "description": "If a legacy billing address is provided, validate that it is in the correct format.",
        "possible_errors": [
            "invalid_address"
        ]
    },
    {
        "name": "Validate life support contact user email",
        "description": "Validates that life support contact user email matches with customers email. When life support <code>preferred_contact_method</code> is <code>EMAIL_ADDRESS</code>, it requires customer with email. When it is <code>PHONE</code>, it requires customer with mobile or landline.",
        "possible_errors": [
            "missing_contact_user_email_or_phone"
        ]
    },
    {
        "name": "Validate metadata",
        "description": "Validate that metadata, which is a list of key value pairs, does not contain duplicate keys.",
        "possible_errors": [
            "metadata_has_duplicate_keys"
        ]
    },
    {
        "name": "Validate unique property external identifiers",
        "description": "Ensures that <code>property_external_identifier</code> is not repeated across <code>supply_addresses</code> and <code>properties</code>.",
        "possible_errors": [
            "duplicate_property_external_identifiers"
        ]
    },
    {
        "name": "Validate managed account type is allowed",
        "description": "Validate that this instance of Kraken allows managed account types.",
        "possible_errors": [
            "managed_accounts_are_not_allowed"
        ]
    },
    {
        "name": "Validate only portfolio lead has portfolio setting",
        "description": "Validates that if portfolio settings are provided, then the account is marked as the portfolio lead.",
        "possible_errors": [
            "portfolio_settings_included_when_not_lead"
        ]
    },
    {
        "name": "Validate no customers for unknown occupier",
        "description": "Validate that no customers are provided for an unknown occupier.",
        "possible_errors": [
            "customer_with_unknown_occupier"
        ]
    },
    {
        "name": "Validate that a customer given name is provided for business accounts",
        "description": "Validate that a given name is provided for all customers on a business account. Note that this validation only applies if Kraken is configured to send registration flows for this import supplier.",
        "possible_errors": [
            "customer_given_name_required"
        ]
    },
    {
        "name": "Validate portfolio reference provided correctly",
        "description": "Validate that a portfolio reference is provided if portfolio settings have been provided and that a portfolio reference is not provided if the import supplier is set to create new portfolios.",
        "possible_errors": [
            "portfolio_references_missing",
            "portfolio_references_provided"
        ]
    },
    {
        "name": "Validate billing address style",
        "description": "Validate that a legacy billing address (<code>billing_address1</code> etc.) and new-style billing address (<code>billing_address</code> object) are not both provided.",
        "possible_errors": [
            "billing_address_new_style_and_legacy"
        ]
    },
    {
        "name": "Validate agreements are consecutive per supply point",
        "description": "Validate that the agreements provided in the payload are consecutive per supply point i.e. there are no gaps or overlaps. The exception to this is for agreements provided before the current supply period for the supply point. Agreements provided before the <code>supply_start_date</code> are allowed gaps since they represent historic periods of supply and cannot be used for billing in Kraken.",
        "possible_errors": [
            "gaps_or_overlaps_in_agreement_dates"
        ]
    },
    {
        "name": "Validate supply charge line items covered by a single agreement",
        "description": "Validate each supply charge has a single agreement with matching product code that covers the period defined by it's line items minimum <code>start_date</code> to maximum <code>end_date</code>.",
        "possible_errors": [
            "supply_charge_line_items_not_covered_by_single_agreement"
        ]
    },
    {
        "name": "Validate that Kraken can calculate when to start billing the account",
        "description": "Validate that Kraken can calculate when to start billing the account. This is determined based on the existence of last billed to date, last statement closing date, and agreements.",
        "possible_errors": [
            "cannot_determine_responsible_for_billing_from_date"
        ]
    },
    {
        "name": "Validate historical statement period end must not be in the future",
        "description": "Ensures that the historical statement period end date (last_statement_closing_date or latest transaction_date) is not set in the future.",
        "possible_errors": [
            "historical_statement_period_end_in_future"
        ]
    },
    {
        "name": "Validate that terms with supply type matches a supply point supply type",
        "description": "Validate that for terms containing a <code>supply_type</code> field that there is a supply point in the payload with a matching <code>supply_type</code>.",
        "possible_errors": [
            "term_supply_type_mismatch"
        ]
    },
    {
        "name": "Validate that supply addresses and supply points are provided if account contracts are provided",
        "description": "Validate that if <code>account_contracts</code> have been provided that a supply address with supply points has been provided under <code>supply_addresses</code>",
        "possible_errors": [
            "account_contracts_without_supply_points"
        ]
    },
    {
        "name": "Validate historical statement billing document identifier presence",
        "description": "Ensure that billing document identifiers are only provided for historical statement transactions and only when the relevant feature flag is enabled.",
        "possible_errors": [
            "historical_statement_billing_document_identifier_missing",
            "historical_statement_billing_document_identifier_not_allowed_when_feature_flag_disabled"
        ]
    },
    {
        "name": "Validate current statement transactions do not provide <code>billing_document_identifier</code>",
        "description": "Validate that none of the current statement transactions include a <code>billing_document_identifier</code>, as this field is only applicable to historical statement transactions.",
        "possible_errors": [
            "billing_document_identifier_not_allowed_for_current_statement_transactions"
        ]
    },
    {
        "name": "Validate historical statement transaction billing document identifier",
        "description": "Ensure that the billing document identifier is the same for all historical statement transactions.",
        "possible_errors": [
            "historical_statement_billing_document_identifier_mismatch"
        ]
    },
    {
        "name": "Validate that contract terms' product codes are part of supply agreements",
        "description": "Ensure that any contract terms with product references have corresponding products in supply addresses.",
        "possible_errors": [
            "contract_term_product_code_not_in_agreements"
        ]
    },
    {
        "name": "Validate that business is provided if enforcing business contracts",
        "description": "Validate that the business field is provided if <code>enforce_business_contracts_exist</code> is set to True on the import supplier configuration.",
        "possible_errors": [
            "business_field_required"
        ]
    },
    {
        "name": "Validate agreement business contract identifier is declared",
        "description": "Validates that an agreement's <code>business_contract_identifier</code>, if provided, is one of the account's declared <code>business_contract_identifiers</code>.",
        "possible_errors": [
            "agreement_business_contract_identifier_not_declared"
        ]
    },
    {
        "name": "Validate that the sum of ledger balances equals the transfer balance",
        "description": "Validate that the sum of all <code>ledger_balance</code> provided for each ledger in <code>ledgers</code> equals the account-level <code>transfer_balance</code>.",
        "possible_errors": [
            "ledger_balances_not_equal_to_transfer_balance"
        ]
    },
    {
        "name": "Validate business user info against customer info",
        "description": "Validates that business user information matches the corresponding customer information for basic fields.",
        "possible_errors": [
            "customer_details_and_user_details_both_provided"
        ]
    },
    {
        "name": "Validate payment preference <code>ledger_identifier</code>",
        "description": "Ensure that the <code>ledger_identifier</code> provided has an equivalent <code>ledger</code> object with the same <code>ledger_identifier</code> .",
        "possible_errors": [
            "invalid_payment_preference_ledger_identifier"
        ]
    },
    {
        "name": "Validate that referenced ledgers are unique in payment preferences",
        "description": "Ensure that each ledger is referenced in at most one payment preference.",
        "possible_errors": [
            "duplicate_ledger_in_payment_preferences"
        ]
    },
    {
        "name": "Validate that valid instruction_identifier provided for <code>ACTIVE_NEW</code> payment preference",
        "description": "Ensure that <code>ACTIVE_NEW</code> payment preference has instruction_identifier from </code>payment_instructions</code> object.",
        "possible_errors": [
            "active_new_payment_preference_invalid_instruction_identifier"
        ]
    },
    {
        "name": "Validate that the transactions for a voucher do not exceed its value",
        "description": "Validate that the sum of all transaction values for a voucher is not greater than the value of the voucher.",
        "possible_errors": [
            "voucher_transactions_sum_greater_than_voucher_value"
        ]
    },
    {
        "name": "Validate that each voucher charge transaction id has a matching transaction id within a transaction of type CHARGE",
        "description": "Validate that each <code>voucher</code> <code>charge_transaction_id</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CHARGE in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
        "possible_errors": [
            "voucher_charge_transaction_id_not_found"
        ]
    },
    {
        "name": "Validate that each voucher redemption credit transaction id has a matching transaction id within a transaction of type CREDIT",
        "description": "Validate that every <code>credit_transaction_id</code> in all <code>voucher_redemptions</code> in every <code>voucher</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CREDIT in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
        "possible_errors": [
            "voucher_redemption_credit_transaction_id_not_found"
        ]
    },
    {
        "name": "Validate parent property references exist",
        "description": "Validates that all <code>parent_property_reference</code> values in <code>supply_addresses</code> and <code>properties</code> correspond to a <code>property_external_identifier</code> in the payload. This ensures the property hierarchy is valid.",
        "possible_errors": [
            "parent_property_reference_not_found"
        ]
    },
    {
        "name": "Validate that a portfolio lead account has no supply address since it makes no sense for it to have one",
        "description": "Validate that a portfolio lead account has no supply address.",
        "possible_errors": [
            "portfolio_lead_has_a_supply_address"
        ]
    },
    {
        "name": "Validate that a system account has no supply address",
        "description": "Validate that a system account has no supply address",
        "possible_errors": [
            "system_account_has_a_supply_address"
        ]
    },
    {
        "name": "Validate auto allocation of operations team",
        "description": "Validate that operations_team_name is provided if auto allocation is not configured.",
        "possible_errors": [
            "operations_team_provided_when_using_auto_allocation",
            "operations_team_should_be_provided"
        ]
    },
    {
        "name": "Validate ledger identifiers are known",
        "description": "Validate ledger identifiers are among supply point identifiers.",
        "possible_errors": [
            "unknown_ledger_identifiers"
        ]
    },
    {
        "name": "Validate identifiers are unique in ledgers",
        "description": "Validate identifier is not declared twice in ledgers.",
        "possible_errors": [
            "duplicate_identifiers_entries_found"
        ]
    },
    {
        "name": "Validate agreements cover last statement closing date",
        "description": "Validate that there is an agreement for each supply point covering each ledger's <code>last_statement_closing_date</code>.",
        "possible_errors": [
            "no_agreement_covering_last_statement_closing_date"
        ]
    },
    {
        "name": "Validate no unbilled period on former supply addresses",
        "description": "Validate that if a customer is no longer at the given supply address they have been fully billed. This check is performed if we are importing supply address history.",
        "possible_errors": [
            "unbilled_former_supply_address"
        ]
    },
    {
        "name": "Validate at least one billable meter point is provided",
        "description": "Validate that account must have at least one billable meter point unless import config skip_meter_point_creation is ON or account is a portfolio lead, or account is an unmetered service, or account is an inactive account.",
        "possible_errors": [
            "no_supply_point_on_supply"
        ]
    },
    {
        "name": "Validate alternative phone number is unique",
        "description": "Validate customers defined in the payload do not have the same alternative phone numbers.",
        "possible_errors": [
            "duplicated_alternative_phone_numbers"
        ]
    },
    {
        "name": "Validate billing address style",
        "description": "Validate that a legacy billing address (<code>billing_address1</code> etc.) and new-style billing address (<code>billing_address</code> object) are not both provided.",
        "possible_errors": [
            "billing_address_new_style_and_legacy"
        ]
    },
    {
        "name": "Validate business type not provided for domestic accounts",
        "description": "Validate that a business type is not provided for domestic accounts.",
        "possible_errors": [
            "business_fields_provided_for_domestic_accounts"
        ]
    },
    {
        "name": "Validate that blackhole email addresses are paired with 'online' communication prefernence",
        "description": "Validate that the communication preference 'online' when a blackhole email address is provided.",
        "possible_errors": [
            "blackhole_email_with_online_comms"
        ]
    },
    {
        "name": "Validate customer family name",
        "description": "Validate the family name is provided for all customers on a domestic account.",
        "possible_errors": [
            "customer_family_name_required"
        ]
    },
    {
        "name": "Validate portfolio lead communication preference",
        "description": "Validates that portfolio lead is using ONLINE communication preference.",
        "possible_errors": [
            "invalid_portfolio_lead_communication_preference"
        ]
    },
    {
        "name": "Validate all billable meter points are covered by agreements in the payload",
        "description": "Validate that agreements have been provided for all billable meter points and vice versa for the period covered by Kraken from a billing perspective. A billable meter point is one that has an open-ended or future dated supply end date.",
        "possible_errors": [
            "meter_point_with_no_agreement",
            "meterpoint_with_agreement_not_on_supply"
        ]
    },
    {
        "name": "Validate transfer readings exist on active gas meters",
        "description": "Validate that each active gas meter has a single transfer reading provided.",
        "possible_errors": [
            "active_gas_meter_with_multiple_transfer_readings",
            "active_gas_meter_without_transfer_reading",
            "reading_meter_fully_billed"
        ]
    },
    {
        "name": "Validate transfer readings exist on active electricity registers",
        "description": "Validate that each active electricity meter register has a single transfer reading provided.",
        "possible_errors": [
            "missing_transfer_reading_for_register",
            "multiple_transfer_readings_for_register"
        ]
    },
    {
        "name": "Validate concession card and concession credids paid current year",
        "description": "Validates that only one customer with concession card and concession credids paid current year provided; customer with concession card needs to match with customer with concession credits paid current year.",
        "possible_errors": [
            "concession_cards_too_many_users",
            "concession_credits_and_cards_too_many_users",
            "concession_credits_paid_too_many_users"
        ]
    },
    {
        "name": "Validate payment terms apply to portfolio",
        "description": "Validate that portfolio lead account must have <code>apply_to_portfolio</code> set to true and only portfolio lead account can set <code>apply_to_portfolio</code> to true.",
        "possible_errors": [
            "invalid_apply_to_portfolio"
        ]
    },
    {
        "name": "Validate manually defined eligibility periods",
        "description": "Validates that manually defined rebate periods cannot be added without a primary address and some manually defined rebate periods need a concession card as well.",
        "possible_errors": [
            "manually_defined_eligibility_periods_without_concession_card",
            "manually_defined_rebate_periods_without_primary_address"
        ]
    },
    {
        "name": "Validate primary place of residence without concession card or credits paid or manually defined eligibility periods",
        "description": "Validates that only customer with concession card, credits paid or manually defined eligibility periods can have a primary place of residence.",
        "possible_errors": [
            "primary_place_of_residence_without_concession_card_or_credits_paid_or_rebate"
        ]
    },
    {
        "name": "Validate concession cards or credits paid without primary place of residence",
        "description": "Validates that concession cards cannot be loaded without a primary address and concession credits paid for the year cannot be recorded without a primary address except it is proprietor account.",
        "possible_errors": [
            "concession_cards_or_credits_paid_without_primary_place_of_residence"
        ]
    }
]

{
    "x-validators": [
        {
            "name": "Validate alternative phone number is not in kraken",
            "description": "Validate the alternative phone number provided does not exist in the database.",
            "possible_errors": [
                "alternative_phone_numbers_already_exists"
            ]
        }
    ]
}

{
    "x-validators": [
        {
            "name": "Validate alternative phone number is not in kraken",
            "description": "Validate the alternative phone number provided does not exist in the database.",
            "possible_errors": [
                "alternative_phone_numbers_already_exists"
            ]
        }
    ]
}

[
    {
        "name": "Validate <code>\u2068end_date\u2069</code> not before <code>\u2068start_date\u2069</code>",
        "description": "Validates that <code>\u2068end_date\u2069</code>, if given, is on or later than <code>\u2068start_date\u2069</code>.",
        "possible_errors": [
            "start_date_later_than_end_date"
        ]
    },
    {
        "name": "Validate fixed payment schedule has amount",
        "description": "Validates that a fixed payment schedule has an non zero amount provided in the payload. A fixed schedule is defined as a payment schedule with a trigger that is not type BILL.",
        "possible_errors": [
            "zero_payment_schedule_amount"
        ]
    },
    {
        "name": "Validate regular payment schedule frequency provided",
        "description": "Validates that a fixed regular payment schedule has a frequency provided in the payload.",
        "possible_errors": [
            "fixed_payment_schedule_missing_frequency"
        ]
    },
    {
        "name": "Validate payment schedule balance threshold provided",
        "description": "Validates that a payment schedule with a balance trigger has a balance threshold provided in the payload. This balance threshold is the amount the ledger balance must drop below to trigger a payment.",
        "possible_errors": [
            "balance_triggered_schedule_missing_threshold"
        ]
    },
    {
        "name": "Validate debt repayment end date provided",
        "description": "Validates that a debt repayment end date is provided in the payload if a debt repayment element is provided.",
        "possible_errors": [
            "debt_repayment_missing_end_date"
        ]
    },
    {
        "name": "Validate debt repayment end date is not later than schedule end date",
        "description": "Validates that a debt repayment end date is not later than  the payment schedule end date if both are provided.",
        "possible_errors": [
            "debt_repayment_end_date_after_schedule_end_date"
        ]
    },
    {
        "name": "Validate exempt from payment adequacy is applied only to regular schedule",
        "description": "Validates that only a regular payment schedule is marked as exempted from payment adequacy, so as to create a fixed regular payment schedule.",
        "possible_errors": [
            "invalid_payment_schedule_to_exempt_from_payment_adequacy"
        ]
    },
    {
        "name": "Validate fixed payment schedule has payment day",
        "description": "Validates that a fixed payment schedule has a day of month in the payload. A fixed schedule is defined as a payment schedule with a trigger of type REGULAR.",
        "possible_errors": [
            "fixed_payment_schedule_missing_day_of_month"
        ]
    },
    {
        "name": "Validate instalments is provided if trigger is PLAN",
        "description": "Validate that the instalment field is not empty if payment schedule trigger is PLAN.",
        "possible_errors": [
            "payment_instalments_not_provided"
        ]
    },
    {
        "name": "Validate instalment payment amounts sum to total amount",
        "description": "Validate instalment payment amounts sum to total amount given.",
        "possible_errors": [
            "payment_instalments_do_not_sum_to_total"
        ]
    },
    {
        "name": "Validate instalment payment date is within payment schedule active period",
        "description": "Validate instalment payment date is within the period between start date and end date provided.",
        "possible_errors": [
            "payment_instalments_date_outside_of_payment_schedule_active_period"
        ]
    },
    {
        "name": "Validate that the delayer days is set if delayer strategy is set",
        "description": "Validate that the delayer days is set if delayer strategy is set",
        "possible_errors": [
            "payment_schedule_delay_must_have_bill_trigger",
            "payment_schedule_delay_strategy_missing_delay_days"
        ]
    },
    {
        "name": "Validate that the payment amount for fixed payment schedules is within the minor currency unit range of \u20680\u2069 - \u2068upper_bound\u2069",
        "description": "Validate that the payment amount for any fixed payment schedule is within the major currency unit range of \u2068lower_limit\u2069 - \u2068UNLIMITED\u2069.",
        "possible_errors": [
            "fixed_payment_schedule_amount_out_of_range"
        ]
    },
    {
        "name": "Standalone payment request method code is unexpected",
        "description": "Validates that standalone_payment_request_method_code is only provided for MANUAL payment schedules.",
        "possible_errors": [
            "standalone_payment_request_method_code_unexpected"
        ]
    },
    {
        "name": "Standalone payment request method code is valid",
        "description": "Validates that standalone_payment_request_method_code matches a registered method.",
        "possible_errors": [
            "standalone_payment_request_method_code_invalid"
        ]
    }
]

[
    {
        "name": "Validate <code>\u2068end_date\u2069</code> not before <code>\u2068start_date\u2069</code>",
        "description": "Validates that <code>\u2068end_date\u2069</code>, if given, is on or later than <code>\u2068start_date\u2069</code>.",
        "possible_errors": [
            "start_date_later_than_end_date"
        ]
    },
    {
        "name": "Validate fixed payment schedule has amount",
        "description": "Validates that a fixed payment schedule has an non zero amount provided in the payload. A fixed schedule is defined as a payment schedule with a trigger that is not type BILL.",
        "possible_errors": [
            "zero_payment_schedule_amount"
        ]
    },
    {
        "name": "Validate regular payment schedule frequency provided",
        "description": "Validates that a fixed regular payment schedule has a frequency provided in the payload.",
        "possible_errors": [
            "fixed_payment_schedule_missing_frequency"
        ]
    },
    {
        "name": "Validate payment schedule balance threshold provided",
        "description": "Validates that a payment schedule with a balance trigger has a balance threshold provided in the payload. This balance threshold is the amount the ledger balance must drop below to trigger a payment.",
        "possible_errors": [
            "balance_triggered_schedule_missing_threshold"
        ]
    },
    {
        "name": "Validate debt repayment end date provided",
        "description": "Validates that a debt repayment end date is provided in the payload if a debt repayment element is provided.",
        "possible_errors": [
            "debt_repayment_missing_end_date"
        ]
    },
    {
        "name": "Validate debt repayment end date is not later than schedule end date",
        "description": "Validates that a debt repayment end date is not later than  the payment schedule end date if both are provided.",
        "possible_errors": [
            "debt_repayment_end_date_after_schedule_end_date"
        ]
    },
    {
        "name": "Validate exempt from payment adequacy is applied only to regular schedule",
        "description": "Validates that only a regular payment schedule is marked as exempted from payment adequacy, so as to create a fixed regular payment schedule.",
        "possible_errors": [
            "invalid_payment_schedule_to_exempt_from_payment_adequacy"
        ]
    },
    {
        "name": "Validate fixed payment schedule has payment day",
        "description": "Validates that a fixed payment schedule has a day of month in the payload. A fixed schedule is defined as a payment schedule with a trigger of type REGULAR.",
        "possible_errors": [
            "fixed_payment_schedule_missing_day_of_month"
        ]
    },
    {
        "name": "Validate instalments is provided if trigger is PLAN",
        "description": "Validate that the instalment field is not empty if payment schedule trigger is PLAN.",
        "possible_errors": [
            "payment_instalments_not_provided"
        ]
    },
    {
        "name": "Validate instalment payment amounts sum to total amount",
        "description": "Validate instalment payment amounts sum to total amount given.",
        "possible_errors": [
            "payment_instalments_do_not_sum_to_total"
        ]
    },
    {
        "name": "Validate instalment payment date is within payment schedule active period",
        "description": "Validate instalment payment date is within the period between start date and end date provided.",
        "possible_errors": [
            "payment_instalments_date_outside_of_payment_schedule_active_period"
        ]
    },
    {
        "name": "Validate that the delayer days is set if delayer strategy is set",
        "description": "Validate that the delayer days is set if delayer strategy is set",
        "possible_errors": [
            "payment_schedule_delay_must_have_bill_trigger",
            "payment_schedule_delay_strategy_missing_delay_days"
        ]
    },
    {
        "name": "Validate that the payment amount for fixed payment schedules is within the minor currency unit range of \u20680\u2069 - \u2068upper_bound\u2069",
        "description": "Validate that the payment amount for any fixed payment schedule is within the major currency unit range of \u2068lower_limit\u2069 - \u2068UNLIMITED\u2069.",
        "possible_errors": [
            "fixed_payment_schedule_amount_out_of_range"
        ]
    }
]

{
    "x-enum-descriptions": {
        "9720": "9720",
        "NASS11S": "NASS11S",
        "BLNE14AU": "BLNE14AU"
    }
}

{
    "x-enum-descriptions": {}
}

[
    {
        "name": "Validate account type is valid",
        "description": "Validate that only one account type is specified in the payload.",
        "possible_errors": [
            "multiple_account_types_selected"
        ]
    },
    {
        "name": "Derive occupier billing address from supply address",
        "description": "When an occupier account has no explicit billing address and exactly one supply address is provided, copy the supply address into the billing address fields.",
        "possible_errors": []
    },
    {
        "name": "Validate billing address fields",
        "description": "If a legacy billing address is provided, validate that it is in the correct format.",
        "possible_errors": [
            "invalid_address"
        ]
    },
    {
        "name": "Validate life support contact user email",
        "description": "Validates that life support contact user email matches with customers email. When life support <code>preferred_contact_method</code> is <code>EMAIL_ADDRESS</code>, it requires customer with email. When it is <code>PHONE</code>, it requires customer with mobile or landline.",
        "possible_errors": [
            "missing_contact_user_email_or_phone"
        ]
    },
    {
        "name": "Validate metadata",
        "description": "Validate that metadata, which is a list of key value pairs, does not contain duplicate keys.",
        "possible_errors": [
            "metadata_has_duplicate_keys"
        ]
    },
    {
        "name": "Validate unique property external identifiers",
        "description": "Ensures that <code>property_external_identifier</code> is not repeated across <code>supply_addresses</code> and <code>properties</code>.",
        "possible_errors": [
            "duplicate_property_external_identifiers"
        ]
    },
    {
        "name": "Validate managed account type is allowed",
        "description": "Validate that this instance of Kraken allows managed account types.",
        "possible_errors": [
            "managed_accounts_are_not_allowed"
        ]
    },
    {
        "name": "Validate only portfolio lead has portfolio setting",
        "description": "Validates that if portfolio settings are provided, then the account is marked as the portfolio lead.",
        "possible_errors": [
            "portfolio_settings_included_when_not_lead"
        ]
    },
    {
        "name": "Validate no customers for unknown occupier",
        "description": "Validate that no customers are provided for an unknown occupier.",
        "possible_errors": [
            "customer_with_unknown_occupier"
        ]
    },
    {
        "name": "Validate that a customer given name is provided for business accounts",
        "description": "Validate that a given name is provided for all customers on a business account. Note that this validation only applies if Kraken is configured to send registration flows for this import supplier.",
        "possible_errors": [
            "customer_given_name_required"
        ]
    },
    {
        "name": "Validate portfolio reference provided correctly",
        "description": "Validate that a portfolio reference is provided if portfolio settings have been provided and that a portfolio reference is not provided if the import supplier is set to create new portfolios.",
        "possible_errors": [
            "portfolio_references_missing",
            "portfolio_references_provided"
        ]
    },
    {
        "name": "Validate billing address style",
        "description": "Validate that a legacy billing address (<code>billing_address1</code> etc.) and new-style billing address (<code>billing_address</code> object) are not both provided.",
        "possible_errors": [
            "billing_address_new_style_and_legacy"
        ]
    },
    {
        "name": "Validate agreements are consecutive per supply point",
        "description": "Validate that the agreements provided in the payload are consecutive per supply point i.e. there are no gaps or overlaps. The exception to this is for agreements provided before the current supply period for the supply point. Agreements provided before the <code>supply_start_date</code> are allowed gaps since they represent historic periods of supply and cannot be used for billing in Kraken.",
        "possible_errors": [
            "gaps_or_overlaps_in_agreement_dates"
        ]
    },
    {
        "name": "Validate supply charge line items covered by a single agreement",
        "description": "Validate each supply charge has a single agreement with matching product code that covers the period defined by it's line items minimum <code>start_date</code> to maximum <code>end_date</code>.",
        "possible_errors": [
            "supply_charge_line_items_not_covered_by_single_agreement"
        ]
    },
    {
        "name": "Validate that Kraken can calculate when to start billing the account",
        "description": "Validate that Kraken can calculate when to start billing the account. This is determined based on the existence of last billed to date, last statement closing date, and agreements.",
        "possible_errors": [
            "cannot_determine_responsible_for_billing_from_date"
        ]
    },
    {
        "name": "Validate historical statement period end must not be in the future",
        "description": "Ensures that the historical statement period end date (last_statement_closing_date or latest transaction_date) is not set in the future.",
        "possible_errors": [
            "historical_statement_period_end_in_future"
        ]
    },
    {
        "name": "Validate that terms with supply type matches a supply point supply type",
        "description": "Validate that for terms containing a <code>supply_type</code> field that there is a supply point in the payload with a matching <code>supply_type</code>.",
        "possible_errors": [
            "term_supply_type_mismatch"
        ]
    },
    {
        "name": "Validate that supply addresses and supply points are provided if account contracts are provided",
        "description": "Validate that if <code>account_contracts</code> have been provided that a supply address with supply points has been provided under <code>supply_addresses</code>",
        "possible_errors": [
            "account_contracts_without_supply_points"
        ]
    },
    {
        "name": "Validate historical statement billing document identifier presence",
        "description": "Ensure that billing document identifiers are only provided for historical statement transactions and only when the relevant feature flag is enabled.",
        "possible_errors": [
            "historical_statement_billing_document_identifier_missing",
            "historical_statement_billing_document_identifier_not_allowed_when_feature_flag_disabled"
        ]
    },
    {
        "name": "Validate current statement transactions do not provide <code>billing_document_identifier</code>",
        "description": "Validate that none of the current statement transactions include a <code>billing_document_identifier</code>, as this field is only applicable to historical statement transactions.",
        "possible_errors": [
            "billing_document_identifier_not_allowed_for_current_statement_transactions"
        ]
    },
    {
        "name": "Validate historical statement transaction billing document identifier",
        "description": "Ensure that the billing document identifier is the same for all historical statement transactions.",
        "possible_errors": [
            "historical_statement_billing_document_identifier_mismatch"
        ]
    },
    {
        "name": "Validate that contract terms' product codes are part of supply agreements",
        "description": "Ensure that any contract terms with product references have corresponding products in supply addresses.",
        "possible_errors": [
            "contract_term_product_code_not_in_agreements"
        ]
    },
    {
        "name": "Validate that business is provided if enforcing business contracts",
        "description": "Validate that the business field is provided if <code>enforce_business_contracts_exist</code> is set to True on the import supplier configuration.",
        "possible_errors": [
            "business_field_required"
        ]
    },
    {
        "name": "Validate agreement business contract identifier is declared",
        "description": "Validates that an agreement's <code>business_contract_identifier</code>, if provided, is one of the account's declared <code>business_contract_identifiers</code>.",
        "possible_errors": [
            "agreement_business_contract_identifier_not_declared"
        ]
    },
    {
        "name": "Validate that the sum of ledger balances equals the transfer balance",
        "description": "Validate that the sum of all <code>ledger_balance</code> provided for each ledger in <code>ledgers</code> equals the account-level <code>transfer_balance</code>.",
        "possible_errors": [
            "ledger_balances_not_equal_to_transfer_balance"
        ]
    },
    {
        "name": "Validate business user info against customer info",
        "description": "Validates that business user information matches the corresponding customer information for basic fields.",
        "possible_errors": [
            "customer_details_and_user_details_both_provided"
        ]
    },
    {
        "name": "Validate payment preference <code>ledger_identifier</code>",
        "description": "Ensure that the <code>ledger_identifier</code> provided has an equivalent <code>ledger</code> object with the same <code>ledger_identifier</code> .",
        "possible_errors": [
            "invalid_payment_preference_ledger_identifier"
        ]
    },
    {
        "name": "Validate that referenced ledgers are unique in payment preferences",
        "description": "Ensure that each ledger is referenced in at most one payment preference.",
        "possible_errors": [
            "duplicate_ledger_in_payment_preferences"
        ]
    },
    {
        "name": "Validate that valid instruction_identifier provided for <code>ACTIVE_NEW</code> payment preference",
        "description": "Ensure that <code>ACTIVE_NEW</code> payment preference has instruction_identifier from </code>payment_instructions</code> object.",
        "possible_errors": [
            "active_new_payment_preference_invalid_instruction_identifier"
        ]
    },
    {
        "name": "Validate that the transactions for a voucher do not exceed its value",
        "description": "Validate that the sum of all transaction values for a voucher is not greater than the value of the voucher.",
        "possible_errors": [
            "voucher_transactions_sum_greater_than_voucher_value"
        ]
    },
    {
        "name": "Validate that each voucher charge transaction id has a matching transaction id within a transaction of type CHARGE",
        "description": "Validate that each <code>voucher</code> <code>charge_transaction_id</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CHARGE in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
        "possible_errors": [
            "voucher_charge_transaction_id_not_found"
        ]
    },
    {
        "name": "Validate that each voucher redemption credit transaction id has a matching transaction id within a transaction of type CREDIT",
        "description": "Validate that every <code>credit_transaction_id</code> in all <code>voucher_redemptions</code> in every <code>voucher</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CREDIT in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
        "possible_errors": [
            "voucher_redemption_credit_transaction_id_not_found"
        ]
    },
    {
        "name": "Validate parent property references exist",
        "description": "Validates that all <code>parent_property_reference</code> values in <code>supply_addresses</code> and <code>properties</code> correspond to a <code>property_external_identifier</code> in the payload. This ensures the property hierarchy is valid.",
        "possible_errors": [
            "parent_property_reference_not_found"
        ]
    },
    {
        "name": "Validate that a portfolio lead account has no supply address since it makes no sense for it to have one",
        "description": "Validate that a portfolio lead account has no supply address.",
        "possible_errors": [
            "portfolio_lead_has_a_supply_address"
        ]
    },
    {
        "name": "Validate that a system account has no supply address",
        "description": "Validate that a system account has no supply address",
        "possible_errors": [
            "system_account_has_a_supply_address"
        ]
    },
    {
        "name": "Validate auto allocation of operations team",
        "description": "Validate that operations_team_name is provided if auto allocation is not configured.",
        "possible_errors": [
            "operations_team_provided_when_using_auto_allocation",
            "operations_team_should_be_provided"
        ]
    },
    {
        "name": "Validate ledger identifiers are known",
        "description": "Validate ledger identifiers are among supply point identifiers.",
        "possible_errors": [
            "unknown_ledger_identifiers"
        ]
    },
    {
        "name": "Validate identifiers are unique in ledgers",
        "description": "Validate identifier is not declared twice in ledgers.",
        "possible_errors": [
            "duplicate_identifiers_entries_found"
        ]
    },
    {
        "name": "Validate agreements cover last statement closing date",
        "description": "Validate that there is an agreement for each supply point covering each ledger's <code>last_statement_closing_date</code>.",
        "possible_errors": [
            "no_agreement_covering_last_statement_closing_date"
        ]
    },
    {
        "name": "Validate no unbilled period on former supply addresses",
        "description": "Validate that if a customer is no longer at the given supply address they have been fully billed. This check is performed if we are importing supply address history.",
        "possible_errors": [
            "unbilled_former_supply_address"
        ]
    },
    {
        "name": "Validate at least one billable meter point is provided",
        "description": "Validate that account must have at least one billable meter point unless import config skip_meter_point_creation is ON or account is a portfolio lead, or account is an unmetered service, or account is an inactive account.",
        "possible_errors": [
            "no_supply_point_on_supply"
        ]
    },
    {
        "name": "Validate alternative phone number is unique",
        "description": "Validate customers defined in the payload do not have the same alternative phone numbers.",
        "possible_errors": [
            "duplicated_alternative_phone_numbers"
        ]
    },
    {
        "name": "Validate billing address style",
        "description": "Validate that a legacy billing address (<code>billing_address1</code> etc.) and new-style billing address (<code>billing_address</code> object) are not both provided.",
        "possible_errors": [
            "billing_address_new_style_and_legacy"
        ]
    },
    {
        "name": "Validate business type not provided for domestic accounts",
        "description": "Validate that a business type is not provided for domestic accounts.",
        "possible_errors": [
            "business_fields_provided_for_domestic_accounts"
        ]
    },
    {
        "name": "Validate that blackhole email addresses are paired with 'online' communication prefernence",
        "description": "Validate that the communication preference 'online' when a blackhole email address is provided.",
        "possible_errors": [
            "blackhole_email_with_online_comms"
        ]
    },
    {
        "name": "Validate customer family name",
        "description": "Validate the family name is provided for all customers on a domestic account.",
        "possible_errors": [
            "customer_family_name_required"
        ]
    },
    {
        "name": "Validate portfolio lead communication preference",
        "description": "Validates that portfolio lead is using ONLINE communication preference.",
        "possible_errors": [
            "invalid_portfolio_lead_communication_preference"
        ]
    },
    {
        "name": "Validate all billable meter points are covered by agreements in the payload",
        "description": "Validate that agreements have been provided for all billable meter points and vice versa for the period covered by Kraken from a billing perspective. A billable meter point is one that has an open-ended or future dated supply end date.",
        "possible_errors": [
            "meter_point_with_no_agreement",
            "meterpoint_with_agreement_not_on_supply"
        ]
    },
    {
        "name": "Validate transfer readings exist on active gas meters",
        "description": "Validate that each active gas meter has a single transfer reading provided.",
        "possible_errors": [
            "active_gas_meter_with_multiple_transfer_readings",
            "active_gas_meter_without_transfer_reading",
            "reading_meter_fully_billed"
        ]
    },
    {
        "name": "Validate transfer readings exist on active electricity registers",
        "description": "Validate that each active electricity meter register has a single transfer reading provided.",
        "possible_errors": [
            "missing_transfer_reading_for_register",
            "multiple_transfer_readings_for_register"
        ]
    },
    {
        "name": "Validate concession card and concession credids paid current year",
        "description": "Validates that only one customer with concession card and concession credids paid current year provided; customer with concession card needs to match with customer with concession credits paid current year.",
        "possible_errors": [
            "concession_cards_too_many_users",
            "concession_credits_and_cards_too_many_users",
            "concession_credits_paid_too_many_users"
        ]
    },
    {
        "name": "Validate payment terms apply to portfolio",
        "description": "Validate that portfolio lead account must have <code>apply_to_portfolio</code> set to true and only portfolio lead account can set <code>apply_to_portfolio</code> to true.",
        "possible_errors": [
            "invalid_apply_to_portfolio"
        ]
    },
    {
        "name": "Validate manually defined eligibility periods",
        "description": "Validates that manually defined rebate periods cannot be added without a primary address and some manually defined rebate periods need a concession card as well.",
        "possible_errors": [
            "manually_defined_eligibility_periods_without_concession_card",
            "manually_defined_rebate_periods_without_primary_address"
        ]
    },
    {
        "name": "Validate primary place of residence without concession card or credits paid or manually defined eligibility periods",
        "description": "Validates that only customer with concession card, credits paid or manually defined eligibility periods can have a primary place of residence.",
        "possible_errors": [
            "primary_place_of_residence_without_concession_card_or_credits_paid_or_rebate"
        ]
    },
    {
        "name": "Validate concession cards or credits paid without primary place of residence",
        "description": "Validates that concession cards cannot be loaded without a primary address and concession credits paid for the year cannot be recorded without a primary address except it is proprietor account.",
        "possible_errors": [
            "concession_cards_or_credits_paid_without_primary_place_of_residence"
        ]
    }
]

[
    {
        "name": "Validate account type is valid",
        "description": "Validate that only one account type is specified in the payload.",
        "possible_errors": [
            "multiple_account_types_selected"
        ]
    },
    {
        "name": "Validate billing address fields",
        "description": "If a legacy billing address is provided, validate that it is in the correct format.",
        "possible_errors": [
            "invalid_address"
        ]
    },
    {
        "name": "Validate life support contact user email",
        "description": "Validates that life support contact user email matches with customers email. When life support <code>preferred_contact_method</code> is <code>EMAIL_ADDRESS</code>, it requires customer with email. When it is <code>PHONE</code>, it requires customer with mobile or landline.",
        "possible_errors": [
            "missing_contact_user_email_or_phone"
        ]
    },
    {
        "name": "Validate metadata",
        "description": "Validate that metadata, which is a list of key value pairs, does not contain duplicate keys.",
        "possible_errors": [
            "metadata_has_duplicate_keys"
        ]
    },
    {
        "name": "Validate unique property external identifiers",
        "description": "Ensures that <code>property_external_identifier</code> is not repeated across <code>supply_addresses</code> and <code>properties</code>.",
        "possible_errors": [
            "duplicate_property_external_identifiers"
        ]
    },
    {
        "name": "Validate managed account type is allowed",
        "description": "Validate that this instance of Kraken allows managed account types.",
        "possible_errors": [
            "managed_accounts_are_not_allowed"
        ]
    },
    {
        "name": "Validate only portfolio lead has portfolio setting",
        "description": "Validates that if portfolio settings are provided, then the account is marked as the portfolio lead.",
        "possible_errors": [
            "portfolio_settings_included_when_not_lead"
        ]
    },
    {
        "name": "Validate no customers for unknown occupier",
        "description": "Validate that no customers are provided for an unknown occupier.",
        "possible_errors": [
            "customer_with_unknown_occupier"
        ]
    },
    {
        "name": "Validate that a customer given name is provided for business accounts",
        "description": "Validate that a given name is provided for all customers on a business account. Note that this validation only applies if Kraken is configured to send registration flows for this import supplier.",
        "possible_errors": [
            "customer_given_name_required"
        ]
    },
    {
        "name": "Validate portfolio reference provided correctly",
        "description": "Validate that a portfolio reference is provided if portfolio settings have been provided and that a portfolio reference is not provided if the import supplier is set to create new portfolios.",
        "possible_errors": [
            "portfolio_references_missing",
            "portfolio_references_provided"
        ]
    },
    {
        "name": "Validate billing address style",
        "description": "Validate that a legacy billing address (<code>billing_address1</code> etc.) and new-style billing address (<code>billing_address</code> object) are not both provided.",
        "possible_errors": [
            "billing_address_new_style_and_legacy"
        ]
    },
    {
        "name": "Validate agreements are consecutive per supply point",
        "description": "Validate that the agreements provided in the payload are consecutive per supply point i.e. there are no gaps or overlaps. The exception to this is for agreements provided before the current supply period for the supply point. Agreements provided before the <code>supply_start_date</code> are allowed gaps since they represent historic periods of supply and cannot be used for billing in Kraken.",
        "possible_errors": [
            "gaps_or_overlaps_in_agreement_dates"
        ]
    },
    {
        "name": "Validate supply charge line items covered by a single agreement",
        "description": "Validate each supply charge has a single agreement with matching product code that covers the period defined by it's line items minimum <code>start_date</code> to maximum <code>end_date</code>.",
        "possible_errors": [
            "supply_charge_line_items_not_covered_by_single_agreement"
        ]
    },
    {
        "name": "Validate that Kraken can calculate when to start billing the account",
        "description": "Validate that Kraken can calculate when to start billing the account. This is determined based on the existence of last billed to date, last statement closing date, and agreements.",
        "possible_errors": [
            "cannot_determine_responsible_for_billing_from_date"
        ]
    },
    {
        "name": "Validate historical statement period end must not be in the future",
        "description": "Ensures that the historical statement period end date (last_statement_closing_date or latest transaction_date) is not set in the future.",
        "possible_errors": [
            "historical_statement_period_end_in_future"
        ]
    },
    {
        "name": "Validate that terms with supply type matches a supply point supply type",
        "description": "Validate that for terms containing a <code>supply_type</code> field that there is a supply point in the payload with a matching <code>supply_type</code>.",
        "possible_errors": [
            "term_supply_type_mismatch"
        ]
    },
    {
        "name": "Validate that supply addresses and supply points are provided if account contracts are provided",
        "description": "Validate that if <code>account_contracts</code> have been provided that a supply address with supply points has been provided under <code>supply_addresses</code>",
        "possible_errors": [
            "account_contracts_without_supply_points"
        ]
    },
    {
        "name": "Validate historical statement billing document identifier presence",
        "description": "Ensure that billing document identifiers are only provided for historical statement transactions and only when the relevant feature flag is enabled.",
        "possible_errors": [
            "historical_statement_billing_document_identifier_missing",
            "historical_statement_billing_document_identifier_not_allowed_when_feature_flag_disabled"
        ]
    },
    {
        "name": "Validate current statement transactions do not provide <code>billing_document_identifier</code>",
        "description": "Validate that none of the current statement transactions include a <code>billing_document_identifier</code>, as this field is only applicable to historical statement transactions.",
        "possible_errors": [
            "billing_document_identifier_not_allowed_for_current_statement_transactions"
        ]
    },
    {
        "name": "Validate historical statement transaction billing document identifier",
        "description": "Ensure that the billing document identifier is the same for all historical statement transactions.",
        "possible_errors": [
            "historical_statement_billing_document_identifier_mismatch"
        ]
    },
    {
        "name": "Validate that contract terms' product codes are part of supply agreements",
        "description": "Ensure that any contract terms with product references have corresponding products in supply addresses.",
        "possible_errors": [
            "contract_term_product_code_not_in_agreements"
        ]
    },
    {
        "name": "Validate that business is provided if enforcing business contracts",
        "description": "Validate that the business field is provided if <code>enforce_business_contracts_exist</code> is set to True on the import supplier configuration.",
        "possible_errors": [
            "business_field_required"
        ]
    },
    {
        "name": "Validate agreement business contract identifier is declared",
        "description": "Validates that an agreement's <code>business_contract_identifier</code>, if provided, is one of the account's declared <code>business_contract_identifiers</code>.",
        "possible_errors": [
            "agreement_business_contract_identifier_not_declared"
        ]
    },
    {
        "name": "Validate that the sum of ledger balances equals the transfer balance",
        "description": "Validate that the sum of all <code>ledger_balance</code> provided for each ledger in <code>ledgers</code> equals the account-level <code>transfer_balance</code>.",
        "possible_errors": [
            "ledger_balances_not_equal_to_transfer_balance"
        ]
    },
    {
        "name": "Validate business user info against customer info",
        "description": "Validates that business user information matches the corresponding customer information for basic fields.",
        "possible_errors": [
            "customer_details_and_user_details_both_provided"
        ]
    },
    {
        "name": "Validate payment preference <code>ledger_identifier</code>",
        "description": "Ensure that the <code>ledger_identifier</code> provided has an equivalent <code>ledger</code> object with the same <code>ledger_identifier</code> .",
        "possible_errors": [
            "invalid_payment_preference_ledger_identifier"
        ]
    },
    {
        "name": "Validate that referenced ledgers are unique in payment preferences",
        "description": "Ensure that each ledger is referenced in at most one payment preference.",
        "possible_errors": [
            "duplicate_ledger_in_payment_preferences"
        ]
    },
    {
        "name": "Validate that valid instruction_identifier provided for <code>ACTIVE_NEW</code> payment preference",
        "description": "Ensure that <code>ACTIVE_NEW</code> payment preference has instruction_identifier from </code>payment_instructions</code> object.",
        "possible_errors": [
            "active_new_payment_preference_invalid_instruction_identifier"
        ]
    },
    {
        "name": "Validate that the transactions for a voucher do not exceed its value",
        "description": "Validate that the sum of all transaction values for a voucher is not greater than the value of the voucher.",
        "possible_errors": [
            "voucher_transactions_sum_greater_than_voucher_value"
        ]
    },
    {
        "name": "Validate that each voucher charge transaction id has a matching transaction id within a transaction of type CHARGE",
        "description": "Validate that each <code>voucher</code> <code>charge_transaction_id</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CHARGE in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
        "possible_errors": [
            "voucher_charge_transaction_id_not_found"
        ]
    },
    {
        "name": "Validate that each voucher redemption credit transaction id has a matching transaction id within a transaction of type CREDIT",
        "description": "Validate that every <code>credit_transaction_id</code> in all <code>voucher_redemptions</code> in every <code>voucher</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CREDIT in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
        "possible_errors": [
            "voucher_redemption_credit_transaction_id_not_found"
        ]
    },
    {
        "name": "Validate parent property references exist",
        "description": "Validates that all <code>parent_property_reference</code> values in <code>supply_addresses</code> and <code>properties</code> correspond to a <code>property_external_identifier</code> in the payload. This ensures the property hierarchy is valid.",
        "possible_errors": [
            "parent_property_reference_not_found"
        ]
    },
    {
        "name": "Validate that a portfolio lead account has no supply address since it makes no sense for it to have one",
        "description": "Validate that a portfolio lead account has no supply address.",
        "possible_errors": [
            "portfolio_lead_has_a_supply_address"
        ]
    },
    {
        "name": "Validate that a system account has no supply address",
        "description": "Validate that a system account has no supply address",
        "possible_errors": [
            "system_account_has_a_supply_address"
        ]
    },
    {
        "name": "Validate auto allocation of operations team",
        "description": "Validate that operations_team_name is provided if auto allocation is not configured.",
        "possible_errors": [
            "operations_team_provided_when_using_auto_allocation",
            "operations_team_should_be_provided"
        ]
    },
    {
        "name": "Validate ledger identifiers are known",
        "description": "Validate ledger identifiers are among supply point identifiers.",
        "possible_errors": [
            "unknown_ledger_identifiers"
        ]
    },
    {
        "name": "Validate identifiers are unique in ledgers",
        "description": "Validate identifier is not declared twice in ledgers.",
        "possible_errors": [
            "duplicate_identifiers_entries_found"
        ]
    },
    {
        "name": "Validate agreements cover last statement closing date",
        "description": "Validate that there is an agreement for each supply point covering each ledger's <code>last_statement_closing_date</code>.",
        "possible_errors": [
            "no_agreement_covering_last_statement_closing_date"
        ]
    },
    {
        "name": "Validate no unbilled period on former supply addresses",
        "description": "Validate that if a customer is no longer at the given supply address they have been fully billed. This check is performed if we are importing supply address history.",
        "possible_errors": [
            "unbilled_former_supply_address"
        ]
    },
    {
        "name": "Validate at least one billable meter point is provided",
        "description": "Validate that account must have at least one billable meter point unless import config skip_meter_point_creation is ON or account is a portfolio lead, or account is an unmetered service, or account is an inactive account.",
        "possible_errors": [
            "no_supply_point_on_supply"
        ]
    },
    {
        "name": "Validate alternative phone number is unique",
        "description": "Validate customers defined in the payload do not have the same alternative phone numbers.",
        "possible_errors": [
            "duplicated_alternative_phone_numbers"
        ]
    },
    {
        "name": "Validate billing address style",
        "description": "Validate that a legacy billing address (<code>billing_address1</code> etc.) and new-style billing address (<code>billing_address</code> object) are not both provided.",
        "possible_errors": [
            "billing_address_new_style_and_legacy"
        ]
    },
    {
        "name": "Validate business type not provided for domestic accounts",
        "description": "Validate that a business type is not provided for domestic accounts.",
        "possible_errors": [
            "business_fields_provided_for_domestic_accounts"
        ]
    },
    {
        "name": "Validate that blackhole email addresses are paired with 'online' communication prefernence",
        "description": "Validate that the communication preference 'online' when a blackhole email address is provided.",
        "possible_errors": [
            "blackhole_email_with_online_comms"
        ]
    },
    {
        "name": "Validate customer family name",
        "description": "Validate the family name is provided for all customers on a domestic account.",
        "possible_errors": [
            "customer_family_name_required"
        ]
    },
    {
        "name": "Validate portfolio lead communication preference",
        "description": "Validates that portfolio lead is using ONLINE communication preference.",
        "possible_errors": [
            "invalid_portfolio_lead_communication_preference"
        ]
    },
    {
        "name": "Validate all billable meter points are covered by agreements in the payload",
        "description": "Validate that agreements have been provided for all billable meter points and vice versa for the period covered by Kraken from a billing perspective. A billable meter point is one that has an open-ended or future dated supply end date.",
        "possible_errors": [
            "meter_point_with_no_agreement",
            "meterpoint_with_agreement_not_on_supply"
        ]
    },
    {
        "name": "Validate transfer readings exist on active gas meters",
        "description": "Validate that each active gas meter has a single transfer reading provided.",
        "possible_errors": [
            "active_gas_meter_with_multiple_transfer_readings",
            "active_gas_meter_without_transfer_reading",
            "reading_meter_fully_billed"
        ]
    },
    {
        "name": "Validate transfer readings exist on active electricity registers",
        "description": "Validate that each active electricity meter register has a single transfer reading provided.",
        "possible_errors": [
            "missing_transfer_reading_for_register",
            "multiple_transfer_readings_for_register"
        ]
    },
    {
        "name": "Validate concession card and concession credids paid current year",
        "description": "Validates that only one customer with concession card and concession credids paid current year provided; customer with concession card needs to match with customer with concession credits paid current year.",
        "possible_errors": [
            "concession_cards_too_many_users",
            "concession_credits_and_cards_too_many_users",
            "concession_credits_paid_too_many_users"
        ]
    },
    {
        "name": "Validate payment terms apply to portfolio",
        "description": "Validate that portfolio lead account must have <code>apply_to_portfolio</code> set to true and only portfolio lead account can set <code>apply_to_portfolio</code> to true.",
        "possible_errors": [
            "invalid_apply_to_portfolio"
        ]
    },
    {
        "name": "Validate manually defined eligibility periods",
        "description": "Validates that manually defined rebate periods cannot be added without a primary address and some manually defined rebate periods need a concession card as well.",
        "possible_errors": [
            "manually_defined_eligibility_periods_without_concession_card",
            "manually_defined_rebate_periods_without_primary_address"
        ]
    },
    {
        "name": "Validate primary place of residence without concession card or credits paid or manually defined eligibility periods",
        "description": "Validates that only customer with concession card, credits paid or manually defined eligibility periods can have a primary place of residence.",
        "possible_errors": [
            "primary_place_of_residence_without_concession_card_or_credits_paid_or_rebate"
        ]
    },
    {
        "name": "Validate concession cards or credits paid without primary place of residence",
        "description": "Validates that concession cards cannot be loaded without a primary address and concession credits paid for the year cannot be recorded without a primary address except it is proprietor account.",
        "possible_errors": [
            "concession_cards_or_credits_paid_without_primary_place_of_residence"
        ]
    }
]

{
    "x-enum-descriptions": {
        "WESTPAC_QUICKSTREAM_RED_ENERGY": "Westpac QuickStream (Red Energy)",
        "WESTPAC_QUICKSTREAM_LUMO_ENERGY": "Westpac QuickStream (Lumo Energy)"
    }
}

{
    "x-enum-descriptions": {}
}

{
    "x-enum-descriptions": {
        "WESTPAC_QUICKSTREAM_RED_ENERGY": "Westpac QuickStream (Red Energy)",
        "WESTPAC_QUICKSTREAM_LUMO_ENERGY": "Westpac QuickStream (Lumo Energy)"
    }
}

{
    "x-enum-descriptions": {}
}

{
    "x-enum-descriptions": {
        "WESTPAC_QUICKSTREAM_RED_ENERGY": "Westpac QuickStream (Red Energy)",
        "WESTPAC_QUICKSTREAM_LUMO_ENERGY": "Westpac QuickStream (Lumo Energy)"
    }
}

{
    "x-enum-descriptions": {}
}

{
    "maxItems": 1
}

{
    "maxItems": 1
}

[
    {
        "name": "Ensures only <code>user_details</code> or <code>details</code> are provided",
        "description": "Ensures that only <code>user_details</code> or <code>details</code> are provided, not both.",
        "possible_errors": [
            "customer_details_and_user_details_both_provided"
        ]
    },
    {
        "name": "Validate no contact details for occupier",
        "description": "Validates that a customer identified as \"The Occupier\" does not have contact details. If contact details are provided it implies that the identity of the customer is known, and it therefore not an unknown occupier.",
        "possible_errors": [
            "contact_details_for_occupier"
        ]
    },
    {
        "name": "Validate that the customer's name is not \"The Occupier\"",
        "description": "Validate that the customer's name is not \"The Occupier\". To indicate an occupier account, use the <code>unknown_occupier</code> flag at the account-level.",
        "possible_errors": [
            "customer_may_not_be_named_the_occupier"
        ]
    },
    {
        "name": "Validate metadata",
        "description": "Validate that metadata, which is a list of key value pairs, does not contain duplicate keys.",
        "possible_errors": [
            "metadata_has_duplicate_keys"
        ]
    },
    {
        "name": "Validate user role",
        "description": "Validates that at least one user role is provided through <code>portfolio_roles</code> or <code>account_roles</code>.",
        "possible_errors": [
            "required_user_role"
        ]
    },
    {
        "name": "Validate exclusive role assignment",
        "description": "Validates that an exclusively-assignable role is not assigned to a user alongside any other role, whether in the same payload or already held by the user.",
        "possible_errors": [
            "customer_has_exclusive_role_conflict"
        ]
    },
    {
        "name": "Validate that <code>\u2068customer_preferences\u2069</code> and <code>\u2068consents\u2069</code> are not both provided",
        "description": "Validate that \u2068customer_preferences\u2069 and \u2068consents\u2069 are not both provided.",
        "possible_errors": [
            "fields_are_mutually_exclusive"
        ]
    }
]

[
    {
        "name": "Ensures only <code>user_details</code> or <code>details</code> are provided",
        "description": "Ensures that only <code>user_details</code> or <code>details</code> are provided, not both.",
        "possible_errors": [
            "customer_details_and_user_details_both_provided"
        ]
    },
    {
        "name": "Validate no contact details for occupier",
        "description": "Validates that a customer identified as \"The Occupier\" does not have contact details. If contact details are provided it implies that the identity of the customer is known, and it therefore not an unknown occupier.",
        "possible_errors": [
            "contact_details_for_occupier"
        ]
    },
    {
        "name": "Validate that the customer's name is not \"The Occupier\"",
        "description": "Validate that the customer's name is not \"The Occupier\". To indicate an occupier account, use the <code>unknown_occupier</code> flag at the account-level.",
        "possible_errors": [
            "customer_may_not_be_named_the_occupier"
        ]
    },
    {
        "name": "Validate metadata",
        "description": "Validate that metadata, which is a list of key value pairs, does not contain duplicate keys.",
        "possible_errors": [
            "metadata_has_duplicate_keys"
        ]
    },
    {
        "name": "Validate user role",
        "description": "Validates that at least one user role is provided through <code>portfolio_roles</code> or <code>account_roles</code>.",
        "possible_errors": [
            "required_user_role"
        ]
    },
    {
        "name": "Validate that <code>\u2068customer_preferences\u2069</code> and <code>\u2068consents\u2069</code> are not both provided",
        "description": "Validate that \u2068customer_preferences\u2069 and \u2068consents\u2069 are not both provided.",
        "possible_errors": [
            "fields_are_mutually_exclusive"
        ]
    }
]

[
    {
        "name": "Validate portfolio reference provided correctly",
        "description": "Validate that a portfolio reference is provided if portfolio settings have been provided and that a portfolio reference is not provided if the import supplier is set to create new portfolios.",
        "possible_errors": [
            "portfolio_references_missing",
            "portfolio_references_provided"
        ]
    },
    {
        "name": "Validate no duplicate portfolio reference namespaces",
        "description": "Validate that there are no duplicate portfolio reference namespaces in the payload.",
        "possible_errors": [
            "duplicate_portfolio_references"
        ]
    }
]

[
    {
        "name": "Validate portfolio reference provided correctly",
        "description": "Validate that a portfolio reference is provided if portfolio settings have been provided and that a portfolio reference is not provided if the import supplier is set to create new portfolios.",
        "possible_errors": [
            "portfolio_references_missing",
            "portfolio_references_provided"
        ]
    }
]

[
    {
        "name": "Validate portfolio reference provided correctly",
        "description": "Validate that a portfolio reference is provided if portfolio settings have been provided and that a portfolio reference is not provided if the import supplier is set to create new portfolios.",
        "possible_errors": [
            "portfolio_references_missing",
            "portfolio_references_provided"
        ]
    },
    {
        "name": "Validate no duplicate portfolio reference namespaces",
        "description": "Validate that there are no duplicate portfolio reference namespaces in the payload.",
        "possible_errors": [
            "duplicate_portfolio_references"
        ]
    }
]

[
    {
        "name": "Validate portfolio reference provided correctly",
        "description": "Validate that a portfolio reference is provided if portfolio settings have been provided and that a portfolio reference is not provided if the import supplier is set to create new portfolios.",
        "possible_errors": [
            "portfolio_references_missing",
            "portfolio_references_provided"
        ]
    }
]

[
    {
        "name": "Validate portfolio reference provided correctly",
        "description": "Validate that a portfolio reference is provided if portfolio settings have been provided and that a portfolio reference is not provided if the import supplier is set to create new portfolios.",
        "possible_errors": [
            "portfolio_references_missing",
            "portfolio_references_provided"
        ]
    },
    {
        "name": "Validate no duplicate portfolio reference namespaces",
        "description": "Validate that there are no duplicate portfolio reference namespaces in the payload.",
        "possible_errors": [
            "duplicate_portfolio_references"
        ]
    }
]

[
    {
        "name": "Validate portfolio reference provided correctly",
        "description": "Validate that a portfolio reference is provided if portfolio settings have been provided and that a portfolio reference is not provided if the import supplier is set to create new portfolios.",
        "possible_errors": [
            "portfolio_references_missing",
            "portfolio_references_provided"
        ]
    }
]

{
    "x-enum-descriptions": {
        "BLNBSS1_22E": "BLNBSS1_22E",
        "BLNRSS2_12E": "BLNRSS2_12E",
        "BLNT2AL_22D": "BLNT2AL_22D",
        "BLNT3AL_12D": "BLNT3AL_12D"
    }
}

{
    "x-enum-descriptions": {}
}

{
    "x-enum-descriptions": {
        "RTC12F": "RTC12F"
    }
}

{
    "x-enum-descriptions": {
        "RTCSSO": "RTCSSO"
    }
}

{
    "x-validators": [
        {
            "name": "Validate additional historical transactions do not contain charges",
            "description": "Validate that <code>additional_historical_transactions</code> does not contain entries of type <code>CHARGE</code> or <code>SUPPLY_CHARGE</code>. Charges must be supplied on a historical billing document so that debt obligations and allocations are tracked correctly.",
            "possible_errors": [
                "charges_not_allowed_in_additional_historical_transactions"
            ]
        }
    ]
}

{
    "x-enum-descriptions": {
        "EVCT2": "EVCT2",
        "EVCT3": "EVCT3",
        "EVNT2": "EVNT2",
        "EVNT3": "EVNT3",
        "EVCBT1": "EVCBT1",
        "EVCBT2": "EVCBT2",
        "EVCBT3": "EVCBT3",
        "EVCCT1": "EVCCT1",
        "EVCCT2": "EVCCT2",
        "EVCCT3": "EVCCT3",
        "EVCXT2": "EVCXT2",
        "EVCXT3": "EVCXT3",
        "EVNBT1": "EVNBT1",
        "EVNBT2": "EVNBT2",
        "EVNBT3": "EVNBT3",
        "EVNCT1": "EVNCT1",
        "EVNCT2": "EVNCT2",
        "EVNCT3": "EVNCT3",
        "EVNXT2": "EVNXT2",
        "EVNXT3": "EVNXT3",
        "RTC50C_KW": "RTC50C_KW",
        "RTC50C_KVA": "RTC50C_KVA"
    }
}

{
    "x-enum-descriptions": {}
}

{
    "x-enum-descriptions": {
        "N62": "N62",
        "NC04": "NC04",
        "EA250": "EA250",
        "EA260": "EA260",
        "BLNC1AR": "BLNC1AR",
        "BLNC1CO": "BLNC1CO",
        "BLNC3NU": "BLNC3NU"
    }
}

{
    "x-enum-descriptions": {}
}

[
    {
        "name": "Validate that business information is provided if not linking account to business with contract",
        "description": "Validate that business information is provided for the business to link the account to if <code>link_account_to_business_with_contract</code> is false for the given import supplier.",
        "possible_errors": [
            "business_information_required_if_not_linking_via_contract"
        ]
    },
    {
        "name": "Validate that business information is not provided if linking an account to the business of the business contract.",
        "description": "Validate that business information is not provided for the business to link the account to if <code>link_account_to_business_with_contract</code> is true for the given import supplier.",
        "possible_errors": [
            "business_information_not_required_if_linking_via_contract"
        ]
    },
    {
        "name": "Validate that at least one contract identifier is provided for import",
        "description": "Validate that at least one of <code>business_contract_identifiers</code> or <code>business_contract_identifier</code> is provided in the payload.",
        "possible_errors": [
            "missing_contract_identifier"
        ]
    }
]

[
    {
        "name": "Validate that values are unique in Kraken for unique registered keys",
        "description": "Validate that keys with unique constraints do not already have provided value in Kraken.",
        "possible_errors": [
            "business_detail_value_exists_for_unique_key"
        ]
    },
    {
        "name": "Validate that business information is provided if not linking account to business with contract",
        "description": "Validate that business information is provided for the business to link the account to if <code>link_account_to_business_with_contract</code> is false for the given import supplier.",
        "possible_errors": [
            "business_information_required_if_not_linking_via_contract"
        ]
    },
    {
        "name": "Validate that business information is not provided if linking an account to the business of the business contract.",
        "description": "Validate that business information is not provided for the business to link the account to if <code>link_account_to_business_with_contract</code> is true for the given import supplier.",
        "possible_errors": [
            "business_information_not_required_if_linking_via_contract"
        ]
    },
    {
        "name": "Validate that at least one contract identifier is provided for import",
        "description": "Validate that at least one of <code>business_contract_identifiers</code> or <code>business_contract_identifier</code> is provided in the payload.",
        "possible_errors": [
            "missing_contract_identifier"
        ]
    }
]

{
    "x-enum-descriptions": {
        "COMMS8": "COMMS8"
    }
}

{
    "x-enum-descriptions": {}
}

[
    {
        "name": "Validate account type is valid",
        "description": "Validate that only one account type is specified in the payload.",
        "possible_errors": [
            "multiple_account_types_selected"
        ]
    },
    {
        "name": "Validate billing address fields",
        "description": "If a legacy billing address is provided, validate that it is in the correct format.",
        "possible_errors": [
            "invalid_address"
        ]
    },
    {
        "name": "Validate life support contact user email",
        "description": "Validates that life support contact user email matches with customers email. When life support <code>preferred_contact_method</code> is <code>EMAIL_ADDRESS</code>, it requires customer with email. When it is <code>PHONE</code>, it requires customer with mobile or landline.",
        "possible_errors": [
            "missing_contact_user_email_or_phone"
        ]
    },
    {
        "name": "Validate metadata",
        "description": "Validate that metadata, which is a list of key value pairs, does not contain duplicate keys.",
        "possible_errors": [
            "metadata_has_duplicate_keys"
        ]
    },
    {
        "name": "Validate unique property external identifiers",
        "description": "Ensures that <code>property_external_identifier</code> is not repeated across <code>supply_addresses</code> and <code>properties</code>.",
        "possible_errors": [
            "duplicate_property_external_identifiers"
        ]
    },
    {
        "name": "Validate managed account type is allowed",
        "description": "Validate that this instance of Kraken allows managed account types.",
        "possible_errors": [
            "managed_accounts_are_not_allowed"
        ]
    },
    {
        "name": "Validate only portfolio lead has portfolio setting",
        "description": "Validates that if portfolio settings are provided, then the account is marked as the portfolio lead.",
        "possible_errors": [
            "portfolio_settings_included_when_not_lead"
        ]
    },
    {
        "name": "Validate no customers for unknown occupier",
        "description": "Validate that no customers are provided for an unknown occupier.",
        "possible_errors": [
            "customer_with_unknown_occupier"
        ]
    },
    {
        "name": "Validate that a customer given name is provided for business accounts",
        "description": "Validate that a given name is provided for all customers on a business account. Note that this validation only applies if Kraken is configured to send registration flows for this import supplier.",
        "possible_errors": [
            "customer_given_name_required"
        ]
    },
    {
        "name": "Validate portfolio reference provided correctly",
        "description": "Validate that a portfolio reference is provided if portfolio settings have been provided and that a portfolio reference is not provided if the import supplier is set to create new portfolios.",
        "possible_errors": [
            "portfolio_references_missing",
            "portfolio_references_provided"
        ]
    },
    {
        "name": "Validate billing address style",
        "description": "Validate that a legacy billing address (<code>billing_address1</code> etc.) and new-style billing address (<code>billing_address</code> object) are not both provided.",
        "possible_errors": [
            "billing_address_new_style_and_legacy"
        ]
    },
    {
        "name": "Validate agreements are consecutive per supply point",
        "description": "Validate that the agreements provided in the payload are consecutive per supply point i.e. there are no gaps or overlaps. The exception to this is for agreements provided before the current supply period for the supply point. Agreements provided before the <code>supply_start_date</code> are allowed gaps since they represent historic periods of supply and cannot be used for billing in Kraken.",
        "possible_errors": [
            "gaps_or_overlaps_in_agreement_dates"
        ]
    },
    {
        "name": "Validate supply charge line items covered by a single agreement",
        "description": "Validate each supply charge has a single agreement with matching product code that covers the period defined by it's line items minimum <code>start_date</code> to maximum <code>end_date</code>.",
        "possible_errors": [
            "supply_charge_line_items_not_covered_by_single_agreement"
        ]
    },
    {
        "name": "Validate that Kraken can calculate when to start billing the account",
        "description": "Validate that Kraken can calculate when to start billing the account. This is determined based on the existence of last billed to date, last statement closing date, and agreements.",
        "possible_errors": [
            "cannot_determine_responsible_for_billing_from_date"
        ]
    },
    {
        "name": "Validate historical statement period end must not be in the future",
        "description": "Ensures that the historical statement period end date (last_statement_closing_date or latest transaction_date) is not set in the future.",
        "possible_errors": [
            "historical_statement_period_end_in_future"
        ]
    },
    {
        "name": "Validate that terms with supply type matches a supply point supply type",
        "description": "Validate that for terms containing a <code>supply_type</code> field that there is a supply point in the payload with a matching <code>supply_type</code>.",
        "possible_errors": [
            "term_supply_type_mismatch"
        ]
    },
    {
        "name": "Validate that supply addresses and supply points are provided if account contracts are provided",
        "description": "Validate that if <code>account_contracts</code> have been provided that a supply address with supply points has been provided under <code>supply_addresses</code>",
        "possible_errors": [
            "account_contracts_without_supply_points"
        ]
    },
    {
        "name": "Validate historical statement billing document identifier presence",
        "description": "Ensure that billing document identifiers are only provided for historical statement transactions and only when the relevant feature flag is enabled.",
        "possible_errors": [
            "historical_statement_billing_document_identifier_missing",
            "historical_statement_billing_document_identifier_not_allowed_when_feature_flag_disabled"
        ]
    },
    {
        "name": "Validate current statement transactions do not provide <code>billing_document_identifier</code>",
        "description": "Validate that none of the current statement transactions include a <code>billing_document_identifier</code>, as this field is only applicable to historical statement transactions.",
        "possible_errors": [
            "billing_document_identifier_not_allowed_for_current_statement_transactions"
        ]
    },
    {
        "name": "Validate historical statement transaction billing document identifier",
        "description": "Ensure that the billing document identifier is the same for all historical statement transactions.",
        "possible_errors": [
            "historical_statement_billing_document_identifier_mismatch"
        ]
    },
    {
        "name": "Validate that contract terms' product codes are part of supply agreements",
        "description": "Ensure that any contract terms with product references have corresponding products in supply addresses.",
        "possible_errors": [
            "contract_term_product_code_not_in_agreements"
        ]
    },
    {
        "name": "Validate that business is provided if enforcing business contracts",
        "description": "Validate that the business field is provided if <code>enforce_business_contracts_exist</code> is set to True on the import supplier configuration.",
        "possible_errors": [
            "business_field_required"
        ]
    },
    {
        "name": "Validate agreement business contract identifier is declared",
        "description": "Validates that an agreement's <code>business_contract_identifier</code>, if provided, is one of the account's declared <code>business_contract_identifiers</code>.",
        "possible_errors": [
            "agreement_business_contract_identifier_not_declared"
        ]
    },
    {
        "name": "Validate that the sum of ledger balances equals the transfer balance",
        "description": "Validate that the sum of all <code>ledger_balance</code> provided for each ledger in <code>ledgers</code> equals the account-level <code>transfer_balance</code>.",
        "possible_errors": [
            "ledger_balances_not_equal_to_transfer_balance"
        ]
    },
    {
        "name": "Validate business user info against customer info",
        "description": "Validates that business user information matches the corresponding customer information for basic fields.",
        "possible_errors": [
            "customer_details_and_user_details_both_provided"
        ]
    },
    {
        "name": "Validate payment preference <code>ledger_identifier</code>",
        "description": "Ensure that the <code>ledger_identifier</code> provided has an equivalent <code>ledger</code> object with the same <code>ledger_identifier</code> .",
        "possible_errors": [
            "invalid_payment_preference_ledger_identifier"
        ]
    },
    {
        "name": "Validate that referenced ledgers are unique in payment preferences",
        "description": "Ensure that each ledger is referenced in at most one payment preference.",
        "possible_errors": [
            "duplicate_ledger_in_payment_preferences"
        ]
    },
    {
        "name": "Validate that valid instruction_identifier provided for <code>ACTIVE_NEW</code> payment preference",
        "description": "Ensure that <code>ACTIVE_NEW</code> payment preference has instruction_identifier from </code>payment_instructions</code> object.",
        "possible_errors": [
            "active_new_payment_preference_invalid_instruction_identifier"
        ]
    },
    {
        "name": "Validate that the transactions for a voucher do not exceed its value",
        "description": "Validate that the sum of all transaction values for a voucher is not greater than the value of the voucher.",
        "possible_errors": [
            "voucher_transactions_sum_greater_than_voucher_value"
        ]
    },
    {
        "name": "Validate that each voucher charge transaction id has a matching transaction id within a transaction of type CHARGE",
        "description": "Validate that each <code>voucher</code> <code>charge_transaction_id</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CHARGE in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
        "possible_errors": [
            "voucher_charge_transaction_id_not_found"
        ]
    },
    {
        "name": "Validate that each voucher redemption credit transaction id has a matching transaction id within a transaction of type CREDIT",
        "description": "Validate that every <code>credit_transaction_id</code> in all <code>voucher_redemptions</code> in every <code>voucher</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CREDIT in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
        "possible_errors": [
            "voucher_redemption_credit_transaction_id_not_found"
        ]
    },
    {
        "name": "Validate parent property references exist",
        "description": "Validates that all <code>parent_property_reference</code> values in <code>supply_addresses</code> and <code>properties</code> correspond to a <code>property_external_identifier</code> in the payload. This ensures the property hierarchy is valid.",
        "possible_errors": [
            "parent_property_reference_not_found"
        ]
    },
    {
        "name": "Validate that a portfolio lead account has no supply address since it makes no sense for it to have one",
        "description": "Validate that a portfolio lead account has no supply address.",
        "possible_errors": [
            "portfolio_lead_has_a_supply_address"
        ]
    },
    {
        "name": "Validate that a system account has no supply address",
        "description": "Validate that a system account has no supply address",
        "possible_errors": [
            "system_account_has_a_supply_address"
        ]
    },
    {
        "name": "Validate auto allocation of operations team",
        "description": "Validate that operations_team_name is provided if auto allocation is not configured.",
        "possible_errors": [
            "operations_team_provided_when_using_auto_allocation",
            "operations_team_should_be_provided"
        ]
    },
    {
        "name": "Validate ledger identifiers are known",
        "description": "Validate ledger identifiers are among supply point identifiers.",
        "possible_errors": [
            "unknown_ledger_identifiers"
        ]
    },
    {
        "name": "Validate identifiers are unique in ledgers",
        "description": "Validate identifier is not declared twice in ledgers.",
        "possible_errors": [
            "duplicate_identifiers_entries_found"
        ]
    },
    {
        "name": "Validate agreements cover last statement closing date",
        "description": "Validate that there is an agreement for each supply point covering each ledger's <code>last_statement_closing_date</code>.",
        "possible_errors": [
            "no_agreement_covering_last_statement_closing_date"
        ]
    },
    {
        "name": "Validate no unbilled period on former supply addresses",
        "description": "Validate that if a customer is no longer at the given supply address they have been fully billed. This check is performed if we are importing supply address history.",
        "possible_errors": [
            "unbilled_former_supply_address"
        ]
    },
    {
        "name": "Validate at least one billable meter point is provided",
        "description": "Validate that account must have at least one billable meter point unless import config skip_meter_point_creation is ON or account is a portfolio lead, or account is an unmetered service, or account is an inactive account.",
        "possible_errors": [
            "no_supply_point_on_supply"
        ]
    },
    {
        "name": "Validate alternative phone number is unique",
        "description": "Validate customers defined in the payload do not have the same alternative phone numbers.",
        "possible_errors": [
            "duplicated_alternative_phone_numbers"
        ]
    },
    {
        "name": "Validate billing address style",
        "description": "Validate that a legacy billing address (<code>billing_address1</code> etc.) and new-style billing address (<code>billing_address</code> object) are not both provided.",
        "possible_errors": [
            "billing_address_new_style_and_legacy"
        ]
    },
    {
        "name": "Validate business type not provided for domestic accounts",
        "description": "Validate that a business type is not provided for domestic accounts.",
        "possible_errors": [
            "business_fields_provided_for_domestic_accounts"
        ]
    },
    {
        "name": "Validate that blackhole email addresses are paired with 'online' communication prefernence",
        "description": "Validate that the communication preference 'online' when a blackhole email address is provided.",
        "possible_errors": [
            "blackhole_email_with_online_comms"
        ]
    },
    {
        "name": "Validate customer family name",
        "description": "Validate the family name is provided for all customers on a domestic account.",
        "possible_errors": [
            "customer_family_name_required"
        ]
    },
    {
        "name": "Validate portfolio lead communication preference",
        "description": "Validates that portfolio lead is using ONLINE communication preference.",
        "possible_errors": [
            "invalid_portfolio_lead_communication_preference"
        ]
    },
    {
        "name": "Validate all billable meter points are covered by agreements in the payload",
        "description": "Validate that agreements have been provided for all billable meter points and vice versa for the period covered by Kraken from a billing perspective. A billable meter point is one that has an open-ended or future dated supply end date.",
        "possible_errors": [
            "meter_point_with_no_agreement",
            "meterpoint_with_agreement_not_on_supply"
        ]
    },
    {
        "name": "Validate transfer readings exist on active gas meters",
        "description": "Validate that each active gas meter has a single transfer reading provided.",
        "possible_errors": [
            "active_gas_meter_with_multiple_transfer_readings",
            "active_gas_meter_without_transfer_reading",
            "reading_meter_fully_billed"
        ]
    },
    {
        "name": "Validate transfer readings exist on active electricity registers",
        "description": "Validate that each active electricity meter register has a single transfer reading provided.",
        "possible_errors": [
            "missing_transfer_reading_for_register",
            "multiple_transfer_readings_for_register"
        ]
    },
    {
        "name": "Validate concession card and concession credids paid current year",
        "description": "Validates that only one customer with concession card and concession credids paid current year provided; customer with concession card needs to match with customer with concession credits paid current year.",
        "possible_errors": [
            "concession_cards_too_many_users",
            "concession_credits_and_cards_too_many_users",
            "concession_credits_paid_too_many_users"
        ]
    },
    {
        "name": "Validate payment terms apply to portfolio",
        "description": "Validate that portfolio lead account must have <code>apply_to_portfolio</code> set to true and only portfolio lead account can set <code>apply_to_portfolio</code> to true.",
        "possible_errors": [
            "invalid_apply_to_portfolio"
        ]
    },
    {
        "name": "Validate manually defined eligibility periods",
        "description": "Validates that manually defined rebate periods cannot be added without a primary address and some manually defined rebate periods need a concession card as well.",
        "possible_errors": [
            "manually_defined_eligibility_periods_without_concession_card",
            "manually_defined_rebate_periods_without_primary_address"
        ]
    },
    {
        "name": "Validate primary place of residence without concession card or credits paid or manually defined eligibility periods",
        "description": "Validates that only customer with concession card, credits paid or manually defined eligibility periods can have a primary place of residence.",
        "possible_errors": [
            "primary_place_of_residence_without_concession_card_or_credits_paid_or_rebate"
        ]
    },
    {
        "name": "Validate concession cards or credits paid without primary place of residence",
        "description": "Validates that concession cards cannot be loaded without a primary address and concession credits paid for the year cannot be recorded without a primary address except it is proprietor account.",
        "possible_errors": [
            "concession_cards_or_credits_paid_without_primary_place_of_residence"
        ]
    }
]

[
    {
        "name": "Validate account type is valid",
        "description": "Validate that only one account type is specified in the payload.",
        "possible_errors": [
            "multiple_account_types_selected"
        ]
    },
    {
        "name": "Validate billing address fields",
        "description": "If a legacy billing address is provided, validate that it is in the correct format.",
        "possible_errors": [
            "invalid_address"
        ]
    },
    {
        "name": "Validate life support contact user email",
        "description": "Validates that life support contact user email matches with customers email. When life support <code>preferred_contact_method</code> is <code>EMAIL_ADDRESS</code>, it requires customer with email. When it is <code>PHONE</code>, it requires customer with mobile or landline.",
        "possible_errors": [
            "missing_contact_user_email_or_phone"
        ]
    },
    {
        "name": "Validate metadata",
        "description": "Validate that metadata, which is a list of key value pairs, does not contain duplicate keys.",
        "possible_errors": [
            "metadata_has_duplicate_keys"
        ]
    },
    {
        "name": "Validate unique property external identifiers",
        "description": "Ensures that <code>property_external_identifier</code> is not repeated across <code>supply_addresses</code> and <code>properties</code>.",
        "possible_errors": [
            "duplicate_property_external_identifiers"
        ]
    },
    {
        "name": "Validate managed account type is allowed",
        "description": "Validate that this instance of Kraken allows managed account types.",
        "possible_errors": [
            "managed_accounts_are_not_allowed"
        ]
    },
    {
        "name": "Validate only portfolio lead has portfolio setting",
        "description": "Validates that if portfolio settings are provided, then the account is marked as the portfolio lead.",
        "possible_errors": [
            "portfolio_settings_included_when_not_lead"
        ]
    },
    {
        "name": "Validate no customers for unknown occupier",
        "description": "Validate that no customers are provided for an unknown occupier.",
        "possible_errors": [
            "customer_with_unknown_occupier"
        ]
    },
    {
        "name": "Validate that a customer given name is provided for business accounts",
        "description": "Validate that a given name is provided for all customers on a business account. Note that this validation only applies if Kraken is configured to send registration flows for this import supplier.",
        "possible_errors": [
            "customer_given_name_required"
        ]
    },
    {
        "name": "Validate portfolio reference provided correctly",
        "description": "Validate that a portfolio reference is provided if portfolio settings have been provided and that a portfolio reference is not provided if the import supplier is set to create new portfolios.",
        "possible_errors": [
            "portfolio_references_missing",
            "portfolio_references_provided"
        ]
    },
    {
        "name": "Validate billing address style",
        "description": "Validate that a legacy billing address (<code>billing_address1</code> etc.) and new-style billing address (<code>billing_address</code> object) are not both provided.",
        "possible_errors": [
            "billing_address_new_style_and_legacy"
        ]
    },
    {
        "name": "Validate agreements are consecutive per supply point",
        "description": "Validate that the agreements provided in the payload are consecutive per supply point i.e. there are no gaps or overlaps. The exception to this is for agreements provided before the current supply period for the supply point. Agreements provided before the <code>supply_start_date</code> are allowed gaps since they represent historic periods of supply and cannot be used for billing in Kraken.",
        "possible_errors": [
            "gaps_or_overlaps_in_agreement_dates"
        ]
    },
    {
        "name": "Validate supply charge line items covered by a single agreement",
        "description": "Validate each supply charge has a single agreement with matching product code that covers the period defined by it's line items minimum <code>start_date</code> to maximum <code>end_date</code>.",
        "possible_errors": [
            "supply_charge_line_items_not_covered_by_single_agreement"
        ]
    },
    {
        "name": "Validate that Kraken can calculate when to start billing the account",
        "description": "Validate that Kraken can calculate when to start billing the account. This is determined based on the existence of last billed to date, last statement closing date, and agreements.",
        "possible_errors": [
            "cannot_determine_responsible_for_billing_from_date"
        ]
    },
    {
        "name": "Validate historical statement period end must not be in the future",
        "description": "Ensures that the historical statement period end date (last_statement_closing_date or latest transaction_date) is not set in the future.",
        "possible_errors": [
            "historical_statement_period_end_in_future"
        ]
    },
    {
        "name": "Validate that terms with supply type matches a supply point supply type",
        "description": "Validate that for terms containing a <code>supply_type</code> field that there is a supply point in the payload with a matching <code>supply_type</code>.",
        "possible_errors": [
            "term_supply_type_mismatch"
        ]
    },
    {
        "name": "Validate that supply addresses and supply points are provided if account contracts are provided",
        "description": "Validate that if <code>account_contracts</code> have been provided that a supply address with supply points has been provided under <code>supply_addresses</code>",
        "possible_errors": [
            "account_contracts_without_supply_points"
        ]
    },
    {
        "name": "Validate historical statement billing document identifier presence",
        "description": "Ensure that billing document identifiers are only provided for historical statement transactions and only when the relevant feature flag is enabled.",
        "possible_errors": [
            "historical_statement_billing_document_identifier_missing",
            "historical_statement_billing_document_identifier_not_allowed_when_feature_flag_disabled"
        ]
    },
    {
        "name": "Validate current statement transactions do not provide <code>billing_document_identifier</code>",
        "description": "Validate that none of the current statement transactions include a <code>billing_document_identifier</code>, as this field is only applicable to historical statement transactions.",
        "possible_errors": [
            "billing_document_identifier_not_allowed_for_current_statement_transactions"
        ]
    },
    {
        "name": "Validate historical statement transaction billing document identifier",
        "description": "Ensure that the billing document identifier is the same for all historical statement transactions.",
        "possible_errors": [
            "historical_statement_billing_document_identifier_mismatch"
        ]
    },
    {
        "name": "Validate that contract terms' product codes are part of supply agreements",
        "description": "Ensure that any contract terms with product references have corresponding products in supply addresses.",
        "possible_errors": [
            "contract_term_product_code_not_in_agreements"
        ]
    },
    {
        "name": "Validate that business is provided if enforcing business contracts",
        "description": "Validate that the business field is provided if <code>enforce_business_contracts_exist</code> is set to True on the import supplier configuration.",
        "possible_errors": [
            "business_field_required"
        ]
    },
    {
        "name": "Validate that the sum of ledger balances equals the transfer balance",
        "description": "Validate that the sum of all <code>ledger_balance</code> provided for each ledger in <code>ledgers</code> equals the account-level <code>transfer_balance</code>.",
        "possible_errors": [
            "ledger_balances_not_equal_to_transfer_balance"
        ]
    },
    {
        "name": "Validate business user info against customer info",
        "description": "Validates that business user information matches the corresponding customer information for basic fields.",
        "possible_errors": [
            "customer_details_and_user_details_both_provided"
        ]
    },
    {
        "name": "Validate payment preference <code>ledger_identifier</code>",
        "description": "Ensure that the <code>ledger_identifier</code> provided has an equivalent <code>ledger</code> object with the same <code>ledger_identifier</code> .",
        "possible_errors": [
            "invalid_payment_preference_ledger_identifier"
        ]
    },
    {
        "name": "Validate that referenced ledgers are unique in payment preferences",
        "description": "Ensure that each ledger is referenced in at most one payment preference.",
        "possible_errors": [
            "duplicate_ledger_in_payment_preferences"
        ]
    },
    {
        "name": "Validate that valid instruction_identifier provided for <code>ACTIVE_NEW</code> payment preference",
        "description": "Ensure that <code>ACTIVE_NEW</code> payment preference has instruction_identifier from </code>payment_instructions</code> object.",
        "possible_errors": [
            "active_new_payment_preference_invalid_instruction_identifier"
        ]
    },
    {
        "name": "Validate that the transactions for a voucher do not exceed its value",
        "description": "Validate that the sum of all transaction values for a voucher is not greater than the value of the voucher.",
        "possible_errors": [
            "voucher_transactions_sum_greater_than_voucher_value"
        ]
    },
    {
        "name": "Validate that each voucher charge transaction id has a matching transaction id within a transaction of type CHARGE",
        "description": "Validate that each <code>voucher</code> <code>charge_transaction_id</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CHARGE in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
        "possible_errors": [
            "voucher_charge_transaction_id_not_found"
        ]
    },
    {
        "name": "Validate that each voucher redemption credit transaction id has a matching transaction id within a transaction of type CREDIT",
        "description": "Validate that every <code>credit_transaction_id</code> in all <code>voucher_redemptions</code> in every <code>voucher</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CREDIT in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
        "possible_errors": [
            "voucher_redemption_credit_transaction_id_not_found"
        ]
    },
    {
        "name": "Validate parent property references exist",
        "description": "Validates that all <code>parent_property_reference</code> values in <code>supply_addresses</code> and <code>properties</code> correspond to a <code>property_external_identifier</code> in the payload. This ensures the property hierarchy is valid.",
        "possible_errors": [
            "parent_property_reference_not_found"
        ]
    },
    {
        "name": "Validate that a portfolio lead account has no supply address since it makes no sense for it to have one",
        "description": "Validate that a portfolio lead account has no supply address.",
        "possible_errors": [
            "portfolio_lead_has_a_supply_address"
        ]
    },
    {
        "name": "Validate that a system account has no supply address",
        "description": "Validate that a system account has no supply address",
        "possible_errors": [
            "system_account_has_a_supply_address"
        ]
    },
    {
        "name": "Validate auto allocation of operations team",
        "description": "Validate that operations_team_name is provided if auto allocation is not configured.",
        "possible_errors": [
            "operations_team_provided_when_using_auto_allocation",
            "operations_team_should_be_provided"
        ]
    },
    {
        "name": "Validate ledger identifiers are known",
        "description": "Validate ledger identifiers are among supply point identifiers.",
        "possible_errors": [
            "unknown_ledger_identifiers"
        ]
    },
    {
        "name": "Validate identifiers are unique in ledgers",
        "description": "Validate identifier is not declared twice in ledgers.",
        "possible_errors": [
            "duplicate_identifiers_entries_found"
        ]
    },
    {
        "name": "Validate agreements cover last statement closing date",
        "description": "Validate that there is an agreement for each supply point covering each ledger's <code>last_statement_closing_date</code>.",
        "possible_errors": [
            "no_agreement_covering_last_statement_closing_date"
        ]
    },
    {
        "name": "Validate no unbilled period on former supply addresses",
        "description": "Validate that if a customer is no longer at the given supply address they have been fully billed. This check is performed if we are importing supply address history.",
        "possible_errors": [
            "unbilled_former_supply_address"
        ]
    },
    {
        "name": "Validate at least one billable meter point is provided",
        "description": "Validate that account must have at least one billable meter point unless import config skip_meter_point_creation is ON or account is a portfolio lead, or account is an unmetered service, or account is an inactive account.",
        "possible_errors": [
            "no_supply_point_on_supply"
        ]
    },
    {
        "name": "Validate alternative phone number is unique",
        "description": "Validate customers defined in the payload do not have the same alternative phone numbers.",
        "possible_errors": [
            "duplicated_alternative_phone_numbers"
        ]
    },
    {
        "name": "Validate billing address style",
        "description": "Validate that a legacy billing address (<code>billing_address1</code> etc.) and new-style billing address (<code>billing_address</code> object) are not both provided.",
        "possible_errors": [
            "billing_address_new_style_and_legacy"
        ]
    },
    {
        "name": "Validate business type not provided for domestic accounts",
        "description": "Validate that a business type is not provided for domestic accounts.",
        "possible_errors": [
            "business_fields_provided_for_domestic_accounts"
        ]
    },
    {
        "name": "Validate that blackhole email addresses are paired with 'online' communication prefernence",
        "description": "Validate that the communication preference 'online' when a blackhole email address is provided.",
        "possible_errors": [
            "blackhole_email_with_online_comms"
        ]
    },
    {
        "name": "Validate customer family name",
        "description": "Validate the family name is provided for all customers on a domestic account.",
        "possible_errors": [
            "customer_family_name_required"
        ]
    },
    {
        "name": "Validate portfolio lead communication preference",
        "description": "Validates that portfolio lead is using ONLINE communication preference.",
        "possible_errors": [
            "invalid_portfolio_lead_communication_preference"
        ]
    },
    {
        "name": "Validate all billable meter points are covered by agreements in the payload",
        "description": "Validate that agreements have been provided for all billable meter points and vice versa for the period covered by Kraken from a billing perspective. A billable meter point is one that has an open-ended or future dated supply end date.",
        "possible_errors": [
            "meter_point_with_no_agreement",
            "meterpoint_with_agreement_not_on_supply"
        ]
    },
    {
        "name": "Validate transfer readings exist on active gas meters",
        "description": "Validate that each active gas meter has a single transfer reading provided.",
        "possible_errors": [
            "active_gas_meter_with_multiple_transfer_readings",
            "active_gas_meter_without_transfer_reading",
            "reading_meter_fully_billed"
        ]
    },
    {
        "name": "Validate transfer readings exist on active electricity registers",
        "description": "Validate that each active electricity meter register has a single transfer reading provided.",
        "possible_errors": [
            "missing_transfer_reading_for_register",
            "multiple_transfer_readings_for_register"
        ]
    },
    {
        "name": "Validate concession card and concession credids paid current year",
        "description": "Validates that only one customer with concession card and concession credids paid current year provided; customer with concession card needs to match with customer with concession credits paid current year.",
        "possible_errors": [
            "concession_cards_too_many_users",
            "concession_credits_and_cards_too_many_users",
            "concession_credits_paid_too_many_users"
        ]
    },
    {
        "name": "Validate payment terms apply to portfolio",
        "description": "Validate that portfolio lead account must have <code>apply_to_portfolio</code> set to true and only portfolio lead account can set <code>apply_to_portfolio</code> to true.",
        "possible_errors": [
            "invalid_apply_to_portfolio"
        ]
    },
    {
        "name": "Validate manually defined eligibility periods",
        "description": "Validates that manually defined rebate periods cannot be added without a primary address and some manually defined rebate periods need a concession card as well.",
        "possible_errors": [
            "manually_defined_eligibility_periods_without_concession_card",
            "manually_defined_rebate_periods_without_primary_address"
        ]
    },
    {
        "name": "Validate primary place of residence without concession card or credits paid or manually defined eligibility periods",
        "description": "Validates that only customer with concession card, credits paid or manually defined eligibility periods can have a primary place of residence.",
        "possible_errors": [
            "primary_place_of_residence_without_concession_card_or_credits_paid_or_rebate"
        ]
    },
    {
        "name": "Validate concession cards or credits paid without primary place of residence",
        "description": "Validates that concession cards cannot be loaded without a primary address and concession credits paid for the year cannot be recorded without a primary address except it is proprietor account.",
        "possible_errors": [
            "concession_cards_or_credits_paid_without_primary_place_of_residence"
        ]
    }
]

{
    "x-enum-descriptions": {
        "RTCSSO": "RTCSSO"
    }
}

{
    "x-enum-descriptions": {}
}

{
    "allOf": [
        {
            "$ref": "#/components/schemas/RedenergyBillingAddress"
        }
    ]
}

{
    "allOf": [
        {
            "$ref": "#/components/schemas/AusBillingAddress"
        }
    ]
}

[
    {
        "name": "Validate account type is valid",
        "description": "Validate that only one account type is specified in the payload.",
        "possible_errors": [
            "multiple_account_types_selected"
        ]
    },
    {
        "name": "Validate billing address fields",
        "description": "If a legacy billing address is provided, validate that it is in the correct format.",
        "possible_errors": [
            "invalid_address"
        ]
    },
    {
        "name": "Validate life support contact user email",
        "description": "Validates that life support contact user email matches with customers email. When life support <code>preferred_contact_method</code> is <code>EMAIL_ADDRESS</code>, it requires customer with email. When it is <code>PHONE</code>, it requires customer with mobile or landline.",
        "possible_errors": [
            "missing_contact_user_email_or_phone"
        ]
    },
    {
        "name": "Validate metadata",
        "description": "Validate that metadata, which is a list of key value pairs, does not contain duplicate keys.",
        "possible_errors": [
            "metadata_has_duplicate_keys"
        ]
    },
    {
        "name": "Validate unique property external identifiers",
        "description": "Ensures that <code>property_external_identifier</code> is not repeated across <code>supply_addresses</code> and <code>properties</code>.",
        "possible_errors": [
            "duplicate_property_external_identifiers"
        ]
    },
    {
        "name": "Validate managed account type is allowed",
        "description": "Validate that this instance of Kraken allows managed account types.",
        "possible_errors": [
            "managed_accounts_are_not_allowed"
        ]
    },
    {
        "name": "Validate only portfolio lead has portfolio setting",
        "description": "Validates that if portfolio settings are provided, then the account is marked as the portfolio lead.",
        "possible_errors": [
            "portfolio_settings_included_when_not_lead"
        ]
    },
    {
        "name": "Validate no customers for unknown occupier",
        "description": "Validate that no customers are provided for an unknown occupier.",
        "possible_errors": [
            "customer_with_unknown_occupier"
        ]
    },
    {
        "name": "Validate that a customer given name is provided for business accounts",
        "description": "Validate that a given name is provided for all customers on a business account. Note that this validation only applies if Kraken is configured to send registration flows for this import supplier.",
        "possible_errors": [
            "customer_given_name_required"
        ]
    },
    {
        "name": "Validate portfolio reference provided correctly",
        "description": "Validate that a portfolio reference is provided if portfolio settings have been provided and that a portfolio reference is not provided if the import supplier is set to create new portfolios.",
        "possible_errors": [
            "portfolio_references_missing",
            "portfolio_references_provided"
        ]
    },
    {
        "name": "Validate billing address style",
        "description": "Validate that a legacy billing address (<code>billing_address1</code> etc.) and new-style billing address (<code>billing_address</code> object) are not both provided.",
        "possible_errors": [
            "billing_address_new_style_and_legacy"
        ]
    },
    {
        "name": "Validate agreements are consecutive per supply point",
        "description": "Validate that the agreements provided in the payload are consecutive per supply point i.e. there are no gaps or overlaps. The exception to this is for agreements provided before the current supply period for the supply point. Agreements provided before the <code>supply_start_date</code> are allowed gaps since they represent historic periods of supply and cannot be used for billing in Kraken.",
        "possible_errors": [
            "gaps_or_overlaps_in_agreement_dates"
        ]
    },
    {
        "name": "Validate supply charge line items covered by a single agreement",
        "description": "Validate each supply charge has a single agreement with matching product code that covers the period defined by it's line items minimum <code>start_date</code> to maximum <code>end_date</code>.",
        "possible_errors": [
            "supply_charge_line_items_not_covered_by_single_agreement"
        ]
    },
    {
        "name": "Validate that Kraken can calculate when to start billing the account",
        "description": "Validate that Kraken can calculate when to start billing the account. This is determined based on the existence of last billed to date, last statement closing date, and agreements.",
        "possible_errors": [
            "cannot_determine_responsible_for_billing_from_date"
        ]
    },
    {
        "name": "Validate historical statement period end must not be in the future",
        "description": "Ensures that the historical statement period end date (last_statement_closing_date or latest transaction_date) is not set in the future.",
        "possible_errors": [
            "historical_statement_period_end_in_future"
        ]
    },
    {
        "name": "Validate that terms with supply type matches a supply point supply type",
        "description": "Validate that for terms containing a <code>supply_type</code> field that there is a supply point in the payload with a matching <code>supply_type</code>.",
        "possible_errors": [
            "term_supply_type_mismatch"
        ]
    },
    {
        "name": "Validate that supply addresses and supply points are provided if account contracts are provided",
        "description": "Validate that if <code>account_contracts</code> have been provided that a supply address with supply points has been provided under <code>supply_addresses</code>",
        "possible_errors": [
            "account_contracts_without_supply_points"
        ]
    },
    {
        "name": "Validate historical statement billing document identifier presence",
        "description": "Ensure that billing document identifiers are only provided for historical statement transactions and only when the relevant feature flag is enabled.",
        "possible_errors": [
            "historical_statement_billing_document_identifier_missing",
            "historical_statement_billing_document_identifier_not_allowed_when_feature_flag_disabled"
        ]
    },
    {
        "name": "Validate current statement transactions do not provide <code>billing_document_identifier</code>",
        "description": "Validate that none of the current statement transactions include a <code>billing_document_identifier</code>, as this field is only applicable to historical statement transactions.",
        "possible_errors": [
            "billing_document_identifier_not_allowed_for_current_statement_transactions"
        ]
    },
    {
        "name": "Validate historical statement transaction billing document identifier",
        "description": "Ensure that the billing document identifier is the same for all historical statement transactions.",
        "possible_errors": [
            "historical_statement_billing_document_identifier_mismatch"
        ]
    },
    {
        "name": "Validate that contract terms' product codes are part of supply agreements",
        "description": "Ensure that any contract terms with product references have corresponding products in supply addresses.",
        "possible_errors": [
            "contract_term_product_code_not_in_agreements"
        ]
    },
    {
        "name": "Validate that business is provided if enforcing business contracts",
        "description": "Validate that the business field is provided if <code>enforce_business_contracts_exist</code> is set to True on the import supplier configuration.",
        "possible_errors": [
            "business_field_required"
        ]
    },
    {
        "name": "Validate that the sum of ledger balances equals the transfer balance",
        "description": "Validate that the sum of all <code>ledger_balance</code> provided for each ledger in <code>ledgers</code> equals the account-level <code>transfer_balance</code>.",
        "possible_errors": [
            "ledger_balances_not_equal_to_transfer_balance"
        ]
    },
    {
        "name": "Validate business user info against customer info",
        "description": "Validates that business user information matches the corresponding customer information for basic fields.",
        "possible_errors": [
            "customer_details_and_user_details_both_provided"
        ]
    },
    {
        "name": "Validate payment preference <code>ledger_identifier</code>",
        "description": "Ensure that the <code>ledger_identifier</code> provided has an equivalent <code>ledger</code> object with the same <code>ledger_identifier</code> .",
        "possible_errors": [
            "invalid_payment_preference_ledger_identifier"
        ]
    },
    {
        "name": "Validate that referenced ledgers are unique in payment preferences",
        "description": "Ensure that each ledger is referenced in at most one payment preference.",
        "possible_errors": [
            "duplicate_ledger_in_payment_preferences"
        ]
    },
    {
        "name": "Validate that valid instruction_identifier provided for <code>ACTIVE_NEW</code> payment preference",
        "description": "Ensure that <code>ACTIVE_NEW</code> payment preference has instruction_identifier from </code>payment_instructions</code> object.",
        "possible_errors": [
            "active_new_payment_preference_invalid_instruction_identifier"
        ]
    },
    {
        "name": "Validate that the transactions for a voucher do not exceed its value",
        "description": "Validate that the sum of all transaction values for a voucher is not greater than the value of the voucher.",
        "possible_errors": [
            "voucher_transactions_sum_greater_than_voucher_value"
        ]
    },
    {
        "name": "Validate that each voucher charge transaction id has a matching transaction id within a transaction of type CHARGE",
        "description": "Validate that each <code>voucher</code> <code>charge_transaction_id</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CHARGE in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
        "possible_errors": [
            "voucher_charge_transaction_id_not_found"
        ]
    },
    {
        "name": "Validate that each voucher redemption credit transaction id has a matching transaction id within a transaction of type CREDIT",
        "description": "Validate that every <code>credit_transaction_id</code> in all <code>voucher_redemptions</code> in every <code>voucher</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CREDIT in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
        "possible_errors": [
            "voucher_redemption_credit_transaction_id_not_found"
        ]
    },
    {
        "name": "Validate parent property references exist",
        "description": "Validates that all <code>parent_property_reference</code> values in <code>supply_addresses</code> and <code>properties</code> correspond to a <code>property_external_identifier</code> in the payload. This ensures the property hierarchy is valid.",
        "possible_errors": [
            "parent_property_reference_not_found"
        ]
    },
    {
        "name": "Validate that a portfolio lead account has no supply address since it makes no sense for it to have one",
        "description": "Validate that a portfolio lead account has no supply address.",
        "possible_errors": [
            "portfolio_lead_has_a_supply_address"
        ]
    },
    {
        "name": "Validate that a system account has no supply address",
        "description": "Validate that a system account has no supply address",
        "possible_errors": [
            "system_account_has_a_supply_address"
        ]
    },
    {
        "name": "Validate auto allocation of operations team",
        "description": "Validate that operations_team_name is provided if auto allocation is not configured.",
        "possible_errors": [
            "operations_team_provided_when_using_auto_allocation",
            "operations_team_should_be_provided"
        ]
    },
    {
        "name": "Validate ledger identifiers are known",
        "description": "Validate ledger identifiers are among supply point identifiers.",
        "possible_errors": [
            "unknown_ledger_identifiers"
        ]
    },
    {
        "name": "Validate identifiers are unique in ledgers",
        "description": "Validate identifier is not declared twice in ledgers.",
        "possible_errors": [
            "duplicate_identifiers_entries_found"
        ]
    },
    {
        "name": "Validate agreements cover last statement closing date",
        "description": "Validate that there is an agreement for each supply point covering each ledger's <code>last_statement_closing_date</code>.",
        "possible_errors": [
            "no_agreement_covering_last_statement_closing_date"
        ]
    },
    {
        "name": "Validate no unbilled period on former supply addresses",
        "description": "Validate that if a customer is no longer at the given supply address they have been fully billed. This check is performed if we are importing supply address history.",
        "possible_errors": [
            "unbilled_former_supply_address"
        ]
    },
    {
        "name": "Validate at least one billable meter point is provided",
        "description": "Validate that account must have at least one billable meter point unless import config skip_meter_point_creation is ON or account is a portfolio lead, or account is an unmetered service, or account is an inactive account.",
        "possible_errors": [
            "no_supply_point_on_supply"
        ]
    },
    {
        "name": "Validate alternative phone number is unique",
        "description": "Validate customers defined in the payload do not have the same alternative phone numbers.",
        "possible_errors": [
            "duplicated_alternative_phone_numbers"
        ]
    },
    {
        "name": "Validate billing address style",
        "description": "Validate that a legacy billing address (<code>billing_address1</code> etc.) and new-style billing address (<code>billing_address</code> object) are not both provided.",
        "possible_errors": [
            "billing_address_new_style_and_legacy"
        ]
    },
    {
        "name": "Validate business type not provided for domestic accounts",
        "description": "Validate that a business type is not provided for domestic accounts.",
        "possible_errors": [
            "business_fields_provided_for_domestic_accounts"
        ]
    },
    {
        "name": "Validate that blackhole email addresses are paired with 'online' communication prefernence",
        "description": "Validate that the communication preference 'online' when a blackhole email address is provided.",
        "possible_errors": [
            "blackhole_email_with_online_comms"
        ]
    },
    {
        "name": "Validate customer family name",
        "description": "Validate the family name is provided for all customers on a domestic account.",
        "possible_errors": [
            "customer_family_name_required"
        ]
    },
    {
        "name": "Validate portfolio lead communication preference",
        "description": "Validates that portfolio lead is using ONLINE communication preference.",
        "possible_errors": [
            "invalid_portfolio_lead_communication_preference"
        ]
    },
    {
        "name": "Validate all billable meter points are covered by agreements in the payload",
        "description": "Validate that agreements have been provided for all billable meter points and vice versa for the period covered by Kraken from a billing perspective. A billable meter point is one that has an open-ended or future dated supply end date.",
        "possible_errors": [
            "meter_point_with_no_agreement",
            "meterpoint_with_agreement_not_on_supply"
        ]
    },
    {
        "name": "Validate transfer readings exist on active gas meters",
        "description": "Validate that each active gas meter has a single transfer reading provided.",
        "possible_errors": [
            "active_gas_meter_with_multiple_transfer_readings",
            "active_gas_meter_without_transfer_reading",
            "reading_meter_fully_billed"
        ]
    },
    {
        "name": "Validate transfer readings exist on active electricity registers",
        "description": "Validate that each active electricity meter register has a single transfer reading provided.",
        "possible_errors": [
            "missing_transfer_reading_for_register",
            "multiple_transfer_readings_for_register"
        ]
    },
    {
        "name": "Validate concession card and concession credids paid current year",
        "description": "Validates that only one customer with concession card and concession credids paid current year provided; customer with concession card needs to match with customer with concession credits paid current year.",
        "possible_errors": [
            "concession_cards_too_many_users",
            "concession_credits_and_cards_too_many_users",
            "concession_credits_paid_too_many_users"
        ]
    },
    {
        "name": "Validate payment terms apply to portfolio",
        "description": "Validate that portfolio lead account must have <code>apply_to_portfolio</code> set to true and only portfolio lead account can set <code>apply_to_portfolio</code> to true.",
        "possible_errors": [
            "invalid_apply_to_portfolio"
        ]
    },
    {
        "name": "Validate manually defined eligibility periods",
        "description": "Validates that manually defined rebate periods cannot be added without a primary address and some manually defined rebate periods need a concession card as well.",
        "possible_errors": [
            "manually_defined_eligibility_periods_without_concession_card",
            "manually_defined_rebate_periods_without_primary_address"
        ]
    },
    {
        "name": "Validate primary place of residence without concession card or credits paid or manually defined eligibility periods",
        "description": "Validates that only customer with concession card, credits paid or manually defined eligibility periods can have a primary place of residence.",
        "possible_errors": [
            "primary_place_of_residence_without_concession_card_or_credits_paid_or_rebate"
        ]
    },
    {
        "name": "Validate concession cards or credits paid without primary place of residence",
        "description": "Validates that concession cards cannot be loaded without a primary address and concession credits paid for the year cannot be recorded without a primary address except it is proprietor account.",
        "possible_errors": [
            "concession_cards_or_credits_paid_without_primary_place_of_residence"
        ]
    }
]

[
    {
        "name": "Validate account type is valid",
        "description": "Validate that only one account type is specified in the payload.",
        "possible_errors": [
            "multiple_account_types_selected"
        ]
    },
    {
        "name": "Validate billing address fields",
        "description": "If a legacy billing address is provided, validate that it is in the correct format.",
        "possible_errors": [
            "invalid_address"
        ]
    },
    {
        "name": "Validate life support contact user email",
        "description": "Validates that life support contact user email matches with customers email. When life support <code>preferred_contact_method</code> is <code>EMAIL_ADDRESS</code>, it requires customer with email. When it is <code>PHONE</code>, it requires customer with mobile or landline.",
        "possible_errors": [
            "missing_contact_user_email_or_phone"
        ]
    },
    {
        "name": "Validate metadata",
        "description": "Validate that metadata, which is a list of key value pairs, does not contain duplicate keys.",
        "possible_errors": [
            "metadata_has_duplicate_keys"
        ]
    },
    {
        "name": "Validate unique property external identifiers",
        "description": "Ensures that <code>property_external_identifier</code> is not repeated across <code>supply_addresses</code> and <code>properties</code>.",
        "possible_errors": [
            "duplicate_property_external_identifiers"
        ]
    },
    {
        "name": "Validate managed account type is allowed",
        "description": "Validate that this instance of Kraken allows managed account types.",
        "possible_errors": [
            "managed_accounts_are_not_allowed"
        ]
    },
    {
        "name": "Validate only portfolio lead has portfolio setting",
        "description": "Validates that if portfolio settings are provided, then the account is marked as the portfolio lead.",
        "possible_errors": [
            "portfolio_settings_included_when_not_lead"
        ]
    },
    {
        "name": "Validate no customers for unknown occupier",
        "description": "Validate that no customers are provided for an unknown occupier.",
        "possible_errors": [
            "customer_with_unknown_occupier"
        ]
    },
    {
        "name": "Validate that a customer given name is provided for business accounts",
        "description": "Validate that a given name is provided for all customers on a business account. Note that this validation only applies if Kraken is configured to send registration flows for this import supplier.",
        "possible_errors": [
            "customer_given_name_required"
        ]
    },
    {
        "name": "Validate portfolio reference provided correctly",
        "description": "Validate that a portfolio reference is provided if portfolio settings have been provided and that a portfolio reference is not provided if the import supplier is set to create new portfolios.",
        "possible_errors": [
            "portfolio_references_missing",
            "portfolio_references_provided"
        ]
    },
    {
        "name": "Validate billing address style",
        "description": "Validate that a legacy billing address (<code>billing_address1</code> etc.) and new-style billing address (<code>billing_address</code> object) are not both provided.",
        "possible_errors": [
            "billing_address_new_style_and_legacy"
        ]
    },
    {
        "name": "Validate agreements are consecutive per supply point",
        "description": "Validate that the agreements provided in the payload are consecutive per supply point i.e. there are no gaps or overlaps. The exception to this is for agreements provided before the current supply period for the supply point. Agreements provided before the <code>supply_start_date</code> are allowed gaps since they represent historic periods of supply and cannot be used for billing in Kraken.",
        "possible_errors": [
            "gaps_or_overlaps_in_agreement_dates"
        ]
    },
    {
        "name": "Validate supply charge line items covered by a single agreement",
        "description": "Validate each supply charge has a single agreement with matching product code that covers the period defined by it's line items minimum <code>start_date</code> to maximum <code>end_date</code>.",
        "possible_errors": [
            "supply_charge_line_items_not_covered_by_single_agreement"
        ]
    },
    {
        "name": "Validate that Kraken can calculate when to start billing the account",
        "description": "Validate that Kraken can calculate when to start billing the account. This is determined based on the existence of last billed to date, last statement closing date, and agreements.",
        "possible_errors": [
            "cannot_determine_responsible_for_billing_from_date"
        ]
    },
    {
        "name": "Validate historical statement period end must not be in the future",
        "description": "Ensures that the historical statement period end date (last_statement_closing_date or latest transaction_date) is not set in the future.",
        "possible_errors": [
            "historical_statement_period_end_in_future"
        ]
    },
    {
        "name": "Validate that terms with supply type matches a supply point supply type",
        "description": "Validate that for terms containing a <code>supply_type</code> field that there is a supply point in the payload with a matching <code>supply_type</code>.",
        "possible_errors": [
            "term_supply_type_mismatch"
        ]
    },
    {
        "name": "Validate that supply addresses and supply points are provided if account contracts are provided",
        "description": "Validate that if <code>account_contracts</code> have been provided that a supply address with supply points has been provided under <code>supply_addresses</code>",
        "possible_errors": [
            "account_contracts_without_supply_points"
        ]
    },
    {
        "name": "Validate historical statement billing document identifier presence",
        "description": "Ensure that billing document identifiers are only provided for historical statement transactions and only when the relevant feature flag is enabled.",
        "possible_errors": [
            "historical_statement_billing_document_identifier_missing",
            "historical_statement_billing_document_identifier_not_allowed_when_feature_flag_disabled"
        ]
    },
    {
        "name": "Validate current statement transactions do not provide <code>billing_document_identifier</code>",
        "description": "Validate that none of the current statement transactions include a <code>billing_document_identifier</code>, as this field is only applicable to historical statement transactions.",
        "possible_errors": [
            "billing_document_identifier_not_allowed_for_current_statement_transactions"
        ]
    },
    {
        "name": "Validate historical statement transaction billing document identifier",
        "description": "Ensure that the billing document identifier is the same for all historical statement transactions.",
        "possible_errors": [
            "historical_statement_billing_document_identifier_mismatch"
        ]
    },
    {
        "name": "Validate that contract terms' product codes are part of supply agreements",
        "description": "Ensure that any contract terms with product references have corresponding products in supply addresses.",
        "possible_errors": [
            "contract_term_product_code_not_in_agreements"
        ]
    },
    {
        "name": "Validate that business is provided if enforcing business contracts",
        "description": "Validate that the business field is provided if <code>enforce_business_contracts_exist</code> is set to True on the import supplier configuration.",
        "possible_errors": [
            "business_field_required"
        ]
    },
    {
        "name": "Validate that the sum of ledger balances equals the transfer balance",
        "description": "Validate that the sum of all <code>ledger_balance</code> provided for each ledger in <code>ledgers</code> equals the account-level <code>transfer_balance</code>.",
        "possible_errors": [
            "ledger_balances_not_equal_to_transfer_balance"
        ]
    },
    {
        "name": "Validate business user info against customer info",
        "description": "Validates that business user information matches the corresponding customer information for basic fields.",
        "possible_errors": [
            "customer_details_and_user_details_both_provided"
        ]
    },
    {
        "name": "Validate payment preference <code>ledger_identifier</code>",
        "description": "Ensure that the <code>ledger_identifier</code> provided has an equivalent <code>ledger</code> object with the same <code>ledger_identifier</code> .",
        "possible_errors": [
            "invalid_payment_preference_ledger_identifier"
        ]
    },
    {
        "name": "Validate that referenced ledgers are unique in payment preferences",
        "description": "Ensure that each ledger is referenced in at most one payment preference.",
        "possible_errors": [
            "duplicate_ledger_in_payment_preferences"
        ]
    },
    {
        "name": "Validate that valid instruction_identifier provided for <code>ACTIVE_NEW</code> payment preference",
        "description": "Ensure that <code>ACTIVE_NEW</code> payment preference has instruction_identifier from </code>payment_instructions</code> object.",
        "possible_errors": [
            "active_new_payment_preference_invalid_instruction_identifier"
        ]
    },
    {
        "name": "Validate that the transactions for a voucher do not exceed its value",
        "description": "Validate that the sum of all transaction values for a voucher is not greater than the value of the voucher.",
        "possible_errors": [
            "voucher_transactions_sum_greater_than_voucher_value"
        ]
    },
    {
        "name": "Validate that each voucher charge transaction id has a matching transaction id within a transaction of type CHARGE",
        "description": "Validate that each <code>voucher</code> <code>charge_transaction_id</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CHARGE in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
        "possible_errors": [
            "voucher_charge_transaction_id_not_found"
        ]
    },
    {
        "name": "Validate that each voucher redemption credit transaction id has a matching transaction id within a transaction of type CREDIT",
        "description": "Validate that every <code>credit_transaction_id</code> in all <code>voucher_redemptions</code> in every <code>voucher</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CREDIT in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
        "possible_errors": [
            "voucher_redemption_credit_transaction_id_not_found"
        ]
    },
    {
        "name": "Validate parent property references exist",
        "description": "Validates that all <code>parent_property_reference</code> values in <code>supply_addresses</code> and <code>properties</code> correspond to a <code>property_external_identifier</code> in the payload. This ensures the property hierarchy is valid.",
        "possible_errors": [
            "parent_property_reference_not_found"
        ]
    },
    {
        "name": "Validate auto allocation of operations team",
        "description": "Validate that operations_team_name is provided if auto allocation is not configured.",
        "possible_errors": [
            "operations_team_provided_when_using_auto_allocation",
            "operations_team_should_be_provided"
        ]
    },
    {
        "name": "Validate ledger identifiers are known",
        "description": "Validate ledger identifiers are among supply point identifiers.",
        "possible_errors": [
            "unknown_ledger_identifiers"
        ]
    },
    {
        "name": "Validate identifiers are unique in ledgers",
        "description": "Validate identifier is not declared twice in ledgers.",
        "possible_errors": [
            "duplicate_identifiers_entries_found"
        ]
    },
    {
        "name": "Validate agreements cover last statement closing date",
        "description": "Validate that there is an agreement for each supply point covering each ledger's <code>last_statement_closing_date</code>.",
        "possible_errors": [
            "no_agreement_covering_last_statement_closing_date"
        ]
    },
    {
        "name": "Validate no unbilled period on former supply addresses",
        "description": "Validate that if a customer is no longer at the given supply address they have been fully billed. This check is performed if we are importing supply address history.",
        "possible_errors": [
            "unbilled_former_supply_address"
        ]
    },
    {
        "name": "Validate at least one billable meter point is provided",
        "description": "Validate that account must have at least one billable meter point unless import config skip_meter_point_creation is ON or account is a portfolio lead, or account is an unmetered service, or account is an inactive account.",
        "possible_errors": [
            "no_supply_point_on_supply"
        ]
    },
    {
        "name": "Validate alternative phone number is unique",
        "description": "Validate customers defined in the payload do not have the same alternative phone numbers.",
        "possible_errors": [
            "duplicated_alternative_phone_numbers"
        ]
    },
    {
        "name": "Validate billing address style",
        "description": "Validate that a legacy billing address (<code>billing_address1</code> etc.) and new-style billing address (<code>billing_address</code> object) are not both provided.",
        "possible_errors": [
            "billing_address_new_style_and_legacy"
        ]
    },
    {
        "name": "Validate business type not provided for domestic accounts",
        "description": "Validate that a business type is not provided for domestic accounts.",
        "possible_errors": [
            "business_fields_provided_for_domestic_accounts"
        ]
    },
    {
        "name": "Validate that blackhole email addresses are paired with 'online' communication prefernence",
        "description": "Validate that the communication preference 'online' when a blackhole email address is provided.",
        "possible_errors": [
            "blackhole_email_with_online_comms"
        ]
    },
    {
        "name": "Validate customer family name",
        "description": "Validate the family name is provided for all customers on a domestic account.",
        "possible_errors": [
            "customer_family_name_required"
        ]
    },
    {
        "name": "Validate portfolio lead communication preference",
        "description": "Validates that portfolio lead is using ONLINE communication preference.",
        "possible_errors": [
            "invalid_portfolio_lead_communication_preference"
        ]
    },
    {
        "name": "Validate all billable meter points are covered by agreements in the payload",
        "description": "Validate that agreements have been provided for all billable meter points and vice versa for the period covered by Kraken from a billing perspective. A billable meter point is one that has an open-ended or future dated supply end date.",
        "possible_errors": [
            "meter_point_with_no_agreement",
            "meterpoint_with_agreement_not_on_supply"
        ]
    },
    {
        "name": "Validate transfer readings exist on active gas meters",
        "description": "Validate that each active gas meter has a single transfer reading provided.",
        "possible_errors": [
            "active_gas_meter_with_multiple_transfer_readings",
            "active_gas_meter_without_transfer_reading",
            "reading_meter_fully_billed"
        ]
    },
    {
        "name": "Validate transfer readings exist on active electricity registers",
        "description": "Validate that each active electricity meter register has a single transfer reading provided.",
        "possible_errors": [
            "missing_transfer_reading_for_register",
            "multiple_transfer_readings_for_register"
        ]
    },
    {
        "name": "Validate concession card and concession credids paid current year",
        "description": "Validates that only one customer with concession card and concession credids paid current year provided; customer with concession card needs to match with customer with concession credits paid current year.",
        "possible_errors": [
            "concession_cards_too_many_users",
            "concession_credits_and_cards_too_many_users",
            "concession_credits_paid_too_many_users"
        ]
    },
    {
        "name": "Validate payment terms apply to portfolio",
        "description": "Validate that portfolio lead account must have <code>apply_to_portfolio</code> set to true and only portfolio lead account can set <code>apply_to_portfolio</code> to true.",
        "possible_errors": [
            "invalid_apply_to_portfolio"
        ]
    },
    {
        "name": "Validate manually defined eligibility periods",
        "description": "Validates that manually defined rebate periods cannot be added without a primary address and some manually defined rebate periods need a concession card as well.",
        "possible_errors": [
            "manually_defined_eligibility_periods_without_concession_card",
            "manually_defined_rebate_periods_without_primary_address"
        ]
    },
    {
        "name": "Validate primary place of residence without concession card or credits paid or manually defined eligibility periods",
        "description": "Validates that only customer with concession card, credits paid or manually defined eligibility periods can have a primary place of residence.",
        "possible_errors": [
            "primary_place_of_residence_without_concession_card_or_credits_paid_or_rebate"
        ]
    },
    {
        "name": "Validate concession cards or credits paid without primary place of residence",
        "description": "Validates that concession cards cannot be loaded without a primary address and concession credits paid for the year cannot be recorded without a primary address except it is proprietor account.",
        "possible_errors": [
            "concession_cards_or_credits_paid_without_primary_place_of_residence"
        ]
    }
]

{
    "x-enum-descriptions": {
        "SYSTEM": "System"
    }
}

{
    "x-enum-descriptions": {}
}

{
    "x-enum-descriptions": {
        "UMBO": "UMBO"
    }
}

{
    "x-enum-descriptions": {}
}

{
    "x-enum-descriptions": {
        "Rabbi": "Rabbi"
    }
}

{
    "x-enum-descriptions": {}
}

{
    "x-enum-descriptions": {
        "UMBD": "UMBD"
    }
}

{
    "x-enum-descriptions": {}
}