Data Import REST API Changelog
This page shows recent changes to Data Import REST API.
18 March 2026 - Latest
New
{
"x-enum-descriptions": {
"BULK_SUPPLY": "Bulk supply"
}
}Old
{
"x-enum-descriptions": {}
}16 March 2026
New
{
"x-enum-descriptions": {
"bds_renewal_investigation": "BDS Renewal Investigation"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"BDS Renewal Investigation": "BDS Renewal Investigation"
}
}Old
{
"x-enum-descriptions": {}
}9 March 2026
New
[
{
"name": "Validate that the <code>\u2068latitude\u2069</code> coordinate fall within the specified range (-\u206890\u2069: \u206890\u2069)",
"description": "Ensure that for the <code>\u2068latitude\u2069</code> coordinate provided, the value falls within the specified range (-\u206890\u2069: \u206890\u2069).",
"possible_errors": [
"coordinate_out_of_range"
]
},
{
"name": "Validate that the <code>\u2068longitude\u2069</code> coordinate fall within the specified range (-\u2068180\u2069: \u2068180\u2069)",
"description": "Ensure that for the <code>\u2068longitude\u2069</code> coordinate provided, the value falls within the specified range (-\u2068180\u2069: \u2068180\u2069).",
"possible_errors": [
"coordinate_out_of_range"
]
},
{
"name": "Validate that the provided route ID conforms to client standards",
"description": "Ensure that the route ID conforms to the clients standards",
"possible_errors": [
"route_id_invalid"
]
},
{
"name": "Validate that the reading months are a valid subset of the configuration",
"description": "Ensure that the reading months are a valid subset of the configuration",
"possible_errors": [
"reading_months_invalid"
]
},
{
"name": "Validate a list of meter readings",
"description": "Ensure that the meter's readings do not indicate negative consumption",
"possible_errors": [
"readings_indicate_negative_consumption"
]
}
]Old
[
{
"name": "Validate that the <code>\u2068latitude\u2069</code> coordinate fall within the specified range (-\u206890\u2069: \u206890\u2069)",
"description": "Ensure that for the <code>\u2068latitude\u2069</code> coordinate provided, the value falls within the specified range (-\u206890\u2069: \u206890\u2069).",
"possible_errors": [
"coordinate_out_of_range"
]
},
{
"name": "Validate that the <code>\u2068longitude\u2069</code> coordinate fall within the specified range (-\u2068180\u2069: \u2068180\u2069)",
"description": "Ensure that for the <code>\u2068longitude\u2069</code> coordinate provided, the value falls within the specified range (-\u2068180\u2069: \u2068180\u2069).",
"possible_errors": [
"coordinate_out_of_range"
]
},
{
"name": "Validate that the provided route ID conforms to client standards",
"description": "Ensure that the route ID conforms to the clients standards",
"possible_errors": [
"route_id_invalid"
]
},
{
"name": "Validate that the reading months are a valid subset of the configuration",
"description": "Ensure that the reading months are a valid subset of the configuration",
"possible_errors": [
"reading_months_invalid"
]
}
]3 March 2026
New
{
"x-enum-descriptions": {
"CAMBRIDGE": "Cambridge Water"
}
}Old
{
"x-enum-descriptions": {}
}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"
]
}
]
}25 February 2026
New
{
"x-enum-descriptions": {
"cls_final_account_call_cls_if_any_queries": "CLS final account call CLS if any queries",
"cls_invoiced_account_call_cls_if_any_queries": "CLS invoiced account call CLS if any queries"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"CLS final account call CLS if any queries": "CLS final account call CLS if any queries",
"CLS invoiced account call CLS if any queries": "CLS invoiced account call CLS if any queries"
}
}Old
{
"x-enum-descriptions": {}
}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 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": "Convert the raw billing address if it is a gbr address, else use the provided international billing address",
"description": "Ensure that only one billing address format is provided, and convert the provided billing address into the legacy address format if it's gbr-specific.",
"possible_errors": [
"multiple_billing_addresses_supplied",
"no_billing_address_supplied"
]
},
{
"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 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 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": "gbr:data-import--validation--date-provided-for-last-statement-balance--display-name",
"description": "gbr:data-import--validation--date-provided-for-last-statement-balance--help-text",
"possible_errors": [
"last_statement_balance_without_last_billed_to_or_statement_issue_date"
]
},
{
"name": "Validate alternative phone number is unique",
"description": "Validate customers defined in the payload do not have the same alternative phone numbers.",
"possible_errors": [
"duplicated_alternative_phone_numbers"
]
},
{
"name": "Validate that current statement transactions are not before the current statement opening date",
"description": "Validate that all <code>current_statement_transactions</code>, if provided, are not before the current statement opening date. This date is one day after the last statement closing date if provided, otherwise it is based on the last billed to date.",
"possible_errors": [
"current_statement_transaction_before_current_statement_opening_date"
]
},
{
"name": "Validate current statement transactions are not before <code>last_billed_to_date</code>",
"description": "Validate that there are no current statement transactions that occurred before the <code>last_billed_to_date</code> (this includes the supply point-level <code>last_billed_to_date</code>, as well as any meter- or register-level dates where applicable).",
"possible_errors": [
"current_statement_transaction_before_last_billed_to_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 payment adequacy changes or last payment review date not both",
"description": "Validate that only one of <code>payment_adequacy_changes</code> or <code>last_payment_review_date</code> is provided in the payload.",
"possible_errors": [
"payment_adequacy_changes_and_last_payment_review_date_provided"
]
},
{
"name": "Validate <code>last_statement_balance</code> plus/minus <code>current_statement_transactions</code> equal <code>transfer_balance</code>",
"description": "Validate that the sum of <code>current_statement_transactions</code> plus the <code>last_statement_balance</code> is equal to the <code>transfer_balance</code>. For example, if a <code>last_statement_balance</code> of 100 is provided, and the <code>current_statement_transactions</code> include one payment of 50, then the expected <code>transfer_balance</code> would 150. Transactions that are payments or credits add to the balance. Transactions that are repayments or charges subtract from the balance.",
"possible_errors": [
"balance_mismatch_on_transfer_balance"
]
},
{
"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 no more than one property for unknown occupier",
"description": "Validate that no more than one property is provided for an unknown occupier account.",
"possible_errors": [
"occupier_account_with_multiple_supply_addresses"
]
},
{
"name": "Validate no direct debit reference for the occupier",
"description": "Validate that if any customer is identified as an occupier, then no <code>dd_reference</code> is provided for the account. If a <code>dd_reference</code> is provided, then it implies that there is a known occupier for the account.",
"possible_errors": [
"dd_reference_for_occupier_account"
]
},
{
"name": "Validate that the summed historical statement transactions match the last statement balance",
"description": "Validate that the sum of the <code>historical_statement_transactions</code> equals the <code>last_statement_balance</code>.",
"possible_errors": [
"historical_statement_transactions_balance_mismatch"
]
},
{
"name": "Validate that there are no historical statement transactions after the last statement closing date",
"description": "Validate that if <code>historical_statement_transactions</code> are provided then none are later than the <code>last_statement_closing_date</code>. If a <code>last_statement_closing_date</code> is not provided then this is inferred from the earliest <code>last_billed_to_date</code> on the account or supply points.",
"possible_errors": [
"historical_statement_transaction_after_last_statement_closing_date"
]
},
{
"name": "Validate that the last statement issue date is on or after the last statement closing date",
"description": "Validate that the <code>last_statement_issue_date</code>, if given, is on or after the <code>last_statement_closing_date</code> given. If a <code>last_statement_closing_date</code> is not provided then this is inferred from the earliest <code>last_billed_to_date</code> on the account or supply points.",
"possible_errors": [
"last_statement_issued_before_closing_date"
]
},
{
"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 financial vulnerability status is correct if provided",
"description": "Validate that if metadata with key <code>FINANCIAL_SUPPORT</code> is provided, the corresponding value is a valid option.",
"possible_errors": [
"invalid_financial_support_type"
]
},
{
"name": "data-import--validation--account-vacant--display-name",
"description": "data-import--validation--account-vacant--help-text",
"possible_errors": [
"vacant_account_has_current_statement_transactions",
"vacant_account_has_customers",
"vacant_account_has_historical_statement_transactions",
"vacant_account_has_payment_instructions",
"vacant_account_has_payment_schedules",
"vacant_account_has_statements",
"vacant_account_has_transfer_balance",
"vacant_account_missing_supply_address",
"vacant_account_missing_supply_points"
]
},
{
"name": "data-import--validation--account-customer-details-valid--display-name",
"description": "data-import--validation--account-customer-details-valid--help-text",
"possible_errors": [
"property_developer_details_not_matching"
]
},
{
"name": "data-import--validation--account-billable-supply-point-has-agreements--display-name",
"description": "data-import--validation--account-billable-supply-point-has-agreements--help-text",
"possible_errors": [
"billable_supply_point_has_no_agreements",
"non_billable_supply_point_has_agreements"
]
},
{
"name": "Validate that a last_billed_to_date is required for transactions and balances",
"description": "Validate that a last_billed_to_date is required if there are any transactions or balances on the account.",
"possible_errors": [
"last_billed_to_date_required"
]
}
]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 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": "Convert the raw billing address if it is a gbr address, else use the provided international billing address",
"description": "Ensure that only one billing address format is provided, and convert the provided billing address into the legacy address format if it's gbr-specific.",
"possible_errors": [
"multiple_billing_addresses_supplied",
"no_billing_address_supplied"
]
},
{
"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 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 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": "gbr:data-import--validation--date-provided-for-last-statement-balance--display-name",
"description": "gbr:data-import--validation--date-provided-for-last-statement-balance--help-text",
"possible_errors": [
"last_statement_balance_without_last_billed_to_or_statement_issue_date"
]
},
{
"name": "Validate alternative phone number is unique",
"description": "Validate customers defined in the payload do not have the same alternative phone numbers.",
"possible_errors": [
"duplicated_alternative_phone_numbers"
]
},
{
"name": "Validate that current statement transactions are not before the current statement opening date",
"description": "Validate that all <code>current_statement_transactions</code>, if provided, are not before the current statement opening date. This date is one day after the last statement closing date if provided, otherwise it is based on the last billed to date.",
"possible_errors": [
"current_statement_transaction_before_current_statement_opening_date"
]
},
{
"name": "Validate current statement transactions are not before <code>last_billed_to_date</code>",
"description": "Validate that there are no current statement transactions that occurred before the <code>last_billed_to_date</code> (this includes the supply point-level <code>last_billed_to_date</code>, as well as any meter- or register-level dates where applicable).",
"possible_errors": [
"current_statement_transaction_before_last_billed_to_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 payment adequacy changes or last payment review date not both",
"description": "Validate that only one of <code>payment_adequacy_changes</code> or <code>last_payment_review_date</code> is provided in the payload.",
"possible_errors": [
"payment_adequacy_changes_and_last_payment_review_date_provided"
]
},
{
"name": "Validate <code>last_statement_balance</code> plus/minus <code>current_statement_transactions</code> equal <code>transfer_balance</code>",
"description": "Validate that the sum of <code>current_statement_transactions</code> plus the <code>last_statement_balance</code> is equal to the <code>transfer_balance</code>. For example, if a <code>last_statement_balance</code> of 100 is provided, and the <code>current_statement_transactions</code> include one payment of 50, then the expected <code>transfer_balance</code> would 150. Transactions that are payments or credits add to the balance. Transactions that are repayments or charges subtract from the balance.",
"possible_errors": [
"balance_mismatch_on_transfer_balance"
]
},
{
"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 no more than one property for unknown occupier",
"description": "Validate that no more than one property is provided for an unknown occupier account.",
"possible_errors": [
"occupier_account_with_multiple_supply_addresses"
]
},
{
"name": "Validate no direct debit reference for the occupier",
"description": "Validate that if any customer is identified as an occupier, then no <code>dd_reference</code> is provided for the account. If a <code>dd_reference</code> is provided, then it implies that there is a known occupier for the account.",
"possible_errors": [
"dd_reference_for_occupier_account"
]
},
{
"name": "Validate that the summed historical statement transactions match the last statement balance",
"description": "Validate that the sum of the <code>historical_statement_transactions</code> equals the <code>last_statement_balance</code>.",
"possible_errors": [
"historical_statement_transactions_balance_mismatch"
]
},
{
"name": "Validate that there are no historical statement transactions after the last statement closing date",
"description": "Validate that if <code>historical_statement_transactions</code> are provided then none are later than the <code>last_statement_closing_date</code>. If a <code>last_statement_closing_date</code> is not provided then this is inferred from the earliest <code>last_billed_to_date</code> on the account or supply points.",
"possible_errors": [
"historical_statement_transaction_after_last_statement_closing_date"
]
},
{
"name": "Validate that the last statement issue date is on or after the last statement closing date",
"description": "Validate that the <code>last_statement_issue_date</code>, if given, is on or after the <code>last_statement_closing_date</code> given. If a <code>last_statement_closing_date</code> is not provided then this is inferred from the earliest <code>last_billed_to_date</code> on the account or supply points.",
"possible_errors": [
"last_statement_issued_before_closing_date"
]
},
{
"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 financial vulnerability status is correct if provided",
"description": "Validate that if metadata with key <code>FINANCIAL_SUPPORT</code> is provided, the corresponding value is a valid option.",
"possible_errors": [
"invalid_financial_support_type"
]
},
{
"name": "data-import--validation--account-vacant--display-name",
"description": "data-import--validation--account-vacant--help-text",
"possible_errors": [
"vacant_account_has_current_statement_transactions",
"vacant_account_has_customers",
"vacant_account_has_historical_statement_transactions",
"vacant_account_has_payment_instructions",
"vacant_account_has_payment_schedules",
"vacant_account_has_statements",
"vacant_account_has_transfer_balance",
"vacant_account_missing_supply_address",
"vacant_account_missing_supply_points"
]
},
{
"name": "data-import--validation--account-customer-details-valid--display-name",
"description": "data-import--validation--account-customer-details-valid--help-text",
"possible_errors": [
"property_developer_details_not_matching"
]
},
{
"name": "data-import--validation--account-billable-supply-point-has-agreements--display-name",
"description": "data-import--validation--account-billable-supply-point-has-agreements--help-text",
"possible_errors": [
"billable_supply_point_has_no_agreements",
"non_billable_supply_point_has_agreements"
]
},
{
"name": "Validate that a last_billed_to_date is required for transactions and balances",
"description": "Validate that a last_billed_to_date is required if there are any transactions or balances on the account.",
"possible_errors": [
"last_billed_to_date_required"
]
}
]17 February 2026
New
{
"x-enum-descriptions": {
"email_complaint_open_at_time_of_migration": "Email Complaint open at time of migration"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"Email Complaint open at time of migration": "Email Complaint open at time of migration"
}
}Old
{
"x-enum-descriptions": {}
}13 February 2026
No attributes to display
New
{
"required": true
}Use instead
consents