{
    "x-enum-descriptions": {
        "up-for-renewal": "Up for renewal"
    }
}

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

{
    "x-enum-descriptions": {
        "Up for renewal": "Up for renewal"
    }
}

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

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

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

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

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

[
    {
        "name": "Validate <code>\u2068supply_end_date\u2069</code> not before <code>\u2068supply_start_date\u2069</code>",
        "description": "Validates that <code>\u2068supply_end_date\u2069</code>, if given, is on or later than <code>\u2068supply_start_date\u2069</code>.",
        "possible_errors": [
            "start_date_later_than_end_date"
        ]
    },
    {
        "name": "Validate agreements do not start before supply start date",
        "description": "Validate that agreements do not start before the supply point's supply start date, if provided.",
        "possible_errors": [
            "agreement_start_date_before_supply_start_date"
        ]
    },
    {
        "name": "Validate that exactly one active agreement is provided",
        "description": "Validate that exactly one active agreement is provided for the supply point if it is already on supply. If the <code>supply_start_date</code> is in the future or the <code>supply_end_date</code> is in the past then we do not check for an active agreement.",
        "possible_errors": [
            "exactly_one_active_agreement_required"
        ]
    },
    {
        "name": "Validate that a future agreement provided if supply start date is in the future",
        "description": "Validate that exactly one future agreement is provided if the supply start date is in the future. This future agreement must start on the supply start date.",
        "possible_errors": [
            "future_agreement_required"
        ]
    },
    {
        "name": "Validate that switch_on or last_billed_to_date is provided",
        "description": "Ensure that either switch_on or last_billed_to_date is provided for the supply point.",
        "possible_errors": [
            "switch_date_cannot_be_determined"
        ]
    }
]

[
    {
        "name": "Validate <code>\u2068supply_end_date\u2069</code> not before <code>\u2068supply_start_date\u2069</code>",
        "description": "Validates that <code>\u2068supply_end_date\u2069</code>, if given, is on or later than <code>\u2068supply_start_date\u2069</code>.",
        "possible_errors": [
            "start_date_later_than_end_date"
        ]
    },
    {
        "name": "Validate agreements do not start before supply start date",
        "description": "Validate that agreements do not start before the supply point's supply start date, if provided.",
        "possible_errors": [
            "agreement_start_date_before_supply_start_date"
        ]
    },
    {
        "name": "Validate that exactly one active agreement is provided",
        "description": "Validate that exactly one active agreement is provided for the supply point if it is already on supply. If the <code>supply_start_date</code> is in the future or the <code>supply_end_date</code> is in the past then we do not check for an active agreement.",
        "possible_errors": [
            "exactly_one_active_agreement_required"
        ]
    },
    {
        "name": "Validate that a future agreement provided if supply start date is in the future",
        "description": "Validate that exactly one future agreement is provided if the supply start date is in the future. This future agreement must start on the supply start date.",
        "possible_errors": [
            "future_agreement_required"
        ]
    },
    {
        "name": "usa:data-import--validation--switch-on-or-last-billed-to-date-required--display-name",
        "description": "usa:data-import--validation--switch-on-or-last-billed-to-date-required--help-text",
        "possible_errors": [
            "switch_date_cannot_be_determined"
        ]
    }
]

{
    "x-removal-date": "2026-04-29"
}

{
    "x-enum-descriptions": {
        "cc_payment_6_mo": "CC payment last 6 months"
    }
}

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

{
    "x-enum-descriptions": {
        "CC payment last 6 months": "CC payment last 6 months"
    }
}

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

{
    "x-validators": [
        {
            "name": "Validate <code>organisation_number</code>",
            "description": "Validate that the given <code>organisation_number</code> has a corresponding organisation registered in the database.",
            "possible_errors": [
                "partner_organisation_does_not_exist"
            ]
        }
    ]
}

[
    {
        "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 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 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 business type and company number not provided for domestic accounts",
        "description": "Validate that neither a business type or company number are provided for domestic accounts.",
        "possible_errors": [
            "business_fields_provided_for_domestic_accounts"
        ]
    },
    {
        "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 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": "Ensure that we have at least one meter point which needs billing in Kraken right now. This is as\nwe're not currently importing off-supply accounts. Any account that is not on supply at the time\nof import should be final billed in the old system.",
        "possible_errors": [
            "no_supply_point_on_supply"
        ]
    }
]

[
    {
        "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 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 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 business type and company number not provided for domestic accounts",
        "description": "Validate that neither a business type or company number are provided for domestic accounts.",
        "possible_errors": [
            "business_fields_provided_for_domestic_accounts"
        ]
    },
    {
        "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 contracts are consecutive per supply point",
        "description": "Validate that the contracts provided in the payload are consecutive per supply point i.e. there are no gaps or overlaps. The exception to this is for contracts provided before the current supply period for the supply point. Contracts 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 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": "Ensure that we have at least one meter point which needs billing in Kraken right now. This is as\nwe're not currently importing off-supply accounts. Any account that is not on supply at the time\nof import should be final billed in the old system.",
        "possible_errors": [
            "no_supply_point_on_supply"
        ]
    }
]

{
    "x-validators": [
        {
            "name": "Validate line item periods",
            "description": "Validate that no line items overlap (checked per supply point, product, and rate band combination) or have gaps (checked per supply point only) in supply charge transactions.",
            "possible_errors": [
                "gaps_or_overlaps_in_periods"
            ]
        }
    ]
}

{
    "x-validators": [
        {
            "name": "Validate line item periods",
            "description": "Validate that no line items overlap (checked per supply point, product, and rate band combination) or have gaps (checked per supply point only) in supply charge transactions.",
            "possible_errors": [
                "zero_length_periods",
                "gaps_or_overlaps_in_periods"
            ]
        }
    ]
}

{
    "x-validators": [
        {
            "name": "Validate line item periods",
            "description": "Validate that no line items overlap (checked per supply point, product, and rate band combination) or have gaps (checked per supply point only) in supply charge transactions.",
            "possible_errors": [
                "gaps_or_overlaps_in_periods"
            ]
        }
    ]
}

{
    "x-validators": [
        {
            "name": "Validate line item periods",
            "description": "Validate that no line items overlap (checked per supply point, product, and rate band combination) or have gaps (checked per supply point only) in supply charge transactions.",
            "possible_errors": [
                "zero_length_periods",
                "gaps_or_overlaps_in_periods"
            ]
        }
    ]
}