Data Import REST API Changelog
This page shows recent changes to Data Import REST API.
27 May 2026 - Latest
No attributes to display
22 May 2026
New
{
"nullable": true
}Old
{
"required": true
}21 May 2026
No attributes to display
New
[
{
"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 customer family name",
"description": "Validate the family name is provided for all customers on a domestic account. For Business accounts, set the family name to 'Business' if it is not provided.",
"possible_errors": [
"customer_family_name_required"
]
},
{
"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 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 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 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 that the energy meter point and billing configuration periods cover the open settlement period",
"description": "Validate that the energy meter point and billing configuration periods start on or before the <code>last_settlement_closing_date</code> and are open-ended.",
"possible_errors": [
"config_period_does_not_cover_open_settlement_period"
]
},
{
"name": "Validate that the last settlement closing date aligns with the agreement start date",
"description": "Validate that the <code>last_settlement_closing_date</code> aligns with the <code>effective_from</code> of the agreement. Alignment is defined as exactly 12 months between the (inclusive) <code>last_settlement_closing_date</code> and the <code>effective_from</code> of the agreement.",
"possible_errors": [
"last_settlement_closing_date_does_not_align_with_agreement_start_date"
]
},
{
"name": "Validate that each line item start day matches the agreement start day",
"description": "Validate that each line item start day matches the agreement start day. If the agreement start day is not possible in the line item start month (e.g. 29/30/31), the last day of that month should be used.",
"possible_errors": [
"line_item_start_day_does_not_align_with_agreement_start_day"
]
},
{
"name": "Validate that the invoice numbers provided in the statements starting after the <code>last_settlement_closing_date</code> and the transactions in the <code>transactions_in_open_settlement_period</code> match",
"description": "Validate that the invoice numbers provided in the <code>statements</code> starting after the <code>last_settlement_closing_date</code> and the invoice numbers in the <code>SUPPLY_CHARGE</code> <code>transactions</code> in the <code>transactions_in_open_settlement_period</code> are the same.",
"possible_errors": [
"invoice_numbers_do_not_match"
]
},
{
"name": "Validate that the invoice numbers in the statements, with a start date before or on the last settlement closing date, do not match any invoice numbers in the transactions in the open settlement period",
"description": "Validate that the invoice numbers in the <code>statements</code>, with a <code>bill_period_from_date</code> before or on the <code>last_settlement_closing_date</code>, do not match any <code>associated_invoice_number</code> in the <code>transactions</code> in the <code>transactions_in_open_settlement_period</code>.",
"possible_errors": [
"statement_invoice_number_match_found_in_transactions"
]
},
{
"name": "Validate that the statement bill_period_from_date matches the corresponding line items start_date",
"description": "Validate that the <code>bill_period_from_date</code> of each statement matches the <code>start_date</code> of the corresponding line items.",
"possible_errors": [
"statement_bill_period_date_does_not_match_line_item_start_date"
]
},
{
"name": "Validate that the correct rate bands are included in the line items within the transactions in the open settlement period and historical statement transactions",
"description": "Validate that there are no missing or extra <code>rate_bands</code> in the <code>line_items</code> within the <code>transactions_in_open_settlement_period</code> and <code>historical_statement_transactions</code>.",
"possible_errors": [
"line_item_rate_band_not_on_product"
]
}
]Old
[
{
"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 customer family name",
"description": "Validate the family name is provided for all customers on a domestic account. For Business accounts, set the family name to 'Business' if it is not provided.",
"possible_errors": [
"customer_family_name_required"
]
},
{
"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 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 that the energy meter point and billing configuration periods cover the open settlement period",
"description": "Validate that the energy meter point and billing configuration periods start on or before the <code>last_settlement_closing_date</code> and are open-ended.",
"possible_errors": [
"config_period_does_not_cover_open_settlement_period"
]
},
{
"name": "Validate that the last settlement closing date aligns with the agreement start date",
"description": "Validate that the <code>last_settlement_closing_date</code> aligns with the <code>effective_from</code> of the agreement. Alignment is defined as exactly 12 months between the (inclusive) <code>last_settlement_closing_date</code> and the <code>effective_from</code> of the agreement.",
"possible_errors": [
"last_settlement_closing_date_does_not_align_with_agreement_start_date"
]
},
{
"name": "Validate that each line item start day matches the agreement start day",
"description": "Validate that each line item start day matches the agreement start day. If the agreement start day is not possible in the line item start month (e.g. 29/30/31), the last day of that month should be used.",
"possible_errors": [
"line_item_start_day_does_not_align_with_agreement_start_day"
]
},
{
"name": "Validate that the invoice numbers provided in the statements starting after the <code>last_settlement_closing_date</code> and the transactions in the <code>transactions_in_open_settlement_period</code> match",
"description": "Validate that the invoice numbers provided in the <code>statements</code> starting after the <code>last_settlement_closing_date</code> and the invoice numbers in the <code>SUPPLY_CHARGE</code> <code>transactions</code> in the <code>transactions_in_open_settlement_period</code> are the same.",
"possible_errors": [
"invoice_numbers_do_not_match"
]
},
{
"name": "Validate that the invoice numbers in the statements, with a start date before or on the last settlement closing date, do not match any invoice numbers in the transactions in the open settlement period",
"description": "Validate that the invoice numbers in the <code>statements</code>, with a <code>bill_period_from_date</code> before or on the <code>last_settlement_closing_date</code>, do not match any <code>associated_invoice_number</code> in the <code>transactions</code> in the <code>transactions_in_open_settlement_period</code>.",
"possible_errors": [
"statement_invoice_number_match_found_in_transactions"
]
},
{
"name": "Validate that the statement bill_period_from_date matches the corresponding line items start_date",
"description": "Validate that the <code>bill_period_from_date</code> of each statement matches the <code>start_date</code> of the corresponding line items.",
"possible_errors": [
"statement_bill_period_date_does_not_match_line_item_start_date"
]
},
{
"name": "Validate that the correct rate bands are included in the line items within the transactions in the open settlement period and historical statement transactions",
"description": "Validate that there are no missing or extra <code>rate_bands</code> in the <code>line_items</code> within the <code>transactions_in_open_settlement_period</code> and <code>historical_statement_transactions</code>.",
"possible_errors": [
"line_item_rate_band_not_on_product"
]
}
]Old
{
"maxItems": 1
}19 May 2026
No attributes to display
No attributes to display
14 May 2026
No attributes to display
13 May 2026
New
{
"x-enum-descriptions": {
"CHARGEBACK": "Chargeback"
}
}Old
{
"x-enum-descriptions": {}
}New
[
{
"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 customer family name",
"description": "Validate the family name is provided for all customers on a domestic account. For Business accounts, set the family name to 'Business' if it is not provided.",
"possible_errors": [
"customer_family_name_required"
]
},
{
"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 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 that the energy meter point and billing configuration periods cover the open settlement period",
"description": "Validate that the energy meter point and billing configuration periods start on or before the <code>last_settlement_closing_date</code> and are open-ended.",
"possible_errors": [
"config_period_does_not_cover_open_settlement_period"
]
},
{
"name": "Validate that the last settlement closing date aligns with the agreement start date",
"description": "Validate that the <code>last_settlement_closing_date</code> aligns with the <code>effective_from</code> of the agreement. Alignment is defined as exactly 12 months between the (inclusive) <code>last_settlement_closing_date</code> and the <code>effective_from</code> of the agreement.",
"possible_errors": [
"last_settlement_closing_date_does_not_align_with_agreement_start_date"
]
},
{
"name": "Validate that each line item start day matches the agreement start day",
"description": "Validate that each line item start day matches the agreement start day. If the agreement start day is not possible in the line item start month (e.g. 29/30/31), the last day of that month should be used.",
"possible_errors": [
"line_item_start_day_does_not_align_with_agreement_start_day"
]
},
{
"name": "Validate that the invoice numbers provided in the statements starting after the <code>last_settlement_closing_date</code> and the transactions in the <code>transactions_in_open_settlement_period</code> match",
"description": "Validate that the invoice numbers provided in the <code>statements</code> starting after the <code>last_settlement_closing_date</code> and the invoice numbers in the <code>SUPPLY_CHARGE</code> <code>transactions</code> in the <code>transactions_in_open_settlement_period</code> are the same.",
"possible_errors": [
"invoice_numbers_do_not_match"
]
},
{
"name": "Validate that the invoice numbers in the statements, with a start date before or on the last settlement closing date, do not match any invoice numbers in the transactions in the open settlement period",
"description": "Validate that the invoice numbers in the <code>statements</code>, with a <code>bill_period_from_date</code> before or on the <code>last_settlement_closing_date</code>, do not match any <code>associated_invoice_number</code> in the <code>transactions</code> in the <code>transactions_in_open_settlement_period</code>.",
"possible_errors": [
"statement_invoice_number_match_found_in_transactions"
]
},
{
"name": "Validate that the statement bill_period_from_date matches the corresponding line items start_date",
"description": "Validate that the <code>bill_period_from_date</code> of each statement matches the <code>start_date</code> of the corresponding line items.",
"possible_errors": [
"statement_bill_period_date_does_not_match_line_item_start_date"
]
},
{
"name": "Validate that the correct rate bands are included in the line items within the transactions in the open settlement period and historical statement transactions",
"description": "Validate that there are no missing or extra <code>rate_bands</code> in the <code>line_items</code> within the <code>transactions_in_open_settlement_period</code> and <code>historical_statement_transactions</code>.",
"possible_errors": [
"line_item_rate_band_not_on_product"
]
}
]Old
[
{
"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 customer family name",
"description": "Validate the family name is provided for all customers on a domestic account. For Business accounts, set the family name to 'Business' if it is not provided.",
"possible_errors": [
"customer_family_name_required"
]
},
{
"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 that the energy meter point and billing configuration periods cover the open settlement period",
"description": "Validate that the energy meter point and billing configuration periods start on or before the <code>last_settlement_closing_date</code> and are open-ended.",
"possible_errors": [
"config_period_does_not_cover_open_settlement_period"
]
},
{
"name": "Validate that the last settlement closing date aligns with the agreement start date",
"description": "Validate that the <code>last_settlement_closing_date</code> aligns with the <code>effective_from</code> of the agreement. Alignment is defined as exactly 12 months between the (inclusive) <code>last_settlement_closing_date</code> and the <code>effective_from</code> of the agreement.",
"possible_errors": [
"last_settlement_closing_date_does_not_align_with_agreement_start_date"
]
},
{
"name": "Validate that each line item start day matches the agreement start day",
"description": "Validate that each line item start day matches the agreement start day. If the agreement start day is not possible in the line item start month (e.g. 29/30/31), the last day of that month should be used.",
"possible_errors": [
"line_item_start_day_does_not_align_with_agreement_start_day"
]
},
{
"name": "Validate that the invoice numbers provided in the statements starting after the <code>last_settlement_closing_date</code> and the transactions in the <code>transactions_in_open_settlement_period</code> match",
"description": "Validate that the invoice numbers provided in the <code>statements</code> starting after the <code>last_settlement_closing_date</code> and the invoice numbers in the <code>SUPPLY_CHARGE</code> <code>transactions</code> in the <code>transactions_in_open_settlement_period</code> are the same.",
"possible_errors": [
"invoice_numbers_do_not_match"
]
},
{
"name": "Validate that the invoice numbers in the statements, with a start date before or on the last settlement closing date, do not match any invoice numbers in the transactions in the open settlement period",
"description": "Validate that the invoice numbers in the <code>statements</code>, with a <code>bill_period_from_date</code> before or on the <code>last_settlement_closing_date</code>, do not match any <code>associated_invoice_number</code> in the <code>transactions</code> in the <code>transactions_in_open_settlement_period</code>.",
"possible_errors": [
"statement_invoice_number_match_found_in_transactions"
]
},
{
"name": "Validate that the statement bill_period_from_date matches the corresponding line items start_date",
"description": "Validate that the <code>bill_period_from_date</code> of each statement matches the <code>start_date</code> of the corresponding line items.",
"possible_errors": [
"statement_bill_period_date_does_not_match_line_item_start_date"
]
},
{
"name": "Validate that the correct rate bands are included in the line items within the transactions in the open settlement period and historical statement transactions",
"description": "Validate that there are no missing or extra <code>rate_bands</code> in the <code>line_items</code> within the <code>transactions_in_open_settlement_period</code> and <code>historical_statement_transactions</code>.",
"possible_errors": [
"line_item_rate_band_not_on_product"
]
}
]12 May 2026
New
[
{
"name": "Validate that current statement transactions are after the last statement closing date",
"description": "Validate that all <code>current_statement_transactions</code>, if provided, are after the <code>last_statement_closing_date</code>, if this date is given.",
"possible_errors": [
"current_statement_transaction_before_last_statement_closing_date"
]
},
{
"name": "Validate that there are no current statement transactions for unbillable ledger",
"description": "Validate that transactions for ledgers that will never issue any bills are only in <code>historical_statement_transactions</code>.",
"possible_errors": [
"unbillable_ledger_transactions_in_current_statement_transactions"
]
},
{
"name": "Validate unique transaction IDs",
"description": "Validate that all transaction IDs provided are unique.",
"possible_errors": [
"duplicate_transaction_ids",
"missing_transaction_id"
]
},
{
"name": "Validate that the last statement issue date is on or after the last statement closing date",
"description": "Validate if <code>historical_statement_transactions</code> has been provided, that the <code>last_statement_issue_date</code>, if given, is on or after the <code>last_statement_closing_date</code> given.",
"possible_errors": [
"last_statement_issued_before_closing_date"
]
},
{
"name": "Historical statement transactions require <code>last_statement_closing_date</code> for invoices",
"description": "When <code>historical_statement_transactions</code> are provided, the <code>last_statement_closing_date</code> must also be provided to properly create and archive the initial invoice.",
"possible_errors": [
"historical_statement_transactions_require_last_statement_closing_date"
]
},
{
"name": "Validate current statement transactions are after historical statement transactions",
"description": "Validate that all current statement transactions are dated after all current historical statement transactions.",
"possible_errors": [
"historical_statement_transaction_after_current_statement_transaction"
]
},
{
"name": "Validate that only supply charges and payments are allowed in open settlement period",
"description": "Validate that only <code>SUPPLY_CHARGE</code> and <code>PAYMENT</code> transactions are allowed in the <code>transactions_in_open_settlement_period</code>.",
"possible_errors": [
"transactions_other_than_supply_charge_and_payment_in_open_settlement_period"
]
},
{
"name": "Validate that a last settlement closing date is provided for non-zero last settlement balance",
"description": "Validate that if <code>last_settlement_balance</code> is not zero then a <code>last_settlement_closing_date</code> is required.",
"possible_errors": [
"last_settlement_closing_balance_without_last_settlement_closing_date"
]
},
{
"name": "Validate that the transactions in the open settlement period match the ledger balance",
"description": "Validate that the <code>amount</code> of each transaction in <code>transactions_in_open_settlement_period</code> plus the <code>last_settlement_balance</code> matches the <code>ledger_balance</code>.",
"possible_errors": [
"balance_mismatch_on_ledger_balance"
]
},
{
"name": "Validate that the ledger balance matches the last settlement balance",
"description": "Validate that the <code>ledger_balance</code> matches the <code>last_settlement_balance</code>. This means that the balance change during the open settlement period is effectively zero.",
"possible_errors": [
"balance_mismatch_on_ledger_balance"
]
},
{
"name": "Validate that the line items are within the open settlement period",
"description": "Validate that the <code>start_date</code> of each line item in <code>line_items</code> starts after the <code>last_settlement_closing_date</code>.",
"possible_errors": [
"line_item_period_should_start_after_last_settlement_closing_date"
]
},
{
"name": "Validate that the invoice numbers in the historical statement transactions do not match any invoice numbers in the transactions in the open settlement period",
"description": "Validate that each <code>associated_invoice_number</code> in the <code>historical_statement_transactions</code> does not match any <code>associated_invoice_number</code> in the </code>transactions_in_open_settlement_period</code>.",
"possible_errors": [
"historical_invoice_number_match_found_in_open_settlement_transactions"
]
},
{
"name": "Validate that the line items in the historical statement transactions are before the open settlement period",
"description": "Validate that the <code>end_date</code> of each line item in <code>line_items</code> in <code>historical_statement_transactions</code> is before or on the <code>last_settlement_closing_date</code>.",
"possible_errors": [
"historical_transaction_line_item_ends_after_last_settlement_closing_date"
]
},
{
"name": "Validate that the last settlement closing date is provided if there are historical statement transactions",
"description": "Validate that the <code>last_settlement_closing_date</code> is provided if there are any <code>historical_statement_transactions</code>.",
"possible_errors": [
"historical_transactions_without_last_settlement_closing_date"
]
}
]Old
[
{
"name": "Validate that current statement transactions are after the last statement closing date",
"description": "Validate that all <code>current_statement_transactions</code>, if provided, are after the <code>last_statement_closing_date</code>, if this date is given.",
"possible_errors": [
"current_statement_transaction_before_last_statement_closing_date"
]
},
{
"name": "Validate that there are no current statement transactions for unbillable ledger",
"description": "Validate that transactions for ledgers that will never issue any bills are only in <code>historical_statement_transactions</code>.",
"possible_errors": [
"unbillable_ledger_transactions_in_current_statement_transactions"
]
},
{
"name": "Validate unique transaction IDs",
"description": "Validate that all transaction IDs provided are unique.",
"possible_errors": [
"duplicate_transaction_ids",
"missing_transaction_id"
]
},
{
"name": "Validate that the last statement issue date is on or after the last statement closing date",
"description": "Validate if <code>historical_statement_transactions</code> has been provided, that the <code>last_statement_issue_date</code>, if given, is on or after the <code>last_statement_closing_date</code> given.",
"possible_errors": [
"last_statement_issued_before_closing_date"
]
},
{
"name": "Historical statement transactions require <code>last_statement_closing_date</code> for invoices",
"description": "When <code>historical_statement_transactions</code> are provided, the <code>last_statement_closing_date</code> must also be provided to properly create and archive the initial invoice.",
"possible_errors": [
"historical_statement_transactions_require_last_statement_closing_date"
]
},
{
"name": "Validate current statement transactions are after historical statement transactions",
"description": "Validate that all current statement transactions are dated after all current historical statement transactions.",
"possible_errors": [
"historical_statement_transaction_after_current_statement_transaction"
]
},
{
"name": "Validate that a last settlement closing date is provided for non-zero last settlement balance",
"description": "Validate that if <code>last_settlement_balance</code> is not zero then a <code>last_settlement_closing_date</code> is required.",
"possible_errors": [
"last_settlement_closing_balance_without_last_settlement_closing_date"
]
},
{
"name": "Validate that the transactions in the open settlement period match the ledger balance",
"description": "Validate that the <code>amount</code> of each transaction in <code>transactions_in_open_settlement_period</code> plus the <code>last_settlement_balance</code> matches the <code>ledger_balance</code>.",
"possible_errors": [
"balance_mismatch_on_ledger_balance"
]
},
{
"name": "Validate that the ledger balance matches the last settlement balance",
"description": "Validate that the <code>ledger_balance</code> matches the <code>last_settlement_balance</code>. This means that the balance change during the open settlement period is effectively zero.",
"possible_errors": [
"balance_mismatch_on_ledger_balance"
]
},
{
"name": "Validate that the line items are within the open settlement period",
"description": "Validate that the <code>start_date</code> of each line item in <code>line_items</code> starts after the <code>last_settlement_closing_date</code>.",
"possible_errors": [
"line_item_period_should_start_after_last_settlement_closing_date"
]
},
{
"name": "Validate that the invoice numbers in the historical statement transactions do not match any invoice numbers in the transactions in the open settlement period",
"description": "Validate that each <code>associated_invoice_number</code> in the <code>historical_statement_transactions</code> does not match any <code>associated_invoice_number</code> in the </code>transactions_in_open_settlement_period</code>.",
"possible_errors": [
"historical_invoice_number_match_found_in_open_settlement_transactions"
]
},
{
"name": "Validate that the line items in the historical statement transactions are before the open settlement period",
"description": "Validate that the <code>end_date</code> of each line item in <code>line_items</code> in <code>historical_statement_transactions</code> is before or on the <code>last_settlement_closing_date</code>.",
"possible_errors": [
"historical_transaction_line_item_ends_after_last_settlement_closing_date"
]
},
{
"name": "Validate that the last settlement closing date is provided if there are historical statement transactions",
"description": "Validate that the <code>last_settlement_closing_date</code> is provided if there are any <code>historical_statement_transactions</code>.",
"possible_errors": [
"historical_transactions_without_last_settlement_closing_date"
]
}
]New
{
"x-validators": [
{
"name": "Validate that there are at most two supply charges for every advance invoice",
"description": "Validate that there are at most two <code>SUPPLY_CHARGE</code> transactions for every unique <code>associated_invoice_number</code>.",
"possible_errors": [
"more_than_two_supply_charges_for_advance_invoice"
]
},
{
"name": "Validate that the invoice numbers provided in the payment and supply charge transactions match",
"description": "Validate that the invoice numbers in the <code>SUPPLY_CHARGE</code> and <code>PAYMENT</code> <code>transactions</code> in the <code>transactions_in_open_settlement_period</code> are the same.",
"possible_errors": [
"invoice_numbers_do_not_match"
]
}
]
}Old
{
"x-validators": [
{
"name": "Validate that only supply charges and payments are allowed in open settlement period",
"description": "Validate that only <code>SUPPLY_CHARGE</code> and <code>PAYMENT</code> transactions are allowed in the <code>transactions_in_open_settlement_period</code>.",
"possible_errors": [
"transactions_other_than_supply_charge_and_payment_in_open_settlement_period"
]
},
{
"name": "Validate that there are at most two supply charges for every advance invoice",
"description": "Validate that there are at most two <code>SUPPLY_CHARGE</code> transactions for every unique <code>associated_invoice_number</code>.",
"possible_errors": [
"more_than_two_supply_charges_for_advance_invoice"
]
},
{
"name": "Validate that the invoice numbers provided in the payment and supply charge transactions match",
"description": "Validate that the invoice numbers in the <code>SUPPLY_CHARGE</code> and <code>PAYMENT</code> <code>transactions</code> in the <code>transactions_in_open_settlement_period</code> are the same.",
"possible_errors": [
"invoice_numbers_do_not_match"
]
}
]
}11 May 2026
No attributes to display
7 May 2026
No attributes to display
No attributes to display
No attributes to display
6 May 2026
No attributes to display
29 April 2026
No attributes to display
No attributes to display
28 April 2026
No attributes to display
20 April 2026
New
{
"x-removal-date": "2026-05-20"
}New
{
"x-removal-date": "2026-05-20"
}Old
{
"nullable": true
}17 April 2026
No attributes to display
13 April 2026
New
{
"x-validators": [
{
"name": "Validate that only supply charges and payments are allowed in open settlement period",
"description": "Validate that only <code>SUPPLY_CHARGE</code> and <code>PAYMENT</code> transactions are allowed in the <code>transactions_in_open_settlement_period</code>.",
"possible_errors": [
"transactions_other_than_supply_charge_and_payment_in_open_settlement_period"
]
},
{
"name": "Validate that there are at most two supply charges for every advance invoice",
"description": "Validate that there are at most two <code>SUPPLY_CHARGE</code> transactions for every unique <code>associated_invoice_number</code>.",
"possible_errors": [
"more_than_two_supply_charges_for_advance_invoice"
]
},
{
"name": "Validate that the invoice numbers provided in the payment and supply charge transactions match",
"description": "Validate that the invoice numbers in the <code>SUPPLY_CHARGE</code> and <code>PAYMENT</code> <code>transactions</code> in the <code>transactions_in_open_settlement_period</code> are the same.",
"possible_errors": [
"invoice_numbers_do_not_match"
]
}
]
}Old
{
"x-validators": [
{
"name": "Validate that only supply charges and payments are allowed in open settlement period",
"description": "Validate that only <code>SUPPLY_CHARGE</code> and <code>PAYMENT</code> transactions are allowed in the <code>transactions_in_open_settlement_period</code>.",
"possible_errors": [
"transactions_other_than_supply_charge_and_payment_in_open_settlement_period"
]
},
{
"name": "Validate that there are at most two supply charges for every advance invoice",
"description": "Validate that there are at most two <code>SUPPLY_CHARGE</code> transactions for every unique <code>associated_invoice_number</code>.",
"possible_errors": [
"more_than_two_supply_charges_for_advance_invoice"
]
},
{
"name": "Validate that the correct rate bands are included in the line items within the transactions in the open settlement period and historical statement transactions",
"description": "Validate that there are no missing or extra <code>rate_bands</code> in the <code>line_items</code> within the <code>transactions_in_open_settlement_period</code> and <code>historical_statement_transactions</code>.",
"possible_errors": [
"invalid_or_missing_rate_band"
]
},
{
"name": "Validate that the invoice numbers provided in the payment and supply charge transactions match",
"description": "Validate that the invoice numbers in the <code>SUPPLY_CHARGE</code> and <code>PAYMENT</code> <code>transactions</code> in the <code>transactions_in_open_settlement_period</code> are the same.",
"possible_errors": [
"invoice_numbers_do_not_match"
]
}
]
}New
{
"x-validators": [
{
"name": "Validate that the historical statement transaction type is valid",
"description": "Validate that the <code>type</code> in a <code>historical_statement_transaction</code> is one of the following: CREDIT, PAYMENT, REPAYMENT, SUPPLY_CHARGE.",
"possible_errors": [
"invalid_historical_statement_transaction_type"
]
}
]
}Old
{
"x-validators": [
{
"name": "Validate that the historical statement transaction type is valid",
"description": "Validate that the <code>type</code> in a <code>historical_statement_transaction</code> is one of the following: CREDIT, PAYMENT, REPAYMENT, SUPPLY_CHARGE.",
"possible_errors": [
"invalid_historical_statement_transaction_type"
]
},
{
"name": "Validate that the correct rate bands are included in the line items within the transactions in the open settlement period and historical statement transactions",
"description": "Validate that there are no missing or extra <code>rate_bands</code> in the <code>line_items</code> within the <code>transactions_in_open_settlement_period</code> and <code>historical_statement_transactions</code>.",
"possible_errors": [
"invalid_or_missing_rate_band"
]
}
]
}New
[
{
"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 customer family name",
"description": "Validate the family name is provided for all customers on a domestic account. For Business accounts, set the family name to 'Business' if it is not provided.",
"possible_errors": [
"customer_family_name_required"
]
},
{
"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 that the energy meter point and billing configuration periods cover the open settlement period",
"description": "Validate that the energy meter point and billing configuration periods start on or before the <code>last_settlement_closing_date</code> and are open-ended.",
"possible_errors": [
"config_period_does_not_cover_open_settlement_period"
]
},
{
"name": "Validate that the last settlement closing date aligns with the agreement start date",
"description": "Validate that the <code>last_settlement_closing_date</code> aligns with the <code>effective_from</code> of the agreement. Alignment is defined as exactly 12 months between the (inclusive) <code>last_settlement_closing_date</code> and the <code>effective_from</code> of the agreement.",
"possible_errors": [
"last_settlement_closing_date_does_not_align_with_agreement_start_date"
]
},
{
"name": "Validate that each line item start day matches the agreement start day",
"description": "Validate that each line item start day matches the agreement start day. If the agreement start day is not possible in the line item start month (e.g. 29/30/31), the last day of that month should be used.",
"possible_errors": [
"line_item_start_day_does_not_align_with_agreement_start_day"
]
},
{
"name": "Validate that the invoice numbers provided in the statements starting after the <code>last_settlement_closing_date</code> and the transactions in the <code>transactions_in_open_settlement_period</code> match",
"description": "Validate that the invoice numbers provided in the <code>statements</code> starting after the <code>last_settlement_closing_date</code> and the invoice numbers in the <code>SUPPLY_CHARGE</code> <code>transactions</code> in the <code>transactions_in_open_settlement_period</code> are the same.",
"possible_errors": [
"invoice_numbers_do_not_match"
]
},
{
"name": "Validate that the invoice numbers in the statements, with a start date before or on the last settlement closing date, do not match any invoice numbers in the transactions in the open settlement period",
"description": "Validate that the invoice numbers in the <code>statements</code>, with a <code>bill_period_from_date</code> before or on the <code>last_settlement_closing_date</code>, do not match any <code>associated_invoice_number</code> in the <code>transactions</code> in the <code>transactions_in_open_settlement_period</code>.",
"possible_errors": [
"statement_invoice_number_match_found_in_transactions"
]
},
{
"name": "Validate that the statement bill_period_from_date matches the corresponding line items start_date",
"description": "Validate that the <code>bill_period_from_date</code> of each statement matches the <code>start_date</code> of the corresponding line items.",
"possible_errors": [
"statement_bill_period_date_does_not_match_line_item_start_date"
]
},
{
"name": "Validate that the correct rate bands are included in the line items within the transactions in the open settlement period and historical statement transactions",
"description": "Validate that there are no missing or extra <code>rate_bands</code> in the <code>line_items</code> within the <code>transactions_in_open_settlement_period</code> and <code>historical_statement_transactions</code>.",
"possible_errors": [
"line_item_rate_band_not_on_product"
]
}
]Old
[
{
"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 customer family name",
"description": "Validate the family name is provided for all customers on a domestic account. For Business accounts, set the family name to 'Business' if it is not provided.",
"possible_errors": [
"customer_family_name_required"
]
},
{
"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 that the energy meter point and billing configuration periods cover the open settlement period",
"description": "Validate that the energy meter point and billing configuration periods start on or before the <code>last_settlement_closing_date</code> and are open-ended.",
"possible_errors": [
"config_period_does_not_cover_open_settlement_period"
]
},
{
"name": "Validate that the last settlement closing date aligns with the agreement start date",
"description": "Validate that the <code>last_settlement_closing_date</code> aligns with the <code>effective_from</code> of the agreement. Alignment is defined as exactly 12 months between the (inclusive) <code>last_settlement_closing_date</code> and the <code>effective_from</code> of the agreement.",
"possible_errors": [
"last_settlement_closing_date_does_not_align_with_agreement_start_date"
]
},
{
"name": "Validate that each line item start day matches the agreement start day",
"description": "Validate that each line item start day matches the agreement start day. If the agreement start day is not possible in the line item start month (e.g. 29/30/31), the last day of that month should be used.",
"possible_errors": [
"line_item_start_day_does_not_align_with_agreement_start_day"
]
},
{
"name": "Validate that the invoice numbers provided in the statements starting after the <code>last_settlement_closing_date</code> and the transactions in the <code>transactions_in_open_settlement_period</code> match",
"description": "Validate that the invoice numbers provided in the <code>statements</code> starting after the <code>last_settlement_closing_date</code> and the invoice numbers in the <code>SUPPLY_CHARGE</code> <code>transactions</code> in the <code>transactions_in_open_settlement_period</code> are the same.",
"possible_errors": [
"invoice_numbers_do_not_match"
]
},
{
"name": "Validate that the invoice numbers in the statements, with a start date before or on the last settlement closing date, do not match any invoice numbers in the transactions in the open settlement period",
"description": "Validate that the invoice numbers in the <code>statements</code>, with a <code>bill_period_from_date</code> before or on the <code>last_settlement_closing_date</code>, do not match any <code>associated_invoice_number</code> in the <code>transactions</code> in the <code>transactions_in_open_settlement_period</code>.",
"possible_errors": [
"statement_invoice_number_match_found_in_transactions"
]
},
{
"name": "Validate that the statement bill_period_from_date matches the corresponding line items start_date",
"description": "Validate that the <code>bill_period_from_date</code> of each statement matches the <code>start_date</code> of the corresponding line items.",
"possible_errors": [
"statement_bill_period_date_does_not_match_line_item_start_date"
]
}
]Old
{
"enum": [
"ADVANCE_SUPPLIER_DYNAMIC_COST",
"ADVANCE_SUPPLIER_PURCHASING_COST",
"ADVANCE_SUPPLIER_FIXED_COST",
"ADVANCE_GRID_FEE",
"ADVANCE_ENERGY_TAX_STEP_1",
"ADVANCE_ENERGY_TAX_STEP_2",
"ADVANCE_ENERGY_TAX_STEP_3",
"ADVANCE_ENERGY_TAX_STEP_4",
"ADVANCE_ENERGY_TAX_STEP_5",
"ADVANCE_ENERGY_TAX_REDUCTION"
],
"x-spec-enum-id": "7188ffad38109cb8",
"x-enum-descriptions": {
"ADVANCE_GRID_FEE": "Advance Grid Fee",
"ADVANCE_ENERGY_TAX_STEP_1": "Advance Energy Tax Step 1",
"ADVANCE_ENERGY_TAX_STEP_2": "Advance Energy Tax Step 2",
"ADVANCE_ENERGY_TAX_STEP_3": "Advance Energy Tax Step 3",
"ADVANCE_ENERGY_TAX_STEP_4": "Advance Energy Tax Step 4",
"ADVANCE_ENERGY_TAX_STEP_5": "Advance Energy Tax Step 5",
"ADVANCE_SUPPLIER_FIXED_COST": "Advance Supplier Fixed Cost",
"ADVANCE_ENERGY_TAX_REDUCTION": "Advance Energy Tax Reduction",
"ADVANCE_SUPPLIER_DYNAMIC_COST": "Advance Supplier Dynamic Cost",
"ADVANCE_SUPPLIER_PURCHASING_COST": "Advance Supplier Purchasing Cost"
}
}New
[
{
"name": "Validate <code>\u2068effective_to\u2069</code> not before <code>\u2068effective_from\u2069</code>",
"description": "Validates that <code>\u2068effective_to\u2069</code>, if given, is on or later than <code>\u2068effective_from\u2069</code>.",
"possible_errors": [
"start_date_later_than_end_date"
]
},
{
"name": "Validate addons are compatible with their agreement",
"description": "Validate that addons provided for an agreement are compatible and configured for agreement's product.",
"possible_errors": [
"addon_band_not_valid_for_agreement",
"multiple_addons_in_the_same_family"
]
},
{
"name": "Validate that the rate bands given in the rate overrides are valid for the product code",
"description": "Validate that the rate bands given in the rate overrides exist for the agreement's product.",
"possible_errors": [
"invalid_period",
"rate_band_does_not_exist"
]
},
{
"name": "Validate that cost detail bands match product rates",
"description": "Validate that all bands specified in the monthly advance charge template cost details exist as rate bands on the selected product.",
"possible_errors": [
"cost_detail_band_not_on_product"
]
}
]Old
[
{
"name": "Validate <code>\u2068effective_to\u2069</code> not before <code>\u2068effective_from\u2069</code>",
"description": "Validates that <code>\u2068effective_to\u2069</code>, if given, is on or later than <code>\u2068effective_from\u2069</code>.",
"possible_errors": [
"start_date_later_than_end_date"
]
},
{
"name": "Validate addons are compatible with their agreement",
"description": "Validate that addons provided for an agreement are compatible and configured for agreement's product.",
"possible_errors": [
"addon_band_not_valid_for_agreement",
"multiple_addons_in_the_same_family"
]
},
{
"name": "Validate that the rate bands given in the rate overrides are valid for the product code",
"description": "Validate that the rate bands given in the rate overrides exist for the agreement's product.",
"possible_errors": [
"invalid_period",
"rate_band_does_not_exist"
]
}
]30 March 2026
No attributes to display
No attributes to display
27 March 2026
New
{
"x-enum-descriptions": {
"CUSTOM": "Custom"
}
}Old
{
"x-enum-descriptions": {}
}24 March 2026
New
{
"x-removal-date": "2026-04-29"
}27 February 2026
New
{
"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"
]
}
]
}24 February 2026
No attributes to display
19 February 2026
New
[
{
"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 customer family name",
"description": "Validate the family name is provided for all customers on a domestic account. For Business accounts, set the family name to 'Business' if it is not provided.",
"possible_errors": [
"customer_family_name_required"
]
},
{
"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 that the energy meter point and billing configuration periods cover the open settlement period",
"description": "Validate that the energy meter point and billing configuration periods start on or before the <code>last_settlement_closing_date</code> and are open-ended.",
"possible_errors": [
"config_period_does_not_cover_open_settlement_period"
]
},
{
"name": "Validate that the last settlement closing date aligns with the agreement start date",
"description": "Validate that the <code>last_settlement_closing_date</code> aligns with the <code>effective_from</code> of the agreement. Alignment is defined as exactly 12 months between the (inclusive) <code>last_settlement_closing_date</code> and the <code>effective_from</code> of the agreement.",
"possible_errors": [
"last_settlement_closing_date_does_not_align_with_agreement_start_date"
]
},
{
"name": "Validate that each line item start day matches the agreement start day",
"description": "Validate that each line item start day matches the agreement start day. If the agreement start day is not possible in the line item start month (e.g. 29/30/31), the last day of that month should be used.",
"possible_errors": [
"line_item_start_day_does_not_align_with_agreement_start_day"
]
},
{
"name": "Validate that the invoice numbers provided in the statements starting after the <code>last_settlement_closing_date</code> and the transactions in the <code>transactions_in_open_settlement_period</code> match",
"description": "Validate that the invoice numbers provided in the <code>statements</code> starting after the <code>last_settlement_closing_date</code> and the invoice numbers in the <code>SUPPLY_CHARGE</code> <code>transactions</code> in the <code>transactions_in_open_settlement_period</code> are the same.",
"possible_errors": [
"invoice_numbers_do_not_match"
]
},
{
"name": "Validate that the invoice numbers in the statements, with a start date before or on the last settlement closing date, do not match any invoice numbers in the transactions in the open settlement period",
"description": "Validate that the invoice numbers in the <code>statements</code>, with a <code>bill_period_from_date</code> before or on the <code>last_settlement_closing_date</code>, do not match any <code>associated_invoice_number</code> in the <code>transactions</code> in the <code>transactions_in_open_settlement_period</code>.",
"possible_errors": [
"statement_invoice_number_match_found_in_transactions"
]
},
{
"name": "Validate that the statement bill_period_from_date matches the corresponding line items start_date",
"description": "Validate that the <code>bill_period_from_date</code> of each statement matches the <code>start_date</code> of the corresponding line items.",
"possible_errors": [
"statement_bill_period_date_does_not_match_line_item_start_date"
]
}
]Old
[
{
"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 customer family name",
"description": "Validate the family name is provided for all customers on a domestic account. For Business accounts, set the family name to 'Business' if it is not provided.",
"possible_errors": [
"customer_family_name_required"
]
},
{
"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 that the energy meter point and billing configuration periods cover the open settlement period",
"description": "Validate that the energy meter point and billing configuration periods start on or before the <code>last_settlement_closing_date</code> and are open-ended.",
"possible_errors": [
"config_period_does_not_cover_open_settlement_period"
]
},
{
"name": "Validate that the last settlement closing date aligns with the agreement start date",
"description": "Validate that the <code>last_settlement_closing_date</code> aligns with the <code>effective_from</code> of the agreement. Alignment is defined as exactly 12 months between the (inclusive) <code>last_settlement_closing_date</code> and the <code>effective_from</code> of the agreement.",
"possible_errors": [
"last_settlement_closing_date_does_not_align_with_agreement_start_date"
]
},
{
"name": "Validate that each line item start day matches the agreement start day",
"description": "Validate that each line item start day matches the agreement start day. If the agreement start day is not possible in the line item start month (e.g. 29/30/31), the last day of that month should be used.",
"possible_errors": [
"line_item_start_day_does_not_align_with_agreement_start_day"
]
},
{
"name": "Validate that the invoice numbers provided in the statements starting after the <code>last_settlement_closing_date</code> and the transactions in the <code>transactions_in_open_settlement_period</code> match",
"description": "Validate that the invoice numbers provided in the <code>statements</code> starting after the <code>last_settlement_closing_date</code> and the invoice numbers in the <code>SUPPLY_CHARGE</code> <code>transactions</code> in the <code>transactions_in_open_settlement_period</code> are the same.",
"possible_errors": [
"invoice_numbers_do_not_match"
]
},
{
"name": "Validate that the invoice numbers in the statements, with a start date before or on the last settlement closing date, do not match any invoice numbers in the transactions in the open settlement period",
"description": "Validate that the invoice numbers in the <code>statements</code>, with a <code>bill_period_from_date</code> before or on the <code>last_settlement_closing_date</code>, do not match any <code>associated_invoice_number</code> in the <code>transactions</code> in the <code>transactions_in_open_settlement_period</code>.",
"possible_errors": [
"statement_invoice_number_match_found_in_transactions"
]
},
{
"name": "Validate that the statement bill_period_from_date matches the corresponding line items start_date",
"description": "Validate that the <code>bill_period_from_date</code> of each statement matches the <code>start_date</code> of the corresponding line items.",
"possible_errors": [
"statement_bill_period_date_does_not_match_line_item_start_date"
]
}
]