Data Import REST API Changelog
This page shows recent changes to Data Import REST API.
7 August 2026 - Latest
New
{
"oneOf": [
{
"type": "string",
"format": "email",
"maxLength": 254
},
{
"type": "string",
"maxLength": 0
}
]
}Old
{
"type": "string",
"format": "email",
"maxLength": 254
}New
{
"oneOf": [
{
"type": "string",
"format": "email",
"maxLength": 254
},
{
"type": "string",
"maxLength": 0
}
]
}Old
{
"type": "string",
"format": "email",
"maxLength": 254
}New
{
"oneOf": [
{
"type": "string",
"format": "email",
"maxLength": 254
},
{
"type": "string",
"maxLength": 0
}
]
}Old
{
"type": "string",
"format": "email",
"maxLength": 254
}New
{
"oneOf": [
{
"type": "string",
"format": "email",
"maxLength": 254
},
{
"type": "string",
"maxLength": 0
}
]
}Old
{
"type": "string",
"format": "email",
"maxLength": 254
}3 August 2026
New
{
"x-enum-descriptions": {
"feedback.chi-survey": "Consent to be contacted for Customer Happiness Index (CHI) feedback surveys following service interactions"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"feedback.chi-survey": "Consent to be contacted for Customer Happiness Index (CHI) feedback surveys following service interactions"
}
}Old
{
"x-enum-descriptions": {}
}31 July 2026
New
{
"enum": [
"marketing.account-service-updates"
],
"type": "string",
"x-spec-enum-id": "b8398a12769cacf1",
"x-enum-descriptions": {
"marketing.account-service-updates": "Opted in to account/service update messages"
}
}Old
{
"x-comment": "Choices for this field are dynamic, once appropriate values have been configured they will be rendered here.",
"x-spec-enum-id": "4f53cda18c2baa0c"
}New
{
"enum": [
"marketing.account-service-updates"
],
"type": "string",
"x-spec-enum-id": "b8398a12769cacf1",
"x-enum-descriptions": {
"marketing.account-service-updates": "Opted in to account/service update messages"
}
}Old
{
"x-comment": "Choices for this field are dynamic, once appropriate values have been configured they will be rendered here.",
"x-spec-enum-id": "4f53cda18c2baa0c"
}29 July 2026
New
{
"x-enum-descriptions": {
"issuance_migrated": "New issuance migration complete",
"market_supply_migration_completed": "Market supply migration: complete",
"market_supply_migration_in_progress": "Market supply migration: in progress"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"New issuance migration complete": "New issuance migration complete",
"Market supply migration: complete": "Market supply migration: complete",
"Market supply migration: in progress": "Market supply migration: in progress"
}
}Old
{
"x-enum-descriptions": {}
}24 July 2026
New
{
"x-enum-descriptions": {
"SWEB": "EDF Energy Customers Ltd (SWEB)"
}
}Old
{
"x-enum-descriptions": {}
}22 July 2026
New
{
"x-validators": [
{
"name": "Validate that each child has a unique combination of values for the <code>\u2068payment_date, payment_type\u2069</code> fields",
"description": "Validate that each child has a unique combination of values for the <code>\u2068payment_date, payment_type\u2069</code> fields.",
"possible_errors": [
"children_with_duplicate_values"
]
}
]
}Old
{
"x-validators": [
{
"name": "Validate that each child has unique values for the <code>\u2068payment_date\u2069</code> field",
"description": "Validate that each child has unique values for the <code>\u2068payment_date\u2069</code> field.",
"possible_errors": [
"children_with_duplicate_values"
]
}
]
}21 July 2026
No attributes to display
17 July 2026
No attributes to display
16 July 2026
No attributes to display
Old
{
"x-validators": [
{
"name": "Validate alternative phone number is not in kraken",
"description": "Validate the alternative phone number provided does not exist in the database.",
"possible_errors": [
"alternative_phone_numbers_already_exists"
]
}
]
}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": "Derive occupier billing address from supply address",
"description": "When an occupier account has no explicit billing address and exactly one supply address is provided, copy the supply address into the billing address fields.",
"possible_errors": []
},
{
"name": "Validate billing address fields",
"description": "If a legacy billing address is provided, validate that it is in the correct format.",
"possible_errors": [
"invalid_address"
]
},
{
"name": "Validate 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 historical statement period end must not be in the future",
"description": "Ensures that the historical statement period end date (last_statement_closing_date or latest transaction_date) is not set in the future.",
"possible_errors": [
"historical_statement_period_end_in_future"
]
},
{
"name": "Validate that terms with supply type matches a supply point supply type",
"description": "Validate that for terms containing a <code>supply_type</code> field that there is a supply point in the payload with a matching <code>supply_type</code>.",
"possible_errors": [
"term_supply_type_mismatch"
]
},
{
"name": "Validate that supply addresses and supply points are provided if account contracts are provided",
"description": "Validate that if <code>account_contracts</code> have been provided that a supply address with supply points has been provided under <code>supply_addresses</code>",
"possible_errors": [
"account_contracts_without_supply_points"
]
},
{
"name": "Validate historical statement billing document identifier presence",
"description": "Ensure that billing document identifiers are only provided for historical statement transactions and only when the relevant feature flag is enabled.",
"possible_errors": [
"historical_statement_billing_document_identifier_missing",
"historical_statement_billing_document_identifier_not_allowed_when_feature_flag_disabled"
]
},
{
"name": "Validate current statement transactions do not provide <code>billing_document_identifier</code>",
"description": "Validate that none of the current statement transactions include a <code>billing_document_identifier</code>, as this field is only applicable to historical statement transactions.",
"possible_errors": [
"billing_document_identifier_not_allowed_for_current_statement_transactions"
]
},
{
"name": "Validate historical statement transaction billing document identifier",
"description": "Ensure that the billing document identifier is the same for all historical statement transactions.",
"possible_errors": [
"historical_statement_billing_document_identifier_mismatch"
]
},
{
"name": "Validate that contract terms' product codes are part of supply agreements",
"description": "Ensure that any contract terms with product references have corresponding products in supply addresses.",
"possible_errors": [
"contract_term_product_code_not_in_agreements"
]
},
{
"name": "Validate that business is provided if enforcing business contracts",
"description": "Validate that the business field is provided if <code>enforce_business_contracts_exist</code> is set to True on the import supplier configuration.",
"possible_errors": [
"business_field_required"
]
},
{
"name": "Validate agreement business contract identifier is declared",
"description": "Validates that an agreement's <code>business_contract_identifier</code>, if provided, is one of the account's declared <code>business_contract_identifiers</code>.",
"possible_errors": [
"agreement_business_contract_identifier_not_declared"
]
},
{
"name": "Validate that the sum of ledger balances equals the transfer balance",
"description": "Validate that the sum of all <code>ledger_balance</code> provided for each ledger in <code>ledgers</code> equals the account-level <code>transfer_balance</code>.",
"possible_errors": [
"ledger_balances_not_equal_to_transfer_balance"
]
},
{
"name": "Validate business user info against customer info",
"description": "Validates that business user information matches the corresponding customer information for basic fields.",
"possible_errors": [
"customer_details_and_user_details_both_provided"
]
},
{
"name": "Validate payment preference <code>ledger_identifier</code>",
"description": "Ensure that the <code>ledger_identifier</code> provided has an equivalent <code>ledger</code> object with the same <code>ledger_identifier</code> .",
"possible_errors": [
"invalid_payment_preference_ledger_identifier"
]
},
{
"name": "Validate that referenced ledgers are unique in payment preferences",
"description": "Ensure that each ledger is referenced in at most one payment preference.",
"possible_errors": [
"duplicate_ledger_in_payment_preferences"
]
},
{
"name": "Validate that valid instruction_identifier provided for <code>ACTIVE_NEW</code> payment preference",
"description": "Ensure that <code>ACTIVE_NEW</code> payment preference has instruction_identifier from </code>payment_instructions</code> object.",
"possible_errors": [
"active_new_payment_preference_invalid_instruction_identifier"
]
},
{
"name": "Validate that the transactions for a voucher do not exceed its value",
"description": "Validate that the sum of all transaction values for a voucher is not greater than the value of the voucher.",
"possible_errors": [
"voucher_transactions_sum_greater_than_voucher_value"
]
},
{
"name": "Validate that each voucher charge transaction id has a matching transaction id within a transaction of type CHARGE",
"description": "Validate that each <code>voucher</code> <code>charge_transaction_id</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CHARGE in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_charge_transaction_id_not_found"
]
},
{
"name": "Validate that each voucher redemption credit transaction id has a matching transaction id within a transaction of type CREDIT",
"description": "Validate that every <code>credit_transaction_id</code> in all <code>voucher_redemptions</code> in every <code>voucher</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CREDIT in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_redemption_credit_transaction_id_not_found"
]
},
{
"name": "Validate parent property references exist",
"description": "Validates that all <code>parent_property_reference</code> values in <code>supply_addresses</code> and <code>properties</code> correspond to a <code>property_external_identifier</code> in the payload. This ensures the property hierarchy is valid.",
"possible_errors": [
"parent_property_reference_not_found"
]
},
{
"name": "Validate that a portfolio lead account has no supply address since it makes no sense for it to have one",
"description": "Validate that a portfolio lead account has no supply address.",
"possible_errors": [
"portfolio_lead_has_a_supply_address"
]
},
{
"name": "Validate that a system account has no supply address",
"description": "Validate that a system account has no supply address",
"possible_errors": [
"system_account_has_a_supply_address"
]
},
{
"name": "Validate 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 that if historical statement transaction are provided then so is a last statement closing date or last billed to date",
"description": "Validate that if <code>historical_statement_transactions</code> are provided in the payload then either a <code>last_statement_closing_date</code> or <code>last_billed_to_date</code> is also provided. If a <code>last_statement_closing_date</code> is not provided then the earliest <code>last_billed_to_date</code> on the account or supply points is used to determine when the last statement should have closed.",
"possible_errors": [
"historical_statement_transactions_without_last_statement_closing_date_or_last_billed_to_date"
]
},
{
"name": "Validate unique transaction IDs",
"description": "Validate that all transaction IDs provided are unique.",
"possible_errors": [
"duplicate_transaction_ids",
"missing_transaction_id"
]
},
{
"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 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 no duplicated ledgers are provided",
"description": "Validate no duplicated ledger codes are in `ledgers` section.",
"possible_errors": [
"duplicate_ledger_entries_found"
]
},
{
"name": "Validate identifiers are unique in ledgers",
"description": "Validate identifier is not declared twice in ledgers.",
"possible_errors": [
"duplicate_identifiers_entries_found"
]
},
{
"name": "Validate ledger identifiers are known",
"description": "Validate ledger identifiers are among supply point identifiers.",
"possible_errors": [
"unknown_ledger_identifiers"
]
},
{
"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 that payment plans and payment schedules for the same ledger are not both in payload",
"description": "Validate that if there are payment plans in the payload, there are not also payment schedules on the same ledger because payment plans create a schedule containing all of the planned payments.",
"possible_errors": [
"payment_plan_and_payment_schedule_not_allowed_on_same_ledger"
]
},
{
"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 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 agreements cover the last billed to date",
"description": "Validate that there is an agreement covering the last billed to date for each supply point.",
"possible_errors": [
"no_agreement_covering_last_billed_to_date"
]
},
{
"name": "Validate debt and debts",
"description": "Validates that both debt and debts are not specified in the payload.",
"possible_errors": [
"debt_and_debts_are_defined"
]
},
{
"name": "Validate that a last billed to date has been provided correctly",
"description": "Validate that, for each meter, a last billed to date has been provided in the appropriate place. For electricity meters, it must be provided on each of the meter's settlement registers. For gas meters, it must be provided on the meter. This validation does not apply to meters with half-hourly billing, or meters that have been exchanged where the new meter has already been billed. This validation is skipped if the account has not yet been billed and therefore has no historical statement data.",
"possible_errors": [
"last_billed_to_date_not_found"
]
},
{
"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. Note that any prepay vend transactions are not included in the above check.",
"possible_errors": [
"current_statement_transaction_before_current_statement_opening_date"
]
},
{
"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. Prepay transactions (those with the <code>to_prepay_meter_serial_number</code> field on the transaction) are filtered out as these are treated separately during account creation.",
"possible_errors": [
"balance_mismatch_on_transfer_balance"
]
},
{
"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>. Prepay transactions (those with the <code>to_prepay_meter_serial_number</code> field on the transaction) are filtered out as these are treated separately during account creation.",
"possible_errors": [
"historical_statement_transactions_balance_mismatch"
]
},
{
"name": "Validate next bill due date provided for quarterly billing",
"description": "Validate that if <code>use_industry_billing</code> is false in the account billing options and the <code>period_length</code> is <code>QUARTERLY</code>, then a <code>next_bill_due_date</code> is provided.",
"possible_errors": [
"next_bill_to_date_not_provided_for_quarterly_billing"
]
},
{
"name": "Validate account billing options",
"description": "Validate that account billing options have only been provided for business accounts.",
"possible_errors": [
"account_billing_options_provided_for_domestic_accounts"
]
},
{
"name": "Validate that prepay transactions target initialised prepay meters",
"description": "Validate that if <code>current_statement_transactions</code> or <code>historical_statement_transactions</code> target a prepay meter (i.e. has the <code>to_prepay_meter_serial_number</code> field), then a prepay meter with that serial number exists in the payload. A prepay meter is identified in the payload by the presence of <code>prepay_details</code>.",
"possible_errors": [
"transactions_target_non_initialised_prepay_meter"
]
},
{
"name": "Validate tax exemption for appropriate account type",
"description": "Validate that the tax exemption is only in place for business accounts.",
"possible_errors": [
"tax_exemptions_provided_for_domestic_account"
]
},
{
"name": "Validate prepay transfer vend read dates match last billed to date",
"description": "Validate that the transfer vend read dates match the last billed to date. This only applies to prepay meters.The last billed to date can be either at the account level or the at the meter/register level. Last billed to dates at the meter/register level take precedent over the account level date if both are provided.",
"possible_errors": [
"prepay_details_on_fully_billed_meter",
"transfer_vend_read_date_must_match_last_billed_to_date"
]
},
{
"name": "Validate that the tariff type and meter point type match",
"description": "Validate that the tariff we have on a given contract matches the meter point type. For example, check eco7 (2-rate) meter points don't have single-rate tariffs or vice versa.",
"possible_errors": [
"tariff_type_does_not_match_meter_point_type"
]
},
{
"name": "Validate bespoke rates",
"description": "Validate that if bespoke rates have been set the account is business.",
"possible_errors": [
"business_fields_provided_for_domestic_accounts"
]
},
{
"name": "Validate billing address provided",
"description": "Validate <code>billing_address1</code> and <code>billing_postcode</code> are provided for non-occupier accounts.",
"possible_errors": [
"billing_address_not_provided"
]
},
{
"name": "Validate current AQ for billable meter point",
"description": "Check that we have a currently valid AQ for a billable MPRN.",
"possible_errors": [
"no_current_or_future_aq_entry_found"
]
},
{
"name": "Validate all billable meter points are covered by agreements in the payload",
"description": "Validate that agreements have been provided for all billable meter points and vice versa for the period covered by Kraken from a billing perspective. A billable meter point is one that has an open-ended or future dated supply end date.",
"possible_errors": [
"meter_point_with_no_agreement",
"meterpoint_with_agreement_not_on_supply"
]
},
{
"name": "Validate transfer readings exist on active gas meters",
"description": "Validate that each active gas meter has a single transfer reading provided.",
"possible_errors": [
"active_gas_meter_with_multiple_transfer_readings",
"active_gas_meter_without_transfer_reading",
"reading_meter_fully_billed"
]
},
{
"name": "Validate EACs provided for active registers",
"description": "Validate that EACs are provided in the <code>eac_history</code> array for each active electricity register. EACs are matched to registers using the <code>tpr</code> field present on both the EAC and register objects.",
"possible_errors": [
"missing_eacs_for_active_register_tpr"
]
},
{
"name": "Validate that prepay meters are matched to agreements of the correct type",
"description": "Validate that each prepay meter has a matching agreement on a prepay tariff, and similarly non-prepay meters on non-prepay tariffs. Note that this validation only applies for active meters and agreements.",
"possible_errors": [
"tariff_type_does_not_match_meter_type"
]
},
{
"name": "Validate each agreement is not effective before the product is available",
"description": "Ensures that the agreement <code>effective_from</code> is not before the datetime the agreement's product is available from. We check this if Kraken will be responsible for billing before the product is available and the product is a variable or tracker product.",
"possible_errors": [
"agreement_effective_from_before_product_available_from"
]
},
{
"name": "Validate that all variable products on a contract have start dates after the product start date",
"description": "Validate that any variable products that are part of a contract only become effective after the product is available.",
"possible_errors": [
"agreement_cannot_start_before_product_available"
]
},
{
"name": "Validate that no meter points are ending supply in the future",
"description": "Ensure that all meters points have either ended supply or are not planned for supply to end.",
"possible_errors": [
"future_supply_end_date"
]
},
{
"name": "Validate that all off supply meter points with meters have a final reading",
"description": "Ensure that all off supply meter points which have meters have a final reading on their end date.",
"possible_errors": [
"no_reading_on_supply_end_date"
]
},
{
"name": "Validate that no billable meter points are starting supply in the future",
"description": "Validate that no billable meter points are set to start supply in the future.",
"possible_errors": [
"future_supply_start_date"
]
},
{
"name": "Validate that all billable meter points have active meters",
"description": "Ensure that all meter points that are billable have active meters or have an unmetered measurement class provided in the payload.",
"possible_errors": [
"meter_point_with_no_meters"
]
},
{
"name": "Validate that at least one of the meter points needs billing",
"description": "Ensure that at least one of the meter points for this account are billable.",
"possible_errors": [
"no_supply_point_on_supply"
]
},
{
"name": "Validate that a domestic account does not have any business only supply points",
"description": "Validate that a domestic account does not have supply points with supply types <code>REGOS_EXPORT_CERTIFICATES</code> or <code>ROCS_EXPORT_CERTIFICATES</code> which are business only supply types.",
"possible_errors": [
"business_supply_type_on_domestic_account"
]
},
{
"name": "Validate business account has account billing options with <code>period_start_day</code> and <code>period_length</code>",
"description": "Validate that business account's <code>account_billing_options</code> include period start day and period length if <code>account_billing_options</code> is being provided. If <code>account_billing_options</code> is not provided then the defaults of 1 for <code>period_start_day</code> and \"MONTHLY\" for <code>period_length</code> will be used.",
"possible_errors": [
"business_account_missing_billing_options"
]
},
{
"name": "Validate that customers provided for business accounts",
"description": "Validate that at least one customer is provided for business accounts. Customers are needed for business accounts to ensure that meter points can be successfully registered for supply.",
"possible_errors": [
"business_account_missing_customers"
]
},
{
"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 transfer readings exist on active electricity registers",
"description": "Validate that each active electricity meter register has a single transfer reading provided.",
"possible_errors": [
"missing_transfer_reading_for_register",
"multiple_transfer_readings_for_register"
]
}
]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": "Derive occupier billing address from supply address",
"description": "When an occupier account has no explicit billing address and exactly one supply address is provided, copy the supply address into the billing address fields.",
"possible_errors": []
},
{
"name": "Validate billing address fields",
"description": "If a legacy billing address is provided, validate that it is in the correct format.",
"possible_errors": [
"invalid_address"
]
},
{
"name": "Validate 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 historical statement period end must not be in the future",
"description": "Ensures that the historical statement period end date (last_statement_closing_date or latest transaction_date) is not set in the future.",
"possible_errors": [
"historical_statement_period_end_in_future"
]
},
{
"name": "Validate that terms with supply type matches a supply point supply type",
"description": "Validate that for terms containing a <code>supply_type</code> field that there is a supply point in the payload with a matching <code>supply_type</code>.",
"possible_errors": [
"term_supply_type_mismatch"
]
},
{
"name": "Validate that supply addresses and supply points are provided if account contracts are provided",
"description": "Validate that if <code>account_contracts</code> have been provided that a supply address with supply points has been provided under <code>supply_addresses</code>",
"possible_errors": [
"account_contracts_without_supply_points"
]
},
{
"name": "Validate historical statement billing document identifier presence",
"description": "Ensure that billing document identifiers are only provided for historical statement transactions and only when the relevant feature flag is enabled.",
"possible_errors": [
"historical_statement_billing_document_identifier_missing",
"historical_statement_billing_document_identifier_not_allowed_when_feature_flag_disabled"
]
},
{
"name": "Validate current statement transactions do not provide <code>billing_document_identifier</code>",
"description": "Validate that none of the current statement transactions include a <code>billing_document_identifier</code>, as this field is only applicable to historical statement transactions.",
"possible_errors": [
"billing_document_identifier_not_allowed_for_current_statement_transactions"
]
},
{
"name": "Validate historical statement transaction billing document identifier",
"description": "Ensure that the billing document identifier is the same for all historical statement transactions.",
"possible_errors": [
"historical_statement_billing_document_identifier_mismatch"
]
},
{
"name": "Validate that contract terms' product codes are part of supply agreements",
"description": "Ensure that any contract terms with product references have corresponding products in supply addresses.",
"possible_errors": [
"contract_term_product_code_not_in_agreements"
]
},
{
"name": "Validate that business is provided if enforcing business contracts",
"description": "Validate that the business field is provided if <code>enforce_business_contracts_exist</code> is set to True on the import supplier configuration.",
"possible_errors": [
"business_field_required"
]
},
{
"name": "Validate agreement business contract identifier is declared",
"description": "Validates that an agreement's <code>business_contract_identifier</code>, if provided, is one of the account's declared <code>business_contract_identifiers</code>.",
"possible_errors": [
"agreement_business_contract_identifier_not_declared"
]
},
{
"name": "Validate that the sum of ledger balances equals the transfer balance",
"description": "Validate that the sum of all <code>ledger_balance</code> provided for each ledger in <code>ledgers</code> equals the account-level <code>transfer_balance</code>.",
"possible_errors": [
"ledger_balances_not_equal_to_transfer_balance"
]
},
{
"name": "Validate business user info against customer info",
"description": "Validates that business user information matches the corresponding customer information for basic fields.",
"possible_errors": [
"customer_details_and_user_details_both_provided"
]
},
{
"name": "Validate payment preference <code>ledger_identifier</code>",
"description": "Ensure that the <code>ledger_identifier</code> provided has an equivalent <code>ledger</code> object with the same <code>ledger_identifier</code> .",
"possible_errors": [
"invalid_payment_preference_ledger_identifier"
]
},
{
"name": "Validate that referenced ledgers are unique in payment preferences",
"description": "Ensure that each ledger is referenced in at most one payment preference.",
"possible_errors": [
"duplicate_ledger_in_payment_preferences"
]
},
{
"name": "Validate that valid instruction_identifier provided for <code>ACTIVE_NEW</code> payment preference",
"description": "Ensure that <code>ACTIVE_NEW</code> payment preference has instruction_identifier from </code>payment_instructions</code> object.",
"possible_errors": [
"active_new_payment_preference_invalid_instruction_identifier"
]
},
{
"name": "Validate that the transactions for a voucher do not exceed its value",
"description": "Validate that the sum of all transaction values for a voucher is not greater than the value of the voucher.",
"possible_errors": [
"voucher_transactions_sum_greater_than_voucher_value"
]
},
{
"name": "Validate that each voucher charge transaction id has a matching transaction id within a transaction of type CHARGE",
"description": "Validate that each <code>voucher</code> <code>charge_transaction_id</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CHARGE in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_charge_transaction_id_not_found"
]
},
{
"name": "Validate that each voucher redemption credit transaction id has a matching transaction id within a transaction of type CREDIT",
"description": "Validate that every <code>credit_transaction_id</code> in all <code>voucher_redemptions</code> in every <code>voucher</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CREDIT in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_redemption_credit_transaction_id_not_found"
]
},
{
"name": "Validate parent property references exist",
"description": "Validates that all <code>parent_property_reference</code> values in <code>supply_addresses</code> and <code>properties</code> correspond to a <code>property_external_identifier</code> in the payload. This ensures the property hierarchy is valid.",
"possible_errors": [
"parent_property_reference_not_found"
]
},
{
"name": "Validate that a portfolio lead account has no supply address since it makes no sense for it to have one",
"description": "Validate that a portfolio lead account has no supply address.",
"possible_errors": [
"portfolio_lead_has_a_supply_address"
]
},
{
"name": "Validate that a system account has no supply address",
"description": "Validate that a system account has no supply address",
"possible_errors": [
"system_account_has_a_supply_address"
]
},
{
"name": "Validate 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 that if historical statement transaction are provided then so is a last statement closing date or last billed to date",
"description": "Validate that if <code>historical_statement_transactions</code> are provided in the payload then either a <code>last_statement_closing_date</code> or <code>last_billed_to_date</code> is also provided. If a <code>last_statement_closing_date</code> is not provided then the earliest <code>last_billed_to_date</code> on the account or supply points is used to determine when the last statement should have closed.",
"possible_errors": [
"historical_statement_transactions_without_last_statement_closing_date_or_last_billed_to_date"
]
},
{
"name": "Validate unique transaction IDs",
"description": "Validate that all transaction IDs provided are unique.",
"possible_errors": [
"duplicate_transaction_ids",
"missing_transaction_id"
]
},
{
"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 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 no duplicated ledgers are provided",
"description": "Validate no duplicated ledger codes are in `ledgers` section.",
"possible_errors": [
"duplicate_ledger_entries_found"
]
},
{
"name": "Validate identifiers are unique in ledgers",
"description": "Validate identifier is not declared twice in ledgers.",
"possible_errors": [
"duplicate_identifiers_entries_found"
]
},
{
"name": "Validate ledger identifiers are known",
"description": "Validate ledger identifiers are among supply point identifiers.",
"possible_errors": [
"unknown_ledger_identifiers"
]
},
{
"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 that payment plans and payment schedules for the same ledger are not both in payload",
"description": "Validate that if there are payment plans in the payload, there are not also payment schedules on the same ledger because payment plans create a schedule containing all of the planned payments.",
"possible_errors": [
"payment_plan_and_payment_schedule_not_allowed_on_same_ledger"
]
},
{
"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 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 agreements cover the last billed to date",
"description": "Validate that there is an agreement covering the last billed to date for each supply point.",
"possible_errors": [
"no_agreement_covering_last_billed_to_date"
]
},
{
"name": "Validate debt and debts",
"description": "Validates that both debt and debts are not specified in the payload.",
"possible_errors": [
"debt_and_debts_are_defined"
]
},
{
"name": "Validate that a last billed to date has been provided correctly",
"description": "Validate that, for each meter, a last billed to date has been provided in the appropriate place. For electricity meters, it must be provided on each of the meter's settlement registers. For gas meters, it must be provided on the meter. This validation does not apply to meters with half-hourly billing, or meters that have been exchanged where the new meter has already been billed. This validation is skipped if the account has not yet been billed and therefore has no historical statement data.",
"possible_errors": [
"last_billed_to_date_not_found"
]
},
{
"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. Note that any prepay vend transactions are not included in the above check.",
"possible_errors": [
"current_statement_transaction_before_current_statement_opening_date"
]
},
{
"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. Prepay transactions (those with the <code>to_prepay_meter_serial_number</code> field on the transaction) are filtered out as these are treated separately during account creation.",
"possible_errors": [
"balance_mismatch_on_transfer_balance"
]
},
{
"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>. Prepay transactions (those with the <code>to_prepay_meter_serial_number</code> field on the transaction) are filtered out as these are treated separately during account creation.",
"possible_errors": [
"historical_statement_transactions_balance_mismatch"
]
},
{
"name": "Validate next bill due date provided for quarterly billing",
"description": "Validate that if <code>use_industry_billing</code> is false in the account billing options and the <code>period_length</code> is <code>QUARTERLY</code>, then a <code>next_bill_due_date</code> is provided.",
"possible_errors": [
"next_bill_to_date_not_provided_for_quarterly_billing"
]
},
{
"name": "Validate account billing options",
"description": "Validate that account billing options have only been provided for business accounts.",
"possible_errors": [
"account_billing_options_provided_for_domestic_accounts"
]
},
{
"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 prepay transactions target initialised prepay meters",
"description": "Validate that if <code>current_statement_transactions</code> or <code>historical_statement_transactions</code> target a prepay meter (i.e. has the <code>to_prepay_meter_serial_number</code> field), then a prepay meter with that serial number exists in the payload. A prepay meter is identified in the payload by the presence of <code>prepay_details</code>.",
"possible_errors": [
"transactions_target_non_initialised_prepay_meter"
]
},
{
"name": "Validate tax exemption for appropriate account type",
"description": "Validate that the tax exemption is only in place for business accounts.",
"possible_errors": [
"tax_exemptions_provided_for_domestic_account"
]
},
{
"name": "Validate prepay transfer vend read dates match last billed to date",
"description": "Validate that the transfer vend read dates match the last billed to date. This only applies to prepay meters.The last billed to date can be either at the account level or the at the meter/register level. Last billed to dates at the meter/register level take precedent over the account level date if both are provided.",
"possible_errors": [
"prepay_details_on_fully_billed_meter",
"transfer_vend_read_date_must_match_last_billed_to_date"
]
},
{
"name": "Validate that the tariff type and meter point type match",
"description": "Validate that the tariff we have on a given contract matches the meter point type. For example, check eco7 (2-rate) meter points don't have single-rate tariffs or vice versa.",
"possible_errors": [
"tariff_type_does_not_match_meter_point_type"
]
},
{
"name": "Validate bespoke rates",
"description": "Validate that if bespoke rates have been set the account is business.",
"possible_errors": [
"business_fields_provided_for_domestic_accounts"
]
},
{
"name": "Validate billing address provided",
"description": "Validate <code>billing_address1</code> and <code>billing_postcode</code> are provided for non-occupier accounts.",
"possible_errors": [
"billing_address_not_provided"
]
},
{
"name": "Validate current AQ for billable meter point",
"description": "Check that we have a currently valid AQ for a billable MPRN.",
"possible_errors": [
"no_current_or_future_aq_entry_found"
]
},
{
"name": "Validate all billable meter points are covered by agreements in the payload",
"description": "Validate that agreements have been provided for all billable meter points and vice versa for the period covered by Kraken from a billing perspective. A billable meter point is one that has an open-ended or future dated supply end date.",
"possible_errors": [
"meter_point_with_no_agreement",
"meterpoint_with_agreement_not_on_supply"
]
},
{
"name": "Validate transfer readings exist on active gas meters",
"description": "Validate that each active gas meter has a single transfer reading provided.",
"possible_errors": [
"active_gas_meter_with_multiple_transfer_readings",
"active_gas_meter_without_transfer_reading",
"reading_meter_fully_billed"
]
},
{
"name": "Validate EACs provided for active registers",
"description": "Validate that EACs are provided in the <code>eac_history</code> array for each active electricity register. EACs are matched to registers using the <code>tpr</code> field present on both the EAC and register objects.",
"possible_errors": [
"missing_eacs_for_active_register_tpr"
]
},
{
"name": "Validate that prepay meters are matched to agreements of the correct type",
"description": "Validate that each prepay meter has a matching agreement on a prepay tariff, and similarly non-prepay meters on non-prepay tariffs. Note that this validation only applies for active meters and agreements.",
"possible_errors": [
"tariff_type_does_not_match_meter_type"
]
},
{
"name": "Validate each agreement is not effective before the product is available",
"description": "Ensures that the agreement <code>effective_from</code> is not before the datetime the agreement's product is available from. We check this if Kraken will be responsible for billing before the product is available and the product is a variable or tracker product.",
"possible_errors": [
"agreement_effective_from_before_product_available_from"
]
},
{
"name": "Validate that all variable products on a contract have start dates after the product start date",
"description": "Validate that any variable products that are part of a contract only become effective after the product is available.",
"possible_errors": [
"agreement_cannot_start_before_product_available"
]
},
{
"name": "Validate that no meter points are ending supply in the future",
"description": "Ensure that all meters points have either ended supply or are not planned for supply to end.",
"possible_errors": [
"future_supply_end_date"
]
},
{
"name": "Validate that all off supply meter points with meters have a final reading",
"description": "Ensure that all off supply meter points which have meters have a final reading on their end date.",
"possible_errors": [
"no_reading_on_supply_end_date"
]
},
{
"name": "Validate that no billable meter points are starting supply in the future",
"description": "Validate that no billable meter points are set to start supply in the future.",
"possible_errors": [
"future_supply_start_date"
]
},
{
"name": "Validate that all billable meter points have active meters",
"description": "Ensure that all meter points that are billable have active meters or have an unmetered measurement class provided in the payload.",
"possible_errors": [
"meter_point_with_no_meters"
]
},
{
"name": "Validate that at least one of the meter points needs billing",
"description": "Ensure that at least one of the meter points for this account are billable.",
"possible_errors": [
"no_supply_point_on_supply"
]
},
{
"name": "Validate that a domestic account does not have any business only supply points",
"description": "Validate that a domestic account does not have supply points with supply types <code>REGOS_EXPORT_CERTIFICATES</code> or <code>ROCS_EXPORT_CERTIFICATES</code> which are business only supply types.",
"possible_errors": [
"business_supply_type_on_domestic_account"
]
},
{
"name": "Validate business account has account billing options with <code>period_start_day</code> and <code>period_length</code>",
"description": "Validate that business account's <code>account_billing_options</code> include period start day and period length if <code>account_billing_options</code> is being provided. If <code>account_billing_options</code> is not provided then the defaults of 1 for <code>period_start_day</code> and \"MONTHLY\" for <code>period_length</code> will be used.",
"possible_errors": [
"business_account_missing_billing_options"
]
},
{
"name": "Validate that customers provided for business accounts",
"description": "Validate that at least one customer is provided for business accounts. Customers are needed for business accounts to ensure that meter points can be successfully registered for supply.",
"possible_errors": [
"business_account_missing_customers"
]
},
{
"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 transfer readings exist on active electricity registers",
"description": "Validate that each active electricity meter register has a single transfer reading provided.",
"possible_errors": [
"missing_transfer_reading_for_register",
"multiple_transfer_readings_for_register"
]
}
]Old
{
"x-validators": [
{
"name": "Validate alternative phone number is not in kraken",
"description": "Validate the alternative phone number provided does not exist in the database.",
"possible_errors": [
"alternative_phone_numbers_already_exists"
]
}
]
}New
{
"x-enum-descriptions": {
"ESSENTIAL_WATER_FIELD": "Essential Water Field Services"
}
}Old
{
"x-enum-descriptions": {}
}15 July 2026
New
{
"x-enum-descriptions": {}
}Old
{
"x-enum-descriptions": {
"ESSENTIAL_WATER_FIELD": "Essential Water Field Services"
}
}New
{
"x-enum-descriptions": {
"ESSENTIAL_WATER_FIELD": "Essential Water Field Services"
}
}Old
{
"x-enum-descriptions": {}
}New
[
{
"name": "Validate <code>\u2068end_date\u2069</code> not before <code>\u2068start_date\u2069</code>",
"description": "Validates that <code>\u2068end_date\u2069</code>, if given, is on or later than <code>\u2068start_date\u2069</code>.",
"possible_errors": [
"start_date_later_than_end_date"
]
},
{
"name": "Validate fixed payment schedule has amount",
"description": "Validates that a fixed payment schedule has an non zero amount provided in the payload. A fixed schedule is defined as a payment schedule with a trigger that is not type BILL.",
"possible_errors": [
"zero_payment_schedule_amount"
]
},
{
"name": "Validate regular payment schedule frequency provided",
"description": "Validates that a fixed regular payment schedule has a frequency provided in the payload.",
"possible_errors": [
"fixed_payment_schedule_missing_frequency"
]
},
{
"name": "Validate payment schedule balance threshold provided",
"description": "Validates that a payment schedule with a balance trigger has a balance threshold provided in the payload. This balance threshold is the amount the ledger balance must drop below to trigger a payment.",
"possible_errors": [
"balance_triggered_schedule_missing_threshold"
]
},
{
"name": "Validate debt repayment end date provided",
"description": "Validates that a debt repayment end date is provided in the payload if a debt repayment element is provided.",
"possible_errors": [
"debt_repayment_missing_end_date"
]
},
{
"name": "Validate debt repayment end date is not later than schedule end date",
"description": "Validates that a debt repayment end date is not later than the payment schedule end date if both are provided.",
"possible_errors": [
"debt_repayment_end_date_after_schedule_end_date"
]
},
{
"name": "Validate exempt from payment adequacy is applied only to regular schedule",
"description": "Validates that only a regular payment schedule is marked as exempted from payment adequacy, so as to create a fixed regular payment schedule.",
"possible_errors": [
"invalid_payment_schedule_to_exempt_from_payment_adequacy"
]
},
{
"name": "Validate fixed payment schedule has payment day",
"description": "Validates that a fixed payment schedule has a day of month in the payload. A fixed schedule is defined as a payment schedule with a trigger of type REGULAR.",
"possible_errors": [
"fixed_payment_schedule_missing_day_of_month"
]
},
{
"name": "Validate instalments is provided if trigger is PLAN",
"description": "Validate that the instalment field is not empty if payment schedule trigger is PLAN.",
"possible_errors": [
"payment_instalments_not_provided"
]
},
{
"name": "Validate instalment payment amounts sum to total amount",
"description": "Validate instalment payment amounts sum to total amount given.",
"possible_errors": [
"payment_instalments_do_not_sum_to_total"
]
},
{
"name": "Validate instalment payment date is within payment schedule active period",
"description": "Validate instalment payment date is within the period between start date and end date provided.",
"possible_errors": [
"payment_instalments_date_outside_of_payment_schedule_active_period"
]
},
{
"name": "Validate that the delayer days is set if delayer strategy is set",
"description": "Validate that the delayer days is set if delayer strategy is set",
"possible_errors": [
"payment_schedule_delay_must_have_bill_trigger",
"payment_schedule_delay_strategy_missing_delay_days"
]
},
{
"name": "Validate that the payment amount for fixed payment schedules is within the minor currency unit range of \u20680\u2069 - \u2068upper_bound\u2069",
"description": "Validate that the payment amount for any fixed payment schedule is within the major currency unit range of \u2068lower_limit\u2069 - \u2068UNLIMITED\u2069.",
"possible_errors": [
"fixed_payment_schedule_amount_out_of_range"
]
},
{
"name": "Standalone payment request method code is unexpected",
"description": "Validates that standalone_payment_request_method_code is only provided for MANUAL payment schedules.",
"possible_errors": [
"standalone_payment_request_method_code_unexpected"
]
},
{
"name": "Standalone payment request method code is valid",
"description": "Validates that standalone_payment_request_method_code matches a registered method.",
"possible_errors": [
"standalone_payment_request_method_code_invalid"
]
}
]Old
[
{
"name": "Validate <code>\u2068end_date\u2069</code> not before <code>\u2068start_date\u2069</code>",
"description": "Validates that <code>\u2068end_date\u2069</code>, if given, is on or later than <code>\u2068start_date\u2069</code>.",
"possible_errors": [
"start_date_later_than_end_date"
]
},
{
"name": "Validate fixed payment schedule has amount",
"description": "Validates that a fixed payment schedule has an non zero amount provided in the payload. A fixed schedule is defined as a payment schedule with a trigger that is not type BILL.",
"possible_errors": [
"zero_payment_schedule_amount"
]
},
{
"name": "Validate regular payment schedule frequency provided",
"description": "Validates that a fixed regular payment schedule has a frequency provided in the payload.",
"possible_errors": [
"fixed_payment_schedule_missing_frequency"
]
},
{
"name": "Validate payment schedule balance threshold provided",
"description": "Validates that a payment schedule with a balance trigger has a balance threshold provided in the payload. This balance threshold is the amount the ledger balance must drop below to trigger a payment.",
"possible_errors": [
"balance_triggered_schedule_missing_threshold"
]
},
{
"name": "Validate debt repayment end date provided",
"description": "Validates that a debt repayment end date is provided in the payload if a debt repayment element is provided.",
"possible_errors": [
"debt_repayment_missing_end_date"
]
},
{
"name": "Validate debt repayment end date is not later than schedule end date",
"description": "Validates that a debt repayment end date is not later than the payment schedule end date if both are provided.",
"possible_errors": [
"debt_repayment_end_date_after_schedule_end_date"
]
},
{
"name": "Validate exempt from payment adequacy is applied only to regular schedule",
"description": "Validates that only a regular payment schedule is marked as exempted from payment adequacy, so as to create a fixed regular payment schedule.",
"possible_errors": [
"invalid_payment_schedule_to_exempt_from_payment_adequacy"
]
},
{
"name": "Validate fixed payment schedule has payment day",
"description": "Validates that a fixed payment schedule has a day of month in the payload. A fixed schedule is defined as a payment schedule with a trigger of type REGULAR.",
"possible_errors": [
"fixed_payment_schedule_missing_day_of_month"
]
},
{
"name": "Validate instalments is provided if trigger is PLAN",
"description": "Validate that the instalment field is not empty if payment schedule trigger is PLAN.",
"possible_errors": [
"payment_instalments_not_provided"
]
},
{
"name": "Validate instalment payment amounts sum to total amount",
"description": "Validate instalment payment amounts sum to total amount given.",
"possible_errors": [
"payment_instalments_do_not_sum_to_total"
]
},
{
"name": "Validate instalment payment date is within payment schedule active period",
"description": "Validate instalment payment date is within the period between start date and end date provided.",
"possible_errors": [
"payment_instalments_date_outside_of_payment_schedule_active_period"
]
},
{
"name": "Validate that the delayer days is set if delayer strategy is set",
"description": "Validate that the delayer days is set if delayer strategy is set",
"possible_errors": [
"payment_schedule_delay_must_have_bill_trigger",
"payment_schedule_delay_strategy_missing_delay_days"
]
},
{
"name": "Validate that the payment amount for fixed payment schedules is within the minor currency unit range of \u20680\u2069 - \u2068upper_bound\u2069",
"description": "Validate that the payment amount for any fixed payment schedule is within the major currency unit range of \u2068lower_limit\u2069 - \u2068UNLIMITED\u2069.",
"possible_errors": [
"fixed_payment_schedule_amount_out_of_range"
]
}
]9 July 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": "Derive occupier billing address from supply address",
"description": "When an occupier account has no explicit billing address and exactly one supply address is provided, copy the supply address into the billing address fields.",
"possible_errors": []
},
{
"name": "Validate billing address fields",
"description": "If a legacy billing address is provided, validate that it is in the correct format.",
"possible_errors": [
"invalid_address"
]
},
{
"name": "Validate 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 historical statement period end must not be in the future",
"description": "Ensures that the historical statement period end date (last_statement_closing_date or latest transaction_date) is not set in the future.",
"possible_errors": [
"historical_statement_period_end_in_future"
]
},
{
"name": "Validate that terms with supply type matches a supply point supply type",
"description": "Validate that for terms containing a <code>supply_type</code> field that there is a supply point in the payload with a matching <code>supply_type</code>.",
"possible_errors": [
"term_supply_type_mismatch"
]
},
{
"name": "Validate that supply addresses and supply points are provided if account contracts are provided",
"description": "Validate that if <code>account_contracts</code> have been provided that a supply address with supply points has been provided under <code>supply_addresses</code>",
"possible_errors": [
"account_contracts_without_supply_points"
]
},
{
"name": "Validate historical statement billing document identifier presence",
"description": "Ensure that billing document identifiers are only provided for historical statement transactions and only when the relevant feature flag is enabled.",
"possible_errors": [
"historical_statement_billing_document_identifier_missing",
"historical_statement_billing_document_identifier_not_allowed_when_feature_flag_disabled"
]
},
{
"name": "Validate current statement transactions do not provide <code>billing_document_identifier</code>",
"description": "Validate that none of the current statement transactions include a <code>billing_document_identifier</code>, as this field is only applicable to historical statement transactions.",
"possible_errors": [
"billing_document_identifier_not_allowed_for_current_statement_transactions"
]
},
{
"name": "Validate historical statement transaction billing document identifier",
"description": "Ensure that the billing document identifier is the same for all historical statement transactions.",
"possible_errors": [
"historical_statement_billing_document_identifier_mismatch"
]
},
{
"name": "Validate that contract terms' product codes are part of supply agreements",
"description": "Ensure that any contract terms with product references have corresponding products in supply addresses.",
"possible_errors": [
"contract_term_product_code_not_in_agreements"
]
},
{
"name": "Validate that business is provided if enforcing business contracts",
"description": "Validate that the business field is provided if <code>enforce_business_contracts_exist</code> is set to True on the import supplier configuration.",
"possible_errors": [
"business_field_required"
]
},
{
"name": "Validate agreement business contract identifier is declared",
"description": "Validates that an agreement's <code>business_contract_identifier</code>, if provided, is one of the account's declared <code>business_contract_identifiers</code>.",
"possible_errors": [
"agreement_business_contract_identifier_not_declared"
]
},
{
"name": "Validate that the sum of ledger balances equals the transfer balance",
"description": "Validate that the sum of all <code>ledger_balance</code> provided for each ledger in <code>ledgers</code> equals the account-level <code>transfer_balance</code>.",
"possible_errors": [
"ledger_balances_not_equal_to_transfer_balance"
]
},
{
"name": "Validate business user info against customer info",
"description": "Validates that business user information matches the corresponding customer information for basic fields.",
"possible_errors": [
"customer_details_and_user_details_both_provided"
]
},
{
"name": "Validate payment preference <code>ledger_identifier</code>",
"description": "Ensure that the <code>ledger_identifier</code> provided has an equivalent <code>ledger</code> object with the same <code>ledger_identifier</code> .",
"possible_errors": [
"invalid_payment_preference_ledger_identifier"
]
},
{
"name": "Validate that referenced ledgers are unique in payment preferences",
"description": "Ensure that each ledger is referenced in at most one payment preference.",
"possible_errors": [
"duplicate_ledger_in_payment_preferences"
]
},
{
"name": "Validate that valid instruction_identifier provided for <code>ACTIVE_NEW</code> payment preference",
"description": "Ensure that <code>ACTIVE_NEW</code> payment preference has instruction_identifier from </code>payment_instructions</code> object.",
"possible_errors": [
"active_new_payment_preference_invalid_instruction_identifier"
]
},
{
"name": "Validate that the transactions for a voucher do not exceed its value",
"description": "Validate that the sum of all transaction values for a voucher is not greater than the value of the voucher.",
"possible_errors": [
"voucher_transactions_sum_greater_than_voucher_value"
]
},
{
"name": "Validate that each voucher charge transaction id has a matching transaction id within a transaction of type CHARGE",
"description": "Validate that each <code>voucher</code> <code>charge_transaction_id</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CHARGE in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_charge_transaction_id_not_found"
]
},
{
"name": "Validate that each voucher redemption credit transaction id has a matching transaction id within a transaction of type CREDIT",
"description": "Validate that every <code>credit_transaction_id</code> in all <code>voucher_redemptions</code> in every <code>voucher</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CREDIT in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_redemption_credit_transaction_id_not_found"
]
},
{
"name": "Validate parent property references exist",
"description": "Validates that all <code>parent_property_reference</code> values in <code>supply_addresses</code> and <code>properties</code> correspond to a <code>property_external_identifier</code> in the payload. This ensures the property hierarchy is valid.",
"possible_errors": [
"parent_property_reference_not_found"
]
},
{
"name": "Validate that a portfolio lead account has no supply address since it makes no sense for it to have one",
"description": "Validate that a portfolio lead account has no supply address.",
"possible_errors": [
"portfolio_lead_has_a_supply_address"
]
},
{
"name": "Validate that a system account has no supply address",
"description": "Validate that a system account has no supply address",
"possible_errors": [
"system_account_has_a_supply_address"
]
},
{
"name": "Validate 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 that if historical statement transaction are provided then so is a last statement closing date or last billed to date",
"description": "Validate that if <code>historical_statement_transactions</code> are provided in the payload then either a <code>last_statement_closing_date</code> or <code>last_billed_to_date</code> is also provided. If a <code>last_statement_closing_date</code> is not provided then the earliest <code>last_billed_to_date</code> on the account or supply points is used to determine when the last statement should have closed.",
"possible_errors": [
"historical_statement_transactions_without_last_statement_closing_date_or_last_billed_to_date"
]
},
{
"name": "Validate unique transaction IDs",
"description": "Validate that all transaction IDs provided are unique.",
"possible_errors": [
"duplicate_transaction_ids",
"missing_transaction_id"
]
},
{
"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 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 no duplicated ledgers are provided",
"description": "Validate no duplicated ledger codes are in `ledgers` section.",
"possible_errors": [
"duplicate_ledger_entries_found"
]
},
{
"name": "Validate identifiers are unique in ledgers",
"description": "Validate identifier is not declared twice in ledgers.",
"possible_errors": [
"duplicate_identifiers_entries_found"
]
},
{
"name": "Validate ledger identifiers are known",
"description": "Validate ledger identifiers are among supply point identifiers.",
"possible_errors": [
"unknown_ledger_identifiers"
]
},
{
"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 that payment plans and payment schedules for the same ledger are not both in payload",
"description": "Validate that if there are payment plans in the payload, there are not also payment schedules on the same ledger because payment plans create a schedule containing all of the planned payments.",
"possible_errors": [
"payment_plan_and_payment_schedule_not_allowed_on_same_ledger"
]
},
{
"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 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 agreements cover the last billed to date",
"description": "Validate that there is an agreement covering the last billed to date for each supply point.",
"possible_errors": [
"no_agreement_covering_last_billed_to_date"
]
},
{
"name": "Validate debt and debts",
"description": "Validates that both debt and debts are not specified in the payload.",
"possible_errors": [
"debt_and_debts_are_defined"
]
},
{
"name": "Validate that a last billed to date has been provided correctly",
"description": "Validate that, for each meter, a last billed to date has been provided in the appropriate place. For electricity meters, it must be provided on each of the meter's settlement registers. For gas meters, it must be provided on the meter. This validation does not apply to meters with half-hourly billing, or meters that have been exchanged where the new meter has already been billed. This validation is skipped if the account has not yet been billed and therefore has no historical statement data.",
"possible_errors": [
"last_billed_to_date_not_found"
]
},
{
"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. Note that any prepay vend transactions are not included in the above check.",
"possible_errors": [
"current_statement_transaction_before_current_statement_opening_date"
]
},
{
"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. Prepay transactions (those with the <code>to_prepay_meter_serial_number</code> field on the transaction) are filtered out as these are treated separately during account creation.",
"possible_errors": [
"balance_mismatch_on_transfer_balance"
]
},
{
"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>. Prepay transactions (those with the <code>to_prepay_meter_serial_number</code> field on the transaction) are filtered out as these are treated separately during account creation.",
"possible_errors": [
"historical_statement_transactions_balance_mismatch"
]
},
{
"name": "Validate next bill due date provided for quarterly billing",
"description": "Validate that if <code>use_industry_billing</code> is false in the account billing options and the <code>period_length</code> is <code>QUARTERLY</code>, then a <code>next_bill_due_date</code> is provided.",
"possible_errors": [
"next_bill_to_date_not_provided_for_quarterly_billing"
]
},
{
"name": "Validate account billing options",
"description": "Validate that account billing options have only been provided for business accounts.",
"possible_errors": [
"account_billing_options_provided_for_domestic_accounts"
]
},
{
"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 prepay transactions target initialised prepay meters",
"description": "Validate that if <code>current_statement_transactions</code> or <code>historical_statement_transactions</code> target a prepay meter (i.e. has the <code>to_prepay_meter_serial_number</code> field), then a prepay meter with that serial number exists in the payload. A prepay meter is identified in the payload by the presence of <code>prepay_details</code>.",
"possible_errors": [
"transactions_target_non_initialised_prepay_meter"
]
},
{
"name": "Validate tax exemption for appropriate account type",
"description": "Validate that the tax exemption is only in place for business accounts.",
"possible_errors": [
"tax_exemptions_provided_for_domestic_account"
]
},
{
"name": "Validate prepay transfer vend read dates match last billed to date",
"description": "Validate that the transfer vend read dates match the last billed to date. This only applies to prepay meters.The last billed to date can be either at the account level or the at the meter/register level. Last billed to dates at the meter/register level take precedent over the account level date if both are provided.",
"possible_errors": [
"prepay_details_on_fully_billed_meter",
"transfer_vend_read_date_must_match_last_billed_to_date"
]
},
{
"name": "Validate that the tariff type and meter point type match",
"description": "Validate that the tariff we have on a given contract matches the meter point type. For example, check eco7 (2-rate) meter points don't have single-rate tariffs or vice versa.",
"possible_errors": [
"tariff_type_does_not_match_meter_point_type"
]
},
{
"name": "Validate bespoke rates",
"description": "Validate that if bespoke rates have been set the account is business.",
"possible_errors": [
"business_fields_provided_for_domestic_accounts"
]
},
{
"name": "Validate billing address provided",
"description": "Validate <code>billing_address1</code> and <code>billing_postcode</code> are provided for non-occupier accounts.",
"possible_errors": [
"billing_address_not_provided"
]
},
{
"name": "Validate current AQ for billable meter point",
"description": "Check that we have a currently valid AQ for a billable MPRN.",
"possible_errors": [
"no_current_or_future_aq_entry_found"
]
},
{
"name": "Validate all billable meter points are covered by agreements in the payload",
"description": "Validate that agreements have been provided for all billable meter points and vice versa for the period covered by Kraken from a billing perspective. A billable meter point is one that has an open-ended or future dated supply end date.",
"possible_errors": [
"meter_point_with_no_agreement",
"meterpoint_with_agreement_not_on_supply"
]
},
{
"name": "Validate transfer readings exist on active gas meters",
"description": "Validate that each active gas meter has a single transfer reading provided.",
"possible_errors": [
"active_gas_meter_with_multiple_transfer_readings",
"active_gas_meter_without_transfer_reading",
"reading_meter_fully_billed"
]
},
{
"name": "Validate EACs provided for active registers",
"description": "Validate that EACs are provided in the <code>eac_history</code> array for each active electricity register. EACs are matched to registers using the <code>tpr</code> field present on both the EAC and register objects.",
"possible_errors": [
"missing_eacs_for_active_register_tpr"
]
},
{
"name": "Validate that prepay meters are matched to agreements of the correct type",
"description": "Validate that each prepay meter has a matching agreement on a prepay tariff, and similarly non-prepay meters on non-prepay tariffs. Note that this validation only applies for active meters and agreements.",
"possible_errors": [
"tariff_type_does_not_match_meter_type"
]
},
{
"name": "Validate each agreement is not effective before the product is available",
"description": "Ensures that the agreement <code>effective_from</code> is not before the datetime the agreement's product is available from. We check this if Kraken will be responsible for billing before the product is available and the product is a variable or tracker product.",
"possible_errors": [
"agreement_effective_from_before_product_available_from"
]
},
{
"name": "Validate that all variable products on a contract have start dates after the product start date",
"description": "Validate that any variable products that are part of a contract only become effective after the product is available.",
"possible_errors": [
"agreement_cannot_start_before_product_available"
]
},
{
"name": "Validate that no meter points are ending supply in the future",
"description": "Ensure that all meters points have either ended supply or are not planned for supply to end.",
"possible_errors": [
"future_supply_end_date"
]
},
{
"name": "Validate that all off supply meter points with meters have a final reading",
"description": "Ensure that all off supply meter points which have meters have a final reading on their end date.",
"possible_errors": [
"no_reading_on_supply_end_date"
]
},
{
"name": "Validate that no billable meter points are starting supply in the future",
"description": "Validate that no billable meter points are set to start supply in the future.",
"possible_errors": [
"future_supply_start_date"
]
},
{
"name": "Validate that all billable meter points have active meters",
"description": "Ensure that all meter points that are billable have active meters or have an unmetered measurement class provided in the payload.",
"possible_errors": [
"meter_point_with_no_meters"
]
},
{
"name": "Validate that at least one of the meter points needs billing",
"description": "Ensure that at least one of the meter points for this account are billable.",
"possible_errors": [
"no_supply_point_on_supply"
]
},
{
"name": "Validate that a domestic account does not have any business only supply points",
"description": "Validate that a domestic account does not have supply points with supply types <code>REGOS_EXPORT_CERTIFICATES</code> or <code>ROCS_EXPORT_CERTIFICATES</code> which are business only supply types.",
"possible_errors": [
"business_supply_type_on_domestic_account"
]
},
{
"name": "Validate business account has account billing options with <code>period_start_day</code> and <code>period_length</code>",
"description": "Validate that business account's <code>account_billing_options</code> include period start day and period length if <code>account_billing_options</code> is being provided. If <code>account_billing_options</code> is not provided then the defaults of 1 for <code>period_start_day</code> and \"MONTHLY\" for <code>period_length</code> will be used.",
"possible_errors": [
"business_account_missing_billing_options"
]
},
{
"name": "Validate that customers provided for business accounts",
"description": "Validate that at least one customer is provided for business accounts. Customers are needed for business accounts to ensure that meter points can be successfully registered for supply.",
"possible_errors": [
"business_account_missing_customers"
]
},
{
"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 transfer readings exist on active electricity registers",
"description": "Validate that each active electricity meter register has a single transfer reading provided.",
"possible_errors": [
"missing_transfer_reading_for_register",
"multiple_transfer_readings_for_register"
]
}
]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 historical statement period end must not be in the future",
"description": "Ensures that the historical statement period end date (last_statement_closing_date or latest transaction_date) is not set in the future.",
"possible_errors": [
"historical_statement_period_end_in_future"
]
},
{
"name": "Validate that terms with supply type matches a supply point supply type",
"description": "Validate that for terms containing a <code>supply_type</code> field that there is a supply point in the payload with a matching <code>supply_type</code>.",
"possible_errors": [
"term_supply_type_mismatch"
]
},
{
"name": "Validate that supply addresses and supply points are provided if account contracts are provided",
"description": "Validate that if <code>account_contracts</code> have been provided that a supply address with supply points has been provided under <code>supply_addresses</code>",
"possible_errors": [
"account_contracts_without_supply_points"
]
},
{
"name": "Validate historical statement billing document identifier presence",
"description": "Ensure that billing document identifiers are only provided for historical statement transactions and only when the relevant feature flag is enabled.",
"possible_errors": [
"historical_statement_billing_document_identifier_missing",
"historical_statement_billing_document_identifier_not_allowed_when_feature_flag_disabled"
]
},
{
"name": "Validate current statement transactions do not provide <code>billing_document_identifier</code>",
"description": "Validate that none of the current statement transactions include a <code>billing_document_identifier</code>, as this field is only applicable to historical statement transactions.",
"possible_errors": [
"billing_document_identifier_not_allowed_for_current_statement_transactions"
]
},
{
"name": "Validate historical statement transaction billing document identifier",
"description": "Ensure that the billing document identifier is the same for all historical statement transactions.",
"possible_errors": [
"historical_statement_billing_document_identifier_mismatch"
]
},
{
"name": "Validate that contract terms' product codes are part of supply agreements",
"description": "Ensure that any contract terms with product references have corresponding products in supply addresses.",
"possible_errors": [
"contract_term_product_code_not_in_agreements"
]
},
{
"name": "Validate that business is provided if enforcing business contracts",
"description": "Validate that the business field is provided if <code>enforce_business_contracts_exist</code> is set to True on the import supplier configuration.",
"possible_errors": [
"business_field_required"
]
},
{
"name": "Validate agreement business contract identifier is declared",
"description": "Validates that an agreement's <code>business_contract_identifier</code>, if provided, is one of the account's declared <code>business_contract_identifiers</code>.",
"possible_errors": [
"agreement_business_contract_identifier_not_declared"
]
},
{
"name": "Validate that the sum of ledger balances equals the transfer balance",
"description": "Validate that the sum of all <code>ledger_balance</code> provided for each ledger in <code>ledgers</code> equals the account-level <code>transfer_balance</code>.",
"possible_errors": [
"ledger_balances_not_equal_to_transfer_balance"
]
},
{
"name": "Validate business user info against customer info",
"description": "Validates that business user information matches the corresponding customer information for basic fields.",
"possible_errors": [
"customer_details_and_user_details_both_provided"
]
},
{
"name": "Validate payment preference <code>ledger_identifier</code>",
"description": "Ensure that the <code>ledger_identifier</code> provided has an equivalent <code>ledger</code> object with the same <code>ledger_identifier</code> .",
"possible_errors": [
"invalid_payment_preference_ledger_identifier"
]
},
{
"name": "Validate that referenced ledgers are unique in payment preferences",
"description": "Ensure that each ledger is referenced in at most one payment preference.",
"possible_errors": [
"duplicate_ledger_in_payment_preferences"
]
},
{
"name": "Validate that valid instruction_identifier provided for <code>ACTIVE_NEW</code> payment preference",
"description": "Ensure that <code>ACTIVE_NEW</code> payment preference has instruction_identifier from </code>payment_instructions</code> object.",
"possible_errors": [
"active_new_payment_preference_invalid_instruction_identifier"
]
},
{
"name": "Validate that the transactions for a voucher do not exceed its value",
"description": "Validate that the sum of all transaction values for a voucher is not greater than the value of the voucher.",
"possible_errors": [
"voucher_transactions_sum_greater_than_voucher_value"
]
},
{
"name": "Validate that each voucher charge transaction id has a matching transaction id within a transaction of type CHARGE",
"description": "Validate that each <code>voucher</code> <code>charge_transaction_id</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CHARGE in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_charge_transaction_id_not_found"
]
},
{
"name": "Validate that each voucher redemption credit transaction id has a matching transaction id within a transaction of type CREDIT",
"description": "Validate that every <code>credit_transaction_id</code> in all <code>voucher_redemptions</code> in every <code>voucher</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CREDIT in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_redemption_credit_transaction_id_not_found"
]
},
{
"name": "Validate parent property references exist",
"description": "Validates that all <code>parent_property_reference</code> values in <code>supply_addresses</code> and <code>properties</code> correspond to a <code>property_external_identifier</code> in the payload. This ensures the property hierarchy is valid.",
"possible_errors": [
"parent_property_reference_not_found"
]
},
{
"name": "Validate that a portfolio lead account has no supply address since it makes no sense for it to have one",
"description": "Validate that a portfolio lead account has no supply address.",
"possible_errors": [
"portfolio_lead_has_a_supply_address"
]
},
{
"name": "Validate that a system account has no supply address",
"description": "Validate that a system account has no supply address",
"possible_errors": [
"system_account_has_a_supply_address"
]
},
{
"name": "Validate 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 that if historical statement transaction are provided then so is a last statement closing date or last billed to date",
"description": "Validate that if <code>historical_statement_transactions</code> are provided in the payload then either a <code>last_statement_closing_date</code> or <code>last_billed_to_date</code> is also provided. If a <code>last_statement_closing_date</code> is not provided then the earliest <code>last_billed_to_date</code> on the account or supply points is used to determine when the last statement should have closed.",
"possible_errors": [
"historical_statement_transactions_without_last_statement_closing_date_or_last_billed_to_date"
]
},
{
"name": "Validate unique transaction IDs",
"description": "Validate that all transaction IDs provided are unique.",
"possible_errors": [
"duplicate_transaction_ids",
"missing_transaction_id"
]
},
{
"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 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 no duplicated ledgers are provided",
"description": "Validate no duplicated ledger codes are in `ledgers` section.",
"possible_errors": [
"duplicate_ledger_entries_found"
]
},
{
"name": "Validate identifiers are unique in ledgers",
"description": "Validate identifier is not declared twice in ledgers.",
"possible_errors": [
"duplicate_identifiers_entries_found"
]
},
{
"name": "Validate ledger identifiers are known",
"description": "Validate ledger identifiers are among supply point identifiers.",
"possible_errors": [
"unknown_ledger_identifiers"
]
},
{
"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 that payment plans and payment schedules for the same ledger are not both in payload",
"description": "Validate that if there are payment plans in the payload, there are not also payment schedules on the same ledger because payment plans create a schedule containing all of the planned payments.",
"possible_errors": [
"payment_plan_and_payment_schedule_not_allowed_on_same_ledger"
]
},
{
"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 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 agreements cover the last billed to date",
"description": "Validate that there is an agreement covering the last billed to date for each supply point.",
"possible_errors": [
"no_agreement_covering_last_billed_to_date"
]
},
{
"name": "Validate debt and debts",
"description": "Validates that both debt and debts are not specified in the payload.",
"possible_errors": [
"debt_and_debts_are_defined"
]
},
{
"name": "Validate that a last billed to date has been provided correctly",
"description": "Validate that, for each meter, a last billed to date has been provided in the appropriate place. For electricity meters, it must be provided on each of the meter's settlement registers. For gas meters, it must be provided on the meter. This validation does not apply to meters with half-hourly billing, or meters that have been exchanged where the new meter has already been billed. This validation is skipped if the account has not yet been billed and therefore has no historical statement data.",
"possible_errors": [
"last_billed_to_date_not_found"
]
},
{
"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. Note that any prepay vend transactions are not included in the above check.",
"possible_errors": [
"current_statement_transaction_before_current_statement_opening_date"
]
},
{
"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. Prepay transactions (those with the <code>to_prepay_meter_serial_number</code> field on the transaction) are filtered out as these are treated separately during account creation.",
"possible_errors": [
"balance_mismatch_on_transfer_balance"
]
},
{
"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>. Prepay transactions (those with the <code>to_prepay_meter_serial_number</code> field on the transaction) are filtered out as these are treated separately during account creation.",
"possible_errors": [
"historical_statement_transactions_balance_mismatch"
]
},
{
"name": "Validate next bill due date provided for quarterly billing",
"description": "Validate that if <code>use_industry_billing</code> is false in the account billing options and the <code>period_length</code> is <code>QUARTERLY</code>, then a <code>next_bill_due_date</code> is provided.",
"possible_errors": [
"next_bill_to_date_not_provided_for_quarterly_billing"
]
},
{
"name": "Validate account billing options",
"description": "Validate that account billing options have only been provided for business accounts.",
"possible_errors": [
"account_billing_options_provided_for_domestic_accounts"
]
},
{
"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 prepay transactions target initialised prepay meters",
"description": "Validate that if <code>current_statement_transactions</code> or <code>historical_statement_transactions</code> target a prepay meter (i.e. has the <code>to_prepay_meter_serial_number</code> field), then a prepay meter with that serial number exists in the payload. A prepay meter is identified in the payload by the presence of <code>prepay_details</code>.",
"possible_errors": [
"transactions_target_non_initialised_prepay_meter"
]
},
{
"name": "Validate tax exemption for appropriate account type",
"description": "Validate that the tax exemption is only in place for business accounts.",
"possible_errors": [
"tax_exemptions_provided_for_domestic_account"
]
},
{
"name": "Validate prepay transfer vend read dates match last billed to date",
"description": "Validate that the transfer vend read dates match the last billed to date. This only applies to prepay meters.The last billed to date can be either at the account level or the at the meter/register level. Last billed to dates at the meter/register level take precedent over the account level date if both are provided.",
"possible_errors": [
"prepay_details_on_fully_billed_meter",
"transfer_vend_read_date_must_match_last_billed_to_date"
]
},
{
"name": "Validate that the tariff type and meter point type match",
"description": "Validate that the tariff we have on a given contract matches the meter point type. For example, check eco7 (2-rate) meter points don't have single-rate tariffs or vice versa.",
"possible_errors": [
"tariff_type_does_not_match_meter_point_type"
]
},
{
"name": "Validate bespoke rates",
"description": "Validate that if bespoke rates have been set the account is business.",
"possible_errors": [
"business_fields_provided_for_domestic_accounts"
]
},
{
"name": "Validate billing address provided",
"description": "Validate <code>billing_address1</code> and <code>billing_postcode</code> are provided for non-occupier accounts.",
"possible_errors": [
"billing_address_not_provided"
]
},
{
"name": "Validate current AQ for billable meter point",
"description": "Check that we have a currently valid AQ for a billable MPRN.",
"possible_errors": [
"no_current_or_future_aq_entry_found"
]
},
{
"name": "Validate all billable meter points are covered by agreements in the payload",
"description": "Validate that agreements have been provided for all billable meter points and vice versa for the period covered by Kraken from a billing perspective. A billable meter point is one that has an open-ended or future dated supply end date.",
"possible_errors": [
"meter_point_with_no_agreement",
"meterpoint_with_agreement_not_on_supply"
]
},
{
"name": "Validate transfer readings exist on active gas meters",
"description": "Validate that each active gas meter has a single transfer reading provided.",
"possible_errors": [
"active_gas_meter_with_multiple_transfer_readings",
"active_gas_meter_without_transfer_reading",
"reading_meter_fully_billed"
]
},
{
"name": "Validate EACs provided for active registers",
"description": "Validate that EACs are provided in the <code>eac_history</code> array for each active electricity register. EACs are matched to registers using the <code>tpr</code> field present on both the EAC and register objects.",
"possible_errors": [
"missing_eacs_for_active_register_tpr"
]
},
{
"name": "Validate that prepay meters are matched to agreements of the correct type",
"description": "Validate that each prepay meter has a matching agreement on a prepay tariff, and similarly non-prepay meters on non-prepay tariffs. Note that this validation only applies for active meters and agreements.",
"possible_errors": [
"tariff_type_does_not_match_meter_type"
]
},
{
"name": "Validate each agreement is not effective before the product is available",
"description": "Ensures that the agreement <code>effective_from</code> is not before the datetime the agreement's product is available from. We check this if Kraken will be responsible for billing before the product is available and the product is a variable or tracker product.",
"possible_errors": [
"agreement_effective_from_before_product_available_from"
]
},
{
"name": "Validate that all variable products on a contract have start dates after the product start date",
"description": "Validate that any variable products that are part of a contract only become effective after the product is available.",
"possible_errors": [
"agreement_cannot_start_before_product_available"
]
},
{
"name": "Validate that no meter points are ending supply in the future",
"description": "Ensure that all meters points have either ended supply or are not planned for supply to end.",
"possible_errors": [
"future_supply_end_date"
]
},
{
"name": "Validate that all off supply meter points with meters have a final reading",
"description": "Ensure that all off supply meter points which have meters have a final reading on their end date.",
"possible_errors": [
"no_reading_on_supply_end_date"
]
},
{
"name": "Validate that no billable meter points are starting supply in the future",
"description": "Validate that no billable meter points are set to start supply in the future.",
"possible_errors": [
"future_supply_start_date"
]
},
{
"name": "Validate that all billable meter points have active meters",
"description": "Ensure that all meter points that are billable have active meters or have an unmetered measurement class provided in the payload.",
"possible_errors": [
"meter_point_with_no_meters"
]
},
{
"name": "Validate that at least one of the meter points needs billing",
"description": "Ensure that at least one of the meter points for this account are billable.",
"possible_errors": [
"no_supply_point_on_supply"
]
},
{
"name": "Validate that a domestic account does not have any business only supply points",
"description": "Validate that a domestic account does not have supply points with supply types <code>REGOS_EXPORT_CERTIFICATES</code> or <code>ROCS_EXPORT_CERTIFICATES</code> which are business only supply types.",
"possible_errors": [
"business_supply_type_on_domestic_account"
]
},
{
"name": "Validate business account has account billing options with <code>period_start_day</code> and <code>period_length</code>",
"description": "Validate that business account's <code>account_billing_options</code> include period start day and period length if <code>account_billing_options</code> is being provided. If <code>account_billing_options</code> is not provided then the defaults of 1 for <code>period_start_day</code> and \"MONTHLY\" for <code>period_length</code> will be used.",
"possible_errors": [
"business_account_missing_billing_options"
]
},
{
"name": "Validate that customers provided for business accounts",
"description": "Validate that at least one customer is provided for business accounts. Customers are needed for business accounts to ensure that meter points can be successfully registered for supply.",
"possible_errors": [
"business_account_missing_customers"
]
},
{
"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 transfer readings exist on active electricity registers",
"description": "Validate that each active electricity meter register has a single transfer reading provided.",
"possible_errors": [
"missing_transfer_reading_for_register",
"multiple_transfer_readings_for_register"
]
}
]2 July 2026
Old
{
"maxItems": 1
}30 June 2026
No attributes to display
New
[
{
"name": "Ensures only <code>user_details</code> or <code>details</code> are provided",
"description": "Ensures that only <code>user_details</code> or <code>details</code> are provided, not both.",
"possible_errors": [
"customer_details_and_user_details_both_provided"
]
},
{
"name": "Validate no contact details for occupier",
"description": "Validates that a customer identified as \"The Occupier\" does not have contact details. If contact details are provided it implies that the identity of the customer is known, and it therefore not an unknown occupier.",
"possible_errors": [
"contact_details_for_occupier"
]
},
{
"name": "Validate that the customer's name is not \"The Occupier\"",
"description": "Validate that the customer's name is not \"The Occupier\". To indicate an occupier account, use the <code>unknown_occupier</code> flag at the account-level.",
"possible_errors": [
"customer_may_not_be_named_the_occupier"
]
},
{
"name": "Validate metadata",
"description": "Validate that metadata, which is a list of key value pairs, does not contain duplicate keys.",
"possible_errors": [
"metadata_has_duplicate_keys"
]
},
{
"name": "Validate user role",
"description": "Validates that at least one user role is provided through <code>portfolio_roles</code> or <code>account_roles</code>.",
"possible_errors": [
"required_user_role"
]
},
{
"name": "Validate exclusive role assignment",
"description": "Validates that an exclusively-assignable role is not assigned to a user alongside any other role, whether in the same payload or already held by the user.",
"possible_errors": [
"customer_has_exclusive_role_conflict"
]
},
{
"name": "Validate that <code>\u2068customer_preferences\u2069</code> and <code>\u2068consents\u2069</code> are not both provided",
"description": "Validate that \u2068customer_preferences\u2069 and \u2068consents\u2069 are not both provided.",
"possible_errors": [
"fields_are_mutually_exclusive"
]
}
]Old
[
{
"name": "Ensures only <code>user_details</code> or <code>details</code> are provided",
"description": "Ensures that only <code>user_details</code> or <code>details</code> are provided, not both.",
"possible_errors": [
"customer_details_and_user_details_both_provided"
]
},
{
"name": "Validate no contact details for occupier",
"description": "Validates that a customer identified as \"The Occupier\" does not have contact details. If contact details are provided it implies that the identity of the customer is known, and it therefore not an unknown occupier.",
"possible_errors": [
"contact_details_for_occupier"
]
},
{
"name": "Validate that the customer's name is not \"The Occupier\"",
"description": "Validate that the customer's name is not \"The Occupier\". To indicate an occupier account, use the <code>unknown_occupier</code> flag at the account-level.",
"possible_errors": [
"customer_may_not_be_named_the_occupier"
]
},
{
"name": "Validate metadata",
"description": "Validate that metadata, which is a list of key value pairs, does not contain duplicate keys.",
"possible_errors": [
"metadata_has_duplicate_keys"
]
},
{
"name": "Validate user role",
"description": "Validates that at least one user role is provided through <code>portfolio_roles</code> or <code>account_roles</code>.",
"possible_errors": [
"required_user_role"
]
},
{
"name": "Validate that <code>\u2068customer_preferences\u2069</code> and <code>\u2068consents\u2069</code> are not both provided",
"description": "Validate that \u2068customer_preferences\u2069 and \u2068consents\u2069 are not both provided.",
"possible_errors": [
"fields_are_mutually_exclusive"
]
}
]
No attributes to display
No attributes to display
26 June 2026
New
[
{
"name": "Validate portfolio reference provided correctly",
"description": "Validate that a portfolio reference is provided if portfolio settings have been provided and that a portfolio reference is not provided if the import supplier is set to create new portfolios.",
"possible_errors": [
"portfolio_references_missing",
"portfolio_references_provided"
]
},
{
"name": "Validate no duplicate portfolio reference namespaces",
"description": "Validate that there are no duplicate portfolio reference namespaces in the payload.",
"possible_errors": [
"duplicate_portfolio_references"
]
}
]Old
[
{
"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"
]
}
]New
[
{
"name": "Validate portfolio reference provided correctly",
"description": "Validate that a portfolio reference is provided if portfolio settings have been provided and that a portfolio reference is not provided if the import supplier is set to create new portfolios.",
"possible_errors": [
"portfolio_references_missing",
"portfolio_references_provided"
]
},
{
"name": "Validate no duplicate portfolio reference namespaces",
"description": "Validate that there are no duplicate portfolio reference namespaces in the payload.",
"possible_errors": [
"duplicate_portfolio_references"
]
}
]Old
[
{
"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"
]
}
]23 June 2026
New
{
"x-enum-descriptions": {
"collections_process_test": "Collections Process Test"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"Collections Process Test": "Collections Process Test"
}
}Old
{
"x-enum-descriptions": {}
}
No attributes to display
22 June 2026
New
[
{
"name": "Validate that business information is provided if not linking account to business with contract",
"description": "Validate that business information is provided for the business to link the account to if <code>link_account_to_business_with_contract</code> is false for the given import supplier.",
"possible_errors": [
"business_information_required_if_not_linking_via_contract"
]
},
{
"name": "Validate that business information is not provided if linking an account to the business of the business contract.",
"description": "Validate that business information is not provided for the business to link the account to if <code>link_account_to_business_with_contract</code> is true for the given import supplier.",
"possible_errors": [
"business_information_not_required_if_linking_via_contract"
]
},
{
"name": "Validate that at least one contract identifier is provided for import",
"description": "Validate that at least one of <code>business_contract_identifiers</code> or <code>business_contract_identifier</code> is provided in the payload.",
"possible_errors": [
"missing_contract_identifier"
]
}
]Old
[
{
"name": "Validate that values are unique in Kraken for unique registered keys",
"description": "Validate that keys with unique constraints do not already have provided value in Kraken.",
"possible_errors": [
"business_detail_value_exists_for_unique_key"
]
},
{
"name": "Validate that business information is provided if not linking account to business with contract",
"description": "Validate that business information is provided for the business to link the account to if <code>link_account_to_business_with_contract</code> is false for the given import supplier.",
"possible_errors": [
"business_information_required_if_not_linking_via_contract"
]
},
{
"name": "Validate that business information is not provided if linking an account to the business of the business contract.",
"description": "Validate that business information is not provided for the business to link the account to if <code>link_account_to_business_with_contract</code> is true for the given import supplier.",
"possible_errors": [
"business_information_not_required_if_linking_via_contract"
]
},
{
"name": "Validate that at least one contract identifier is provided for import",
"description": "Validate that at least one of <code>business_contract_identifiers</code> or <code>business_contract_identifier</code> is provided in the payload.",
"possible_errors": [
"missing_contract_identifier"
]
}
]
No attributes to display
19 June 2026
No attributes to display
18 June 2026
No attributes to display
New
{
"gbr-gas.payment-method": "#/components/schemas/Gbr-gas.payment-methodCharacteristic"
}New
[
{
"$ref": "#/components/schemas/Gbr-gas.meter-point-grid-supply-point-equivalentCharacteristic"
},
{
"$ref": "#/components/schemas/Gbr-gas.payment-methodCharacteristic"
},
{
"$ref": "#/components/schemas/Gbr-electricity.meter-rate-profileCharacteristic"
},
{
"$ref": "#/components/schemas/SalesChannelCharacteristic"
},
{
"$ref": "#/components/schemas/Gbr-electricity.payment-methodCharacteristic"
},
{
"$ref": "#/components/schemas/MaximumCapacityCharacteristic"
}
]Old
[
{
"$ref": "#/components/schemas/MaximumCapacityCharacteristic"
},
{
"$ref": "#/components/schemas/Gbr-electricity.meter-rate-profileCharacteristic"
},
{
"$ref": "#/components/schemas/SalesChannelCharacteristic"
},
{
"$ref": "#/components/schemas/Gbr-electricity.payment-methodCharacteristic"
},
{
"$ref": "#/components/schemas/Gbr-gas.meter-point-grid-supply-point-equivalentCharacteristic"
}
]
No attributes to display
New
{
"gbr-gas.meter-point-grid-supply-point-equivalent": "#/components/schemas/Gbr-gas.meter-point-grid-supply-point-equivalentCharacteristic"
}New
[
{
"$ref": "#/components/schemas/Gbr-electricity.payment-methodCharacteristic"
},
{
"$ref": "#/components/schemas/MaximumCapacityCharacteristic"
},
{
"$ref": "#/components/schemas/Gbr-gas.meter-point-grid-supply-point-equivalentCharacteristic"
},
{
"$ref": "#/components/schemas/SalesChannelCharacteristic"
},
{
"$ref": "#/components/schemas/Gbr-electricity.meter-rate-profileCharacteristic"
}
]Old
[
{
"$ref": "#/components/schemas/Gbr-electricity.payment-methodCharacteristic"
},
{
"$ref": "#/components/schemas/SalesChannelCharacteristic"
},
{
"$ref": "#/components/schemas/Gbr-electricity.meter-rate-profileCharacteristic"
},
{
"$ref": "#/components/schemas/MaximumCapacityCharacteristic"
}
]17 June 2026
No attributes to display
15 June 2026
No attributes to display
No attributes to display
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 historical statement period end must not be in the future",
"description": "Ensures that the historical statement period end date (last_statement_closing_date or latest transaction_date) is not set in the future.",
"possible_errors": [
"historical_statement_period_end_in_future"
]
},
{
"name": "Validate that terms with supply type matches a supply point supply type",
"description": "Validate that for terms containing a <code>supply_type</code> field that there is a supply point in the payload with a matching <code>supply_type</code>.",
"possible_errors": [
"term_supply_type_mismatch"
]
},
{
"name": "Validate that supply addresses and supply points are provided if account contracts are provided",
"description": "Validate that if <code>account_contracts</code> have been provided that a supply address with supply points has been provided under <code>supply_addresses</code>",
"possible_errors": [
"account_contracts_without_supply_points"
]
},
{
"name": "Validate historical statement billing document identifier presence",
"description": "Ensure that billing document identifiers are only provided for historical statement transactions and only when the relevant feature flag is enabled.",
"possible_errors": [
"historical_statement_billing_document_identifier_missing",
"historical_statement_billing_document_identifier_not_allowed_when_feature_flag_disabled"
]
},
{
"name": "Validate current statement transactions do not provide <code>billing_document_identifier</code>",
"description": "Validate that none of the current statement transactions include a <code>billing_document_identifier</code>, as this field is only applicable to historical statement transactions.",
"possible_errors": [
"billing_document_identifier_not_allowed_for_current_statement_transactions"
]
},
{
"name": "Validate historical statement transaction billing document identifier",
"description": "Ensure that the billing document identifier is the same for all historical statement transactions.",
"possible_errors": [
"historical_statement_billing_document_identifier_mismatch"
]
},
{
"name": "Validate that contract terms' product codes are part of supply agreements",
"description": "Ensure that any contract terms with product references have corresponding products in supply addresses.",
"possible_errors": [
"contract_term_product_code_not_in_agreements"
]
},
{
"name": "Validate that business is provided if enforcing business contracts",
"description": "Validate that the business field is provided if <code>enforce_business_contracts_exist</code> is set to True on the import supplier configuration.",
"possible_errors": [
"business_field_required"
]
},
{
"name": "Validate agreement business contract identifier is declared",
"description": "Validates that an agreement's <code>business_contract_identifier</code>, if provided, is one of the account's declared <code>business_contract_identifiers</code>.",
"possible_errors": [
"agreement_business_contract_identifier_not_declared"
]
},
{
"name": "Validate that the sum of ledger balances equals the transfer balance",
"description": "Validate that the sum of all <code>ledger_balance</code> provided for each ledger in <code>ledgers</code> equals the account-level <code>transfer_balance</code>.",
"possible_errors": [
"ledger_balances_not_equal_to_transfer_balance"
]
},
{
"name": "Validate business user info against customer info",
"description": "Validates that business user information matches the corresponding customer information for basic fields.",
"possible_errors": [
"customer_details_and_user_details_both_provided"
]
},
{
"name": "Validate payment preference <code>ledger_identifier</code>",
"description": "Ensure that the <code>ledger_identifier</code> provided has an equivalent <code>ledger</code> object with the same <code>ledger_identifier</code> .",
"possible_errors": [
"invalid_payment_preference_ledger_identifier"
]
},
{
"name": "Validate that referenced ledgers are unique in payment preferences",
"description": "Ensure that each ledger is referenced in at most one payment preference.",
"possible_errors": [
"duplicate_ledger_in_payment_preferences"
]
},
{
"name": "Validate that valid instruction_identifier provided for <code>ACTIVE_NEW</code> payment preference",
"description": "Ensure that <code>ACTIVE_NEW</code> payment preference has instruction_identifier from </code>payment_instructions</code> object.",
"possible_errors": [
"active_new_payment_preference_invalid_instruction_identifier"
]
},
{
"name": "Validate that the transactions for a voucher do not exceed its value",
"description": "Validate that the sum of all transaction values for a voucher is not greater than the value of the voucher.",
"possible_errors": [
"voucher_transactions_sum_greater_than_voucher_value"
]
},
{
"name": "Validate that each voucher charge transaction id has a matching transaction id within a transaction of type CHARGE",
"description": "Validate that each <code>voucher</code> <code>charge_transaction_id</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CHARGE in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_charge_transaction_id_not_found"
]
},
{
"name": "Validate that each voucher redemption credit transaction id has a matching transaction id within a transaction of type CREDIT",
"description": "Validate that every <code>credit_transaction_id</code> in all <code>voucher_redemptions</code> in every <code>voucher</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CREDIT in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_redemption_credit_transaction_id_not_found"
]
},
{
"name": "Validate parent property references exist",
"description": "Validates that all <code>parent_property_reference</code> values in <code>supply_addresses</code> and <code>properties</code> correspond to a <code>property_external_identifier</code> in the payload. This ensures the property hierarchy is valid.",
"possible_errors": [
"parent_property_reference_not_found"
]
},
{
"name": "Validate that a portfolio lead account has no supply address since it makes no sense for it to have one",
"description": "Validate that a portfolio lead account has no supply address.",
"possible_errors": [
"portfolio_lead_has_a_supply_address"
]
},
{
"name": "Validate that a system account has no supply address",
"description": "Validate that a system account has no supply address",
"possible_errors": [
"system_account_has_a_supply_address"
]
},
{
"name": "Validate 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 that if historical statement transaction are provided then so is a last statement closing date or last billed to date",
"description": "Validate that if <code>historical_statement_transactions</code> are provided in the payload then either a <code>last_statement_closing_date</code> or <code>last_billed_to_date</code> is also provided. If a <code>last_statement_closing_date</code> is not provided then the earliest <code>last_billed_to_date</code> on the account or supply points is used to determine when the last statement should have closed.",
"possible_errors": [
"historical_statement_transactions_without_last_statement_closing_date_or_last_billed_to_date"
]
},
{
"name": "Validate unique transaction IDs",
"description": "Validate that all transaction IDs provided are unique.",
"possible_errors": [
"duplicate_transaction_ids",
"missing_transaction_id"
]
},
{
"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 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 no duplicated ledgers are provided",
"description": "Validate no duplicated ledger codes are in `ledgers` section.",
"possible_errors": [
"duplicate_ledger_entries_found"
]
},
{
"name": "Validate identifiers are unique in ledgers",
"description": "Validate identifier is not declared twice in ledgers.",
"possible_errors": [
"duplicate_identifiers_entries_found"
]
},
{
"name": "Validate ledger identifiers are known",
"description": "Validate ledger identifiers are among supply point identifiers.",
"possible_errors": [
"unknown_ledger_identifiers"
]
},
{
"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 that payment plans and payment schedules for the same ledger are not both in payload",
"description": "Validate that if there are payment plans in the payload, there are not also payment schedules on the same ledger because payment plans create a schedule containing all of the planned payments.",
"possible_errors": [
"payment_plan_and_payment_schedule_not_allowed_on_same_ledger"
]
},
{
"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 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 agreements cover the last billed to date",
"description": "Validate that there is an agreement covering the last billed to date for each supply point.",
"possible_errors": [
"no_agreement_covering_last_billed_to_date"
]
},
{
"name": "Validate debt and debts",
"description": "Validates that both debt and debts are not specified in the payload.",
"possible_errors": [
"debt_and_debts_are_defined"
]
},
{
"name": "Validate that a last billed to date has been provided correctly",
"description": "Validate that, for each meter, a last billed to date has been provided in the appropriate place. For electricity meters, it must be provided on each of the meter's settlement registers. For gas meters, it must be provided on the meter. This validation does not apply to meters with half-hourly billing, or meters that have been exchanged where the new meter has already been billed. This validation is skipped if the account has not yet been billed and therefore has no historical statement data.",
"possible_errors": [
"last_billed_to_date_not_found"
]
},
{
"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. Note that any prepay vend transactions are not included in the above check.",
"possible_errors": [
"current_statement_transaction_before_current_statement_opening_date"
]
},
{
"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. Prepay transactions (those with the <code>to_prepay_meter_serial_number</code> field on the transaction) are filtered out as these are treated separately during account creation.",
"possible_errors": [
"balance_mismatch_on_transfer_balance"
]
},
{
"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>. Prepay transactions (those with the <code>to_prepay_meter_serial_number</code> field on the transaction) are filtered out as these are treated separately during account creation.",
"possible_errors": [
"historical_statement_transactions_balance_mismatch"
]
},
{
"name": "Validate next bill due date provided for quarterly billing",
"description": "Validate that if <code>use_industry_billing</code> is false in the account billing options and the <code>period_length</code> is <code>QUARTERLY</code>, then a <code>next_bill_due_date</code> is provided.",
"possible_errors": [
"next_bill_to_date_not_provided_for_quarterly_billing"
]
},
{
"name": "Validate account billing options",
"description": "Validate that account billing options have only been provided for business accounts.",
"possible_errors": [
"account_billing_options_provided_for_domestic_accounts"
]
},
{
"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 prepay transactions target initialised prepay meters",
"description": "Validate that if <code>current_statement_transactions</code> or <code>historical_statement_transactions</code> target a prepay meter (i.e. has the <code>to_prepay_meter_serial_number</code> field), then a prepay meter with that serial number exists in the payload. A prepay meter is identified in the payload by the presence of <code>prepay_details</code>.",
"possible_errors": [
"transactions_target_non_initialised_prepay_meter"
]
},
{
"name": "Validate tax exemption for appropriate account type",
"description": "Validate that the tax exemption is only in place for business accounts.",
"possible_errors": [
"tax_exemptions_provided_for_domestic_account"
]
},
{
"name": "Validate prepay transfer vend read dates match last billed to date",
"description": "Validate that the transfer vend read dates match the last billed to date. This only applies to prepay meters.The last billed to date can be either at the account level or the at the meter/register level. Last billed to dates at the meter/register level take precedent over the account level date if both are provided.",
"possible_errors": [
"prepay_details_on_fully_billed_meter",
"transfer_vend_read_date_must_match_last_billed_to_date"
]
},
{
"name": "Validate that the tariff type and meter point type match",
"description": "Validate that the tariff we have on a given contract matches the meter point type. For example, check eco7 (2-rate) meter points don't have single-rate tariffs or vice versa.",
"possible_errors": [
"tariff_type_does_not_match_meter_point_type"
]
},
{
"name": "Validate bespoke rates",
"description": "Validate that if bespoke rates have been set the account is business.",
"possible_errors": [
"business_fields_provided_for_domestic_accounts"
]
},
{
"name": "Validate billing address provided",
"description": "Validate <code>billing_address1</code> and <code>billing_postcode</code> are provided for non-occupier accounts.",
"possible_errors": [
"billing_address_not_provided"
]
},
{
"name": "Validate current AQ for billable meter point",
"description": "Check that we have a currently valid AQ for a billable MPRN.",
"possible_errors": [
"no_current_or_future_aq_entry_found"
]
},
{
"name": "Validate all billable meter points are covered by agreements in the payload",
"description": "Validate that agreements have been provided for all billable meter points and vice versa for the period covered by Kraken from a billing perspective. A billable meter point is one that has an open-ended or future dated supply end date.",
"possible_errors": [
"meter_point_with_no_agreement",
"meterpoint_with_agreement_not_on_supply"
]
},
{
"name": "Validate transfer readings exist on active gas meters",
"description": "Validate that each active gas meter has a single transfer reading provided.",
"possible_errors": [
"active_gas_meter_with_multiple_transfer_readings",
"active_gas_meter_without_transfer_reading",
"reading_meter_fully_billed"
]
},
{
"name": "Validate EACs provided for active registers",
"description": "Validate that EACs are provided in the <code>eac_history</code> array for each active electricity register. EACs are matched to registers using the <code>tpr</code> field present on both the EAC and register objects.",
"possible_errors": [
"missing_eacs_for_active_register_tpr"
]
},
{
"name": "Validate that prepay meters are matched to agreements of the correct type",
"description": "Validate that each prepay meter has a matching agreement on a prepay tariff, and similarly non-prepay meters on non-prepay tariffs. Note that this validation only applies for active meters and agreements.",
"possible_errors": [
"tariff_type_does_not_match_meter_type"
]
},
{
"name": "Validate each agreement is not effective before the product is available",
"description": "Ensures that the agreement <code>effective_from</code> is not before the datetime the agreement's product is available from. We check this if Kraken will be responsible for billing before the product is available and the product is a variable or tracker product.",
"possible_errors": [
"agreement_effective_from_before_product_available_from"
]
},
{
"name": "Validate that all variable products on a contract have start dates after the product start date",
"description": "Validate that any variable products that are part of a contract only become effective after the product is available.",
"possible_errors": [
"agreement_cannot_start_before_product_available"
]
},
{
"name": "Validate that no meter points are ending supply in the future",
"description": "Ensure that all meters points have either ended supply or are not planned for supply to end.",
"possible_errors": [
"future_supply_end_date"
]
},
{
"name": "Validate that all off supply meter points with meters have a final reading",
"description": "Ensure that all off supply meter points which have meters have a final reading on their end date.",
"possible_errors": [
"no_reading_on_supply_end_date"
]
},
{
"name": "Validate that no billable meter points are starting supply in the future",
"description": "Validate that no billable meter points are set to start supply in the future.",
"possible_errors": [
"future_supply_start_date"
]
},
{
"name": "Validate that all billable meter points have active meters",
"description": "Ensure that all meter points that are billable have active meters or have an unmetered measurement class provided in the payload.",
"possible_errors": [
"meter_point_with_no_meters"
]
},
{
"name": "Validate that at least one of the meter points needs billing",
"description": "Ensure that at least one of the meter points for this account are billable.",
"possible_errors": [
"no_supply_point_on_supply"
]
},
{
"name": "Validate that a domestic account does not have any business only supply points",
"description": "Validate that a domestic account does not have supply points with supply types <code>REGOS_EXPORT_CERTIFICATES</code> or <code>ROCS_EXPORT_CERTIFICATES</code> which are business only supply types.",
"possible_errors": [
"business_supply_type_on_domestic_account"
]
},
{
"name": "Validate business account has account billing options with <code>period_start_day</code> and <code>period_length</code>",
"description": "Validate that business account's <code>account_billing_options</code> include period start day and period length if <code>account_billing_options</code> is being provided. If <code>account_billing_options</code> is not provided then the defaults of 1 for <code>period_start_day</code> and \"MONTHLY\" for <code>period_length</code> will be used.",
"possible_errors": [
"business_account_missing_billing_options"
]
},
{
"name": "Validate that customers provided for business accounts",
"description": "Validate that at least one customer is provided for business accounts. Customers are needed for business accounts to ensure that meter points can be successfully registered for supply.",
"possible_errors": [
"business_account_missing_customers"
]
},
{
"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 transfer readings exist on active electricity registers",
"description": "Validate that each active electricity meter register has a single transfer reading provided.",
"possible_errors": [
"missing_transfer_reading_for_register",
"multiple_transfer_readings_for_register"
]
}
]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 historical statement period end must not be in the future",
"description": "Ensures that the historical statement period end date (last_statement_closing_date or latest transaction_date) is not set in the future.",
"possible_errors": [
"historical_statement_period_end_in_future"
]
},
{
"name": "Validate that terms with supply type matches a supply point supply type",
"description": "Validate that for terms containing a <code>supply_type</code> field that there is a supply point in the payload with a matching <code>supply_type</code>.",
"possible_errors": [
"term_supply_type_mismatch"
]
},
{
"name": "Validate that supply addresses and supply points are provided if account contracts are provided",
"description": "Validate that if <code>account_contracts</code> have been provided that a supply address with supply points has been provided under <code>supply_addresses</code>",
"possible_errors": [
"account_contracts_without_supply_points"
]
},
{
"name": "Validate historical statement billing document identifier presence",
"description": "Ensure that billing document identifiers are only provided for historical statement transactions and only when the relevant feature flag is enabled.",
"possible_errors": [
"historical_statement_billing_document_identifier_missing",
"historical_statement_billing_document_identifier_not_allowed_when_feature_flag_disabled"
]
},
{
"name": "Validate current statement transactions do not provide <code>billing_document_identifier</code>",
"description": "Validate that none of the current statement transactions include a <code>billing_document_identifier</code>, as this field is only applicable to historical statement transactions.",
"possible_errors": [
"billing_document_identifier_not_allowed_for_current_statement_transactions"
]
},
{
"name": "Validate historical statement transaction billing document identifier",
"description": "Ensure that the billing document identifier is the same for all historical statement transactions.",
"possible_errors": [
"historical_statement_billing_document_identifier_mismatch"
]
},
{
"name": "Validate that contract terms' product codes are part of supply agreements",
"description": "Ensure that any contract terms with product references have corresponding products in supply addresses.",
"possible_errors": [
"contract_term_product_code_not_in_agreements"
]
},
{
"name": "Validate that business is provided if enforcing business contracts",
"description": "Validate that the business field is provided if <code>enforce_business_contracts_exist</code> is set to True on the import supplier configuration.",
"possible_errors": [
"business_field_required"
]
},
{
"name": "Validate that the sum of ledger balances equals the transfer balance",
"description": "Validate that the sum of all <code>ledger_balance</code> provided for each ledger in <code>ledgers</code> equals the account-level <code>transfer_balance</code>.",
"possible_errors": [
"ledger_balances_not_equal_to_transfer_balance"
]
},
{
"name": "Validate business user info against customer info",
"description": "Validates that business user information matches the corresponding customer information for basic fields.",
"possible_errors": [
"customer_details_and_user_details_both_provided"
]
},
{
"name": "Validate payment preference <code>ledger_identifier</code>",
"description": "Ensure that the <code>ledger_identifier</code> provided has an equivalent <code>ledger</code> object with the same <code>ledger_identifier</code> .",
"possible_errors": [
"invalid_payment_preference_ledger_identifier"
]
},
{
"name": "Validate that referenced ledgers are unique in payment preferences",
"description": "Ensure that each ledger is referenced in at most one payment preference.",
"possible_errors": [
"duplicate_ledger_in_payment_preferences"
]
},
{
"name": "Validate that valid instruction_identifier provided for <code>ACTIVE_NEW</code> payment preference",
"description": "Ensure that <code>ACTIVE_NEW</code> payment preference has instruction_identifier from </code>payment_instructions</code> object.",
"possible_errors": [
"active_new_payment_preference_invalid_instruction_identifier"
]
},
{
"name": "Validate that the transactions for a voucher do not exceed its value",
"description": "Validate that the sum of all transaction values for a voucher is not greater than the value of the voucher.",
"possible_errors": [
"voucher_transactions_sum_greater_than_voucher_value"
]
},
{
"name": "Validate that each voucher charge transaction id has a matching transaction id within a transaction of type CHARGE",
"description": "Validate that each <code>voucher</code> <code>charge_transaction_id</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CHARGE in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_charge_transaction_id_not_found"
]
},
{
"name": "Validate that each voucher redemption credit transaction id has a matching transaction id within a transaction of type CREDIT",
"description": "Validate that every <code>credit_transaction_id</code> in all <code>voucher_redemptions</code> in every <code>voucher</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CREDIT in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_redemption_credit_transaction_id_not_found"
]
},
{
"name": "Validate parent property references exist",
"description": "Validates that all <code>parent_property_reference</code> values in <code>supply_addresses</code> and <code>properties</code> correspond to a <code>property_external_identifier</code> in the payload. This ensures the property hierarchy is valid.",
"possible_errors": [
"parent_property_reference_not_found"
]
},
{
"name": "Validate that a portfolio lead account has no supply address since it makes no sense for it to have one",
"description": "Validate that a portfolio lead account has no supply address.",
"possible_errors": [
"portfolio_lead_has_a_supply_address"
]
},
{
"name": "Validate that a system account has no supply address",
"description": "Validate that a system account has no supply address",
"possible_errors": [
"system_account_has_a_supply_address"
]
},
{
"name": "Validate 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 that if historical statement transaction are provided then so is a last statement closing date or last billed to date",
"description": "Validate that if <code>historical_statement_transactions</code> are provided in the payload then either a <code>last_statement_closing_date</code> or <code>last_billed_to_date</code> is also provided. If a <code>last_statement_closing_date</code> is not provided then the earliest <code>last_billed_to_date</code> on the account or supply points is used to determine when the last statement should have closed.",
"possible_errors": [
"historical_statement_transactions_without_last_statement_closing_date_or_last_billed_to_date"
]
},
{
"name": "Validate unique transaction IDs",
"description": "Validate that all transaction IDs provided are unique.",
"possible_errors": [
"duplicate_transaction_ids",
"missing_transaction_id"
]
},
{
"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 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 no duplicated ledgers are provided",
"description": "Validate no duplicated ledger codes are in `ledgers` section.",
"possible_errors": [
"duplicate_ledger_entries_found"
]
},
{
"name": "Validate identifiers are unique in ledgers",
"description": "Validate identifier is not declared twice in ledgers.",
"possible_errors": [
"duplicate_identifiers_entries_found"
]
},
{
"name": "Validate ledger identifiers are known",
"description": "Validate ledger identifiers are among supply point identifiers.",
"possible_errors": [
"unknown_ledger_identifiers"
]
},
{
"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 that payment plans and payment schedules for the same ledger are not both in payload",
"description": "Validate that if there are payment plans in the payload, there are not also payment schedules on the same ledger because payment plans create a schedule containing all of the planned payments.",
"possible_errors": [
"payment_plan_and_payment_schedule_not_allowed_on_same_ledger"
]
},
{
"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 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 agreements cover the last billed to date",
"description": "Validate that there is an agreement covering the last billed to date for each supply point.",
"possible_errors": [
"no_agreement_covering_last_billed_to_date"
]
},
{
"name": "Validate debt and debts",
"description": "Validates that both debt and debts are not specified in the payload.",
"possible_errors": [
"debt_and_debts_are_defined"
]
},
{
"name": "Validate that a last billed to date has been provided correctly",
"description": "Validate that, for each meter, a last billed to date has been provided in the appropriate place. For electricity meters, it must be provided on each of the meter's settlement registers. For gas meters, it must be provided on the meter. This validation does not apply to meters with half-hourly billing, or meters that have been exchanged where the new meter has already been billed. This validation is skipped if the account has not yet been billed and therefore has no historical statement data.",
"possible_errors": [
"last_billed_to_date_not_found"
]
},
{
"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. Note that any prepay vend transactions are not included in the above check.",
"possible_errors": [
"current_statement_transaction_before_current_statement_opening_date"
]
},
{
"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. Prepay transactions (those with the <code>to_prepay_meter_serial_number</code> field on the transaction) are filtered out as these are treated separately during account creation.",
"possible_errors": [
"balance_mismatch_on_transfer_balance"
]
},
{
"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>. Prepay transactions (those with the <code>to_prepay_meter_serial_number</code> field on the transaction) are filtered out as these are treated separately during account creation.",
"possible_errors": [
"historical_statement_transactions_balance_mismatch"
]
},
{
"name": "Validate next bill due date provided for quarterly billing",
"description": "Validate that if <code>use_industry_billing</code> is false in the account billing options and the <code>period_length</code> is <code>QUARTERLY</code>, then a <code>next_bill_due_date</code> is provided.",
"possible_errors": [
"next_bill_to_date_not_provided_for_quarterly_billing"
]
},
{
"name": "Validate account billing options",
"description": "Validate that account billing options have only been provided for business accounts.",
"possible_errors": [
"account_billing_options_provided_for_domestic_accounts"
]
},
{
"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 prepay transactions target initialised prepay meters",
"description": "Validate that if <code>current_statement_transactions</code> or <code>historical_statement_transactions</code> target a prepay meter (i.e. has the <code>to_prepay_meter_serial_number</code> field), then a prepay meter with that serial number exists in the payload. A prepay meter is identified in the payload by the presence of <code>prepay_details</code>.",
"possible_errors": [
"transactions_target_non_initialised_prepay_meter"
]
},
{
"name": "Validate tax exemption for appropriate account type",
"description": "Validate that the tax exemption is only in place for business accounts.",
"possible_errors": [
"tax_exemptions_provided_for_domestic_account"
]
},
{
"name": "Validate prepay transfer vend read dates match last billed to date",
"description": "Validate that the transfer vend read dates match the last billed to date. This only applies to prepay meters.The last billed to date can be either at the account level or the at the meter/register level. Last billed to dates at the meter/register level take precedent over the account level date if both are provided.",
"possible_errors": [
"prepay_details_on_fully_billed_meter",
"transfer_vend_read_date_must_match_last_billed_to_date"
]
},
{
"name": "Validate that the tariff type and meter point type match",
"description": "Validate that the tariff we have on a given contract matches the meter point type. For example, check eco7 (2-rate) meter points don't have single-rate tariffs or vice versa.",
"possible_errors": [
"tariff_type_does_not_match_meter_point_type"
]
},
{
"name": "Validate bespoke rates",
"description": "Validate that if bespoke rates have been set the account is business.",
"possible_errors": [
"business_fields_provided_for_domestic_accounts"
]
},
{
"name": "Validate billing address provided",
"description": "Validate <code>billing_address1</code> and <code>billing_postcode</code> are provided for non-occupier accounts.",
"possible_errors": [
"billing_address_not_provided"
]
},
{
"name": "Validate current AQ for billable meter point",
"description": "Check that we have a currently valid AQ for a billable MPRN.",
"possible_errors": [
"no_current_or_future_aq_entry_found"
]
},
{
"name": "Validate all billable meter points are covered by agreements in the payload",
"description": "Validate that agreements have been provided for all billable meter points and vice versa for the period covered by Kraken from a billing perspective. A billable meter point is one that has an open-ended or future dated supply end date.",
"possible_errors": [
"meter_point_with_no_agreement",
"meterpoint_with_agreement_not_on_supply"
]
},
{
"name": "Validate transfer readings exist on active gas meters",
"description": "Validate that each active gas meter has a single transfer reading provided.",
"possible_errors": [
"active_gas_meter_with_multiple_transfer_readings",
"active_gas_meter_without_transfer_reading",
"reading_meter_fully_billed"
]
},
{
"name": "Validate EACs provided for active registers",
"description": "Validate that EACs are provided in the <code>eac_history</code> array for each active electricity register. EACs are matched to registers using the <code>tpr</code> field present on both the EAC and register objects.",
"possible_errors": [
"missing_eacs_for_active_register_tpr"
]
},
{
"name": "Validate that prepay meters are matched to agreements of the correct type",
"description": "Validate that each prepay meter has a matching agreement on a prepay tariff, and similarly non-prepay meters on non-prepay tariffs. Note that this validation only applies for active meters and agreements.",
"possible_errors": [
"tariff_type_does_not_match_meter_type"
]
},
{
"name": "Validate each agreement is not effective before the product is available",
"description": "Ensures that the agreement <code>effective_from</code> is not before the datetime the agreement's product is available from. We check this if Kraken will be responsible for billing before the product is available and the product is a variable or tracker product.",
"possible_errors": [
"agreement_effective_from_before_product_available_from"
]
},
{
"name": "Validate that all variable products on a contract have start dates after the product start date",
"description": "Validate that any variable products that are part of a contract only become effective after the product is available.",
"possible_errors": [
"agreement_cannot_start_before_product_available"
]
},
{
"name": "Validate that no meter points are ending supply in the future",
"description": "Ensure that all meters points have either ended supply or are not planned for supply to end.",
"possible_errors": [
"future_supply_end_date"
]
},
{
"name": "Validate that all off supply meter points with meters have a final reading",
"description": "Ensure that all off supply meter points which have meters have a final reading on their end date.",
"possible_errors": [
"no_reading_on_supply_end_date"
]
},
{
"name": "Validate that no billable meter points are starting supply in the future",
"description": "Validate that no billable meter points are set to start supply in the future.",
"possible_errors": [
"future_supply_start_date"
]
},
{
"name": "Validate that all billable meter points have active meters",
"description": "Ensure that all meter points that are billable have active meters or have an unmetered measurement class provided in the payload.",
"possible_errors": [
"meter_point_with_no_meters"
]
},
{
"name": "Validate that at least one of the meter points needs billing",
"description": "Ensure that at least one of the meter points for this account are billable.",
"possible_errors": [
"no_supply_point_on_supply"
]
},
{
"name": "Validate that a domestic account does not have any business only supply points",
"description": "Validate that a domestic account does not have supply points with supply types <code>REGOS_EXPORT_CERTIFICATES</code> or <code>ROCS_EXPORT_CERTIFICATES</code> which are business only supply types.",
"possible_errors": [
"business_supply_type_on_domestic_account"
]
},
{
"name": "Validate business account has account billing options with <code>period_start_day</code> and <code>period_length</code>",
"description": "Validate that business account's <code>account_billing_options</code> include period start day and period length if <code>account_billing_options</code> is being provided. If <code>account_billing_options</code> is not provided then the defaults of 1 for <code>period_start_day</code> and \"MONTHLY\" for <code>period_length</code> will be used.",
"possible_errors": [
"business_account_missing_billing_options"
]
},
{
"name": "Validate that customers provided for business accounts",
"description": "Validate that at least one customer is provided for business accounts. Customers are needed for business accounts to ensure that meter points can be successfully registered for supply.",
"possible_errors": [
"business_account_missing_customers"
]
},
{
"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 transfer readings exist on active electricity registers",
"description": "Validate that each active electricity meter register has a single transfer reading provided.",
"possible_errors": [
"missing_transfer_reading_for_register",
"multiple_transfer_readings_for_register"
]
}
]
No attributes to display
12 June 2026
No attributes to display
No attributes to display
9 June 2026
New
{
"x-enum-descriptions": {
"trad_mode": "Traditional Mode"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"Traditional Mode": "Traditional Mode"
}
}Old
{
"x-enum-descriptions": {}
}4 June 2026
No attributes to display
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 historical statement period end must not be in the future",
"description": "Ensures that the historical statement period end date (last_statement_closing_date or latest transaction_date) is not set in the future.",
"possible_errors": [
"historical_statement_period_end_in_future"
]
},
{
"name": "Validate that terms with supply type matches a supply point supply type",
"description": "Validate that for terms containing a <code>supply_type</code> field that there is a supply point in the payload with a matching <code>supply_type</code>.",
"possible_errors": [
"term_supply_type_mismatch"
]
},
{
"name": "Validate that supply addresses and supply points are provided if account contracts are provided",
"description": "Validate that if <code>account_contracts</code> have been provided that a supply address with supply points has been provided under <code>supply_addresses</code>",
"possible_errors": [
"account_contracts_without_supply_points"
]
},
{
"name": "Validate historical statement billing document identifier presence",
"description": "Ensure that billing document identifiers are only provided for historical statement transactions and only when the relevant feature flag is enabled.",
"possible_errors": [
"historical_statement_billing_document_identifier_missing",
"historical_statement_billing_document_identifier_not_allowed_when_feature_flag_disabled"
]
},
{
"name": "Validate current statement transactions do not provide <code>billing_document_identifier</code>",
"description": "Validate that none of the current statement transactions include a <code>billing_document_identifier</code>, as this field is only applicable to historical statement transactions.",
"possible_errors": [
"billing_document_identifier_not_allowed_for_current_statement_transactions"
]
},
{
"name": "Validate historical statement transaction billing document identifier",
"description": "Ensure that the billing document identifier is the same for all historical statement transactions.",
"possible_errors": [
"historical_statement_billing_document_identifier_mismatch"
]
},
{
"name": "Validate that contract terms' product codes are part of supply agreements",
"description": "Ensure that any contract terms with product references have corresponding products in supply addresses.",
"possible_errors": [
"contract_term_product_code_not_in_agreements"
]
},
{
"name": "Validate that business is provided if enforcing business contracts",
"description": "Validate that the business field is provided if <code>enforce_business_contracts_exist</code> is set to True on the import supplier configuration.",
"possible_errors": [
"business_field_required"
]
},
{
"name": "Validate that the sum of ledger balances equals the transfer balance",
"description": "Validate that the sum of all <code>ledger_balance</code> provided for each ledger in <code>ledgers</code> equals the account-level <code>transfer_balance</code>.",
"possible_errors": [
"ledger_balances_not_equal_to_transfer_balance"
]
},
{
"name": "Validate business user info against customer info",
"description": "Validates that business user information matches the corresponding customer information for basic fields.",
"possible_errors": [
"customer_details_and_user_details_both_provided"
]
},
{
"name": "Validate payment preference <code>ledger_identifier</code>",
"description": "Ensure that the <code>ledger_identifier</code> provided has an equivalent <code>ledger</code> object with the same <code>ledger_identifier</code> .",
"possible_errors": [
"invalid_payment_preference_ledger_identifier"
]
},
{
"name": "Validate that referenced ledgers are unique in payment preferences",
"description": "Ensure that each ledger is referenced in at most one payment preference.",
"possible_errors": [
"duplicate_ledger_in_payment_preferences"
]
},
{
"name": "Validate that valid instruction_identifier provided for <code>ACTIVE_NEW</code> payment preference",
"description": "Ensure that <code>ACTIVE_NEW</code> payment preference has instruction_identifier from </code>payment_instructions</code> object.",
"possible_errors": [
"active_new_payment_preference_invalid_instruction_identifier"
]
},
{
"name": "Validate that the transactions for a voucher do not exceed its value",
"description": "Validate that the sum of all transaction values for a voucher is not greater than the value of the voucher.",
"possible_errors": [
"voucher_transactions_sum_greater_than_voucher_value"
]
},
{
"name": "Validate that each voucher charge transaction id has a matching transaction id within a transaction of type CHARGE",
"description": "Validate that each <code>voucher</code> <code>charge_transaction_id</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CHARGE in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_charge_transaction_id_not_found"
]
},
{
"name": "Validate that each voucher redemption credit transaction id has a matching transaction id within a transaction of type CREDIT",
"description": "Validate that every <code>credit_transaction_id</code> in all <code>voucher_redemptions</code> in every <code>voucher</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CREDIT in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_redemption_credit_transaction_id_not_found"
]
},
{
"name": "Validate parent property references exist",
"description": "Validates that all <code>parent_property_reference</code> values in <code>supply_addresses</code> and <code>properties</code> correspond to a <code>property_external_identifier</code> in the payload. This ensures the property hierarchy is valid.",
"possible_errors": [
"parent_property_reference_not_found"
]
},
{
"name": "Validate that a portfolio lead account has no supply address since it makes no sense for it to have one",
"description": "Validate that a portfolio lead account has no supply address.",
"possible_errors": [
"portfolio_lead_has_a_supply_address"
]
},
{
"name": "Validate that a system account has no supply address",
"description": "Validate that a system account has no supply address",
"possible_errors": [
"system_account_has_a_supply_address"
]
},
{
"name": "Validate 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 that if historical statement transaction are provided then so is a last statement closing date or last billed to date",
"description": "Validate that if <code>historical_statement_transactions</code> are provided in the payload then either a <code>last_statement_closing_date</code> or <code>last_billed_to_date</code> is also provided. If a <code>last_statement_closing_date</code> is not provided then the earliest <code>last_billed_to_date</code> on the account or supply points is used to determine when the last statement should have closed.",
"possible_errors": [
"historical_statement_transactions_without_last_statement_closing_date_or_last_billed_to_date"
]
},
{
"name": "Validate unique transaction IDs",
"description": "Validate that all transaction IDs provided are unique.",
"possible_errors": [
"duplicate_transaction_ids",
"missing_transaction_id"
]
},
{
"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 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 no duplicated ledgers are provided",
"description": "Validate no duplicated ledger codes are in `ledgers` section.",
"possible_errors": [
"duplicate_ledger_entries_found"
]
},
{
"name": "Validate identifiers are unique in ledgers",
"description": "Validate identifier is not declared twice in ledgers.",
"possible_errors": [
"duplicate_identifiers_entries_found"
]
},
{
"name": "Validate ledger identifiers are known",
"description": "Validate ledger identifiers are among supply point identifiers.",
"possible_errors": [
"unknown_ledger_identifiers"
]
},
{
"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 that payment plans and payment schedules for the same ledger are not both in payload",
"description": "Validate that if there are payment plans in the payload, there are not also payment schedules on the same ledger because payment plans create a schedule containing all of the planned payments.",
"possible_errors": [
"payment_plan_and_payment_schedule_not_allowed_on_same_ledger"
]
},
{
"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 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 agreements cover the last billed to date",
"description": "Validate that there is an agreement covering the last billed to date for each supply point.",
"possible_errors": [
"no_agreement_covering_last_billed_to_date"
]
},
{
"name": "Validate debt and debts",
"description": "Validates that both debt and debts are not specified in the payload.",
"possible_errors": [
"debt_and_debts_are_defined"
]
},
{
"name": "Validate that a last billed to date has been provided correctly",
"description": "Validate that, for each meter, a last billed to date has been provided in the appropriate place. For electricity meters, it must be provided on each of the meter's settlement registers. For gas meters, it must be provided on the meter. This validation does not apply to meters with half-hourly billing, or meters that have been exchanged where the new meter has already been billed. This validation is skipped if the account has not yet been billed and therefore has no historical statement data.",
"possible_errors": [
"last_billed_to_date_not_found"
]
},
{
"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. Note that any prepay vend transactions are not included in the above check.",
"possible_errors": [
"current_statement_transaction_before_current_statement_opening_date"
]
},
{
"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. Prepay transactions (those with the <code>to_prepay_meter_serial_number</code> field on the transaction) are filtered out as these are treated separately during account creation.",
"possible_errors": [
"balance_mismatch_on_transfer_balance"
]
},
{
"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>. Prepay transactions (those with the <code>to_prepay_meter_serial_number</code> field on the transaction) are filtered out as these are treated separately during account creation.",
"possible_errors": [
"historical_statement_transactions_balance_mismatch"
]
},
{
"name": "Validate next bill due date provided for quarterly billing",
"description": "Validate that if <code>use_industry_billing</code> is false in the account billing options and the <code>period_length</code> is <code>QUARTERLY</code>, then a <code>next_bill_due_date</code> is provided.",
"possible_errors": [
"next_bill_to_date_not_provided_for_quarterly_billing"
]
},
{
"name": "Validate account billing options",
"description": "Validate that account billing options have only been provided for business accounts.",
"possible_errors": [
"account_billing_options_provided_for_domestic_accounts"
]
},
{
"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 prepay transactions target initialised prepay meters",
"description": "Validate that if <code>current_statement_transactions</code> or <code>historical_statement_transactions</code> target a prepay meter (i.e. has the <code>to_prepay_meter_serial_number</code> field), then a prepay meter with that serial number exists in the payload. A prepay meter is identified in the payload by the presence of <code>prepay_details</code>.",
"possible_errors": [
"transactions_target_non_initialised_prepay_meter"
]
},
{
"name": "Validate tax exemption for appropriate account type",
"description": "Validate that the tax exemption is only in place for business accounts.",
"possible_errors": [
"tax_exemptions_provided_for_domestic_account"
]
},
{
"name": "Validate prepay transfer vend read dates match last billed to date",
"description": "Validate that the transfer vend read dates match the last billed to date. This only applies to prepay meters.The last billed to date can be either at the account level or the at the meter/register level. Last billed to dates at the meter/register level take precedent over the account level date if both are provided.",
"possible_errors": [
"prepay_details_on_fully_billed_meter",
"transfer_vend_read_date_must_match_last_billed_to_date"
]
},
{
"name": "Validate that the tariff type and meter point type match",
"description": "Validate that the tariff we have on a given contract matches the meter point type. For example, check eco7 (2-rate) meter points don't have single-rate tariffs or vice versa.",
"possible_errors": [
"tariff_type_does_not_match_meter_point_type"
]
},
{
"name": "Validate bespoke rates",
"description": "Validate that if bespoke rates have been set the account is business.",
"possible_errors": [
"business_fields_provided_for_domestic_accounts"
]
},
{
"name": "Validate billing address provided",
"description": "Validate <code>billing_address1</code> and <code>billing_postcode</code> are provided for non-occupier accounts.",
"possible_errors": [
"billing_address_not_provided"
]
},
{
"name": "Validate current AQ for billable meter point",
"description": "Check that we have a currently valid AQ for a billable MPRN.",
"possible_errors": [
"no_current_or_future_aq_entry_found"
]
},
{
"name": "Validate all billable meter points are covered by agreements in the payload",
"description": "Validate that agreements have been provided for all billable meter points and vice versa for the period covered by Kraken from a billing perspective. A billable meter point is one that has an open-ended or future dated supply end date.",
"possible_errors": [
"meter_point_with_no_agreement",
"meterpoint_with_agreement_not_on_supply"
]
},
{
"name": "Validate transfer readings exist on active gas meters",
"description": "Validate that each active gas meter has a single transfer reading provided.",
"possible_errors": [
"active_gas_meter_with_multiple_transfer_readings",
"active_gas_meter_without_transfer_reading",
"reading_meter_fully_billed"
]
},
{
"name": "Validate EACs provided for active registers",
"description": "Validate that EACs are provided in the <code>eac_history</code> array for each active electricity register. EACs are matched to registers using the <code>tpr</code> field present on both the EAC and register objects.",
"possible_errors": [
"missing_eacs_for_active_register_tpr"
]
},
{
"name": "Validate that prepay meters are matched to agreements of the correct type",
"description": "Validate that each prepay meter has a matching agreement on a prepay tariff, and similarly non-prepay meters on non-prepay tariffs. Note that this validation only applies for active meters and agreements.",
"possible_errors": [
"tariff_type_does_not_match_meter_type"
]
},
{
"name": "Validate each agreement is not effective before the product is available",
"description": "Ensures that the agreement <code>effective_from</code> is not before the datetime the agreement's product is available from. We check this if Kraken will be responsible for billing before the product is available and the product is a variable or tracker product.",
"possible_errors": [
"agreement_effective_from_before_product_available_from"
]
},
{
"name": "Validate that all variable products on a contract have start dates after the product start date",
"description": "Validate that any variable products that are part of a contract only become effective after the product is available.",
"possible_errors": [
"agreement_cannot_start_before_product_available"
]
},
{
"name": "Validate that no meter points are ending supply in the future",
"description": "Ensure that all meters points have either ended supply or are not planned for supply to end.",
"possible_errors": [
"future_supply_end_date"
]
},
{
"name": "Validate that all off supply meter points with meters have a final reading",
"description": "Ensure that all off supply meter points which have meters have a final reading on their end date.",
"possible_errors": [
"no_reading_on_supply_end_date"
]
},
{
"name": "Validate that no billable meter points are starting supply in the future",
"description": "Validate that no billable meter points are set to start supply in the future.",
"possible_errors": [
"future_supply_start_date"
]
},
{
"name": "Validate that all billable meter points have active meters",
"description": "Ensure that all meter points that are billable have active meters or have an unmetered measurement class provided in the payload.",
"possible_errors": [
"meter_point_with_no_meters"
]
},
{
"name": "Validate that at least one of the meter points needs billing",
"description": "Ensure that at least one of the meter points for this account are billable.",
"possible_errors": [
"no_supply_point_on_supply"
]
},
{
"name": "Validate that a domestic account does not have any business only supply points",
"description": "Validate that a domestic account does not have supply points with supply types <code>REGOS_EXPORT_CERTIFICATES</code> or <code>ROCS_EXPORT_CERTIFICATES</code> which are business only supply types.",
"possible_errors": [
"business_supply_type_on_domestic_account"
]
},
{
"name": "Validate business account has account billing options with <code>period_start_day</code> and <code>period_length</code>",
"description": "Validate that business account's <code>account_billing_options</code> include period start day and period length if <code>account_billing_options</code> is being provided. If <code>account_billing_options</code> is not provided then the defaults of 1 for <code>period_start_day</code> and \"MONTHLY\" for <code>period_length</code> will be used.",
"possible_errors": [
"business_account_missing_billing_options"
]
},
{
"name": "Validate that customers provided for business accounts",
"description": "Validate that at least one customer is provided for business accounts. Customers are needed for business accounts to ensure that meter points can be successfully registered for supply.",
"possible_errors": [
"business_account_missing_customers"
]
},
{
"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 transfer readings exist on active electricity registers",
"description": "Validate that each active electricity meter register has a single transfer reading provided.",
"possible_errors": [
"missing_transfer_reading_for_register",
"multiple_transfer_readings_for_register"
]
}
]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 historical statement period end must not be in the future",
"description": "Ensures that the historical statement period end date (last_statement_closing_date or latest transaction_date) is not set in the future.",
"possible_errors": [
"historical_statement_period_end_in_future"
]
},
{
"name": "Validate that terms with supply type matches a supply point supply type",
"description": "Validate that for terms containing a <code>supply_type</code> field that there is a supply point in the payload with a matching <code>supply_type</code>.",
"possible_errors": [
"term_supply_type_mismatch"
]
},
{
"name": "Validate that supply addresses and supply points are provided if account contracts are provided",
"description": "Validate that if <code>account_contracts</code> have been provided that a supply address with supply points has been provided under <code>supply_addresses</code>",
"possible_errors": [
"account_contracts_without_supply_points"
]
},
{
"name": "Validate historical statement billing document identifier presence",
"description": "Ensure that billing document identifiers are only provided for historical statement transactions and only when the relevant feature flag is enabled.",
"possible_errors": [
"historical_statement_billing_document_identifier_missing",
"historical_statement_billing_document_identifier_not_allowed_when_feature_flag_disabled"
]
},
{
"name": "Validate current statement transactions do not provide <code>billing_document_identifier</code>",
"description": "Validate that none of the current statement transactions include a <code>billing_document_identifier</code>, as this field is only applicable to historical statement transactions.",
"possible_errors": [
"billing_document_identifier_not_allowed_for_current_statement_transactions"
]
},
{
"name": "Validate historical statement transaction billing document identifier",
"description": "Ensure that the billing document identifier is the same for all historical statement transactions.",
"possible_errors": [
"historical_statement_billing_document_identifier_mismatch"
]
},
{
"name": "Validate that contract terms' product codes are part of supply agreements",
"description": "Ensure that any contract terms with product references have corresponding products in supply addresses.",
"possible_errors": [
"contract_term_product_code_not_in_agreements"
]
},
{
"name": "Validate that business is provided if enforcing business contracts",
"description": "Validate that the business field is provided if <code>enforce_business_contracts_exist</code> is set to True on the import supplier configuration.",
"possible_errors": [
"business_field_required"
]
},
{
"name": "Validate that the sum of ledger balances equals the transfer balance",
"description": "Validate that the sum of all <code>ledger_balance</code> provided for each ledger in <code>ledgers</code> equals the account-level <code>transfer_balance</code>.",
"possible_errors": [
"ledger_balances_not_equal_to_transfer_balance"
]
},
{
"name": "Validate business user info against customer info",
"description": "Validates that business user information matches the corresponding customer information for basic fields.",
"possible_errors": [
"customer_details_and_user_details_both_provided"
]
},
{
"name": "Validate payment preference <code>ledger_identifier</code>",
"description": "Ensure that the <code>ledger_identifier</code> provided has an equivalent <code>ledger</code> object with the same <code>ledger_identifier</code> .",
"possible_errors": [
"invalid_payment_preference_ledger_identifier"
]
},
{
"name": "Validate that referenced ledgers are unique in payment preferences",
"description": "Ensure that each ledger is referenced in at most one payment preference.",
"possible_errors": [
"duplicate_ledger_in_payment_preferences"
]
},
{
"name": "Validate that valid instruction_identifier provided for <code>ACTIVE_NEW</code> payment preference",
"description": "Ensure that <code>ACTIVE_NEW</code> payment preference has instruction_identifier from </code>payment_instructions</code> object.",
"possible_errors": [
"active_new_payment_preference_invalid_instruction_identifier"
]
},
{
"name": "Validate that the transactions for a voucher do not exceed its value",
"description": "Validate that the sum of all transaction values for a voucher is not greater than the value of the voucher.",
"possible_errors": [
"voucher_transactions_sum_greater_than_voucher_value"
]
},
{
"name": "Validate that each voucher charge transaction id has a matching transaction id within a transaction of type CHARGE",
"description": "Validate that each <code>voucher</code> <code>charge_transaction_id</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CHARGE in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_charge_transaction_id_not_found"
]
},
{
"name": "Validate that each voucher redemption credit transaction id has a matching transaction id within a transaction of type CREDIT",
"description": "Validate that every <code>credit_transaction_id</code> in all <code>voucher_redemptions</code> in every <code>voucher</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CREDIT in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_redemption_credit_transaction_id_not_found"
]
},
{
"name": "Validate parent property references exist",
"description": "Validates that all <code>parent_property_reference</code> values in <code>supply_addresses</code> and <code>properties</code> correspond to a <code>property_external_identifier</code> in the payload. This ensures the property hierarchy is valid.",
"possible_errors": [
"parent_property_reference_not_found"
]
},
{
"name": "Validate that 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 that if historical statement transaction are provided then so is a last statement closing date or last billed to date",
"description": "Validate that if <code>historical_statement_transactions</code> are provided in the payload then either a <code>last_statement_closing_date</code> or <code>last_billed_to_date</code> is also provided. If a <code>last_statement_closing_date</code> is not provided then the earliest <code>last_billed_to_date</code> on the account or supply points is used to determine when the last statement should have closed.",
"possible_errors": [
"historical_statement_transactions_without_last_statement_closing_date_or_last_billed_to_date"
]
},
{
"name": "Validate unique transaction IDs",
"description": "Validate that all transaction IDs provided are unique.",
"possible_errors": [
"duplicate_transaction_ids",
"missing_transaction_id"
]
},
{
"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 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 no duplicated ledgers are provided",
"description": "Validate no duplicated ledger codes are in `ledgers` section.",
"possible_errors": [
"duplicate_ledger_entries_found"
]
},
{
"name": "Validate identifiers are unique in ledgers",
"description": "Validate identifier is not declared twice in ledgers.",
"possible_errors": [
"duplicate_identifiers_entries_found"
]
},
{
"name": "Validate ledger identifiers are known",
"description": "Validate ledger identifiers are among supply point identifiers.",
"possible_errors": [
"unknown_ledger_identifiers"
]
},
{
"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 that payment plans and payment schedules for the same ledger are not both in payload",
"description": "Validate that if there are payment plans in the payload, there are not also payment schedules on the same ledger because payment plans create a schedule containing all of the planned payments.",
"possible_errors": [
"payment_plan_and_payment_schedule_not_allowed_on_same_ledger"
]
},
{
"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 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 agreements cover the last billed to date",
"description": "Validate that there is an agreement covering the last billed to date for each supply point.",
"possible_errors": [
"no_agreement_covering_last_billed_to_date"
]
},
{
"name": "Validate debt and debts",
"description": "Validates that both debt and debts are not specified in the payload.",
"possible_errors": [
"debt_and_debts_are_defined"
]
},
{
"name": "Validate that a last billed to date has been provided correctly",
"description": "Validate that, for each meter, a last billed to date has been provided in the appropriate place. For electricity meters, it must be provided on each of the meter's settlement registers. For gas meters, it must be provided on the meter. This validation does not apply to meters with half-hourly billing, or meters that have been exchanged where the new meter has already been billed. This validation is skipped if the account has not yet been billed and therefore has no historical statement data.",
"possible_errors": [
"last_billed_to_date_not_found"
]
},
{
"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. Note that any prepay vend transactions are not included in the above check.",
"possible_errors": [
"current_statement_transaction_before_current_statement_opening_date"
]
},
{
"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. Prepay transactions (those with the <code>to_prepay_meter_serial_number</code> field on the transaction) are filtered out as these are treated separately during account creation.",
"possible_errors": [
"balance_mismatch_on_transfer_balance"
]
},
{
"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>. Prepay transactions (those with the <code>to_prepay_meter_serial_number</code> field on the transaction) are filtered out as these are treated separately during account creation.",
"possible_errors": [
"historical_statement_transactions_balance_mismatch"
]
},
{
"name": "Validate next bill due date provided for quarterly billing",
"description": "Validate that if <code>use_industry_billing</code> is false in the account billing options and the <code>period_length</code> is <code>QUARTERLY</code>, then a <code>next_bill_due_date</code> is provided.",
"possible_errors": [
"next_bill_to_date_not_provided_for_quarterly_billing"
]
},
{
"name": "Validate account billing options",
"description": "Validate that account billing options have only been provided for business accounts.",
"possible_errors": [
"account_billing_options_provided_for_domestic_accounts"
]
},
{
"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 prepay transactions target initialised prepay meters",
"description": "Validate that if <code>current_statement_transactions</code> or <code>historical_statement_transactions</code> target a prepay meter (i.e. has the <code>to_prepay_meter_serial_number</code> field), then a prepay meter with that serial number exists in the payload. A prepay meter is identified in the payload by the presence of <code>prepay_details</code>.",
"possible_errors": [
"transactions_target_non_initialised_prepay_meter"
]
},
{
"name": "Validate tax exemption for appropriate account type",
"description": "Validate that the tax exemption is only in place for business accounts.",
"possible_errors": [
"tax_exemptions_provided_for_domestic_account"
]
},
{
"name": "Validate prepay transfer vend read dates match last billed to date",
"description": "Validate that the transfer vend read dates match the last billed to date. This only applies to prepay meters.The last billed to date can be either at the account level or the at the meter/register level. Last billed to dates at the meter/register level take precedent over the account level date if both are provided.",
"possible_errors": [
"prepay_details_on_fully_billed_meter",
"transfer_vend_read_date_must_match_last_billed_to_date"
]
},
{
"name": "Validate that the tariff type and meter point type match",
"description": "Validate that the tariff we have on a given contract matches the meter point type. For example, check eco7 (2-rate) meter points don't have single-rate tariffs or vice versa.",
"possible_errors": [
"tariff_type_does_not_match_meter_point_type"
]
},
{
"name": "Validate bespoke rates",
"description": "Validate that if bespoke rates have been set the account is business.",
"possible_errors": [
"business_fields_provided_for_domestic_accounts"
]
},
{
"name": "Validate billing address provided",
"description": "Validate <code>billing_address1</code> and <code>billing_postcode</code> are provided for non-occupier accounts.",
"possible_errors": [
"billing_address_not_provided"
]
},
{
"name": "Validate current AQ for billable meter point",
"description": "Check that we have a currently valid AQ for a billable MPRN.",
"possible_errors": [
"no_current_or_future_aq_entry_found"
]
},
{
"name": "Validate all billable meter points are covered by agreements in the payload",
"description": "Validate that agreements have been provided for all billable meter points and vice versa for the period covered by Kraken from a billing perspective. A billable meter point is one that has an open-ended or future dated supply end date.",
"possible_errors": [
"meter_point_with_no_agreement",
"meterpoint_with_agreement_not_on_supply"
]
},
{
"name": "Validate transfer readings exist on active gas meters",
"description": "Validate that each active gas meter has a single transfer reading provided.",
"possible_errors": [
"active_gas_meter_with_multiple_transfer_readings",
"active_gas_meter_without_transfer_reading",
"reading_meter_fully_billed"
]
},
{
"name": "Validate EACs provided for active registers",
"description": "Validate that EACs are provided in the <code>eac_history</code> array for each active electricity register. EACs are matched to registers using the <code>tpr</code> field present on both the EAC and register objects.",
"possible_errors": [
"missing_eacs_for_active_register_tpr"
]
},
{
"name": "Validate that prepay meters are matched to agreements of the correct type",
"description": "Validate that each prepay meter has a matching agreement on a prepay tariff, and similarly non-prepay meters on non-prepay tariffs. Note that this validation only applies for active meters and agreements.",
"possible_errors": [
"tariff_type_does_not_match_meter_type"
]
},
{
"name": "Validate each agreement is not effective before the product is available",
"description": "Ensures that the agreement <code>effective_from</code> is not before the datetime the agreement's product is available from. We check this if Kraken will be responsible for billing before the product is available and the product is a variable or tracker product.",
"possible_errors": [
"agreement_effective_from_before_product_available_from"
]
},
{
"name": "Validate that all variable products on a contract have start dates after the product start date",
"description": "Validate that any variable products that are part of a contract only become effective after the product is available.",
"possible_errors": [
"agreement_cannot_start_before_product_available"
]
},
{
"name": "Validate that no meter points are ending supply in the future",
"description": "Ensure that all meters points have either ended supply or are not planned for supply to end.",
"possible_errors": [
"future_supply_end_date"
]
},
{
"name": "Validate that all off supply meter points with meters have a final reading",
"description": "Ensure that all off supply meter points which have meters have a final reading on their end date.",
"possible_errors": [
"no_reading_on_supply_end_date"
]
},
{
"name": "Validate that no billable meter points are starting supply in the future",
"description": "Validate that no billable meter points are set to start supply in the future.",
"possible_errors": [
"future_supply_start_date"
]
},
{
"name": "Validate that all billable meter points have active meters",
"description": "Ensure that all meter points that are billable have active meters or have an unmetered measurement class provided in the payload.",
"possible_errors": [
"meter_point_with_no_meters"
]
},
{
"name": "Validate that at least one of the meter points needs billing",
"description": "Ensure that at least one of the meter points for this account are billable.",
"possible_errors": [
"no_supply_point_on_supply"
]
},
{
"name": "Validate that a domestic account does not have any business only supply points",
"description": "Validate that a domestic account does not have supply points with supply types <code>REGOS_EXPORT_CERTIFICATES</code> or <code>ROCS_EXPORT_CERTIFICATES</code> which are business only supply types.",
"possible_errors": [
"business_supply_type_on_domestic_account"
]
},
{
"name": "Validate business account has account billing options with <code>period_start_day</code> and <code>period_length</code>",
"description": "Validate that business account's <code>account_billing_options</code> include period start day and period length if <code>account_billing_options</code> is being provided. If <code>account_billing_options</code> is not provided then the defaults of 1 for <code>period_start_day</code> and \"MONTHLY\" for <code>period_length</code> will be used.",
"possible_errors": [
"business_account_missing_billing_options"
]
},
{
"name": "Validate that customers provided for business accounts",
"description": "Validate that at least one customer is provided for business accounts. Customers are needed for business accounts to ensure that meter points can be successfully registered for supply.",
"possible_errors": [
"business_account_missing_customers"
]
},
{
"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 transfer readings exist on active electricity registers",
"description": "Validate that each active electricity meter register has a single transfer reading provided.",
"possible_errors": [
"missing_transfer_reading_for_register",
"multiple_transfer_readings_for_register"
]
}
]New
{
"x-enum-descriptions": {
"SYSTEM": "System"
}
}Old
{
"x-enum-descriptions": {}
}2 June 2026
New
{
"x-validators": [
{
"name": "Validate that the market participant exists",
"description": "Validate that the market participant ID passed in the payload exists in Kraken.",
"possible_errors": [
"market_participant_not_found",
"supply_type_not_recognised"
]
}
]
}24 May 2026
No attributes to display
No attributes to display
No attributes to display
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 historical statement period end must not be in the future",
"description": "Ensures that the historical statement period end date (last_statement_closing_date or latest transaction_date) is not set in the future.",
"possible_errors": [
"historical_statement_period_end_in_future"
]
},
{
"name": "Validate that terms with supply type matches a supply point supply type",
"description": "Validate that for terms containing a <code>supply_type</code> field that there is a supply point in the payload with a matching <code>supply_type</code>.",
"possible_errors": [
"term_supply_type_mismatch"
]
},
{
"name": "Validate that supply addresses and supply points are provided if account contracts are provided",
"description": "Validate that if <code>account_contracts</code> have been provided that a supply address with supply points has been provided under <code>supply_addresses</code>",
"possible_errors": [
"account_contracts_without_supply_points"
]
},
{
"name": "Validate historical statement billing document identifier presence",
"description": "Ensure that billing document identifiers are only provided for historical statement transactions and only when the relevant feature flag is enabled.",
"possible_errors": [
"historical_statement_billing_document_identifier_missing",
"historical_statement_billing_document_identifier_not_allowed_when_feature_flag_disabled"
]
},
{
"name": "Validate current statement transactions do not provide <code>billing_document_identifier</code>",
"description": "Validate that none of the current statement transactions include a <code>billing_document_identifier</code>, as this field is only applicable to historical statement transactions.",
"possible_errors": [
"billing_document_identifier_not_allowed_for_current_statement_transactions"
]
},
{
"name": "Validate historical statement transaction billing document identifier",
"description": "Ensure that the billing document identifier is the same for all historical statement transactions.",
"possible_errors": [
"historical_statement_billing_document_identifier_mismatch"
]
},
{
"name": "Validate that contract terms' product codes are part of supply agreements",
"description": "Ensure that any contract terms with product references have corresponding products in supply addresses.",
"possible_errors": [
"contract_term_product_code_not_in_agreements"
]
},
{
"name": "Validate that business is provided if enforcing business contracts",
"description": "Validate that the business field is provided if <code>enforce_business_contracts_exist</code> is set to True on the import supplier configuration.",
"possible_errors": [
"business_field_required"
]
},
{
"name": "Validate that the sum of ledger balances equals the transfer balance",
"description": "Validate that the sum of all <code>ledger_balance</code> provided for each ledger in <code>ledgers</code> equals the account-level <code>transfer_balance</code>.",
"possible_errors": [
"ledger_balances_not_equal_to_transfer_balance"
]
},
{
"name": "Validate business user info against customer info",
"description": "Validates that business user information matches the corresponding customer information for basic fields.",
"possible_errors": [
"customer_details_and_user_details_both_provided"
]
},
{
"name": "Validate payment preference <code>ledger_identifier</code>",
"description": "Ensure that the <code>ledger_identifier</code> provided has an equivalent <code>ledger</code> object with the same <code>ledger_identifier</code> .",
"possible_errors": [
"invalid_payment_preference_ledger_identifier"
]
},
{
"name": "Validate that referenced ledgers are unique in payment preferences",
"description": "Ensure that each ledger is referenced in at most one payment preference.",
"possible_errors": [
"duplicate_ledger_in_payment_preferences"
]
},
{
"name": "Validate that valid instruction_identifier provided for <code>ACTIVE_NEW</code> payment preference",
"description": "Ensure that <code>ACTIVE_NEW</code> payment preference has instruction_identifier from </code>payment_instructions</code> object.",
"possible_errors": [
"active_new_payment_preference_invalid_instruction_identifier"
]
},
{
"name": "Validate that the transactions for a voucher do not exceed its value",
"description": "Validate that the sum of all transaction values for a voucher is not greater than the value of the voucher.",
"possible_errors": [
"voucher_transactions_sum_greater_than_voucher_value"
]
},
{
"name": "Validate that each voucher charge transaction id has a matching transaction id within a transaction of type CHARGE",
"description": "Validate that each <code>voucher</code> <code>charge_transaction_id</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CHARGE in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_charge_transaction_id_not_found"
]
},
{
"name": "Validate that each voucher redemption credit transaction id has a matching transaction id within a transaction of type CREDIT",
"description": "Validate that every <code>credit_transaction_id</code> in all <code>voucher_redemptions</code> in every <code>voucher</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CREDIT in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_redemption_credit_transaction_id_not_found"
]
},
{
"name": "Validate parent property references exist",
"description": "Validates that all <code>parent_property_reference</code> values in <code>supply_addresses</code> and <code>properties</code> correspond to a <code>property_external_identifier</code> in the payload. This ensures the property hierarchy is valid.",
"possible_errors": [
"parent_property_reference_not_found"
]
},
{
"name": "Validate that 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 that if historical statement transaction are provided then so is a last statement closing date or last billed to date",
"description": "Validate that if <code>historical_statement_transactions</code> are provided in the payload then either a <code>last_statement_closing_date</code> or <code>last_billed_to_date</code> is also provided. If a <code>last_statement_closing_date</code> is not provided then the earliest <code>last_billed_to_date</code> on the account or supply points is used to determine when the last statement should have closed.",
"possible_errors": [
"historical_statement_transactions_without_last_statement_closing_date_or_last_billed_to_date"
]
},
{
"name": "Validate unique transaction IDs",
"description": "Validate that all transaction IDs provided are unique.",
"possible_errors": [
"duplicate_transaction_ids",
"missing_transaction_id"
]
},
{
"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 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 no duplicated ledgers are provided",
"description": "Validate no duplicated ledger codes are in `ledgers` section.",
"possible_errors": [
"duplicate_ledger_entries_found"
]
},
{
"name": "Validate identifiers are unique in ledgers",
"description": "Validate identifier is not declared twice in ledgers.",
"possible_errors": [
"duplicate_identifiers_entries_found"
]
},
{
"name": "Validate ledger identifiers are known",
"description": "Validate ledger identifiers are among supply point identifiers.",
"possible_errors": [
"unknown_ledger_identifiers"
]
},
{
"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 that payment plans and payment schedules for the same ledger are not both in payload",
"description": "Validate that if there are payment plans in the payload, there are not also payment schedules on the same ledger because payment plans create a schedule containing all of the planned payments.",
"possible_errors": [
"payment_plan_and_payment_schedule_not_allowed_on_same_ledger"
]
},
{
"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 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 agreements cover the last billed to date",
"description": "Validate that there is an agreement covering the last billed to date for each supply point.",
"possible_errors": [
"no_agreement_covering_last_billed_to_date"
]
},
{
"name": "Validate debt and debts",
"description": "Validates that both debt and debts are not specified in the payload.",
"possible_errors": [
"debt_and_debts_are_defined"
]
},
{
"name": "Validate that a last billed to date has been provided correctly",
"description": "Validate that, for each meter, a last billed to date has been provided in the appropriate place. For electricity meters, it must be provided on each of the meter's settlement registers. For gas meters, it must be provided on the meter. This validation does not apply to meters with half-hourly billing, or meters that have been exchanged where the new meter has already been billed. This validation is skipped if the account has not yet been billed and therefore has no historical statement data.",
"possible_errors": [
"last_billed_to_date_not_found"
]
},
{
"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. Note that any prepay vend transactions are not included in the above check.",
"possible_errors": [
"current_statement_transaction_before_current_statement_opening_date"
]
},
{
"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. Prepay transactions (those with the <code>to_prepay_meter_serial_number</code> field on the transaction) are filtered out as these are treated separately during account creation.",
"possible_errors": [
"balance_mismatch_on_transfer_balance"
]
},
{
"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>. Prepay transactions (those with the <code>to_prepay_meter_serial_number</code> field on the transaction) are filtered out as these are treated separately during account creation.",
"possible_errors": [
"historical_statement_transactions_balance_mismatch"
]
},
{
"name": "Validate next bill due date provided for quarterly billing",
"description": "Validate that if <code>use_industry_billing</code> is false in the account billing options and the <code>period_length</code> is <code>QUARTERLY</code>, then a <code>next_bill_due_date</code> is provided.",
"possible_errors": [
"next_bill_to_date_not_provided_for_quarterly_billing"
]
},
{
"name": "Validate account billing options",
"description": "Validate that account billing options have only been provided for business accounts.",
"possible_errors": [
"account_billing_options_provided_for_domestic_accounts"
]
},
{
"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 prepay transactions target initialised prepay meters",
"description": "Validate that if <code>current_statement_transactions</code> or <code>historical_statement_transactions</code> target a prepay meter (i.e. has the <code>to_prepay_meter_serial_number</code> field), then a prepay meter with that serial number exists in the payload. A prepay meter is identified in the payload by the presence of <code>prepay_details</code>.",
"possible_errors": [
"transactions_target_non_initialised_prepay_meter"
]
},
{
"name": "Validate tax exemption for appropriate account type",
"description": "Validate that the tax exemption is only in place for business accounts.",
"possible_errors": [
"tax_exemptions_provided_for_domestic_account"
]
},
{
"name": "Validate prepay transfer vend read dates match last billed to date",
"description": "Validate that the transfer vend read dates match the last billed to date. This only applies to prepay meters.The last billed to date can be either at the account level or the at the meter/register level. Last billed to dates at the meter/register level take precedent over the account level date if both are provided.",
"possible_errors": [
"prepay_details_on_fully_billed_meter",
"transfer_vend_read_date_must_match_last_billed_to_date"
]
},
{
"name": "Validate that the tariff type and meter point type match",
"description": "Validate that the tariff we have on a given contract matches the meter point type. For example, check eco7 (2-rate) meter points don't have single-rate tariffs or vice versa.",
"possible_errors": [
"tariff_type_does_not_match_meter_point_type"
]
},
{
"name": "Validate bespoke rates",
"description": "Validate that if bespoke rates have been set the account is business.",
"possible_errors": [
"business_fields_provided_for_domestic_accounts"
]
},
{
"name": "Validate billing address provided",
"description": "Validate <code>billing_address1</code> and <code>billing_postcode</code> are provided for non-occupier accounts.",
"possible_errors": [
"billing_address_not_provided"
]
},
{
"name": "Validate current AQ for billable meter point",
"description": "Check that we have a currently valid AQ for a billable MPRN.",
"possible_errors": [
"no_current_or_future_aq_entry_found"
]
},
{
"name": "Validate all billable meter points are covered by agreements in the payload",
"description": "Validate that agreements have been provided for all billable meter points and vice versa for the period covered by Kraken from a billing perspective. A billable meter point is one that has an open-ended or future dated supply end date.",
"possible_errors": [
"meter_point_with_no_agreement",
"meterpoint_with_agreement_not_on_supply"
]
},
{
"name": "Validate transfer readings exist on active gas meters",
"description": "Validate that each active gas meter has a single transfer reading provided.",
"possible_errors": [
"active_gas_meter_with_multiple_transfer_readings",
"active_gas_meter_without_transfer_reading",
"reading_meter_fully_billed"
]
},
{
"name": "Validate EACs provided for active registers",
"description": "Validate that EACs are provided in the <code>eac_history</code> array for each active electricity register. EACs are matched to registers using the <code>tpr</code> field present on both the EAC and register objects.",
"possible_errors": [
"missing_eacs_for_active_register_tpr"
]
},
{
"name": "Validate that prepay meters are matched to agreements of the correct type",
"description": "Validate that each prepay meter has a matching agreement on a prepay tariff, and similarly non-prepay meters on non-prepay tariffs. Note that this validation only applies for active meters and agreements.",
"possible_errors": [
"tariff_type_does_not_match_meter_type"
]
},
{
"name": "Validate each agreement is not effective before the product is available",
"description": "Ensures that the agreement <code>effective_from</code> is not before the datetime the agreement's product is available from. We check this if Kraken will be responsible for billing before the product is available and the product is a variable or tracker product.",
"possible_errors": [
"agreement_effective_from_before_product_available_from"
]
},
{
"name": "Validate that all variable products on a contract have start dates after the product start date",
"description": "Validate that any variable products that are part of a contract only become effective after the product is available.",
"possible_errors": [
"agreement_cannot_start_before_product_available"
]
},
{
"name": "Validate that no meter points are ending supply in the future",
"description": "Ensure that all meters points have either ended supply or are not planned for supply to end.",
"possible_errors": [
"future_supply_end_date"
]
},
{
"name": "Validate that all off supply meter points with meters have a final reading",
"description": "Ensure that all off supply meter points which have meters have a final reading on their end date.",
"possible_errors": [
"no_reading_on_supply_end_date"
]
},
{
"name": "Validate that no billable meter points are starting supply in the future",
"description": "Validate that no billable meter points are set to start supply in the future.",
"possible_errors": [
"future_supply_start_date"
]
},
{
"name": "Validate that all billable meter points have active meters",
"description": "Ensure that all meter points that are billable have active meters or have an unmetered measurement class provided in the payload.",
"possible_errors": [
"meter_point_with_no_meters"
]
},
{
"name": "Validate that at least one of the meter points needs billing",
"description": "Ensure that at least one of the meter points for this account are billable.",
"possible_errors": [
"no_supply_point_on_supply"
]
},
{
"name": "Validate that a domestic account does not have any business only supply points",
"description": "Validate that a domestic account does not have supply points with supply types <code>REGOS_EXPORT_CERTIFICATES</code> or <code>ROCS_EXPORT_CERTIFICATES</code> which are business only supply types.",
"possible_errors": [
"business_supply_type_on_domestic_account"
]
},
{
"name": "Validate business account has account billing options with <code>period_start_day</code> and <code>period_length</code>",
"description": "Validate that business account's <code>account_billing_options</code> include period start day and period length if <code>account_billing_options</code> is being provided. If <code>account_billing_options</code> is not provided then the defaults of 1 for <code>period_start_day</code> and \"MONTHLY\" for <code>period_length</code> will be used.",
"possible_errors": [
"business_account_missing_billing_options"
]
},
{
"name": "Validate that customers provided for business accounts",
"description": "Validate that at least one customer is provided for business accounts. Customers are needed for business accounts to ensure that meter points can be successfully registered for supply.",
"possible_errors": [
"business_account_missing_customers"
]
},
{
"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 transfer readings exist on active electricity registers",
"description": "Validate that each active electricity meter register has a single transfer reading provided.",
"possible_errors": [
"missing_transfer_reading_for_register",
"multiple_transfer_readings_for_register"
]
}
]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 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 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 that if historical statement transaction are provided then so is a last statement closing date or last billed to date",
"description": "Validate that if <code>historical_statement_transactions</code> are provided in the payload then either a <code>last_statement_closing_date</code> or <code>last_billed_to_date</code> is also provided. If a <code>last_statement_closing_date</code> is not provided then the earliest <code>last_billed_to_date</code> on the account or supply points is used to determine when the last statement should have closed.",
"possible_errors": [
"historical_statement_transactions_without_last_statement_closing_date_or_last_billed_to_date"
]
},
{
"name": "Validate unique transaction IDs",
"description": "Validate that all transaction IDs provided are unique.",
"possible_errors": [
"duplicate_transaction_ids",
"missing_transaction_id"
]
},
{
"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 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 no duplicated ledgers are provided",
"description": "Validate no duplicated ledger codes are in `ledgers` section.",
"possible_errors": [
"duplicate_ledger_entries_found"
]
},
{
"name": "Validate identifiers are unique in ledgers",
"description": "Validate identifier is not declared twice in ledgers.",
"possible_errors": [
"duplicate_identifiers_entries_found"
]
},
{
"name": "Validate ledger identifiers are known",
"description": "Validate ledger identifiers are among supply point identifiers.",
"possible_errors": [
"unknown_ledger_identifiers"
]
},
{
"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 that payment plans and payment schedules for the same ledger are not both in payload",
"description": "Validate that if there are payment plans in the payload, there are not also payment schedules on the same ledger because payment plans create a schedule containing all of the planned payments.",
"possible_errors": [
"payment_plan_and_payment_schedule_not_allowed_on_same_ledger"
]
},
{
"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 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 agreements cover the last billed to date",
"description": "Validate that there is an agreement covering the last billed to date for each supply point.",
"possible_errors": [
"no_agreement_covering_last_billed_to_date"
]
},
{
"name": "Validate debt and debts",
"description": "Validates that both debt and debts are not specified in the payload.",
"possible_errors": [
"debt_and_debts_are_defined"
]
},
{
"name": "Validate that a last billed to date has been provided correctly",
"description": "Validate that, for each meter, a last billed to date has been provided in the appropriate place. For electricity meters, it must be provided on each of the meter's settlement registers. For gas meters, it must be provided on the meter. This validation does not apply to meters with half-hourly billing, or meters that have been exchanged where the new meter has already been billed. This validation is skipped if the account has not yet been billed and therefore has no historical statement data.",
"possible_errors": [
"last_billed_to_date_not_found"
]
},
{
"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. Note that any prepay vend transactions are not included in the above check.",
"possible_errors": [
"current_statement_transaction_before_current_statement_opening_date"
]
},
{
"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. Prepay transactions (those with the <code>to_prepay_meter_serial_number</code> field on the transaction) are filtered out as these are treated separately during account creation.",
"possible_errors": [
"balance_mismatch_on_transfer_balance"
]
},
{
"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>. Prepay transactions (those with the <code>to_prepay_meter_serial_number</code> field on the transaction) are filtered out as these are treated separately during account creation.",
"possible_errors": [
"historical_statement_transactions_balance_mismatch"
]
},
{
"name": "Validate next bill due date provided for quarterly billing",
"description": "Validate that if <code>use_industry_billing</code> is false in the account billing options and the <code>period_length</code> is <code>QUARTERLY</code>, then a <code>next_bill_due_date</code> is provided.",
"possible_errors": [
"next_bill_to_date_not_provided_for_quarterly_billing"
]
},
{
"name": "Validate account billing options",
"description": "Validate that account billing options have only been provided for business accounts.",
"possible_errors": [
"account_billing_options_provided_for_domestic_accounts"
]
},
{
"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 prepay transactions target initialised prepay meters",
"description": "Validate that if <code>current_statement_transactions</code> or <code>historical_statement_transactions</code> target a prepay meter (i.e. has the <code>to_prepay_meter_serial_number</code> field), then a prepay meter with that serial number exists in the payload. A prepay meter is identified in the payload by the presence of <code>prepay_details</code>.",
"possible_errors": [
"transactions_target_non_initialised_prepay_meter"
]
},
{
"name": "Validate tax exemption for appropriate account type",
"description": "Validate that the tax exemption is only in place for business accounts.",
"possible_errors": [
"tax_exemptions_provided_for_domestic_account"
]
},
{
"name": "Validate prepay transfer vend read dates match last billed to date",
"description": "Validate that the transfer vend read dates match the last billed to date. This only applies to prepay meters.The last billed to date can be either at the account level or the at the meter/register level. Last billed to dates at the meter/register level take precedent over the account level date if both are provided.",
"possible_errors": [
"prepay_details_on_fully_billed_meter",
"transfer_vend_read_date_must_match_last_billed_to_date"
]
},
{
"name": "Validate that the tariff type and meter point type match",
"description": "Validate that the tariff we have on a given contract matches the meter point type. For example, check eco7 (2-rate) meter points don't have single-rate tariffs or vice versa.",
"possible_errors": [
"tariff_type_does_not_match_meter_point_type"
]
},
{
"name": "Validate bespoke rates",
"description": "Validate that if bespoke rates have been set the account is business.",
"possible_errors": [
"business_fields_provided_for_domestic_accounts"
]
},
{
"name": "Validate billing address provided",
"description": "Validate <code>billing_address1</code> and <code>billing_postcode</code> are provided for non-occupier accounts.",
"possible_errors": [
"billing_address_not_provided"
]
},
{
"name": "Validate current AQ for billable meter point",
"description": "Check that we have a currently valid AQ for a billable MPRN.",
"possible_errors": [
"no_current_or_future_aq_entry_found"
]
},
{
"name": "Validate all billable meter points are covered by agreements in the payload",
"description": "Validate that agreements have been provided for all billable meter points and vice versa for the period covered by Kraken from a billing perspective. A billable meter point is one that has an open-ended or future dated supply end date.",
"possible_errors": [
"meter_point_with_no_agreement",
"meterpoint_with_agreement_not_on_supply"
]
},
{
"name": "Validate transfer readings exist on active gas meters",
"description": "Validate that each active gas meter has a single transfer reading provided.",
"possible_errors": [
"active_gas_meter_with_multiple_transfer_readings",
"active_gas_meter_without_transfer_reading",
"reading_meter_fully_billed"
]
},
{
"name": "Validate EACs provided for active registers",
"description": "Validate that EACs are provided in the <code>eac_history</code> array for each active electricity register. EACs are matched to registers using the <code>tpr</code> field present on both the EAC and register objects.",
"possible_errors": [
"missing_eacs_for_active_register_tpr"
]
},
{
"name": "Validate that prepay meters are matched to agreements of the correct type",
"description": "Validate that each prepay meter has a matching agreement on a prepay tariff, and similarly non-prepay meters on non-prepay tariffs. Note that this validation only applies for active meters and agreements.",
"possible_errors": [
"tariff_type_does_not_match_meter_type"
]
},
{
"name": "Validate each agreement is not effective before the product is available",
"description": "Ensures that the agreement <code>effective_from</code> is not before the datetime the agreement's product is available from. We check this if Kraken will be responsible for billing before the product is available and the product is a variable or tracker product.",
"possible_errors": [
"agreement_effective_from_before_product_available_from"
]
},
{
"name": "Validate that all variable products on a contract have start dates after the product start date",
"description": "Validate that any variable products that are part of a contract only become effective after the product is available.",
"possible_errors": [
"agreement_cannot_start_before_product_available"
]
},
{
"name": "Validate that no meter points are ending supply in the future",
"description": "Ensure that all meters points have either ended supply or are not planned for supply to end.",
"possible_errors": [
"future_supply_end_date"
]
},
{
"name": "Validate that all off supply meter points with meters have a final reading",
"description": "Ensure that all off supply meter points which have meters have a final reading on their end date.",
"possible_errors": [
"no_reading_on_supply_end_date"
]
},
{
"name": "Validate that no billable meter points are starting supply in the future",
"description": "Validate that no billable meter points are set to start supply in the future.",
"possible_errors": [
"future_supply_start_date"
]
},
{
"name": "Validate that all billable meter points have active meters",
"description": "Ensure that all meter points that are billable have active meters or have an unmetered measurement class provided in the payload.",
"possible_errors": [
"meter_point_with_no_meters"
]
},
{
"name": "Validate that at least one of the meter points needs billing",
"description": "Ensure that at least one of the meter points for this account are billable.",
"possible_errors": [
"no_supply_point_on_supply"
]
},
{
"name": "Validate that a domestic account does not have any business only supply points",
"description": "Validate that a domestic account does not have supply points with supply types <code>REGOS_EXPORT_CERTIFICATES</code> or <code>ROCS_EXPORT_CERTIFICATES</code> which are business only supply types.",
"possible_errors": [
"business_supply_type_on_domestic_account"
]
},
{
"name": "Validate business account has account billing options with <code>period_start_day</code> and <code>period_length</code>",
"description": "Validate that business account's <code>account_billing_options</code> include period start day and period length if <code>account_billing_options</code> is being provided. If <code>account_billing_options</code> is not provided then the defaults of 1 for <code>period_start_day</code> and \"MONTHLY\" for <code>period_length</code> will be used.",
"possible_errors": [
"business_account_missing_billing_options"
]
},
{
"name": "Validate that customers provided for business accounts",
"description": "Validate that at least one customer is provided for business accounts. Customers are needed for business accounts to ensure that meter points can be successfully registered for supply.",
"possible_errors": [
"business_account_missing_customers"
]
},
{
"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 transfer readings exist on active electricity registers",
"description": "Validate that each active electricity meter register has a single transfer reading provided.",
"possible_errors": [
"missing_transfer_reading_for_register",
"multiple_transfer_readings_for_register"
]
}
]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 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 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 that if historical statement transaction are provided then so is a last statement closing date or last billed to date",
"description": "Validate that if <code>historical_statement_transactions</code> are provided in the payload then either a <code>last_statement_closing_date</code> or <code>last_billed_to_date</code> is also provided. If a <code>last_statement_closing_date</code> is not provided then the earliest <code>last_billed_to_date</code> on the account or supply points is used to determine when the last statement should have closed.",
"possible_errors": [
"historical_statement_transactions_without_last_statement_closing_date_or_last_billed_to_date"
]
},
{
"name": "Validate unique transaction IDs",
"description": "Validate that all transaction IDs provided are unique.",
"possible_errors": [
"duplicate_transaction_ids",
"missing_transaction_id"
]
},
{
"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 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 no duplicated ledgers are provided",
"description": "Validate no duplicated ledger codes are in `ledgers` section.",
"possible_errors": [
"duplicate_ledger_entries_found"
]
},
{
"name": "Validate identifiers are unique in ledgers",
"description": "Validate identifier is not declared twice in ledgers.",
"possible_errors": [
"duplicate_identifiers_entries_found"
]
},
{
"name": "Validate ledger identifiers are known",
"description": "Validate ledger identifiers are among supply point identifiers.",
"possible_errors": [
"unknown_ledger_identifiers"
]
},
{
"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 that payment plans and payment schedules for the same ledger are not both in payload",
"description": "Validate that if there are payment plans in the payload, there are not also payment schedules on the same ledger because payment plans create a schedule containing all of the planned payments.",
"possible_errors": [
"payment_plan_and_payment_schedule_not_allowed_on_same_ledger"
]
},
{
"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 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 agreements cover the last billed to date",
"description": "Validate that there is an agreement covering the last billed to date for each supply point.",
"possible_errors": [
"no_agreement_covering_last_billed_to_date"
]
},
{
"name": "Validate debt and debts",
"description": "Validates that both debt and debts are not specified in the payload.",
"possible_errors": [
"debt_and_debts_are_defined"
]
},
{
"name": "Validate that a last billed to date has been provided correctly",
"description": "Validate that, for each meter, a last billed to date has been provided in the appropriate place. For electricity meters, it must be provided on each of the meter's settlement registers. For gas meters, it must be provided on the meter. This validation does not apply to meters with half-hourly billing, or meters that have been exchanged where the new meter has already been billed. This validation is skipped if the account has not yet been billed and therefore has no historical statement data.",
"possible_errors": [
"last_billed_to_date_not_found"
]
},
{
"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. Note that any prepay vend transactions are not included in the above check.",
"possible_errors": [
"current_statement_transaction_before_current_statement_opening_date"
]
},
{
"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. Prepay transactions (those with the <code>to_prepay_meter_serial_number</code> field on the transaction) are filtered out as these are treated separately during account creation.",
"possible_errors": [
"balance_mismatch_on_transfer_balance"
]
},
{
"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>. Prepay transactions (those with the <code>to_prepay_meter_serial_number</code> field on the transaction) are filtered out as these are treated separately during account creation.",
"possible_errors": [
"historical_statement_transactions_balance_mismatch"
]
},
{
"name": "Validate next bill due date provided for quarterly billing",
"description": "Validate that if <code>use_industry_billing</code> is false in the account billing options and the <code>period_length</code> is <code>QUARTERLY</code>, then a <code>next_bill_due_date</code> is provided.",
"possible_errors": [
"next_bill_to_date_not_provided_for_quarterly_billing"
]
},
{
"name": "Validate account billing options",
"description": "Validate that account billing options have only been provided for business accounts.",
"possible_errors": [
"account_billing_options_provided_for_domestic_accounts"
]
},
{
"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 prepay transactions target initialised prepay meters",
"description": "Validate that if <code>current_statement_transactions</code> or <code>historical_statement_transactions</code> target a prepay meter (i.e. has the <code>to_prepay_meter_serial_number</code> field), then a prepay meter with that serial number exists in the payload. A prepay meter is identified in the payload by the presence of <code>prepay_details</code>.",
"possible_errors": [
"transactions_target_non_initialised_prepay_meter"
]
},
{
"name": "Validate tax exemption for appropriate account type",
"description": "Validate that the tax exemption is only in place for business accounts.",
"possible_errors": [
"tax_exemptions_provided_for_domestic_account"
]
},
{
"name": "Validate prepay transfer vend read dates match last billed to date",
"description": "Validate that the transfer vend read dates match the last billed to date. This only applies to prepay meters.The last billed to date can be either at the account level or the at the meter/register level. Last billed to dates at the meter/register level take precedent over the account level date if both are provided.",
"possible_errors": [
"prepay_details_on_fully_billed_meter",
"transfer_vend_read_date_must_match_last_billed_to_date"
]
},
{
"name": "Validate that the tariff type and meter point type match",
"description": "Validate that the tariff we have on a given contract matches the meter point type. For example, check eco7 (2-rate) meter points don't have single-rate tariffs or vice versa.",
"possible_errors": [
"tariff_type_does_not_match_meter_point_type"
]
},
{
"name": "Validate bespoke rates",
"description": "Validate that if bespoke rates have been set the account is business.",
"possible_errors": [
"business_fields_provided_for_domestic_accounts"
]
},
{
"name": "Validate billing address provided",
"description": "Validate <code>billing_address1</code> and <code>billing_postcode</code> are provided for non-occupier accounts.",
"possible_errors": [
"billing_address_not_provided"
]
},
{
"name": "Validate current AQ for billable meter point",
"description": "Check that we have a currently valid AQ for a billable MPRN.",
"possible_errors": [
"no_current_or_future_aq_entry_found"
]
},
{
"name": "Validate all billable meter points are covered by agreements in the payload",
"description": "Validate that agreements have been provided for all billable meter points and vice versa for the period covered by Kraken from a billing perspective. A billable meter point is one that has an open-ended or future dated supply end date.",
"possible_errors": [
"meter_point_with_no_agreement",
"meterpoint_with_agreement_not_on_supply"
]
},
{
"name": "Validate transfer readings exist on active gas meters",
"description": "Validate that each active gas meter has a single transfer reading provided.",
"possible_errors": [
"active_gas_meter_with_multiple_transfer_readings",
"active_gas_meter_without_transfer_reading",
"reading_meter_fully_billed"
]
},
{
"name": "Validate EACs provided for active registers",
"description": "Validate that EACs are provided in the <code>eac_history</code> array for each active electricity register. EACs are matched to registers using the <code>tpr</code> field present on both the EAC and register objects.",
"possible_errors": [
"missing_eacs_for_active_register_tpr"
]
},
{
"name": "Validate that prepay meters are matched to agreements of the correct type",
"description": "Validate that each prepay meter has a matching agreement on a prepay tariff, and similarly non-prepay meters on non-prepay tariffs. Note that this validation only applies for active meters and agreements.",
"possible_errors": [
"tariff_type_does_not_match_meter_type"
]
},
{
"name": "Validate each agreement is not effective before the product is available",
"description": "Ensures that the agreement <code>effective_from</code> is not before the datetime the agreement's product is available from. We check this if Kraken will be responsible for billing before the product is available and the product is a variable or tracker product.",
"possible_errors": [
"agreement_effective_from_before_product_available_from"
]
},
{
"name": "Validate that all variable products on a contract have start dates after the product start date",
"description": "Validate that any variable products that are part of a contract only become effective after the product is available.",
"possible_errors": [
"agreement_cannot_start_before_product_available"
]
},
{
"name": "Validate that no meter points are ending supply in the future",
"description": "Ensure that all meters points have either ended supply or are not planned for supply to end.",
"possible_errors": [
"future_supply_end_date"
]
},
{
"name": "Validate that all off supply meter points with meters have a final reading",
"description": "Ensure that all off supply meter points which have meters have a final reading on their end date.",
"possible_errors": [
"no_reading_on_supply_end_date"
]
},
{
"name": "Validate that no billable meter points are starting supply in the future",
"description": "Validate that no billable meter points are set to start supply in the future.",
"possible_errors": [
"future_supply_start_date"
]
},
{
"name": "Validate that all billable meter points have active meters",
"description": "Ensure that all meter points that are billable have active meters or have an unmetered measurement class provided in the payload.",
"possible_errors": [
"meter_point_with_no_meters"
]
},
{
"name": "Validate that at least one of the meter points needs billing",
"description": "Ensure that at least one of the meter points for this account are billable.",
"possible_errors": [
"no_supply_point_on_supply"
]
},
{
"name": "Validate that a domestic account does not have any business only supply points",
"description": "Validate that a domestic account does not have supply points with supply types <code>REGOS_EXPORT_CERTIFICATES</code> or <code>ROCS_EXPORT_CERTIFICATES</code> which are business only supply types.",
"possible_errors": [
"business_supply_type_on_domestic_account"
]
},
{
"name": "Validate business account has account billing options with <code>period_start_day</code> and <code>period_length</code>",
"description": "Validate that business account's <code>account_billing_options</code> include period start day and period length if <code>account_billing_options</code> is being provided. If <code>account_billing_options</code> is not provided then the defaults of 1 for <code>period_start_day</code> and \"MONTHLY\" for <code>period_length</code> will be used.",
"possible_errors": [
"business_account_missing_billing_options"
]
},
{
"name": "Validate that customers provided for business accounts",
"description": "Validate that at least one customer is provided for business accounts. Customers are needed for business accounts to ensure that meter points can be successfully registered for supply.",
"possible_errors": [
"business_account_missing_customers"
]
},
{
"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 transfer readings exist on active electricity registers",
"description": "Validate that each active electricity meter register has a single transfer reading provided.",
"possible_errors": [
"missing_transfer_reading_for_register",
"multiple_transfer_readings_for_register"
]
}
]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 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 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 that if historical statement transaction are provided then so is a last statement closing date or last billed to date",
"description": "Validate that if <code>historical_statement_transactions</code> are provided in the payload then either a <code>last_statement_closing_date</code> or <code>last_billed_to_date</code> is also provided. If a <code>last_statement_closing_date</code> is not provided then the earliest <code>last_billed_to_date</code> on the account or supply points is used to determine when the last statement should have closed.",
"possible_errors": [
"historical_statement_transactions_without_last_statement_closing_date_or_last_billed_to_date"
]
},
{
"name": "Validate unique transaction IDs",
"description": "Validate that all transaction IDs provided are unique.",
"possible_errors": [
"duplicate_transaction_ids",
"missing_transaction_id"
]
},
{
"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 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 no duplicated ledgers are provided",
"description": "Validate no duplicated ledger codes are in `ledgers` section.",
"possible_errors": [
"duplicate_ledger_entries_found"
]
},
{
"name": "Validate identifiers are unique in ledgers",
"description": "Validate identifier is not declared twice in ledgers.",
"possible_errors": [
"duplicate_identifiers_entries_found"
]
},
{
"name": "Validate ledger identifiers are known",
"description": "Validate ledger identifiers are among supply point identifiers.",
"possible_errors": [
"unknown_ledger_identifiers"
]
},
{
"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 that payment plans and payment schedules for the same ledger are not both in payload",
"description": "Validate that if there are payment plans in the payload, there are not also payment schedules on the same ledger because payment plans create a schedule containing all of the planned payments.",
"possible_errors": [
"payment_plan_and_payment_schedule_not_allowed_on_same_ledger"
]
},
{
"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 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 agreements cover the last billed to date",
"description": "Validate that there is an agreement covering the last billed to date for each supply point.",
"possible_errors": [
"no_agreement_covering_last_billed_to_date"
]
},
{
"name": "Validate debt and debts",
"description": "Validates that both debt and debts are not specified in the payload.",
"possible_errors": [
"debt_and_debts_are_defined"
]
},
{
"name": "Validate that a last billed to date has been provided correctly",
"description": "Validate that, for each meter, a last billed to date has been provided in the appropriate place. For electricity meters, it must be provided on each of the meter's settlement registers. For gas meters, it must be provided on the meter. This validation does not apply to meters with half-hourly billing, or meters that have been exchanged where the new meter has already been billed. This validation is skipped if the account has not yet been billed and therefore has no historical statement data.",
"possible_errors": [
"last_billed_to_date_not_found"
]
},
{
"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. Note that any prepay vend transactions are not included in the above check.",
"possible_errors": [
"current_statement_transaction_before_current_statement_opening_date"
]
},
{
"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. Prepay transactions (those with the <code>to_prepay_meter_serial_number</code> field on the transaction) are filtered out as these are treated separately during account creation.",
"possible_errors": [
"balance_mismatch_on_transfer_balance"
]
},
{
"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>. Prepay transactions (those with the <code>to_prepay_meter_serial_number</code> field on the transaction) are filtered out as these are treated separately during account creation.",
"possible_errors": [
"historical_statement_transactions_balance_mismatch"
]
},
{
"name": "Validate next bill due date provided for quarterly billing",
"description": "Validate that if <code>use_industry_billing</code> is false in the account billing options and the <code>period_length</code> is <code>QUARTERLY</code>, then a <code>next_bill_due_date</code> is provided.",
"possible_errors": [
"next_bill_to_date_not_provided_for_quarterly_billing"
]
},
{
"name": "Validate account billing options",
"description": "Validate that account billing options have only been provided for business accounts.",
"possible_errors": [
"account_billing_options_provided_for_domestic_accounts"
]
},
{
"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 prepay transactions target initialised prepay meters",
"description": "Validate that if <code>current_statement_transactions</code> or <code>historical_statement_transactions</code> target a prepay meter (i.e. has the <code>to_prepay_meter_serial_number</code> field), then a prepay meter with that serial number exists in the payload. A prepay meter is identified in the payload by the presence of <code>prepay_details</code>.",
"possible_errors": [
"transactions_target_non_initialised_prepay_meter"
]
},
{
"name": "Validate tax exemption for appropriate account type",
"description": "Validate that the tax exemption is only in place for business accounts.",
"possible_errors": [
"tax_exemptions_provided_for_domestic_account"
]
},
{
"name": "Validate prepay transfer vend read dates match last billed to date",
"description": "Validate that the transfer vend read dates match the last billed to date. This only applies to prepay meters.The last billed to date can be either at the account level or the at the meter/register level. Last billed to dates at the meter/register level take precedent over the account level date if both are provided.",
"possible_errors": [
"prepay_details_on_fully_billed_meter",
"transfer_vend_read_date_must_match_last_billed_to_date"
]
},
{
"name": "Validate that the tariff type and meter point type match",
"description": "Validate that the tariff we have on a given contract matches the meter point type. For example, check eco7 (2-rate) meter points don't have single-rate tariffs or vice versa.",
"possible_errors": [
"tariff_type_does_not_match_meter_point_type"
]
},
{
"name": "Validate bespoke rates",
"description": "Validate that if bespoke rates have been set the account is business.",
"possible_errors": [
"business_fields_provided_for_domestic_accounts"
]
},
{
"name": "Validate billing address provided",
"description": "Validate <code>billing_address1</code> and <code>billing_postcode</code> are provided for non-occupier accounts.",
"possible_errors": [
"billing_address_not_provided"
]
},
{
"name": "Validate current AQ for billable meter point",
"description": "Check that we have a currently valid AQ for a billable MPRN.",
"possible_errors": [
"no_current_or_future_aq_entry_found"
]
},
{
"name": "Validate all billable meter points are covered by agreements in the payload",
"description": "Validate that agreements have been provided for all billable meter points and vice versa for the period covered by Kraken from a billing perspective. A billable meter point is one that has an open-ended or future dated supply end date.",
"possible_errors": [
"meter_point_with_no_agreement",
"meterpoint_with_agreement_not_on_supply"
]
},
{
"name": "Validate transfer readings exist on active gas meters",
"description": "Validate that each active gas meter has a single transfer reading provided.",
"possible_errors": [
"active_gas_meter_with_multiple_transfer_readings",
"active_gas_meter_without_transfer_reading",
"reading_meter_fully_billed"
]
},
{
"name": "Validate EACs provided for active registers",
"description": "Validate that EACs are provided in the <code>eac_history</code> array for each active electricity register. EACs are matched to registers using the <code>tpr</code> field present on both the EAC and register objects.",
"possible_errors": [
"missing_eacs_for_active_register_tpr"
]
},
{
"name": "Validate that prepay meters are matched to agreements of the correct type",
"description": "Validate that each prepay meter has a matching agreement on a prepay tariff, and similarly non-prepay meters on non-prepay tariffs. Note that this validation only applies for active meters and agreements.",
"possible_errors": [
"tariff_type_does_not_match_meter_type"
]
},
{
"name": "Validate each agreement is not effective before the product is available",
"description": "Ensures that the agreement <code>effective_from</code> is not before the datetime the agreement's product is available from. We check this if Kraken will be responsible for billing before the product is available and the product is a variable or tracker product.",
"possible_errors": [
"agreement_effective_from_before_product_available_from"
]
},
{
"name": "Validate that all variable products on a contract have start dates after the product start date",
"description": "Validate that any variable products that are part of a contract only become effective after the product is available.",
"possible_errors": [
"agreement_cannot_start_before_product_available"
]
},
{
"name": "Validate that no meter points are ending supply in the future",
"description": "Ensure that all meters points have either ended supply or are not planned for supply to end.",
"possible_errors": [
"future_supply_end_date"
]
},
{
"name": "Validate that all off supply meter points with meters have a final reading",
"description": "Ensure that all off supply meter points which have meters have a final reading on their end date.",
"possible_errors": [
"no_reading_on_supply_end_date"
]
},
{
"name": "Validate that no billable meter points are starting supply in the future",
"description": "Validate that no billable meter points are set to start supply in the future.",
"possible_errors": [
"future_supply_start_date"
]
},
{
"name": "Validate that all billable meter points have active meters",
"description": "Ensure that all meter points that are billable have active meters or have an unmetered measurement class provided in the payload.",
"possible_errors": [
"meter_point_with_no_meters"
]
},
{
"name": "Validate that at least one of the meter points needs billing",
"description": "Ensure that at least one of the meter points for this account are billable.",
"possible_errors": [
"no_supply_point_on_supply"
]
},
{
"name": "Validate that a domestic account does not have any business only supply points",
"description": "Validate that a domestic account does not have supply points with supply types <code>REGOS_EXPORT_CERTIFICATES</code> or <code>ROCS_EXPORT_CERTIFICATES</code> which are business only supply types.",
"possible_errors": [
"business_supply_type_on_domestic_account"
]
},
{
"name": "Validate business account has account billing options with <code>period_start_day</code> and <code>period_length</code>",
"description": "Validate that business account's <code>account_billing_options</code> include period start day and period length if <code>account_billing_options</code> is being provided. If <code>account_billing_options</code> is not provided then the defaults of 1 for <code>period_start_day</code> and \"MONTHLY\" for <code>period_length</code> will be used.",
"possible_errors": [
"business_account_missing_billing_options"
]
},
{
"name": "Validate that customers provided for business accounts",
"description": "Validate that at least one customer is provided for business accounts. Customers are needed for business accounts to ensure that meter points can be successfully registered for supply.",
"possible_errors": [
"business_account_missing_customers"
]
},
{
"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 transfer readings exist on active electricity registers",
"description": "Validate that each active electricity meter register has a single transfer reading provided.",
"possible_errors": [
"missing_transfer_reading_for_register",
"multiple_transfer_readings_for_register"
]
}
]11 May 2026
New
{
"x-enum-descriptions": {
"HMC_GUARANTEE_FULL": "Hourly Matching Credit Guarantee Full rate (pence per kWh) for business tariffs",
"HMC_GUARANTEE_ADVANCE": "Hourly Matching Credit Guarantee Advance rate (pence per kWh) for business tariffs"
}
}Old
{
"x-enum-descriptions": {}
}
No attributes to display
8 May 2026
New
{
"x-removal-date": "2026-05-25"
}New
{
"x-enum-descriptions": {
"HMC_GUARANTEE_ADVANCE": "HMC_GUARANTEE_ADVANCE"
}
}Old
{
"x-enum-descriptions": {
"HMC_GUARANTEE_CREDIT": "HMC_GUARANTEE_CREDIT"
}
}
No attributes to display
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
No attributes to display
No attributes to display
No attributes to display
5 May 2026
New
{
"x-enum-descriptions": {
"SAP": "SAP"
}
}Old
{
"x-enum-descriptions": {}
}29 April 2026
No attributes to display
No attributes to display
New
{
"x-enum-descriptions": {
"HMC_GUARANTEE_CREDIT": "HMC_GUARANTEE_CREDIT"
}
}Old
{
"x-enum-descriptions": {}
}28 April 2026
No attributes to display
24 April 2026
No attributes to display
New
{
"gbr-electricity.payment-method": "#/components/schemas/Gbr-electricity.payment-methodCharacteristic"
}New
[
{
"$ref": "#/components/schemas/Gbr-electricity.payment-methodCharacteristic"
},
{
"$ref": "#/components/schemas/SalesChannelCharacteristic"
},
{
"$ref": "#/components/schemas/MaximumCapacityCharacteristic"
},
{
"$ref": "#/components/schemas/Gbr-electricity.meter-rate-profileCharacteristic"
}
]Old
[
{
"$ref": "#/components/schemas/SalesChannelCharacteristic"
},
{
"$ref": "#/components/schemas/MaximumCapacityCharacteristic"
},
{
"$ref": "#/components/schemas/Gbr-electricity.meter-rate-profileCharacteristic"
}
]23 April 2026
Old
{
"gbr-electricity.payment-method": "#/components/schemas/Gbr-electricity.payment-methodCharacteristic"
}New
[
{
"$ref": "#/components/schemas/SalesChannelCharacteristic"
},
{
"$ref": "#/components/schemas/Gbr-electricity.meter-rate-profileCharacteristic"
},
{
"$ref": "#/components/schemas/MaximumCapacityCharacteristic"
}
]Old
[
{
"$ref": "#/components/schemas/Gbr-electricity.meter-rate-profileCharacteristic"
},
{
"$ref": "#/components/schemas/SalesChannelCharacteristic"
},
{
"$ref": "#/components/schemas/Gbr-electricity.payment-methodCharacteristic"
},
{
"$ref": "#/components/schemas/MaximumCapacityCharacteristic"
}
]
No attributes to display
22 April 2026
New
{
"x-enum-descriptions": {}
}Old
{
"x-enum-descriptions": {
"GBE": "National Grid GBE"
}
}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
No attributes to display
No attributes to display
No attributes to display
15 April 2026
No attributes to display
9 April 2026
New
{
"x-enum-descriptions": {
"POLE": "Pole",
"LIGHT": "Light"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"POLE": "Pole",
"LIGHT": "Light"
}
}Old
{
"x-enum-descriptions": {}
}1 April 2026
New
{
"x-enum-descriptions": {
"IFS": "IFS"
}
}Old
{
"x-enum-descriptions": {}
}30 March 2026
No attributes to display
No attributes to display
27 March 2026
New
{
"x-enum-descriptions": {
"CUSTOM": "Custom"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"CUSTOM": "Custom"
}
}Old
{
"x-enum-descriptions": {}
}24 March 2026
New
{
"x-removal-date": "2026-04-29"
}16 March 2026
No attributes to display
New
{
"gbr-electricity.meter-rate-profile": "#/components/schemas/Gbr-electricity.meter-rate-profileCharacteristic"
}New
[
{
"$ref": "#/components/schemas/Gbr-electricity.payment-methodCharacteristic"
},
{
"$ref": "#/components/schemas/Gbr-electricity.meter-rate-profileCharacteristic"
},
{
"$ref": "#/components/schemas/SalesChannelCharacteristic"
},
{
"$ref": "#/components/schemas/MaximumCapacityCharacteristic"
}
]Old
[
{
"$ref": "#/components/schemas/Gbr-electricity.payment-methodCharacteristic"
},
{
"$ref": "#/components/schemas/MaximumCapacityCharacteristic"
},
{
"$ref": "#/components/schemas/SalesChannelCharacteristic"
}
]13 March 2026
New
{
"x-enum-descriptions": {
"GBE": "National Grid GBE"
}
}Old
{
"x-enum-descriptions": {}
}5 March 2026
New
{
"x-enum-descriptions": {
"services": "Services"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"Services": "Services"
}
}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"
]
}
]
}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 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 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 that if historical statement transaction are provided then so is a last statement closing date or last billed to date",
"description": "Validate that if <code>historical_statement_transactions</code> are provided in the payload then either a <code>last_statement_closing_date</code> or <code>last_billed_to_date</code> is also provided. If a <code>last_statement_closing_date</code> is not provided then the earliest <code>last_billed_to_date</code> on the account or supply points is used to determine when the last statement should have closed.",
"possible_errors": [
"historical_statement_transactions_without_last_statement_closing_date_or_last_billed_to_date"
]
},
{
"name": "Validate unique transaction IDs",
"description": "Validate that all transaction IDs provided are unique.",
"possible_errors": [
"duplicate_transaction_ids",
"missing_transaction_id"
]
},
{
"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 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 no duplicated ledgers are provided",
"description": "Validate no duplicated ledger codes are in `ledgers` section.",
"possible_errors": [
"duplicate_ledger_entries_found"
]
},
{
"name": "Validate identifiers are unique in ledgers",
"description": "Validate identifier is not declared twice in ledgers.",
"possible_errors": [
"duplicate_identifiers_entries_found"
]
},
{
"name": "Validate ledger identifiers are known",
"description": "Validate ledger identifiers are among supply point identifiers.",
"possible_errors": [
"unknown_ledger_identifiers"
]
},
{
"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 that payment plans and payment schedules for the same ledger are not both in payload",
"description": "Validate that if there are payment plans in the payload, there are not also payment schedules on the same ledger because payment plans create a schedule containing all of the planned payments.",
"possible_errors": [
"payment_plan_and_payment_schedule_not_allowed_on_same_ledger"
]
},
{
"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 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 agreements cover the last billed to date",
"description": "Validate that there is an agreement covering the last billed to date for each supply point.",
"possible_errors": [
"no_agreement_covering_last_billed_to_date"
]
},
{
"name": "Validate debt and debts",
"description": "Validates that both debt and debts are not specified in the payload.",
"possible_errors": [
"debt_and_debts_are_defined"
]
},
{
"name": "Validate that a last billed to date has been provided correctly",
"description": "Validate that, for each meter, a last billed to date has been provided in the appropriate place. For electricity meters, it must be provided on each of the meter's settlement registers. For gas meters, it must be provided on the meter. This validation does not apply to meters with half-hourly billing, or meters that have been exchanged where the new meter has already been billed. This validation is skipped if the account has not yet been billed and therefore has no historical statement data.",
"possible_errors": [
"last_billed_to_date_not_found"
]
},
{
"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. Note that any prepay vend transactions are not included in the above check.",
"possible_errors": [
"current_statement_transaction_before_current_statement_opening_date"
]
},
{
"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. Prepay transactions (those with the <code>to_prepay_meter_serial_number</code> field on the transaction) are filtered out as these are treated separately during account creation.",
"possible_errors": [
"balance_mismatch_on_transfer_balance"
]
},
{
"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>. Prepay transactions (those with the <code>to_prepay_meter_serial_number</code> field on the transaction) are filtered out as these are treated separately during account creation.",
"possible_errors": [
"historical_statement_transactions_balance_mismatch"
]
},
{
"name": "Validate next bill due date provided for quarterly billing",
"description": "Validate that if <code>use_industry_billing</code> is false in the account billing options and the <code>period_length</code> is <code>QUARTERLY</code>, then a <code>next_bill_due_date</code> is provided.",
"possible_errors": [
"next_bill_to_date_not_provided_for_quarterly_billing"
]
},
{
"name": "Validate account billing options",
"description": "Validate that account billing options have only been provided for business accounts.",
"possible_errors": [
"account_billing_options_provided_for_domestic_accounts"
]
},
{
"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 prepay transactions target initialised prepay meters",
"description": "Validate that if <code>current_statement_transactions</code> or <code>historical_statement_transactions</code> target a prepay meter (i.e. has the <code>to_prepay_meter_serial_number</code> field), then a prepay meter with that serial number exists in the payload. A prepay meter is identified in the payload by the presence of <code>prepay_details</code>.",
"possible_errors": [
"transactions_target_non_initialised_prepay_meter"
]
},
{
"name": "Validate tax exemption for appropriate account type",
"description": "Validate that the tax exemption is only in place for business accounts.",
"possible_errors": [
"tax_exemptions_provided_for_domestic_account"
]
},
{
"name": "Validate prepay transfer vend read dates match last billed to date",
"description": "Validate that the transfer vend read dates match the last billed to date. This only applies to prepay meters.The last billed to date can be either at the account level or the at the meter/register level. Last billed to dates at the meter/register level take precedent over the account level date if both are provided.",
"possible_errors": [
"prepay_details_on_fully_billed_meter",
"transfer_vend_read_date_must_match_last_billed_to_date"
]
},
{
"name": "Validate that the tariff type and meter point type match",
"description": "Validate that the tariff we have on a given contract matches the meter point type. For example, check eco7 (2-rate) meter points don't have single-rate tariffs or vice versa.",
"possible_errors": [
"tariff_type_does_not_match_meter_point_type"
]
},
{
"name": "Validate bespoke rates",
"description": "Validate that if bespoke rates have been set the account is business.",
"possible_errors": [
"business_fields_provided_for_domestic_accounts"
]
},
{
"name": "Validate billing address provided",
"description": "Validate <code>billing_address1</code> and <code>billing_postcode</code> are provided for non-occupier accounts.",
"possible_errors": [
"billing_address_not_provided"
]
},
{
"name": "Validate current AQ for billable meter point",
"description": "Check that we have a currently valid AQ for a billable MPRN.",
"possible_errors": [
"no_current_or_future_aq_entry_found"
]
},
{
"name": "Validate all billable meter points are covered by agreements in the payload",
"description": "Validate that agreements have been provided for all billable meter points and vice versa for the period covered by Kraken from a billing perspective. A billable meter point is one that has an open-ended or future dated supply end date.",
"possible_errors": [
"meter_point_with_no_agreement",
"meterpoint_with_agreement_not_on_supply"
]
},
{
"name": "Validate transfer readings exist on active gas meters",
"description": "Validate that each active gas meter has a single transfer reading provided.",
"possible_errors": [
"active_gas_meter_with_multiple_transfer_readings",
"active_gas_meter_without_transfer_reading",
"reading_meter_fully_billed"
]
},
{
"name": "Validate EACs provided for active registers",
"description": "Validate that EACs are provided in the <code>eac_history</code> array for each active electricity register. EACs are matched to registers using the <code>tpr</code> field present on both the EAC and register objects.",
"possible_errors": [
"missing_eacs_for_active_register_tpr"
]
},
{
"name": "Validate that prepay meters are matched to agreements of the correct type",
"description": "Validate that each prepay meter has a matching agreement on a prepay tariff, and similarly non-prepay meters on non-prepay tariffs. Note that this validation only applies for active meters and agreements.",
"possible_errors": [
"tariff_type_does_not_match_meter_type"
]
},
{
"name": "Validate each agreement is not effective before the product is available",
"description": "Ensures that the agreement <code>effective_from</code> is not before the datetime the agreement's product is available from. We check this if Kraken will be responsible for billing before the product is available and the product is a variable or tracker product.",
"possible_errors": [
"agreement_effective_from_before_product_available_from"
]
},
{
"name": "Validate that all variable products on a contract have start dates after the product start date",
"description": "Validate that any variable products that are part of a contract only become effective after the product is available.",
"possible_errors": [
"agreement_cannot_start_before_product_available"
]
},
{
"name": "Validate that no meter points are ending supply in the future",
"description": "Ensure that all meters points have either ended supply or are not planned for supply to end.",
"possible_errors": [
"future_supply_end_date"
]
},
{
"name": "Validate that all off supply meter points with meters have a final reading",
"description": "Ensure that all off supply meter points which have meters have a final reading on their end date.",
"possible_errors": [
"no_reading_on_supply_end_date"
]
},
{
"name": "Validate that no billable meter points are starting supply in the future",
"description": "Validate that no billable meter points are set to start supply in the future.",
"possible_errors": [
"future_supply_start_date"
]
},
{
"name": "Validate that all billable meter points have active meters",
"description": "Ensure that all meter points that are billable have active meters or have an unmetered measurement class provided in the payload.",
"possible_errors": [
"meter_point_with_no_meters"
]
},
{
"name": "Validate that at least one of the meter points needs billing",
"description": "Ensure that at least one of the meter points for this account are billable.",
"possible_errors": [
"no_supply_point_on_supply"
]
},
{
"name": "Validate that a domestic account does not have any business only supply points",
"description": "Validate that a domestic account does not have supply points with supply types <code>REGOS_EXPORT_CERTIFICATES</code> or <code>ROCS_EXPORT_CERTIFICATES</code> which are business only supply types.",
"possible_errors": [
"business_supply_type_on_domestic_account"
]
},
{
"name": "Validate business account has account billing options with <code>period_start_day</code> and <code>period_length</code>",
"description": "Validate that business account's <code>account_billing_options</code> include period start day and period length if <code>account_billing_options</code> is being provided. If <code>account_billing_options</code> is not provided then the defaults of 1 for <code>period_start_day</code> and \"MONTHLY\" for <code>period_length</code> will be used.",
"possible_errors": [
"business_account_missing_billing_options"
]
},
{
"name": "Validate that customers provided for business accounts",
"description": "Validate that at least one customer is provided for business accounts. Customers are needed for business accounts to ensure that meter points can be successfully registered for supply.",
"possible_errors": [
"business_account_missing_customers"
]
},
{
"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 transfer readings exist on active electricity registers",
"description": "Validate that each active electricity meter register has a single transfer reading provided.",
"possible_errors": [
"missing_transfer_reading_for_register",
"multiple_transfer_readings_for_register"
]
}
]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 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 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 all contracts have supply points",
"description": "Validates that contracts provided in the payload have a corresponding supply point.",
"possible_errors": [
"agreement_has_no_matching_meter_point"
]
},
{
"name": "Validate that if historical statement transaction are provided then so is a last statement closing date or last billed to date",
"description": "Validate that if <code>historical_statement_transactions</code> are provided in the payload then either a <code>last_statement_closing_date</code> or <code>last_billed_to_date</code> is also provided. If a <code>last_statement_closing_date</code> is not provided then the earliest <code>last_billed_to_date</code> on the account or supply points is used to determine when the last statement should have closed.",
"possible_errors": [
"historical_statement_transactions_without_last_statement_closing_date_or_last_billed_to_date"
]
},
{
"name": "Validate unique transaction IDs",
"description": "Validate that all transaction IDs provided are unique.",
"possible_errors": [
"duplicate_transaction_ids",
"missing_transaction_id"
]
},
{
"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 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 no duplicated ledgers are provided",
"description": "Validate no duplicated ledger codes are in `ledgers` section.",
"possible_errors": [
"duplicate_ledger_entries_found"
]
},
{
"name": "Validate identifiers are unique in ledgers",
"description": "Validate identifier is not declared twice in ledgers.",
"possible_errors": [
"duplicate_identifiers_entries_found"
]
},
{
"name": "Validate ledger identifiers are known",
"description": "Validate ledger identifiers are among supply point identifiers.",
"possible_errors": [
"unknown_ledger_identifiers"
]
},
{
"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 that payment plans and payment schedules for the same ledger are not both in payload",
"description": "Validate that if there are payment plans in the payload, there are not also payment schedules on the same ledger because payment plans create a schedule containing all of the planned payments.",
"possible_errors": [
"payment_plan_and_payment_schedule_not_allowed_on_same_ledger"
]
},
{
"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 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 agreements cover the last billed to date",
"description": "Validate that there is an agreement covering the last billed to date for each supply point.",
"possible_errors": [
"no_agreement_covering_last_billed_to_date"
]
},
{
"name": "Validate debt and debts",
"description": "Validates that both debt and debts are not specified in the payload.",
"possible_errors": [
"debt_and_debts_are_defined"
]
},
{
"name": "Validate that a last billed to date has been provided correctly",
"description": "Validate that, for each meter, a last billed to date has been provided in the appropriate place. For electricity meters, it must be provided on each of the meter's settlement registers. For gas meters, it must be provided on the meter. This validation does not apply to meters with half-hourly billing, or meters that have been exchanged where the new meter has already been billed. This validation is skipped if the account has not yet been billed and therefore has no historical statement data.",
"possible_errors": [
"last_billed_to_date_not_found"
]
},
{
"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. Note that any prepay vend transactions are not included in the above check.",
"possible_errors": [
"current_statement_transaction_before_current_statement_opening_date"
]
},
{
"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. Prepay transactions (those with the <code>to_prepay_meter_serial_number</code> field on the transaction) are filtered out as these are treated separately during account creation.",
"possible_errors": [
"balance_mismatch_on_transfer_balance"
]
},
{
"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>. Prepay transactions (those with the <code>to_prepay_meter_serial_number</code> field on the transaction) are filtered out as these are treated separately during account creation.",
"possible_errors": [
"historical_statement_transactions_balance_mismatch"
]
},
{
"name": "Validate next bill due date provided for quarterly billing",
"description": "Validate that if <code>use_industry_billing</code> is false in the account billing options and the <code>period_length</code> is <code>QUARTERLY</code>, then a <code>next_bill_due_date</code> is provided.",
"possible_errors": [
"next_bill_to_date_not_provided_for_quarterly_billing"
]
},
{
"name": "Validate account billing options",
"description": "Validate that account billing options have only been provided for business accounts.",
"possible_errors": [
"account_billing_options_provided_for_domestic_accounts"
]
},
{
"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 prepay transactions target initialised prepay meters",
"description": "Validate that if <code>current_statement_transactions</code> or <code>historical_statement_transactions</code> target a prepay meter (i.e. has the <code>to_prepay_meter_serial_number</code> field), then a prepay meter with that serial number exists in the payload. A prepay meter is identified in the payload by the presence of <code>prepay_details</code>.",
"possible_errors": [
"transactions_target_non_initialised_prepay_meter"
]
},
{
"name": "Validate tax exemption for appropriate account type",
"description": "Validate that the tax exemption is only in place for business accounts.",
"possible_errors": [
"tax_exemptions_provided_for_domestic_account"
]
},
{
"name": "Validate prepay transfer vend read dates match last billed to date",
"description": "Validate that the transfer vend read dates match the last billed to date. This only applies to prepay meters.The last billed to date can be either at the account level or the at the meter/register level. Last billed to dates at the meter/register level take precedent over the account level date if both are provided.",
"possible_errors": [
"prepay_details_on_fully_billed_meter",
"transfer_vend_read_date_must_match_last_billed_to_date"
]
},
{
"name": "Validate that the tariff type and meter point type match",
"description": "Validate that the tariff we have on a given contract matches the meter point type. For example, check eco7 (2-rate) meter points don't have single-rate tariffs or vice versa.",
"possible_errors": [
"tariff_type_does_not_match_meter_point_type"
]
},
{
"name": "Validate bespoke rates",
"description": "Validate that if bespoke rates have been set the account is business.",
"possible_errors": [
"business_fields_provided_for_domestic_accounts"
]
},
{
"name": "Validate billing address provided",
"description": "Validate <code>billing_address1</code> and <code>billing_postcode</code> are provided for non-occupier accounts.",
"possible_errors": [
"billing_address_not_provided"
]
},
{
"name": "Validate current AQ for billable meter point",
"description": "Check that we have a currently valid AQ for a billable MPRN.",
"possible_errors": [
"no_current_or_future_aq_entry_found"
]
},
{
"name": "Validate all billable meter points are covered by agreements in the payload",
"description": "Validate that agreements have been provided for all billable meter points and vice versa for the period covered by Kraken from a billing perspective. A billable meter point is one that has an open-ended or future dated supply end date.",
"possible_errors": [
"meter_point_with_no_agreement",
"meterpoint_with_agreement_not_on_supply"
]
},
{
"name": "Validate transfer readings exist on active gas meters",
"description": "Validate that each active gas meter has a single transfer reading provided.",
"possible_errors": [
"active_gas_meter_with_multiple_transfer_readings",
"active_gas_meter_without_transfer_reading",
"reading_meter_fully_billed"
]
},
{
"name": "Validate EACs provided for active registers",
"description": "Validate that EACs are provided in the <code>eac_history</code> array for each active electricity register. EACs are matched to registers using the <code>tpr</code> field present on both the EAC and register objects.",
"possible_errors": [
"missing_eacs_for_active_register_tpr"
]
},
{
"name": "Validate that prepay meters are matched to agreements of the correct type",
"description": "Validate that each prepay meter has a matching agreement on a prepay tariff, and similarly non-prepay meters on non-prepay tariffs. Note that this validation only applies for active meters and agreements.",
"possible_errors": [
"tariff_type_does_not_match_meter_type"
]
},
{
"name": "Validate each agreement is not effective before the product is available",
"description": "Ensures that the agreement <code>effective_from</code> is not before the datetime the agreement's product is available from. We check this if Kraken will be responsible for billing before the product is available and the product is a variable or tracker product.",
"possible_errors": [
"agreement_effective_from_before_product_available_from"
]
},
{
"name": "Validate that all variable products on a contract have start dates after the product start date",
"description": "Validate that any variable products that are part of a contract only become effective after the product is available.",
"possible_errors": [
"agreement_cannot_start_before_product_available"
]
},
{
"name": "Validate that no meter points are ending supply in the future",
"description": "Ensure that all meters points have either ended supply or are not planned for supply to end.",
"possible_errors": [
"future_supply_end_date"
]
},
{
"name": "Validate that all off supply meter points with meters have a final reading",
"description": "Ensure that all off supply meter points which have meters have a final reading on their end date.",
"possible_errors": [
"no_reading_on_supply_end_date"
]
},
{
"name": "Validate that no billable meter points are starting supply in the future",
"description": "Validate that no billable meter points are set to start supply in the future.",
"possible_errors": [
"future_supply_start_date"
]
},
{
"name": "Validate that all billable meter points have active meters",
"description": "Ensure that all meter points that are billable have active meters or have an unmetered measurement class provided in the payload.",
"possible_errors": [
"meter_point_with_no_meters"
]
},
{
"name": "Validate that at least one of the meter points needs billing",
"description": "Ensure that at least one of the meter points for this account are billable.",
"possible_errors": [
"no_supply_point_on_supply"
]
},
{
"name": "Validate that a domestic account does not have any business only supply points",
"description": "Validate that a domestic account does not have supply points with supply types <code>REGOS_EXPORT_CERTIFICATES</code> or <code>ROCS_EXPORT_CERTIFICATES</code> which are business only supply types.",
"possible_errors": [
"business_supply_type_on_domestic_account"
]
},
{
"name": "Validate business account has account billing options with <code>period_start_day</code> and <code>period_length</code>",
"description": "Validate that business account's <code>account_billing_options</code> include period start day and period length if <code>account_billing_options</code> is being provided. If <code>account_billing_options</code> is not provided then the defaults of 1 for <code>period_start_day</code> and \"MONTHLY\" for <code>period_length</code> will be used.",
"possible_errors": [
"business_account_missing_billing_options"
]
},
{
"name": "Validate that customers provided for business accounts",
"description": "Validate that at least one customer is provided for business accounts. Customers are needed for business accounts to ensure that meter points can be successfully registered for supply.",
"possible_errors": [
"business_account_missing_customers"
]
},
{
"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 transfer readings exist on active electricity registers",
"description": "Validate that each active electricity meter register has a single transfer reading provided.",
"possible_errors": [
"missing_transfer_reading_for_register",
"multiple_transfer_readings_for_register"
]
}
]13 February 2026
Use instead
consents