Data Import REST API Changelog
This page shows recent changes to Data Import REST API.
Deprecated fields
These fields are currently deprecated. Update integrations before they are removed.
24 fields
FraBusinessWithExistingContracts.business_contract_identifier
Use instead:
business_contracts
Removed by
January 2027
AccountNote.account_number
Use instead:
external_account_number
Removed by
January 2027
PlenitudefrAccount.unknown_occupier
Use instead:
account_type
Removed by
January 2027
View all deprecated fields
Transactions.account_number
Use instead:
external_account_number
Removed by
January 2027
AccountCampaign.campaign_name
Use instead:
slug
Removed by
January 2027
Address.name
No replacement specified
Removed by
January 2027
Address.organization
No replacement specified
Removed by
January 2027
Payment.display_note
No replacement specified
Removed by
January 2027
AccountContract.terms
Use instead:
versions
Removed by
February 2027
BusinessContract.terms
Use instead:
versions
Removed by
February 2027
TerminationFee.amount
Use instead:
market_configs
Removed by
June 2027
TerminationFee.fee_type
Use instead:
market_configs
Removed by
June 2027
TerminationFee.supply_type
Use instead:
market_configs
Removed by
June 2027
BusinessUser.details
Use instead:
user_details
Date not announced
FraBusinessWithExistingContracts.business_contract_identifiers
Use instead:
business_contracts
Date not announced
FraCustomer.customer_preferences
Use instead:
consents
Date not announced
FraCustomer.details
Use instead:
user_details
Date not announced
PropertyAdministrator.address1
No replacement specified
Date not announced
PropertyAdministrator.address2
No replacement specified
Date not announced
PropertyAdministrator.address3
No replacement specified
Date not announced
PropertyAdministrator.address4
No replacement specified
Date not announced
PropertyAdministrator.address5
No replacement specified
Date not announced
PropertyAdministrator.postcode
No replacement specified
Date not announced
Repayment.display_note
No replacement specified
Date not announced
6 November 2026 - Latest
New
{
"x-enum-descriptions": {
"CUSTOMER_REFERRAL": "Customer referral",
"OVERPAYMENT_INVOICE": "Overpayment invoice",
"OVERPAYMENT_INSTALMENT": "Overpayment instalment",
"REFUND_ENERGY_INDUSTRY_ACT": "Refund Energy Industry Act"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"CUSTOM": "Custom"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"CUSTOM": "Custom"
}
}Old
{
"x-enum-descriptions": {}
}5 November 2026
New
[
{
"name": "Validate that at least one contract identifier is provided for import",
"description": "Validate that at least one of <code>business_contract_identifiers</code> or <code>business_contract_identifier</code> is provided in the payload.",
"possible_errors": [
"missing_contract_identifier"
]
},
{
"name": "Validate that <code>\u2068business_contract_identifiers\u2069</code> and <code>\u2068business_contracts\u2069</code> are not both provided",
"description": "Validate that \u2068business_contract_identifiers\u2069 and \u2068business_contracts\u2069 are not both provided.",
"possible_errors": [
"fields_are_mutually_exclusive"
]
},
{
"name": "Validate that the provided <code>siret</code> starts with the provided <code>siren</code>",
"description": "Validate that the SIRET starts with the <code>siren</code> provided in business details. A SIRET is the SIREN followed by a 5-digit establishment number.",
"possible_errors": [
"siret_does_not_match_siren"
]
},
{
"name": "Validate that the provided <code>siret</code> is registered with only one business",
"description": "Validate that SIRET provided is registered with only one business. SIRET should be unique.",
"possible_errors": [
"siret_registered_with_another_business"
]
},
{
"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 both SIREN and SIRET are provided for a business accounts",
"description": "Validate that <code>siren</code> and <code>siret</code> are provided for a business. <code>siret</code> should be provided in business details. This validator will not be active when we choose to link accounts to business using contracts.",
"possible_errors": []
},
{
"name": "Validate that the combination of SIREN and SIRET or condominium registration number is provided for SDC (Syndic de Copropri\u00e9t\u00e9) business accounts",
"description": "Validate that either a combination of <code>siren</code> and <code>siret</code> or <code>condominium_registration_number</code> is provided for business accounts, when the business type is SDC. Both <code>siren</code> and <code>condominium_registration_number</code> should be provided in business details. This validator will not be active when we choose to link accounts to business using contracts.",
"possible_errors": []
},
{
"name": "fra:data-import--validation--siret-is-required-for-non-sdc-business-with-existing-contracts--display-name",
"description": "fra:data-import--validation--siret-is-required-for-non-sdc-business-with-existing-contracts--help-text",
"possible_errors": [
"siret_not_provided_for_non_sdc_business_with_existing_contracts"
]
},
{
"name": "Validate that the provided <code>siret</code> is registered with the business of the business contracts",
"description": "When accounts are linked to the business of their business contracts, validate that the SIRET, if already registered, belongs to that business.",
"possible_errors": [
"siret_registered_with_another_business"
]
}
]Old
[
{
"name": "Validate that at least one contract identifier is provided for import",
"description": "Validate that at least one of <code>business_contract_identifiers</code> or <code>business_contract_identifier</code> is provided in the payload.",
"possible_errors": [
"missing_contract_identifier"
]
},
{
"name": "Validate that <code>\u2068business_contract_identifiers\u2069</code> and <code>\u2068business_contracts\u2069</code> are not both provided",
"description": "Validate that \u2068business_contract_identifiers\u2069 and \u2068business_contracts\u2069 are not both provided.",
"possible_errors": [
"fields_are_mutually_exclusive"
]
},
{
"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 both SIREN and SIRET are provided for a business accounts",
"description": "Validate that <code>siren</code> and <code>siret</code> are provided for a business. <code>siret</code> should be provided in business details. This validator will not be active when we choose to link accounts to business using contracts.",
"possible_errors": []
},
{
"name": "Validate that the combination of SIREN and SIRET or condominium registration number is provided for SDC (Syndic de Copropri\u00e9t\u00e9) business accounts",
"description": "Validate that either a combination of <code>siren</code> and <code>siret</code> or <code>condominium_registration_number</code> is provided for business accounts, when the business type is SDC. Both <code>siren</code> and <code>condominium_registration_number</code> should be provided in business details. This validator will not be active when we choose to link accounts to business using contracts.",
"possible_errors": []
},
{
"name": "fra:data-import--validation--siret-is-required-for-non-sdc-business-with-existing-contracts--display-name",
"description": "fra:data-import--validation--siret-is-required-for-non-sdc-business-with-existing-contracts--help-text",
"possible_errors": [
"siret_not_provided_for_non_sdc_business_with_existing_contracts"
]
}
]New
[
{
"name": "Validate that both SIREN and SIRET are provided for a business",
"description": "Validate that <code>siren</code> and <code>siret</code> are provided for a business. <code>siret</code> should be provided in business details.",
"possible_errors": [
"siren_or_siret_not_provided_for_business"
]
},
{
"name": "Validate that the combination of SIREN and SIRET or condominium registration number is provided for SDC (Syndic de Copropri\u00e9t\u00e9) business",
"description": "Validate that either a combination of <code>siren</code> and <code>siret</code> or <code>condominium_registration_number</code> is provided for business, when the business type is SDC. Both <code>siren</code> and <code>condominium_registration_number</code> should be provided in business details.",
"possible_errors": [
"siren_and_siret_or_condominium_registration_number_not_provided_for_sdc"
]
},
{
"name": "Validate that the provided <code>siret</code> starts with the provided <code>siren</code>",
"description": "Validate that the SIRET starts with the <code>siren</code> provided in business details. A SIRET is the SIREN followed by a 5-digit establishment number.",
"possible_errors": [
"siret_does_not_match_siren"
]
},
{
"name": "Validate that the provided <code>siret</code> is registered with only one business",
"description": "Validate that SIRET provided is registered with only one business. SIRET should be unique.",
"possible_errors": [
"siret_registered_with_another_business"
]
}
]Old
[
{
"name": "Validate that both SIREN and SIRET are provided for a business",
"description": "Validate that <code>siren</code> and <code>siret</code> are provided for a business. <code>siret</code> should be provided in business details.",
"possible_errors": [
"siren_or_siret_not_provided_for_business"
]
},
{
"name": "Validate that the combination of SIREN and SIRET or condominium registration number is provided for SDC (Syndic de Copropri\u00e9t\u00e9) business",
"description": "Validate that either a combination of <code>siren</code> and <code>siret</code> or <code>condominium_registration_number</code> is provided for business, when the business type is SDC. Both <code>siren</code> and <code>condominium_registration_number</code> should be provided in business details.",
"possible_errors": [
"siren_and_siret_or_condominium_registration_number_not_provided_for_sdc"
]
},
{
"name": "Validate that the provided <code>siret</code> is registered with only one business",
"description": "Validate that SIRET provided is registered with only one business. SIRET should be unique.",
"possible_errors": [
"siret_registered_with_another_business"
]
}
]New
[
{
"name": "Validate that both SIREN and SIRET are provided for a business",
"description": "Validate that <code>siren</code> and <code>siret</code> are provided for a business. <code>siret</code> should be provided in business details.",
"possible_errors": [
"siren_or_siret_not_provided_for_business"
]
},
{
"name": "Validate that the combination of SIREN and SIRET or condominium registration number is provided for SDC (Syndic de Copropri\u00e9t\u00e9) business",
"description": "Validate that either a combination of <code>siren</code> and <code>siret</code> or <code>condominium_registration_number</code> is provided for business, when the business type is SDC. Both <code>siren</code> and <code>condominium_registration_number</code> should be provided in business details.",
"possible_errors": [
"siren_and_siret_or_condominium_registration_number_not_provided_for_sdc"
]
},
{
"name": "Validate that the provided <code>siret</code> starts with the provided <code>siren</code>",
"description": "Validate that the SIRET starts with the <code>siren</code> provided in business details. A SIRET is the SIREN followed by a 5-digit establishment number.",
"possible_errors": [
"siret_does_not_match_siren"
]
},
{
"name": "Validate that the provided <code>siret</code> is registered with only one business",
"description": "Validate that SIRET provided is registered with only one business. SIRET should be unique.",
"possible_errors": [
"siret_registered_with_another_business"
]
}
]Old
[
{
"name": "Validate that both SIREN and SIRET are provided for a business",
"description": "Validate that <code>siren</code> and <code>siret</code> are provided for a business. <code>siret</code> should be provided in business details.",
"possible_errors": [
"siren_or_siret_not_provided_for_business"
]
},
{
"name": "Validate that the combination of SIREN and SIRET or condominium registration number is provided for SDC (Syndic de Copropri\u00e9t\u00e9) business",
"description": "Validate that either a combination of <code>siren</code> and <code>siret</code> or <code>condominium_registration_number</code> is provided for business, when the business type is SDC. Both <code>siren</code> and <code>condominium_registration_number</code> should be provided in business details.",
"possible_errors": [
"siren_and_siret_or_condominium_registration_number_not_provided_for_sdc"
]
},
{
"name": "Validate that the provided <code>siret</code> is registered with only one business",
"description": "Validate that SIRET provided is registered with only one business. SIRET should be unique.",
"possible_errors": [
"siret_registered_with_another_business"
]
}
]4 November 2026
New
{
"x-enum-descriptions": {
"ANNUAL_PEAK_CONSUMPTION": "ANNUAL_PEAK_CONSUMPTION"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"test_test": "test rayan"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"test rayan": "test rayan"
}
}Old
{
"x-enum-descriptions": {}
}30 October 2026
New
{
"x-enum-descriptions": {
"B2B-TAIL-FUTURE-CONTRACTS": "Future Contracts"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"B2B-TAIL-FUTURE-CONTRACTS": "Future Contracts"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"B2B-TAIL-FUTURE-CONTRACTS": "Future Contracts"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"B2B-TAIL-FUTURE-CONTRACTS": "Future Contracts"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"B2B-TAIL-FUTURE-CONTRACTS": "Future Contracts"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"B2B-TAIL-FUTURE-CONTRACTS": "Future Contracts"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"B2B-TAIL-FUTURE-CONTRACTS": "Future Contracts"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"B2B-TAIL-FUTURE-CONTRACTS": "Future Contracts"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"B2B-TAIL-FUTURE-CONTRACTS": "Future Contracts"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"B2B-TAIL-FUTURE-CONTRACTS": "Future Contracts"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"B2B-TAIL-FUTURE-CONTRACTS": "Future Contracts"
}
}Old
{
"x-enum-descriptions": {}
}29 October 2026
New
{
"x-enum-descriptions": {
"ee_email_1": "EE Email_1",
"konecta_mhs": "Konecta MHS",
"ee_email_pre": "EE Email Pre",
"konecta_softcall": "Konecta Softcall",
"equipe_interne_mhs": "Equipe interne MHS",
"konecta_avis_de_coupure": "Konecta Avis de Coupure",
"konecta_mise_en_demeure": "Konecta Mise en Demeure",
"equipe_interne_avis_de_coupure": "Equipe interne Avis de Coupure",
"equipe_interne_mise_en_demeure": "Equipe Interne Mise en Demeure"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"EE Email_1": "EE Email_1",
"Konecta MHS": "Konecta MHS",
"EE Email Pre": "EE Email Pre",
"Konecta Softcall": "Konecta Softcall",
"Equipe interne MHS": "Equipe interne MHS",
"Konecta Avis de Coupure": "Konecta Avis de Coupure",
"Konecta Mise en Demeure": "Konecta Mise en Demeure",
"Equipe Interne Mise en Demeure": "Equipe Interne Mise en Demeure",
"Equipe interne Avis de Coupure": "Equipe interne Avis de Coupure"
}
}Old
{
"x-enum-descriptions": {}
}27 October 2026
No attributes to display
No attributes to display
No attributes to display
New
{
"x-enum-descriptions": {
"CUSTOM": "CUSTOM"
}
}Old
{
"x-enum-descriptions": {}
}26 October 2026
No attributes to display
No attributes to display
19 October 2026
No attributes to display
New
{
"enum": [
"INSUFFICIENT_CREDIT_HISTORY",
"ADVERSE_CREDIT_SCORE",
"HIGH_EXPOSURE",
"PRIOR_DEFAULT",
"NON_RESIDENT",
"STANDARD_POLICY",
"REGULATORY",
"OTHER"
],
"x-spec-enum-id": "db4e2cabc89dc6ec",
"x-enum-descriptions": {
"OTHER": "OTHER",
"REGULATORY": "REGULATORY",
"NON_RESIDENT": "NON_RESIDENT",
"HIGH_EXPOSURE": "HIGH_EXPOSURE",
"PRIOR_DEFAULT": "PRIOR_DEFAULT",
"STANDARD_POLICY": "STANDARD_POLICY",
"ADVERSE_CREDIT_SCORE": "ADVERSE_CREDIT_SCORE",
"INSUFFICIENT_CREDIT_HISTORY": "INSUFFICIENT_CREDIT_HISTORY"
}
}16 October 2026
No attributes to display
No attributes to display
No attributes to display
New
{
"x-enum-descriptions": {
"UNMETERED_ELECTRICITY_DISTRIBUTION": "Unmetered Electricity Distribution"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"UNMETERED_ELECTRICITY_DISTRIBUTION": "Unmetered Electricity Distribution"
}
}Old
{
"x-enum-descriptions": {}
}15 October 2026
No attributes to display
No attributes to display
New
[
{
"name": "Validate that contract versions include a version for the current terms",
"description": "Validate that the earliest version in the list of contract versions provided has an <code>applicable_at_date</code> that is equal to the contract <code>valid_from_date</code>.",
"possible_errors": [
"contract_versions_does_not_include_current"
]
},
{
"name": "Validate an affiliate organisation is given for a described partner commission",
"description": "Validate that a contract whose partner commission term describes a commission by its fields also names the affiliate organisation the commission belongs to.",
"possible_errors": [
"affiliate_organisation_required_for_partner_commissions"
]
},
{
"name": "Validate discount target eligibility windows overlap with the contract period",
"description": "Validates that any eligibility windows defined on discount targets within a PromotionAssignment term overlap with the contract's effective period.",
"possible_errors": [
"promotion_assignment_discount_target_eligibility_window_does_not_overlap_contract"
]
}
]Old
[
{
"name": "Validate that contract versions include a version for the current terms",
"description": "Validate that the earliest version in the list of contract versions provided has an <code>applicable_at_date</code> that is equal to the contract <code>valid_from_date</code>.",
"possible_errors": [
"contract_versions_does_not_include_current"
]
},
{
"name": "Validate an affiliate organisation is given for a described partner commission",
"description": "Validate that a contract whose partner commission term describes a commission by its fields also names the affiliate organisation the commission belongs to.",
"possible_errors": [
"affiliate_organisation_required_for_partner_commissions"
]
}
]New
{
"items": {
"x-enum-descriptions": {
"CONSULTATION_B2B": "CONSULTATION_B2B"
}
}
}Old
{
"items": {
"x-enum-descriptions": {}
}
}New
{
"items": {
"x-enum-descriptions": {
"CONSULTATION_B2B": "CONSULTATION_B2B"
}
}
}Old
{
"items": {
"x-enum-descriptions": {}
}
}New
{
"items": {
"x-enum-descriptions": {
"CONSULTATION_B2B": "CONSULTATION_B2B"
}
}
}Old
{
"items": {
"x-enum-descriptions": {}
}
}New
[
{
"name": "Validate campaign slug is provided",
"description": "Validates that a campaign slug is provided in the payload, either directly or resolved from a campaign name.",
"possible_errors": [
"campaign_slug_required"
]
},
{
"name": "Validate campaign exists",
"description": "Validates that a campaign passed in the payload exists in Kraken.",
"possible_errors": [
"campaign_not_found"
]
},
{
"name": "Validate <code>\u2068expiry_date\u2069</code> not before or equal to <code>\u2068start_date\u2069</code>",
"description": "Validates that <code>\u2068expiry_date\u2069</code>, if given, is strictly later than \u2068start_date\u2069.",
"possible_errors": [
"start_date_same_as_end_date"
]
}
]Old
[
{
"name": "Validate campaign name or slug provided",
"description": "Validate that a campaign name or slug is provided in the payload.",
"possible_errors": [
"campaign_name_and_slug_provided",
"campaign_name_or_slug_not_provided"
]
},
{
"name": "Validate campaign exists",
"description": "Validates that a campaign passed in the payload exists in Kraken.",
"possible_errors": [
"campaign_not_found"
]
},
{
"name": "Validate <code>\u2068expiry_date\u2069</code> not before or equal to <code>\u2068start_date\u2069</code>",
"description": "Validates that <code>\u2068expiry_date\u2069</code>, if given, is strictly later than \u2068start_date\u2069.",
"possible_errors": [
"start_date_same_as_end_date"
]
}
]New
{
"x-removal-date": "2027-01-23"
}Old
{
"default": ""
}14 October 2026
No attributes to display
New
{
"x-enum-descriptions": {
"HRA": "HRA",
"HUD": "HUD",
"HEAP": "HEAP",
"EDI_820": "EDI_820",
"ONESTEP": "ONESTEP",
"ACH_PAYMENT": "ACH_PAYMENT",
"DSS_PAYMENT": "DSS_PAYMENT",
"DSS_UTX_TAPE": "DSS_UTX_TAPE",
"CARE_AND_SHARE": "CARE_AND_SHARE",
"DIRECT_DEPOSIT": "DIRECT_DEPOSIT",
"LEGACY_PAYMENT": "LEGACY_PAYMENT",
"FUEL_ASSISTANCE": "FUEL_ASSISTANCE",
"TRUNCATED_CHECK": "TRUNCATED_CHECK",
"FIELD_COLLECTION": "FIELD_COLLECTION",
"EMERGENCY_PAYMENT": "EMERGENCY_PAYMENT",
"BANKRUPTCY_TRUSTEE": "BANKRUPTCY_TRUSTEE",
"LIHEAP_PAYMENT_PRIMARY": "LIHEAP_PAYMENT_PRIMARY",
"MIXED_PAYMENT_CASH_CHECK": "MIXED_PAYMENT_CASH_CHECK",
"RPPS_THIRD_PARTY_PAYMENT": "RPPS_THIRD_PARTY_PAYMENT"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"LEGACY_REFUND": "Legacy Refund"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-validators": [
{
"name": "Validate required customer details namespaces provided",
"description": "No required namespaces configured. Validation skipped.",
"possible_errors": [
"required_customer_details_namespace_missing"
]
},
{
"name": "Validate that user_details does not contain duplicate namespaces",
"description": "Validate that <code>user_details</code> does not contain more than one entry for the same <code>namespace</code>.",
"possible_errors": [
"duplicate_user_detail_namespaces"
]
}
]
}Old
{
"x-validators": [
{
"name": "Validate required customer details namespaces provided",
"description": "No required namespaces configured. Validation skipped.",
"possible_errors": [
"required_customer_details_namespace_missing"
]
}
]
}
No attributes to display
New
{
"x-validators": [
{
"name": "Validate required customer details namespaces provided",
"description": "No required namespaces configured. Validation skipped.",
"possible_errors": [
"required_customer_details_namespace_missing"
]
},
{
"name": "Validate that user_details does not contain duplicate namespaces",
"description": "Validate that <code>user_details</code> does not contain more than one entry for the same <code>namespace</code>.",
"possible_errors": [
"duplicate_user_detail_namespaces"
]
}
]
}Old
{
"x-validators": [
{
"name": "Validate required customer details namespaces provided",
"description": "No required namespaces configured. Validation skipped.",
"possible_errors": [
"required_customer_details_namespace_missing"
]
}
]
}
No attributes to display
New
{
"x-validators": [
{
"name": "Validate tax item amount is a whole number of the minor unit",
"description": "Validates that a tax item's <code>amount</code> is a whole number in the currency's minor unit, for example <code>2000</code> pence rather than <code>2000.75</code>.",
"possible_errors": [
"tax_item_amount_not_whole_minor_unit"
]
}
]
}13 October 2026
New
{
"x-comment": "Choices for this field are dynamic, once appropriate values have been configured they will be rendered here.",
"x-spec-enum-id": "4f53cda18c2baa0c"
}Old
{
"type": "string",
"maxLength": 50
}New
{
"x-removal-date": "2027-01-30"
}New
{
"x-use-instead": "kraken_account_number",
"x-removal-date": "2027-01-31"
}New
{
"x-enum-descriptions": {
"STREETLIGHT_BRACKET_CAPITAL": "Streetlight Bracket Capital",
"STREETLIGHT_SUPPORT_CAPITAL": "Streetlight Support Capital",
"STREETLIGHT_LUMINAIRE_CAPITAL": "Streetlight Luminaire Capital",
"STREETLIGHT_BRACKET_MAINTENANCE": "Streetlight Bracket Maintenance",
"STREETLIGHT_SUPPORT_MAINTENANCE": "Streetlight Support Maintenance",
"STREETLIGHT_LUMINAIRE_MAINTENANCE": "Streetlight Luminaire Maintenance"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"STREETLIGHT_BRACKET_CAPITAL": "Streetlight Bracket Capital",
"STREETLIGHT_SUPPORT_CAPITAL": "Streetlight Support Capital",
"STREETLIGHT_LUMINAIRE_CAPITAL": "Streetlight Luminaire Capital",
"STREETLIGHT_BRACKET_MAINTENANCE": "Streetlight Bracket Maintenance",
"STREETLIGHT_SUPPORT_MAINTENANCE": "Streetlight Support Maintenance",
"STREETLIGHT_LUMINAIRE_MAINTENANCE": "Streetlight Luminaire Maintenance"
}
}Old
{
"x-enum-descriptions": {}
}10 October 2026
No attributes to display
No attributes to display
9 October 2026
New
{
"x-removal-date": "2027-01-30"
}New
{
"x-validators": [
{
"name": "Validate no duplicate contract identifiers",
"description": "Validates that no duplicate contract identifiers have been provided in the payload.",
"possible_errors": [
"duplicate_contract_identifiers"
]
}
]
}New
{
"x-removal-date": "2027-01-30"
}New
{
"x-removal-date": "2027-01-20"
}New
{
"x-removal-date": "2027-01-20"
}
No attributes to display
No attributes to display
7 October 2026
No attributes to display
No attributes to display
Removal date
2027-06-01
Use instead
market_configs
Removal date
2027-06-01
Use instead
market_configs
Removal date
2027-06-01
Use instead
market_configs
5 October 2026
No attributes to display
New
{
"x-enum-descriptions": {
"wekiwi": "wekiwi"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"wekiwi": "wekiwi"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"wekiwi_renew": "Wekiwi Renew"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"Wekiwi Renew": "Wekiwi Renew"
}
}Old
{
"x-enum-descriptions": {}
}
No attributes to display
New
[
{
"name": "Validate <code>\u2068valid_to\u2069</code> not before <code>\u2068valid_from\u2069</code>",
"description": "Validates that <code>\u2068valid_to\u2069</code>, if given, is on or later than <code>\u2068valid_from\u2069</code>.",
"possible_errors": [
"start_date_later_than_end_date"
]
},
{
"name": "Validate contracted volume bounds are ordered",
"description": "Validate that a contracted volume period's minimum is not greater than its maximum",
"possible_errors": [
"contracted_volume_minimum_exceeds_maximum"
]
},
{
"name": "Validate contracted volume unit is valid for its market",
"description": "Validate that a contracted volume period's unit is one its market accepts",
"possible_errors": [
"contracted_volume_unit_invalid_for_market"
]
}
]Old
[
{
"name": "Validate <code>\u2068valid_to\u2069</code> not before <code>\u2068valid_from\u2069</code>",
"description": "Validates that <code>\u2068valid_to\u2069</code>, if given, is on or later than <code>\u2068valid_from\u2069</code>.",
"possible_errors": [
"start_date_later_than_end_date"
]
},
{
"name": "Validate contracted volume bounds are ordered",
"description": "Validate that a contracted volume period's minimum is not greater than its maximum",
"possible_errors": [
"contracted_volume_minimum_exceeds_maximum"
]
},
{
"name": "Validate contracted volume unit is valid for its market",
"description": "Validate that a contracted volume period's unit is one its market accepts",
"possible_errors": [
"contracted_volume_unit_invalid_for_market"
]
},
{
"name": "Validate contracted volume purpose is valid for its market",
"description": "Validate that a contracted volume period's purpose is one its market defines",
"possible_errors": [
"contracted_volume_purpose_invalid_for_market"
]
}
]2 October 2026
New
{
"x-enum-descriptions": {
"REGUL_PRIX": "REGUL_PRIX"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-removal-date": "2027-01-20"
}Old
{
"x-removal-date": "2026-12-10"
}1 October 2026
New
{
"x-enum-descriptions": {
"BANK_TRANSFER": "BANK_TRANSFER"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"INSTANT_BONUS": "Instantbonus",
"INSTANT_BONUS_PAID_OUT_MIGRATION": "Paid Instant Bonus (Migrated)"
}
}Old
{
"x-enum-descriptions": {}
}29 September 2026
New
[
{
"name": "Validate <code>\u2068valid_to\u2069</code> not before <code>\u2068valid_from\u2069</code>",
"description": "Validates that <code>\u2068valid_to\u2069</code>, if given, is on or later than <code>\u2068valid_from\u2069</code>.",
"possible_errors": [
"start_date_later_than_end_date"
]
},
{
"name": "Validate contracted volume bounds are ordered",
"description": "Validate that a contracted volume period's minimum is not greater than its maximum",
"possible_errors": [
"contracted_volume_minimum_exceeds_maximum"
]
},
{
"name": "Validate contracted volume unit is valid for its market",
"description": "Validate that a contracted volume period's unit is one its market accepts",
"possible_errors": [
"contracted_volume_unit_invalid_for_market"
]
},
{
"name": "Validate contracted volume purpose is valid for its market",
"description": "Validate that a contracted volume period's purpose is one its market defines",
"possible_errors": [
"contracted_volume_purpose_invalid_for_market"
]
}
]Old
[
{
"name": "Validate <code>\u2068valid_to\u2069</code> not before <code>\u2068valid_from\u2069</code>",
"description": "Validates that <code>\u2068valid_to\u2069</code>, if given, is on or later than <code>\u2068valid_from\u2069</code>.",
"possible_errors": [
"start_date_later_than_end_date"
]
},
{
"name": "Validate contracted volume bounds are ordered",
"description": "Validate that a contracted volume period's minimum is not greater than its maximum",
"possible_errors": [
"contracted_volume_minimum_exceeds_maximum"
]
},
{
"name": "Validate contracted volume unit is valid for its market",
"description": "Validate that a contracted volume period's unit is one its market accepts",
"possible_errors": [
"contracted_volume_unit_invalid_for_market"
]
}
]
No attributes to display
28 September 2026
New
{
"x-enum-descriptions": {
"test_camp": "TEST_CAMP"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"TEST_CAMP": "TEST_CAMP"
}
}Old
{
"x-enum-descriptions": {}
}25 September 2026
No attributes to display
22 September 2026
New
{
"x-validators": [
{
"name": "Validate that each child has a unique combination of values for the <code>\u2068market_name, fee_type\u2069</code> fields",
"description": "Validate that each child has a unique combination of values for the <code>\u2068market_name, fee_type\u2069</code> fields.",
"possible_errors": [
"children_with_duplicate_values"
]
}
]
}Removal date
2026-10-15
21 September 2026
New
{
"TRANCHE_TARGET_RESIDUAL_FEE": "#/components/schemas/TrancheTargetFee"
}Old
{
"TRANCHE_TARGET_RESIDUAL_FEE": "#/components/schemas/TrancheTargetResidualFee"
}New
[
{
"$ref": "#/components/schemas/BespokeRateConfiguration"
},
{
"$ref": "#/components/schemas/BillDueDate"
},
{
"$ref": "#/components/schemas/BillingDocumentIssuanceFrequencyTerm"
},
{
"$ref": "#/components/schemas/CharacteristicOverrideConfiguration"
},
{
"$ref": "#/components/schemas/CollateralRequired"
},
{
"$ref": "#/components/schemas/ContractMetaData"
},
{
"$ref": "#/components/schemas/ContractedVolumeConfiguration"
},
{
"$ref": "#/components/schemas/CorrectivePeriod"
},
{
"$ref": "#/components/schemas/DelayerDays"
},
{
"$ref": "#/components/schemas/GuaranteeOfOriginConfiguration"
},
{
"$ref": "#/components/schemas/LatePaymentFees"
},
{
"$ref": "#/components/schemas/MinimumContractLength"
},
{
"$ref": "#/components/schemas/PartnerCommission"
},
{
"$ref": "#/components/schemas/PaysByDirectDebitTerm"
},
{
"$ref": "#/components/schemas/ProductRateOverrideConfiguration"
},
{
"$ref": "#/components/schemas/PromotionAssignmentTerm"
},
{
"$ref": "#/components/schemas/RateGroupEligibilityConfiguration"
},
{
"$ref": "#/components/schemas/TaxAdjustmentConfiguration"
},
{
"$ref": "#/components/schemas/TerminationFee"
},
{
"$ref": "#/components/schemas/TrancheTargetConfiguration"
},
{
"$ref": "#/components/schemas/TrancheTargetFee"
}
]Old
[
{
"$ref": "#/components/schemas/BespokeRateConfiguration"
},
{
"$ref": "#/components/schemas/BillDueDate"
},
{
"$ref": "#/components/schemas/BillingDocumentIssuanceFrequencyTerm"
},
{
"$ref": "#/components/schemas/CharacteristicOverrideConfiguration"
},
{
"$ref": "#/components/schemas/CollateralRequired"
},
{
"$ref": "#/components/schemas/ContractMetaData"
},
{
"$ref": "#/components/schemas/ContractedVolumeConfiguration"
},
{
"$ref": "#/components/schemas/CorrectivePeriod"
},
{
"$ref": "#/components/schemas/DelayerDays"
},
{
"$ref": "#/components/schemas/GuaranteeOfOriginConfiguration"
},
{
"$ref": "#/components/schemas/LatePaymentFees"
},
{
"$ref": "#/components/schemas/MinimumContractLength"
},
{
"$ref": "#/components/schemas/PartnerCommission"
},
{
"$ref": "#/components/schemas/PaysByDirectDebitTerm"
},
{
"$ref": "#/components/schemas/ProductRateOverrideConfiguration"
},
{
"$ref": "#/components/schemas/PromotionAssignmentTerm"
},
{
"$ref": "#/components/schemas/RateGroupEligibilityConfiguration"
},
{
"$ref": "#/components/schemas/TrancheTargetResidualFee"
},
{
"$ref": "#/components/schemas/TaxAdjustmentConfiguration"
},
{
"$ref": "#/components/schemas/TerminationFee"
},
{
"$ref": "#/components/schemas/TrancheTargetConfiguration"
}
]17 September 2026
New
{
"x-enum-descriptions": {
"EXCESS_FEE": "EXCESS_FEE",
"SHORTFALL_FEE": "SHORTFALL_FEE"
}
}Old
{
"x-enum-descriptions": {}
}
No attributes to display
16 September 2026
New
{
"x-enum-descriptions": {
"PGO_TELESALES_IN": "PGO_TELESALES_IN"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"PGO_TELESALES_IN": "PGO TELESALES IN"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"PGO_TELESALES_IN": "PGO TELESALES IN"
}
}Old
{
"x-enum-descriptions": {}
}14 September 2026
New
{
"x-removal-date": "2026-10-11"
}New
{
"x-removal-date": "2026-10-11"
}Removal date
2026-12-10
Use instead
account_type
New
{
"x-removal-date": "2026-10-06"
}New
{
"x-removal-date": "2026-10-28"
}11 September 2026
New
[
{
"name": "Validate that either <code>\u2068partner_commission_number\u2069</code> or <code>\u2068partner_commission\u2069</code> are provided",
"description": "Validate that exactly one of <code>\u2068partner_commission_number\u2069</code> or <code>\u2068partner_commission\u2069</code> is provided.",
"possible_errors": [
"mutually_exclusive_field_required"
]
},
{
"name": "Validate an uplift is only applied to a trailing partner commission",
"description": "Validate that apply_uplift is not set for a one-off partner commission, which has no price-adjustment bundle to uplift.",
"possible_errors": [
"partner_commission_definition_invalid"
]
},
{
"name": "Validate a fixed-amount override is only applied to a one-off partner commission",
"description": "Validate that override_fixed_amount is not set for a trailing partner commission, which has no fixed-amount override on its contract.",
"possible_errors": [
"partner_commission_definition_invalid"
]
}
]Old
[
{
"name": "Validate a fixed-amount override is only applied to a one-off partner commission",
"description": "Validate that override_fixed_amount is not set for a trailing partner commission, which has no fixed-amount override on its contract.",
"possible_errors": [
"partner_commission_definition_invalid"
]
}
]
No attributes to display
Old
{
"required": true
}New
{
"x-validators": [
{
"name": "Validate partner commission numbers exist",
"description": "Validate that all partner commission numbers in the term configurations exist in Kraken.",
"possible_errors": [
"not_found"
]
},
{
"name": "Validate partner commission definitions are unique",
"description": "Validate that no two configurations in the term describe the same partner commission, which would resolve to one commission held twice by the term.",
"possible_errors": [
"duplicate_partner_commission_definitions"
]
}
]
}Old
{
"x-validators": [
{
"name": "Validate partner commission numbers exist",
"description": "Validate that all partner commission numbers in the term configurations exist in Kraken.",
"possible_errors": [
"not_found"
]
}
]
}New
[
{
"name": "Validate that contract versions include a version for the current terms",
"description": "Validate that the earliest version in the list of contract versions provided has an <code>applicable_at_date</code> that is equal to the contract <code>valid_from_date</code>.",
"possible_errors": [
"contract_versions_does_not_include_current"
]
},
{
"name": "Validate an affiliate organisation is given for a described partner commission",
"description": "Validate that a contract whose partner commission term describes a commission by its fields also names the affiliate organisation the commission belongs to.",
"possible_errors": [
"affiliate_organisation_required_for_partner_commissions"
]
}
]Old
[
{
"name": "Validate that contract versions include a version for the current terms",
"description": "Validate that the earliest version in the list of contract versions provided has an <code>applicable_at_date</code> that is equal to the contract <code>valid_from_date</code>.",
"possible_errors": [
"contract_versions_does_not_include_current"
]
}
]New
{
"items": {
"x-enum-descriptions": {
"CAN_QUERY_PARTNER_PERMISSIONS": "CAN_QUERY_PARTNER_PERMISSIONS"
}
}
}Old
{
"items": {
"x-enum-descriptions": {}
}
}New
{
"items": {
"x-enum-descriptions": {
"CAN_QUERY_PARTNER_PERMISSIONS": "CAN_QUERY_PARTNER_PERMISSIONS"
}
}
}Old
{
"items": {
"x-enum-descriptions": {}
}
}New
{
"items": {
"x-enum-descriptions": {
"CAN_QUERY_PARTNER_PERMISSIONS": "CAN_QUERY_PARTNER_PERMISSIONS"
}
}
}Old
{
"items": {
"x-enum-descriptions": {}
}
}10 September 2026
No attributes to display
No attributes to display
No attributes to display
No attributes to display
New
{
"required": true
}7 September 2026
New
{
"items": {
"x-enum-descriptions": {
"RECORDING_TRANSCRIPT": "RECORDING_TRANSCRIPT"
}
}
}Old
{
"items": {
"x-enum-descriptions": {}
}
}New
{
"items": {
"x-enum-descriptions": {
"RECORDING_TRANSCRIPT": "RECORDING_TRANSCRIPT"
}
}
}Old
{
"items": {
"x-enum-descriptions": {}
}
}New
{
"items": {
"x-enum-descriptions": {
"RECORDING_TRANSCRIPT": "RECORDING_TRANSCRIPT"
}
}
}Old
{
"items": {
"x-enum-descriptions": {}
}
}New
{
"x-enum-descriptions": {
"prime_fidelite_octobre_2026": "Prime Fid\u00e9lit\u00e9 - Octobre 2026"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"Prime Fid\u00e9lit\u00e9 - Octobre 2026": "Prime Fid\u00e9lit\u00e9 - Octobre 2026"
}
}Old
{
"x-enum-descriptions": {}
}4 September 2026
No attributes to display
31 August 2026
New
[
{
"name": "Validate that account data is staged and account created",
"description": "Validate that an account exists for the <code>external_account_number</code> and <code>import_supplier</code> code. This means that the import data must already have been staged and processed into an account.",
"possible_errors": [
"account_not_found",
"import_process_does_not_exist"
]
},
{
"name": "Validate that migration is ongoing",
"description": "Validate whether or not an import supplier is open for further data migration.",
"possible_errors": [
"import_supplier_migration_not_ongoing"
]
},
{
"name": "Validate that either <code>\u2068instruction_reference\u2069</code> or <code>\u2068reference\u2069</code> are provided",
"description": "Validate that exactly one of <code>\u2068instruction_reference\u2069</code> or <code>\u2068reference\u2069</code> is provided.",
"possible_errors": [
"mutually_exclusive_field_required"
]
},
{
"name": "Validate card type is only given for card instructions",
"description": "Validates that a card type is only provided when the payment instruction is a card.",
"possible_errors": [
"card_type_on_non_card_instruction"
]
}
]Old
[
{
"name": "Validate that account data is staged and account created",
"description": "Validate that an account exists for the <code>external_account_number</code> and <code>import_supplier</code> code. This means that the import data must already have been staged and processed into an account.",
"possible_errors": [
"account_not_found",
"import_process_does_not_exist"
]
},
{
"name": "Validate that migration is ongoing",
"description": "Validate whether or not an import supplier is open for further data migration.",
"possible_errors": [
"import_supplier_migration_not_ongoing"
]
},
{
"name": "Validate that either <code>\u2068instruction_reference\u2069</code> or <code>\u2068reference\u2069</code> are provided",
"description": "Validate that exactly one of <code>\u2068instruction_reference\u2069</code> or <code>\u2068reference\u2069</code> is provided.",
"possible_errors": [
"mutually_exclusive_field_required"
]
}
]
No attributes to display
27 August 2026
No attributes to display
No attributes to display
New
{
"required": true
}New
[
{
"name": "Validate <code>\u2068effective_to\u2069</code> not before <code>\u2068effective_from\u2069</code>",
"description": "Validates that <code>\u2068effective_to\u2069</code>, if given, is on or later than <code>\u2068effective_from\u2069</code>.",
"possible_errors": [
"start_date_later_than_end_date"
]
},
{
"name": "Validate addons are compatible with their agreement",
"description": "Validate that addons provided for an agreement are compatible and configured for agreement's product.",
"possible_errors": [
"addon_band_not_valid_for_agreement",
"multiple_addons_in_the_same_family"
]
},
{
"name": "Validate that the rate bands given in the rate overrides are valid for the product code",
"description": "Validate that the rate bands given in the rate overrides exist for the agreement's product.",
"possible_errors": [
"invalid_period",
"rate_band_does_not_exist"
]
},
{
"name": "Validate that required product characteristics are provided",
"description": "Validates that when an agreement's product is linked to a specification defining product characteristics, a value for each required characteristic is provided in <code>characteristics</code>.",
"possible_errors": [
"missing_required_product_characteristics"
]
}
]Old
[
{
"name": "Validate <code>\u2068effective_to\u2069</code> not before <code>\u2068effective_from\u2069</code>",
"description": "Validates that <code>\u2068effective_to\u2069</code>, if given, is on or later than <code>\u2068effective_from\u2069</code>.",
"possible_errors": [
"start_date_later_than_end_date"
]
},
{
"name": "Validate addons are compatible with their agreement",
"description": "Validate that addons provided for an agreement are compatible and configured for agreement's product.",
"possible_errors": [
"addon_band_not_valid_for_agreement",
"multiple_addons_in_the_same_family"
]
},
{
"name": "Validate that the rate bands given in the rate overrides are valid for the product code",
"description": "Validate that the rate bands given in the rate overrides exist for the agreement's product.",
"possible_errors": [
"invalid_period",
"rate_band_does_not_exist"
]
}
]26 August 2026
No attributes to display
No attributes to display
21 August 2026
New
{
"x-enum-descriptions": {
"FRAIS_DIV": "FRAIS_DIV"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"FRAIS_DIV": "FRAIS_DIV"
}
}Old
{
"x-enum-descriptions": {}
}20 August 2026
No attributes to display
No attributes to display
19 August 2026
New
{
"x-enum-descriptions": {
"ADVANCE_PAYMENT": "Advance Payment"
}
}Old
{
"x-enum-descriptions": {}
}
No attributes to display
18 August 2026
New
[
{
"name": "Validate <code>\u2068valid_to\u2069</code> not before <code>\u2068valid_from\u2069</code>",
"description": "Validates that <code>\u2068valid_to\u2069</code>, if given, is on or later than <code>\u2068valid_from\u2069</code>.",
"possible_errors": [
"start_date_later_than_end_date"
]
},
{
"name": "Validate contracted volume bounds are ordered",
"description": "Validate that a contracted volume period's minimum is not greater than its maximum",
"possible_errors": [
"contracted_volume_minimum_exceeds_maximum"
]
},
{
"name": "Validate contracted volume unit is valid for its market",
"description": "Validate that a contracted volume period's unit is one its market accepts",
"possible_errors": [
"contracted_volume_unit_invalid_for_market"
]
}
]Old
[
{
"name": "Validate <code>\u2068valid_to\u2069</code> not before <code>\u2068valid_from\u2069</code>",
"description": "Validates that <code>\u2068valid_to\u2069</code>, if given, is on or later than <code>\u2068valid_from\u2069</code>.",
"possible_errors": [
"start_date_later_than_end_date"
]
}
]
No attributes to display
No attributes to display
No attributes to display
14 August 2026
New
{
"x-enum-descriptions": {
"NO_CONTRACT": "No contract",
"OVERPAYMENT": "Overpayment",
"TRANSFER_ISU": "Transfer (ISU)",
"DD_FAILURE_ISU": "Direct debit failure (ISU)",
"CONTRACT_CANCELLATION": "Contract cancellation"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-removal-date": "2026-08-28"
}New
{
"x-removal-date": "2026-08-28"
}New
{
"x-removal-date": "2026-10-16"
}13 August 2026
New
[
{
"name": "Validate that at least one contract identifier is provided for import",
"description": "Validate that at least one of <code>business_contract_identifiers</code> or <code>business_contract_identifier</code> is provided in the payload.",
"possible_errors": [
"missing_contract_identifier"
]
},
{
"name": "Validate that <code>\u2068business_contract_identifiers\u2069</code> and <code>\u2068business_contracts\u2069</code> are not both provided",
"description": "Validate that \u2068business_contract_identifiers\u2069 and \u2068business_contracts\u2069 are not both provided.",
"possible_errors": [
"fields_are_mutually_exclusive"
]
},
{
"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 both SIREN and SIRET are provided for a business accounts",
"description": "Validate that <code>siren</code> and <code>siret</code> are provided for a business. <code>siret</code> should be provided in business details. This validator will not be active when we choose to link accounts to business using contracts.",
"possible_errors": []
},
{
"name": "Validate that the combination of SIREN and SIRET or condominium registration number is provided for SDC (Syndic de Copropri\u00e9t\u00e9) business accounts",
"description": "Validate that either a combination of <code>siren</code> and <code>siret</code> or <code>condominium_registration_number</code> is provided for business accounts, when the business type is SDC. Both <code>siren</code> and <code>condominium_registration_number</code> should be provided in business details. This validator will not be active when we choose to link accounts to business using contracts.",
"possible_errors": []
},
{
"name": "fra:data-import--validation--siret-is-required-for-non-sdc-business-with-existing-contracts--display-name",
"description": "fra:data-import--validation--siret-is-required-for-non-sdc-business-with-existing-contracts--help-text",
"possible_errors": [
"siret_not_provided_for_non_sdc_business_with_existing_contracts"
]
}
]Old
[
{
"name": "Validate that at least one contract identifier is provided for import",
"description": "Validate that at least one of <code>business_contract_identifiers</code> or <code>business_contract_identifier</code> is provided in the payload.",
"possible_errors": [
"missing_contract_identifier"
]
},
{
"name": "Validate that 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 both SIREN and SIRET are provided for a business accounts",
"description": "Validate that <code>siren</code> and <code>siret</code> are provided for a business. <code>siret</code> should be provided in business details. This validator will not be active when we choose to link accounts to business using contracts.",
"possible_errors": []
},
{
"name": "Validate that the combination of SIREN and SIRET or condominium registration number is provided for SDC (Syndic de Copropri\u00e9t\u00e9) business accounts",
"description": "Validate that either a combination of <code>siren</code> and <code>siret</code> or <code>condominium_registration_number</code> is provided for business accounts, when the business type is SDC. Both <code>siren</code> and <code>condominium_registration_number</code> should be provided in business details. This validator will not be active when we choose to link accounts to business using contracts.",
"possible_errors": []
},
{
"name": "fra:data-import--validation--siret-is-required-for-non-sdc-business-with-existing-contracts--display-name",
"description": "fra:data-import--validation--siret-is-required-for-non-sdc-business-with-existing-contracts--help-text",
"possible_errors": [
"siret_not_provided_for_non_sdc_business_with_existing_contracts"
]
}
]
No attributes to display
Use instead
business_contracts
New
{
"x-use-instead": "business_contracts"
}Old
{
"x-use-instead": "business_contract_identifiers"
}12 August 2026
New
{
"x-enum-descriptions": {
"KWH_DAYS": "Kilowatt-hour days"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"KWH_DAYS": "Kilowatt-hour days"
}
}Old
{
"x-enum-descriptions": {}
}11 August 2026
No attributes to display
10 August 2026
New
{
"x-enum-descriptions": {
"CEO": "CEO"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"items": {
"x-enum-descriptions": {
"CEO": "CEO"
}
}
}Old
{
"items": {
"x-enum-descriptions": {}
}
}New
{
"items": {
"x-enum-descriptions": {
"CEO": "CEO"
}
}
}Old
{
"items": {
"x-enum-descriptions": {}
}
}New
{
"items": {
"x-enum-descriptions": {
"CEO": "CEO"
}
}
}Old
{
"items": {
"x-enum-descriptions": {}
}
}7 August 2026
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
}5 August 2026
New
{
"x-enum-descriptions": {
"test_without_date": "Test without date"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"Test without date": "Test without date"
}
}Old
{
"x-enum-descriptions": {}
}4 August 2026
New
[
{
"name": null,
"description": null,
"possible_errors": [
"incomplete_payments_not_enabled"
]
}
]Old
[
{
"name": null,
"description": null,
"possible_errors": [
"incomplete_payments_not_enabled"
]
},
{
"name": "Validate card details are provided for card payment instruction",
"description": "Validate that if the payment instruction is of type CARD then card payment details are provided in the payload. This may not be enforced if client is using cashflow instructions as card details are obtained from the vendor in this case.",
"possible_errors": [
"card_details_not_provided_for_card_payment_instruction"
]
}
]31 July 2026
New
[
{
"name": "Validate <code>\u2068valid_to\u2069</code> not before or equal to <code>\u2068valid_from\u2069</code>",
"description": "Validates that <code>\u2068valid_to\u2069</code>, if given, is strictly later than \u2068valid_from\u2069.",
"possible_errors": [
"start_date_same_as_end_date"
]
}
]Old
[
{
"name": "Validate <code>\u2068valid_to\u2069</code> not before or equal to <code>\u2068valid_from\u2069</code>",
"description": "Validates that <code>\u2068valid_to\u2069</code>, if given, is strictly later than \u2068valid_from\u2069.",
"possible_errors": [
"start_date_same_as_end_date"
]
},
{
"name": "Validate each item represents a possible rate for the product",
"description": "Validate each item's rate specification, characteristic values, and scheme labels represent a rate defned on the product.",
"possible_errors": [
"characteristic_code_not_found",
"invalid_characteristic_value",
"invalid_profile_variant_for_specification",
"product_specification_not_found_for_product",
"rate_specification_not_found_for_product",
"shared_rate_not_found",
"shared_rate_not_found_for_product"
]
},
{
"name": "Validate that all required bespoke rates are present and no non-overridable rates are supplied",
"description": "Validates that bespoke rate schedules include all rate specifications marked as must-be-overridden and mandatory, and do not include any rate specifications marked as cannot-be-overridden.",
"possible_errors": [
"bespoke_rate_cannot_be_overridden",
"missing_required_bespoke_rate"
]
}
]Old
{
"x-validators": [
{
"name": "Validate product code exists",
"description": "Validate that the product code exists in Kraken.",
"possible_errors": [
"product_code_does_not_exist"
]
}
]
}Old
{
"x-validators": [
{
"name": "Validate bespoke rate items are unique",
"description": "Validate that no two bespoke rate items in a schedule share the same rate specification code, rate specification type, and variant profile.",
"possible_errors": [
"duplicate_bespoke_rate_items"
]
}
]
}New
{
"x-validators": [
{
"name": "Validate bespoke rates do not conflict",
"description": "Validate bespoke rates for the same target and rate do not conflict during the same period. The target of a bespoke rate is determined by the supply point identifier and product code.",
"possible_errors": [
"overlapping_bespoke_rate_schedules"
]
},
{
"name": "Validate bespoke rate schedules target consistently",
"description": "Validate that bespoke rate schedules either all target supply points via the supply_point_identifier field or none do.",
"possible_errors": [
"inconsistent_bespoke_rate_schedule_targeting"
]
},
{
"name": "Validate bespoke rate schedules are valid",
"description": "Validate that each schedule references an existing product, contains unique items, represents rates defined by the product specification, and satisfies the product's rate override strategies.",
"possible_errors": [
"bespoke_rate_cannot_be_overridden",
"characteristic_code_not_found",
"duplicate_bespoke_rate_items",
"invalid_characteristic_value",
"invalid_profile_variant_for_specification",
"missing_required_bespoke_rate",
"product_code_does_not_exist",
"product_specification_not_found_for_product",
"rate_specification_not_found_for_product",
"shared_rate_not_found",
"shared_rate_not_found_for_product"
]
}
]
}Old
{
"x-validators": [
{
"name": "Validate bespoke rates do not conflict",
"description": "Validate bespoke rates for the same target and rate do not conflict during the same period. The target of a bespoke rate is determined by the supply point identifier and product code.",
"possible_errors": [
"overlapping_bespoke_rate_schedules"
]
},
{
"name": "Validate bespoke rate schedules target consistently",
"description": "Validate that bespoke rate schedules either all target supply points via the supply_point_identifier field or none do.",
"possible_errors": [
"inconsistent_bespoke_rate_schedule_targeting"
]
}
]
}30 July 2026
New
{
"x-enum-descriptions": {
"BLOCK+PEGDAWA-LI0560": "BLOCK+PEGDAWA-LI0560",
"BLOCK+PEGDAWA-LI0565": "BLOCK+PEGDAWA-LI0565"
}
}Old
{
"x-enum-descriptions": {}
}28 July 2026
New
{
"TRANCHE_TARGET_CONFIGURATION": "#/components/schemas/TrancheTargetConfiguration"
}New
[
{
"$ref": "#/components/schemas/BespokeRateConfiguration"
},
{
"$ref": "#/components/schemas/BillDueDate"
},
{
"$ref": "#/components/schemas/BillingDocumentIssuanceFrequencyTerm"
},
{
"$ref": "#/components/schemas/CharacteristicOverrideConfiguration"
},
{
"$ref": "#/components/schemas/CollateralRequired"
},
{
"$ref": "#/components/schemas/ContractMetaData"
},
{
"$ref": "#/components/schemas/ContractedVolumeConfiguration"
},
{
"$ref": "#/components/schemas/CorrectivePeriod"
},
{
"$ref": "#/components/schemas/DelayerDays"
},
{
"$ref": "#/components/schemas/GuaranteeOfOriginConfiguration"
},
{
"$ref": "#/components/schemas/LatePaymentFees"
},
{
"$ref": "#/components/schemas/MinimumContractLength"
},
{
"$ref": "#/components/schemas/PartnerCommission"
},
{
"$ref": "#/components/schemas/PaysByDirectDebitTerm"
},
{
"$ref": "#/components/schemas/ProductRateOverrideConfiguration"
},
{
"$ref": "#/components/schemas/PromotionAssignmentTerm"
},
{
"$ref": "#/components/schemas/RateGroupEligibilityConfiguration"
},
{
"$ref": "#/components/schemas/TrancheTargetResidualFee"
},
{
"$ref": "#/components/schemas/TaxAdjustmentConfiguration"
},
{
"$ref": "#/components/schemas/TerminationFee"
},
{
"$ref": "#/components/schemas/TrancheTargetConfiguration"
}
]Old
[
{
"$ref": "#/components/schemas/BespokeRateConfiguration"
},
{
"$ref": "#/components/schemas/BillDueDate"
},
{
"$ref": "#/components/schemas/BillingDocumentIssuanceFrequencyTerm"
},
{
"$ref": "#/components/schemas/CharacteristicOverrideConfiguration"
},
{
"$ref": "#/components/schemas/CollateralRequired"
},
{
"$ref": "#/components/schemas/ContractMetaData"
},
{
"$ref": "#/components/schemas/ContractedVolumeConfiguration"
},
{
"$ref": "#/components/schemas/CorrectivePeriod"
},
{
"$ref": "#/components/schemas/DelayerDays"
},
{
"$ref": "#/components/schemas/GuaranteeOfOriginConfiguration"
},
{
"$ref": "#/components/schemas/LatePaymentFees"
},
{
"$ref": "#/components/schemas/MinimumContractLength"
},
{
"$ref": "#/components/schemas/PartnerCommission"
},
{
"$ref": "#/components/schemas/PaysByDirectDebitTerm"
},
{
"$ref": "#/components/schemas/ProductRateOverrideConfiguration"
},
{
"$ref": "#/components/schemas/PromotionAssignmentTerm"
},
{
"$ref": "#/components/schemas/RateGroupEligibilityConfiguration"
},
{
"$ref": "#/components/schemas/TrancheTargetResidualFee"
},
{
"$ref": "#/components/schemas/TaxAdjustmentConfiguration"
},
{
"$ref": "#/components/schemas/TerminationFee"
}
]24 July 2026
New
{
"x-enum-descriptions": {
"Pixel_tracking_test": "J'accepte que mes communciations soient suivies par un pixel tracking"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"Pixel_tracking_test": "J'accepte que mes communciations soient suivies par un pixel tracking"
}
}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"
]
}
]
}New
{
"x-enum-descriptions": {
"PLENITUDE_FR_B2B_NO_BC_TEST": "Test Contract terms EZPlenitude FR B2B - Account Contract Only Test"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"PLENITUDE_FR_B2B_NO_BC_TEST": "Test Contract terms EZPlenitude FR B2B - Account Contract Only Test"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"PLENITUDE_FR_B2B_NO_BC_TEST": "Test Contract terms EZPlenitude FR B2B - Account Contract Only Test"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"PLENITUDE_FR_B2B_NO_BC_TEST": "Test Contract terms EZPlenitude FR B2B - Account Contract Only Test"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"PLENITUDE_FR_B2B_NO_BC_TEST": "Test Contract terms EZPlenitude FR B2B - Account Contract Only Test"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"PLENITUDE_FR_B2B_NO_BC_TEST": "Test Contract terms EZPlenitude FR B2B - Account Contract Only Test"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"PLENITUDE_FR_B2B_NO_BC_TEST": "Test Contract terms EZPlenitude FR B2B - Account Contract Only Test"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"PLENITUDE_FR_B2B_NO_BC_TEST": "Test Contract terms EZPlenitude FR B2B - Account Contract Only Test"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"PLENITUDE_FR_B2B_NO_BC_TEST": "Test Contract terms EZPlenitude FR B2B - Account Contract Only Test"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"PLENITUDE_FR_B2B_NO_BC_TEST": "Test Contract terms EZPlenitude FR B2B - Account Contract Only Test"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"PLENITUDE_FR_B2B_NO_BC_TEST": "Test Contract terms EZPlenitude FR B2B - Account Contract Only Test"
}
}Old
{
"x-enum-descriptions": {}
}21 July 2026
New
{
"x-enum-descriptions": {
"GIE": "Groupement d\u2019int\u00e9r\u00eat \u00e9conomique",
"SCP": "Soci\u00e9t\u00e9 civile professionnelle",
"SCOP": "Soci\u00e9t\u00e9 coop\u00e9rative et participative",
"PUBLIC": "Secteur Public",
"PRIVATE": "Secteur Priv\u00e9"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"GIE": "Groupement d\u2019int\u00e9r\u00eat \u00e9conomique",
"SCP": "Soci\u00e9t\u00e9 civile professionnelle",
"SCOP": "Soci\u00e9t\u00e9 coop\u00e9rative et participative",
"PUBLIC": "Secteur Public",
"PRIVATE": "Secteur Priv\u00e9"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"GIE": "Groupement d\u2019int\u00e9r\u00eat \u00e9conomique",
"SCP": "Soci\u00e9t\u00e9 civile professionnelle",
"SCOP": "Soci\u00e9t\u00e9 coop\u00e9rative et participative",
"PUBLIC": "Secteur Public",
"PRIVATE": "Secteur Priv\u00e9"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"PEGWA+Bloc_LI0561": "PEGWA+Bloc_LI0561"
}
}Old
{
"x-enum-descriptions": {}
}
No attributes to display
No attributes to display
17 July 2026
No attributes to display
No attributes to display
No attributes to display
No attributes to display
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"
]
}
]
}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"
]
}
]
}15 July 2026
New
{
"x-enum-descriptions": {
"KVAR_DAYS": "kVA reactive days"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"ADDITIONAL_CREDIT": "Additional credit"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"KVAR_DAYS": "kVA reactive days"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"ADDITIONAL_CREDIT": "Additional credit"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"FLAT": "contracts--terms--termination-fee-fee-type-flat"
}
}Old
{
"x-enum-descriptions": {
"FLAT": "Flat"
}
}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"
]
}
]14 July 2026
New
{
"x-enum-descriptions": {
"DANKORT": "Dankort"
}
}Old
{
"x-enum-descriptions": {}
}New
[
{
"name": "data-import--validation--shared-rate-exists-for-product",
"description": "Validate that the shared rate code provided matches the shared rate for the product with the provided product code.",
"possible_errors": [
"product_specification_not_found_for_product",
"time_series_not_found_for_product"
]
}
]Old
[
{
"name": "data-import--validation--time-series-exists-for-product",
"description": "Validate that the time series code provided matches the time series for the product with the provided product code.",
"possible_errors": [
"product_specification_not_found_for_product",
"time_series_not_found_for_product"
]
}
]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 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 ledger identifiers are known",
"description": "Validate ledger identifiers are among supply point identifiers.",
"possible_errors": [
"unknown_ledger_identifiers"
]
},
{
"name": "Validate identifiers are unique in ledgers",
"description": "Validate identifier is not declared twice in ledgers.",
"possible_errors": [
"duplicate_identifiers_entries_found"
]
},
{
"name": "Validate agreements cover last statement closing date",
"description": "Validate that there is an agreement for each supply point covering each ledger's <code>last_statement_closing_date</code>.",
"possible_errors": [
"no_agreement_covering_last_statement_closing_date"
]
},
{
"name": "Validate no unbilled period on former supply addresses",
"description": "Validate that if a customer is no longer at the given supply address they have been fully billed. This check is performed if we are importing supply address history.",
"possible_errors": [
"unbilled_former_supply_address"
]
},
{
"name": "Validate that Kraken can calculate when to start billing the account",
"description": "Validate that Kraken can calculate when to start billing the account. This is determined based on the existence of last billed to date, last statement closing date, and agreements.",
"possible_errors": [
"cannot_determine_responsible_for_billing_from_date"
]
},
{
"name": "Validate that only payment schedule or monthly billing frequency is provided",
"description": "Validate that only a <code>payment_schedule</code> or a monthly <code>billing_frequency</code> is provided, but not both.",
"possible_errors": [
"billing_frequency_incompatible_with_payment_schedule"
]
},
{
"name": "Validate that the account type is compatible with agreement's products",
"description": "Validate that the account type is compatible with all of the agreements' product codes. Business products cannot be provided for <code>DOMESTIC</code> accounts and vice versa.",
"possible_errors": [
"account_type_incompatible_with_agreement_product"
]
},
{
"name": "Validates that a supply address is provided for non portfolio lead accounts",
"description": "Validates if an account has account type that is not <code>PORTFOLIO_LEAD</code> then at least one supply address is provided.",
"possible_errors": [
"supply_address_missing"
]
},
{
"name": "Payment preference <code>supply_point_identifier</code> to supply point <code>identifier</code> association is valid.",
"description": "Validates that the association between the payment preference <code>supply_point_identifier</code> and supply point <code>identifier</code> are valid. For example:\nif we have a child collection <code>payment_preference</code> and a parent collection <code>supply_points</code>, this validator will ensure that all <code>payment_preferences</code> have a <code>supply_point_identifier</code> that exists in the <code>supply_points</code> collection.",
"possible_errors": [
"invalid_identifier_types",
"non_unique_parent_identifiers",
"parent_child_identifier_mismatch"
]
}
]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 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 ledger identifiers are known",
"description": "Validate ledger identifiers are among supply point identifiers.",
"possible_errors": [
"unknown_ledger_identifiers"
]
},
{
"name": "Validate identifiers are unique in ledgers",
"description": "Validate identifier is not declared twice in ledgers.",
"possible_errors": [
"duplicate_identifiers_entries_found"
]
},
{
"name": "Validate agreements cover last statement closing date",
"description": "Validate that there is an agreement for each supply point covering each ledger's <code>last_statement_closing_date</code>.",
"possible_errors": [
"no_agreement_covering_last_statement_closing_date"
]
},
{
"name": "Validate no unbilled period on former supply addresses",
"description": "Validate that if a customer is no longer at the given supply address they have been fully billed. This check is performed if we are importing supply address history.",
"possible_errors": [
"unbilled_former_supply_address"
]
},
{
"name": "Validate that Kraken can calculate when to start billing the account",
"description": "Validate that Kraken can calculate when to start billing the account. This is determined based on the existence of last billed to date, last statement closing date, and agreements.",
"possible_errors": [
"cannot_determine_responsible_for_billing_from_date"
]
},
{
"name": "Validate that only payment schedule or monthly billing frequency is provided",
"description": "Validate that only a <code>payment_schedule</code> or a monthly <code>billing_frequency</code> is provided, but not both.",
"possible_errors": [
"billing_frequency_incompatible_with_payment_schedule"
]
},
{
"name": "Validate that the account type is compatible with agreement's products",
"description": "Validate that the account type is compatible with all of the agreements' product codes. Business products cannot be provided for <code>DOMESTIC</code> accounts and vice versa.",
"possible_errors": [
"account_type_incompatible_with_agreement_product"
]
},
{
"name": "Validates that a supply address is provided for non portfolio lead accounts",
"description": "Validates if an account has account type that is not <code>PORTFOLIO_LEAD</code> then at least one supply address is provided.",
"possible_errors": [
"supply_address_missing"
]
},
{
"name": "Payment preference <code>supply_point_identifier</code> to supply point <code>identifier</code> association is valid.",
"description": "Validates that the association between the payment preference <code>supply_point_identifier</code> and supply point <code>identifier</code> are valid. For example:\nif we have a child collection <code>payment_preference</code> and a parent collection <code>supply_points</code>, this validator will ensure that all <code>payment_preferences</code> have a <code>supply_point_identifier</code> that exists in the <code>supply_points</code> collection.",
"possible_errors": [
"invalid_identifier_types",
"non_unique_parent_identifiers",
"parent_child_identifier_mismatch"
]
}
]8 July 2026
New
{
"x-validators": [
{
"name": "Validate bespoke rates do not conflict",
"description": "Validate bespoke rates for the same target and rate do not conflict during the same period. The target of a bespoke rate is determined by the supply point identifier and product code.",
"possible_errors": [
"overlapping_bespoke_rate_schedules"
]
},
{
"name": "Validate bespoke rate schedules target consistently",
"description": "Validate that bespoke rate schedules either all target supply points via the supply_point_identifier field or none do.",
"possible_errors": [
"inconsistent_bespoke_rate_schedule_targeting"
]
}
]
}Old
{
"x-validators": [
{
"name": "Validate schedules do not overlap",
"description": "Validate bespoke rate schedules for the same target do not overlap. The supply point identifier will be used as the target if provided, falling back to the product code.",
"possible_errors": [
"overlapping_bespoke_rate_schedules"
]
},
{
"name": "Validate bespoke rate schedules target consistently",
"description": "Validate that bespoke rate schedules either all target supply points via the supply_point_identifier field or none do.",
"possible_errors": [
"inconsistent_bespoke_rate_schedule_targeting"
]
}
]
}7 July 2026
New
[
{
"name": "Validate <code>\u2068valid_to\u2069</code> not before or equal to <code>\u2068valid_from\u2069</code>",
"description": "Validates that <code>\u2068valid_to\u2069</code>, if given, is strictly later than \u2068valid_from\u2069.",
"possible_errors": [
"start_date_same_as_end_date"
]
},
{
"name": "Validate each item represents a possible rate for the product",
"description": "Validate each item's rate specification, characteristic values, and scheme labels represent a rate defned on the product.",
"possible_errors": [
"characteristic_code_not_found",
"invalid_characteristic_value",
"invalid_profile_variant_for_specification",
"product_specification_not_found_for_product",
"rate_specification_not_found_for_product",
"shared_rate_not_found",
"shared_rate_not_found_for_product"
]
},
{
"name": "Validate that all required bespoke rates are present and no non-overridable rates are supplied",
"description": "Validates that bespoke rate schedules include all rate specifications marked as must-be-overridden and mandatory, and do not include any rate specifications marked as cannot-be-overridden.",
"possible_errors": [
"bespoke_rate_cannot_be_overridden",
"missing_required_bespoke_rate"
]
}
]Old
[
{
"name": "Validate <code>\u2068valid_to\u2069</code> not before <code>\u2068valid_from\u2069</code>",
"description": "Validates that <code>\u2068valid_to\u2069</code>, if given, is on or later than <code>\u2068valid_from\u2069</code>.",
"possible_errors": [
"start_date_later_than_end_date"
]
},
{
"name": "Validate each item represents a possible rate for the product",
"description": "Validate each item's rate specification, characteristic values, and scheme labels represent a rate defned on the product.",
"possible_errors": [
"characteristic_code_not_found",
"invalid_characteristic_value",
"invalid_profile_variant_for_specification",
"product_specification_not_found_for_product",
"rate_specification_not_found_for_product",
"shared_rate_not_found",
"shared_rate_not_found_for_product"
]
},
{
"name": "Validate that all required bespoke rates are present and no non-overridable rates are supplied",
"description": "Validates that bespoke rate schedules include all rate specifications marked as must-be-overridden and mandatory, and do not include any rate specifications marked as cannot-be-overridden.",
"possible_errors": [
"bespoke_rate_cannot_be_overridden",
"missing_required_bespoke_rate"
]
}
]6 July 2026
No attributes to display
3 July 2026
New
{
"x-enum-descriptions": {
"FRAIS_TEST": "FRAIS_TEST",
"TAUX_ZEERO": "TAUX_ZEERO"
}
}Old
{
"x-enum-descriptions": {}
}2 July 2026
New
{
"PARTNER_COMMISSION": "#/components/schemas/PartnerCommission"
}New
[
{
"$ref": "#/components/schemas/BespokeRateConfiguration"
},
{
"$ref": "#/components/schemas/BillDueDate"
},
{
"$ref": "#/components/schemas/BillingDocumentIssuanceFrequencyTerm"
},
{
"$ref": "#/components/schemas/CharacteristicOverrideConfiguration"
},
{
"$ref": "#/components/schemas/CollateralRequired"
},
{
"$ref": "#/components/schemas/ContractMetaData"
},
{
"$ref": "#/components/schemas/ContractedVolumeConfiguration"
},
{
"$ref": "#/components/schemas/CorrectivePeriod"
},
{
"$ref": "#/components/schemas/DelayerDays"
},
{
"$ref": "#/components/schemas/GuaranteeOfOriginConfiguration"
},
{
"$ref": "#/components/schemas/LatePaymentFees"
},
{
"$ref": "#/components/schemas/MinimumContractLength"
},
{
"$ref": "#/components/schemas/PartnerCommission"
},
{
"$ref": "#/components/schemas/PaysByDirectDebitTerm"
},
{
"$ref": "#/components/schemas/ProductRateOverrideConfiguration"
},
{
"$ref": "#/components/schemas/PromotionAssignmentTerm"
},
{
"$ref": "#/components/schemas/RateGroupEligibilityConfiguration"
},
{
"$ref": "#/components/schemas/TrancheTargetResidualFee"
},
{
"$ref": "#/components/schemas/TaxAdjustmentConfiguration"
},
{
"$ref": "#/components/schemas/TerminationFee"
}
]Old
[
{
"$ref": "#/components/schemas/BespokeRateConfiguration"
},
{
"$ref": "#/components/schemas/BillDueDate"
},
{
"$ref": "#/components/schemas/BillingDocumentIssuanceFrequencyTerm"
},
{
"$ref": "#/components/schemas/CharacteristicOverrideConfiguration"
},
{
"$ref": "#/components/schemas/CollateralRequired"
},
{
"$ref": "#/components/schemas/ContractMetaData"
},
{
"$ref": "#/components/schemas/ContractedVolumeConfiguration"
},
{
"$ref": "#/components/schemas/CorrectivePeriod"
},
{
"$ref": "#/components/schemas/DelayerDays"
},
{
"$ref": "#/components/schemas/GuaranteeOfOriginConfiguration"
},
{
"$ref": "#/components/schemas/LatePaymentFees"
},
{
"$ref": "#/components/schemas/MinimumContractLength"
},
{
"$ref": "#/components/schemas/PaysByDirectDebitTerm"
},
{
"$ref": "#/components/schemas/ProductRateOverrideConfiguration"
},
{
"$ref": "#/components/schemas/PromotionAssignmentTerm"
},
{
"$ref": "#/components/schemas/RateGroupEligibilityConfiguration"
},
{
"$ref": "#/components/schemas/TrancheTargetResidualFee"
},
{
"$ref": "#/components/schemas/TaxAdjustmentConfiguration"
},
{
"$ref": "#/components/schemas/TerminationFee"
}
]
No attributes to display
No attributes to display
Old
{
"maxItems": 1
}Old
{
"maxItems": 1
}1 July 2026
New
{
"x-validators": [
{
"name": "Validate bespoke rate items are unique",
"description": "Validate that no two bespoke rate items in a schedule share the same rate specification code, rate specification type, and variant profile.",
"possible_errors": [
"duplicate_bespoke_rate_items"
]
}
]
}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"
]
},
{
"name": "Validate that a phone number is provided for a customer with the default user role",
"description": "Validate that either a mobile or landline phone number is provided for a customer with a default portfolio or account user role.",
"possible_errors": [
"no_phone_number_provided"
]
}
]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"
]
},
{
"name": "Validate that a phone number is provided for a customer with the default user role",
"description": "Validate that either a mobile or landline phone number is provided for a customer with a default portfolio or account user role.",
"possible_errors": [
"no_phone_number_provided"
]
}
]
No attributes to display
No attributes to display
New
{
"x-enum-descriptions": {
"check_call_1": "check_call_1"
}
}Old
{
"x-enum-descriptions": {
"check_call_1": "Check_Call_1"
}
}New
{
"x-enum-descriptions": {
"check_call_1": "check_call_1"
}
}Old
{
"x-enum-descriptions": {
"Check_Call_1": "Check_Call_1"
}
}29 June 2026
New
{
"x-enum-descriptions": {
"cabot_mhs": "Cabot MHS",
"concentrix_mhs": "Concentrix MHS",
"softcall_inactif_equipe_interne": "Softcall Inactif Equipe Interne"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"Cabot MHS": "Cabot MHS",
"Concentrix MHS": "Concentrix MHS",
"Softcall Inactif Equipe Interne": "Softcall Inactif Equipe Interne"
}
}Old
{
"x-enum-descriptions": {}
}26 June 2026
New
[
{
"name": "Validate <code>\u2068valid_to\u2069</code> not before <code>\u2068valid_from\u2069</code>",
"description": "Validates that <code>\u2068valid_to\u2069</code>, if given, is on or later than <code>\u2068valid_from\u2069</code>.",
"possible_errors": [
"start_date_later_than_end_date"
]
},
{
"name": "Validate each item represents a possible rate for the product",
"description": "Validate each item's rate specification, characteristic values, and scheme labels represent a rate defned on the product.",
"possible_errors": [
"characteristic_code_not_found",
"invalid_characteristic_value",
"invalid_profile_variant_for_specification",
"product_specification_not_found_for_product",
"rate_specification_not_found_for_product",
"shared_rate_not_found",
"shared_rate_not_found_for_product"
]
},
{
"name": "Validate that all required bespoke rates are present and no non-overridable rates are supplied",
"description": "Validates that bespoke rate schedules include all rate specifications marked as must-be-overridden and mandatory, and do not include any rate specifications marked as cannot-be-overridden.",
"possible_errors": [
"bespoke_rate_cannot_be_overridden",
"missing_required_bespoke_rate"
]
}
]Old
[
{
"name": "Validate <code>\u2068valid_to\u2069</code> not before <code>\u2068valid_from\u2069</code>",
"description": "Validates that <code>\u2068valid_to\u2069</code>, if given, is on or later than <code>\u2068valid_from\u2069</code>.",
"possible_errors": [
"start_date_later_than_end_date"
]
},
{
"name": "Validate each item represents a possible rate for the product",
"description": "Validate each item's rate specification, characteristic values, and scheme labels represent a rate defned on the product.",
"possible_errors": [
"characteristic_code_not_found",
"invalid_characteristic_value",
"invalid_profile_variant_for_specification",
"product_specification_not_found_for_product",
"rate_specification_not_found_for_product",
"shared_rate_not_found",
"shared_rate_not_found_for_product"
]
}
]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"
]
}
]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"
]
}
]24 June 2026
No attributes to display
23 June 2026
New
{
"x-enum-descriptions": {
"concentrix_softcall_complete": "concentrix_softcall_complete"
}
}Old
{
"x-enum-descriptions": {
"concentrix_softcall_complete": "Concentrix_Softcall_Complete"
}
}New
{
"x-enum-descriptions": {
"concentrix_softcall_complete": "concentrix_softcall_complete"
}
}Old
{
"x-enum-descriptions": {
"Concentrix_Softcall_Complete": "Concentrix_Softcall_Complete"
}
}
No attributes to display
19 June 2026
No attributes to display
18 June 2026
New
{
"x-enum-descriptions": {
"vip_1_agro": "vip_1_agro"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"vip_1_agro": "vip_1_agro"
}
}Old
{
"x-enum-descriptions": {}
}15 June 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 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 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 ledger identifiers are known",
"description": "Validate ledger identifiers are among supply point identifiers.",
"possible_errors": [
"unknown_ledger_identifiers"
]
},
{
"name": "Validate identifiers are unique in ledgers",
"description": "Validate identifier is not declared twice in ledgers.",
"possible_errors": [
"duplicate_identifiers_entries_found"
]
},
{
"name": "Validate agreements cover last statement closing date",
"description": "Validate that there is an agreement for each supply point covering each ledger's <code>last_statement_closing_date</code>.",
"possible_errors": [
"no_agreement_covering_last_statement_closing_date"
]
},
{
"name": "Validate no unbilled period on former supply addresses",
"description": "Validate that if a customer is no longer at the given supply address they have been fully billed. This check is performed if we are importing supply address history.",
"possible_errors": [
"unbilled_former_supply_address"
]
},
{
"name": "Validate that Kraken can calculate when to start billing the account",
"description": "Validate that Kraken can calculate when to start billing the account. This is determined based on the existence of last billed to date, last statement closing date, and agreements.",
"possible_errors": [
"cannot_determine_responsible_for_billing_from_date"
]
},
{
"name": "Validate that only payment schedule or monthly billing frequency is provided",
"description": "Validate that only a <code>payment_schedule</code> or a monthly <code>billing_frequency</code> is provided, but not both.",
"possible_errors": [
"billing_frequency_incompatible_with_payment_schedule"
]
},
{
"name": "Validate that the account type is compatible with agreement's products",
"description": "Validate that the account type is compatible with all of the agreements' product codes. Business products cannot be provided for <code>DOMESTIC</code> accounts and vice versa.",
"possible_errors": [
"account_type_incompatible_with_agreement_product"
]
},
{
"name": "Validates that a supply address is provided for non portfolio lead accounts",
"description": "Validates if an account has account type that is not <code>PORTFOLIO_LEAD</code> then at least one supply address is provided.",
"possible_errors": [
"supply_address_missing"
]
},
{
"name": "Payment preference <code>supply_point_identifier</code> to supply point <code>identifier</code> association is valid.",
"description": "Validates that the association between the payment preference <code>supply_point_identifier</code> and supply point <code>identifier</code> are valid. For example:\nif we have a child collection <code>payment_preference</code> and a parent collection <code>supply_points</code>, this validator will ensure that all <code>payment_preferences</code> have a <code>supply_point_identifier</code> that exists in the <code>supply_points</code> collection.",
"possible_errors": [
"invalid_identifier_types",
"non_unique_parent_identifiers",
"parent_child_identifier_mismatch"
]
}
]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 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 ledger identifiers are known",
"description": "Validate ledger identifiers are among supply point identifiers.",
"possible_errors": [
"unknown_ledger_identifiers"
]
},
{
"name": "Validate identifiers are unique in ledgers",
"description": "Validate identifier is not declared twice in ledgers.",
"possible_errors": [
"duplicate_identifiers_entries_found"
]
},
{
"name": "Validate agreements cover last statement closing date",
"description": "Validate that there is an agreement for each supply point covering each ledger's <code>last_statement_closing_date</code>.",
"possible_errors": [
"no_agreement_covering_last_statement_closing_date"
]
},
{
"name": "Validate no unbilled period on former supply addresses",
"description": "Validate that if a customer is no longer at the given supply address they have been fully billed. This check is performed if we are importing supply address history.",
"possible_errors": [
"unbilled_former_supply_address"
]
},
{
"name": "Validate that Kraken can calculate when to start billing the account",
"description": "Validate that Kraken can calculate when to start billing the account. This is determined based on the existence of last billed to date, last statement closing date, and agreements.",
"possible_errors": [
"cannot_determine_responsible_for_billing_from_date"
]
},
{
"name": "Validate that only payment schedule or monthly billing frequency is provided",
"description": "Validate that only a <code>payment_schedule</code> or a monthly <code>billing_frequency</code> is provided, but not both.",
"possible_errors": [
"billing_frequency_incompatible_with_payment_schedule"
]
},
{
"name": "Validate that the account type is compatible with agreement's products",
"description": "Validate that the account type is compatible with all of the agreements' product codes. Business products cannot be provided for <code>DOMESTIC</code> accounts and vice versa.",
"possible_errors": [
"account_type_incompatible_with_agreement_product"
]
},
{
"name": "Validates that a supply address is provided for non portfolio lead accounts",
"description": "Validates if an account has account type that is not <code>PORTFOLIO_LEAD</code> then at least one supply address is provided.",
"possible_errors": [
"supply_address_missing"
]
},
{
"name": "Payment preference <code>supply_point_identifier</code> to supply point <code>identifier</code> association is valid.",
"description": "Validates that the association between the payment preference <code>supply_point_identifier</code> and supply point <code>identifier</code> are valid. For example:\nif we have a child collection <code>payment_preference</code> and a parent collection <code>supply_points</code>, this validator will ensure that all <code>payment_preferences</code> have a <code>supply_point_identifier</code> that exists in the <code>supply_points</code> collection.",
"possible_errors": [
"invalid_identifier_types",
"non_unique_parent_identifiers",
"parent_child_identifier_mismatch"
]
}
]
No attributes to display
12 June 2026
New
{
"x-enum-descriptions": {
"testcross": "TestCross"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"TestCross": "TestCross"
}
}Old
{
"x-enum-descriptions": {}
}
No attributes to display
No attributes to display
11 June 2026
No attributes to display
5 June 2026
New
[
{
"name": "Promotion assignment discount targets are valid",
"description": "Validates that the promotion exists, discounts are defined in the promotion, target types match the discount target type, and target identifiers are valid.",
"possible_errors": [
"discount_not_in_promotion",
"invalid_input_data",
"promotion_not_registered",
"rate_source_provider_not_registered",
"source_data_not_supported_for_fixed_rate",
"source_data_reference_mismatch",
"target_identifier_invalid",
"target_type_mismatch",
"target_type_not_registered"
]
},
{
"name": "Promotion assignment params are valid",
"description": "Validates that the params field contains only valid values. If promotion_start_date is provided, it must be a valid ISO 8601 datetime string.",
"possible_errors": [
"invalid_promotion_start_date"
]
}
]Old
[
{
"name": "Promotion assignment discount targets are valid",
"description": "Validates that the promotion exists, discounts are defined in the promotion, target types match the discount target type, and target identifiers are valid.",
"possible_errors": [
"discount_not_in_promotion",
"invalid_input_data",
"promotion_not_registered",
"rate_source_provider_not_registered",
"source_data_not_supported_for_fixed_rate",
"source_data_reference_mismatch",
"target_identifier_invalid",
"target_type_mismatch",
"target_type_not_registered"
]
}
]
No attributes to display
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 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 ledger identifiers are known",
"description": "Validate ledger identifiers are among supply point identifiers.",
"possible_errors": [
"unknown_ledger_identifiers"
]
},
{
"name": "Validate identifiers are unique in ledgers",
"description": "Validate identifier is not declared twice in ledgers.",
"possible_errors": [
"duplicate_identifiers_entries_found"
]
},
{
"name": "Validate agreements cover last statement closing date",
"description": "Validate that there is an agreement for each supply point covering each ledger's <code>last_statement_closing_date</code>.",
"possible_errors": [
"no_agreement_covering_last_statement_closing_date"
]
},
{
"name": "Validate no unbilled period on former supply addresses",
"description": "Validate that if a customer is no longer at the given supply address they have been fully billed. This check is performed if we are importing supply address history.",
"possible_errors": [
"unbilled_former_supply_address"
]
},
{
"name": "Validate that Kraken can calculate when to start billing the account",
"description": "Validate that Kraken can calculate when to start billing the account. This is determined based on the existence of last billed to date, last statement closing date, and agreements.",
"possible_errors": [
"cannot_determine_responsible_for_billing_from_date"
]
},
{
"name": "Validate that only payment schedule or monthly billing frequency is provided",
"description": "Validate that only a <code>payment_schedule</code> or a monthly <code>billing_frequency</code> is provided, but not both.",
"possible_errors": [
"billing_frequency_incompatible_with_payment_schedule"
]
},
{
"name": "Validate that the account type is compatible with agreement's products",
"description": "Validate that the account type is compatible with all of the agreements' product codes. Business products cannot be provided for <code>DOMESTIC</code> accounts and vice versa.",
"possible_errors": [
"account_type_incompatible_with_agreement_product"
]
},
{
"name": "Validates that a supply address is provided for non portfolio lead accounts",
"description": "Validates if an account has account type that is not <code>PORTFOLIO_LEAD</code> then at least one supply address is provided.",
"possible_errors": [
"supply_address_missing"
]
},
{
"name": "Payment preference <code>supply_point_identifier</code> to supply point <code>identifier</code> association is valid.",
"description": "Validates that the association between the payment preference <code>supply_point_identifier</code> and supply point <code>identifier</code> are valid. For example:\nif we have a child collection <code>payment_preference</code> and a parent collection <code>supply_points</code>, this validator will ensure that all <code>payment_preferences</code> have a <code>supply_point_identifier</code> that exists in the <code>supply_points</code> collection.",
"possible_errors": [
"invalid_identifier_types",
"non_unique_parent_identifiers",
"parent_child_identifier_mismatch"
]
}
]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 that the transactions for a voucher do not exceed its value",
"description": "Validate that the sum of all transaction values for a voucher is not greater than the value of the voucher.",
"possible_errors": [
"voucher_transactions_sum_greater_than_voucher_value"
]
},
{
"name": "Validate that each voucher charge transaction id has a matching transaction id within a transaction of type CHARGE",
"description": "Validate that each <code>voucher</code> <code>charge_transaction_id</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CHARGE in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_charge_transaction_id_not_found"
]
},
{
"name": "Validate that each voucher redemption credit transaction id has a matching transaction id within a transaction of type CREDIT",
"description": "Validate that every <code>credit_transaction_id</code> in all <code>voucher_redemptions</code> in every <code>voucher</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CREDIT in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_redemption_credit_transaction_id_not_found"
]
},
{
"name": "Validate parent property references exist",
"description": "Validates that all <code>parent_property_reference</code> values in <code>supply_addresses</code> and <code>properties</code> correspond to a <code>property_external_identifier</code> in the payload. This ensures the property hierarchy is valid.",
"possible_errors": [
"parent_property_reference_not_found"
]
},
{
"name": "Validate ledger identifiers are known",
"description": "Validate ledger identifiers are among supply point identifiers.",
"possible_errors": [
"unknown_ledger_identifiers"
]
},
{
"name": "Validate identifiers are unique in ledgers",
"description": "Validate identifier is not declared twice in ledgers.",
"possible_errors": [
"duplicate_identifiers_entries_found"
]
},
{
"name": "Validate agreements cover last statement closing date",
"description": "Validate that there is an agreement for each supply point covering each ledger's <code>last_statement_closing_date</code>.",
"possible_errors": [
"no_agreement_covering_last_statement_closing_date"
]
},
{
"name": "Validate no unbilled period on former supply addresses",
"description": "Validate that if a customer is no longer at the given supply address they have been fully billed. This check is performed if we are importing supply address history.",
"possible_errors": [
"unbilled_former_supply_address"
]
},
{
"name": "Validate that 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 only payment schedule or monthly billing frequency is provided",
"description": "Validate that only a <code>payment_schedule</code> or a monthly <code>billing_frequency</code> is provided, but not both.",
"possible_errors": [
"billing_frequency_incompatible_with_payment_schedule"
]
},
{
"name": "Validate that the account type is compatible with agreement's products",
"description": "Validate that the account type is compatible with all of the agreements' product codes. Business products cannot be provided for <code>DOMESTIC</code> accounts and vice versa.",
"possible_errors": [
"account_type_incompatible_with_agreement_product"
]
},
{
"name": "Validates that a supply address is provided for non portfolio lead accounts",
"description": "Validates if an account has account type that is not <code>PORTFOLIO_LEAD</code> then at least one supply address is provided.",
"possible_errors": [
"supply_address_missing"
]
},
{
"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": "Payment preference <code>supply_point_identifier</code> to supply point <code>identifier</code> association is valid.",
"description": "Validates that the association between the payment preference <code>supply_point_identifier</code> and supply point <code>identifier</code> are valid. For example:\nif we have a child collection <code>payment_preference</code> and a parent collection <code>supply_points</code>, this validator will ensure that all <code>payment_preferences</code> have a <code>supply_point_identifier</code> that exists in the <code>supply_points</code> collection.",
"possible_errors": [
"invalid_identifier_types",
"non_unique_parent_identifiers",
"parent_child_identifier_mismatch"
]
}
]New
{
"x-enum-descriptions": {
"SYSTEM": "System"
}
}Old
{
"x-enum-descriptions": {}
}3 June 2026
New
{
"x-enum-descriptions": {
"KVA_KM_DAYS": "kVA kilometre days"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"KVA_KM_DAYS": "kVA kilometre days"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"DISTANCE": "Distance (km)"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"DISTANCE_CHARGE": "Distance charge"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"DISTANCE": "Distance (km)"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"DISTANCE_CHARGE": "Distance charge"
}
}Old
{
"x-enum-descriptions": {}
}2 June 2026
New
{
"TRANCHE_TARGET_RESIDUAL_FEE": "#/components/schemas/TrancheTargetResidualFee"
}New
[
{
"$ref": "#/components/schemas/BespokeRateConfiguration"
},
{
"$ref": "#/components/schemas/BillDueDate"
},
{
"$ref": "#/components/schemas/BillingDocumentIssuanceFrequencyTerm"
},
{
"$ref": "#/components/schemas/CharacteristicOverrideConfiguration"
},
{
"$ref": "#/components/schemas/CollateralRequired"
},
{
"$ref": "#/components/schemas/ContractMetaData"
},
{
"$ref": "#/components/schemas/ContractedVolumeConfiguration"
},
{
"$ref": "#/components/schemas/CorrectivePeriod"
},
{
"$ref": "#/components/schemas/DelayerDays"
},
{
"$ref": "#/components/schemas/GuaranteeOfOriginConfiguration"
},
{
"$ref": "#/components/schemas/LatePaymentFees"
},
{
"$ref": "#/components/schemas/MinimumContractLength"
},
{
"$ref": "#/components/schemas/PaysByDirectDebitTerm"
},
{
"$ref": "#/components/schemas/ProductRateOverrideConfiguration"
},
{
"$ref": "#/components/schemas/PromotionAssignmentTerm"
},
{
"$ref": "#/components/schemas/RateGroupEligibilityConfiguration"
},
{
"$ref": "#/components/schemas/TrancheTargetResidualFee"
},
{
"$ref": "#/components/schemas/TaxAdjustmentConfiguration"
},
{
"$ref": "#/components/schemas/TerminationFee"
}
]Old
[
{
"$ref": "#/components/schemas/BespokeRateConfiguration"
},
{
"$ref": "#/components/schemas/BillDueDate"
},
{
"$ref": "#/components/schemas/BillingDocumentIssuanceFrequencyTerm"
},
{
"$ref": "#/components/schemas/CharacteristicOverrideConfiguration"
},
{
"$ref": "#/components/schemas/CollateralRequired"
},
{
"$ref": "#/components/schemas/ContractMetaData"
},
{
"$ref": "#/components/schemas/ContractedVolumeConfiguration"
},
{
"$ref": "#/components/schemas/CorrectivePeriod"
},
{
"$ref": "#/components/schemas/DelayerDays"
},
{
"$ref": "#/components/schemas/GuaranteeOfOriginConfiguration"
},
{
"$ref": "#/components/schemas/LatePaymentFees"
},
{
"$ref": "#/components/schemas/MinimumContractLength"
},
{
"$ref": "#/components/schemas/PaysByDirectDebitTerm"
},
{
"$ref": "#/components/schemas/ProductRateOverrideConfiguration"
},
{
"$ref": "#/components/schemas/PromotionAssignmentTerm"
},
{
"$ref": "#/components/schemas/RateGroupEligibilityConfiguration"
},
{
"$ref": "#/components/schemas/TaxAdjustmentConfiguration"
},
{
"$ref": "#/components/schemas/TerminationFee"
}
]29 May 2026
Old
{
"maxItems": 2
}24 May 2026
No attributes to display
No attributes to display
22 May 2026
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 that the transactions for a voucher do not exceed its value",
"description": "Validate that the sum of all transaction values for a voucher is not greater than the value of the voucher.",
"possible_errors": [
"voucher_transactions_sum_greater_than_voucher_value"
]
},
{
"name": "Validate that each voucher charge transaction id has a matching transaction id within a transaction of type CHARGE",
"description": "Validate that each <code>voucher</code> <code>charge_transaction_id</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CHARGE in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_charge_transaction_id_not_found"
]
},
{
"name": "Validate that each voucher redemption credit transaction id has a matching transaction id within a transaction of type CREDIT",
"description": "Validate that every <code>credit_transaction_id</code> in all <code>voucher_redemptions</code> in every <code>voucher</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CREDIT in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_redemption_credit_transaction_id_not_found"
]
},
{
"name": "Validate parent property references exist",
"description": "Validates that all <code>parent_property_reference</code> values in <code>supply_addresses</code> and <code>properties</code> correspond to a <code>property_external_identifier</code> in the payload. This ensures the property hierarchy is valid.",
"possible_errors": [
"parent_property_reference_not_found"
]
},
{
"name": "Validate ledger identifiers are known",
"description": "Validate ledger identifiers are among supply point identifiers.",
"possible_errors": [
"unknown_ledger_identifiers"
]
},
{
"name": "Validate identifiers are unique in ledgers",
"description": "Validate identifier is not declared twice in ledgers.",
"possible_errors": [
"duplicate_identifiers_entries_found"
]
},
{
"name": "Validate agreements cover last statement closing date",
"description": "Validate that there is an agreement for each supply point covering each ledger's <code>last_statement_closing_date</code>.",
"possible_errors": [
"no_agreement_covering_last_statement_closing_date"
]
},
{
"name": "Validate no unbilled period on former supply addresses",
"description": "Validate that if a customer is no longer at the given supply address they have been fully billed. This check is performed if we are importing supply address history.",
"possible_errors": [
"unbilled_former_supply_address"
]
},
{
"name": "Validate that 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 only payment schedule or monthly billing frequency is provided",
"description": "Validate that only a <code>payment_schedule</code> or a monthly <code>billing_frequency</code> is provided, but not both.",
"possible_errors": [
"billing_frequency_incompatible_with_payment_schedule"
]
},
{
"name": "Validate that the account type is compatible with agreement's products",
"description": "Validate that the account type is compatible with all of the agreements' product codes. Business products cannot be provided for <code>DOMESTIC</code> accounts and vice versa.",
"possible_errors": [
"account_type_incompatible_with_agreement_product"
]
},
{
"name": "Validates that a supply address is provided for non portfolio lead accounts",
"description": "Validates if an account has account type that is not <code>PORTFOLIO_LEAD</code> then at least one supply address is provided.",
"possible_errors": [
"supply_address_missing"
]
},
{
"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": "Payment preference <code>supply_point_identifier</code> to supply point <code>identifier</code> association is valid.",
"description": "Validates that the association between the payment preference <code>supply_point_identifier</code> and supply point <code>identifier</code> are valid. For example:\nif we have a child collection <code>payment_preference</code> and a parent collection <code>supply_points</code>, this validator will ensure that all <code>payment_preferences</code> have a <code>supply_point_identifier</code> that exists in the <code>supply_points</code> collection.",
"possible_errors": [
"invalid_identifier_types",
"non_unique_parent_identifiers",
"parent_child_identifier_mismatch"
]
}
]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 that the transactions for a voucher do not exceed its value",
"description": "Validate that the sum of all transaction values for a voucher is not greater than the value of the voucher.",
"possible_errors": [
"voucher_transactions_sum_greater_than_voucher_value"
]
},
{
"name": "Validate that each voucher charge transaction id has a matching transaction id within a transaction of type CHARGE",
"description": "Validate that each <code>voucher</code> <code>charge_transaction_id</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CHARGE in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_charge_transaction_id_not_found"
]
},
{
"name": "Validate that each voucher redemption credit transaction id has a matching transaction id within a transaction of type CREDIT",
"description": "Validate that every <code>credit_transaction_id</code> in all <code>voucher_redemptions</code> in every <code>voucher</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CREDIT in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_redemption_credit_transaction_id_not_found"
]
},
{
"name": "Validate ledger identifiers are known",
"description": "Validate ledger identifiers are among supply point identifiers.",
"possible_errors": [
"unknown_ledger_identifiers"
]
},
{
"name": "Validate identifiers are unique in ledgers",
"description": "Validate identifier is not declared twice in ledgers.",
"possible_errors": [
"duplicate_identifiers_entries_found"
]
},
{
"name": "Validate agreements cover last statement closing date",
"description": "Validate that there is an agreement for each supply point covering each ledger's <code>last_statement_closing_date</code>.",
"possible_errors": [
"no_agreement_covering_last_statement_closing_date"
]
},
{
"name": "Validate no unbilled period on former supply addresses",
"description": "Validate that if a customer is no longer at the given supply address they have been fully billed. This check is performed if we are importing supply address history.",
"possible_errors": [
"unbilled_former_supply_address"
]
},
{
"name": "Validate that Kraken can calculate when to start billing the account",
"description": "Validate that Kraken can calculate when to start billing the account. This is determined based on the existence of last billed to date, last statement closing date, and agreements.",
"possible_errors": [
"cannot_determine_responsible_for_billing_from_date"
]
},
{
"name": "Validate that only payment schedule or monthly billing frequency is provided",
"description": "Validate that only a <code>payment_schedule</code> or a monthly <code>billing_frequency</code> is provided, but not both.",
"possible_errors": [
"billing_frequency_incompatible_with_payment_schedule"
]
},
{
"name": "Validate that the account type is compatible with agreement's products",
"description": "Validate that the account type is compatible with all of the agreements' product codes. Business products cannot be provided for <code>DOMESTIC</code> accounts and vice versa.",
"possible_errors": [
"account_type_incompatible_with_agreement_product"
]
},
{
"name": "Validates that a supply address is provided for non portfolio lead accounts",
"description": "Validates if an account has account type that is not <code>PORTFOLIO_LEAD</code> then at least one supply address is provided.",
"possible_errors": [
"supply_address_missing"
]
},
{
"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": "Payment preference <code>supply_point_identifier</code> to supply point <code>identifier</code> association is valid.",
"description": "Validates that the association between the payment preference <code>supply_point_identifier</code> and supply point <code>identifier</code> are valid. For example:\nif we have a child collection <code>payment_preference</code> and a parent collection <code>supply_points</code>, this validator will ensure that all <code>payment_preferences</code> have a <code>supply_point_identifier</code> that exists in the <code>supply_points</code> collection.",
"possible_errors": [
"invalid_identifier_types",
"non_unique_parent_identifiers",
"parent_child_identifier_mismatch"
]
}
]Old
{
"maxItems": 1
}19 May 2026
No attributes to display
No attributes to display
New
{
"x-enum-descriptions": {
"ADDITIONAL_CHARGE": "Additional charge"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"ADDITIONAL_CHARGE": "Additional charge"
}
}Old
{
"x-enum-descriptions": {}
}18 May 2026
New
{
"x-enum-descriptions": {
"test_test_identifier": "vippppppp"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"vippppppp": "vippppppp"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"CORRECTIVE_PERIOD": "#/components/schemas/CorrectivePeriod"
}New
[
{
"$ref": "#/components/schemas/BespokeRateConfiguration"
},
{
"$ref": "#/components/schemas/BillDueDate"
},
{
"$ref": "#/components/schemas/BillingDocumentIssuanceFrequencyTerm"
},
{
"$ref": "#/components/schemas/CharacteristicOverrideConfiguration"
},
{
"$ref": "#/components/schemas/CollateralRequired"
},
{
"$ref": "#/components/schemas/ContractMetaData"
},
{
"$ref": "#/components/schemas/ContractedVolumeConfiguration"
},
{
"$ref": "#/components/schemas/CorrectivePeriod"
},
{
"$ref": "#/components/schemas/DelayerDays"
},
{
"$ref": "#/components/schemas/GuaranteeOfOriginConfiguration"
},
{
"$ref": "#/components/schemas/LatePaymentFees"
},
{
"$ref": "#/components/schemas/MinimumContractLength"
},
{
"$ref": "#/components/schemas/PaysByDirectDebitTerm"
},
{
"$ref": "#/components/schemas/ProductRateOverrideConfiguration"
},
{
"$ref": "#/components/schemas/PromotionAssignmentTerm"
},
{
"$ref": "#/components/schemas/RateGroupEligibilityConfiguration"
},
{
"$ref": "#/components/schemas/TaxAdjustmentConfiguration"
},
{
"$ref": "#/components/schemas/TerminationFee"
}
]Old
[
{
"$ref": "#/components/schemas/BespokeRateConfiguration"
},
{
"$ref": "#/components/schemas/BillDueDate"
},
{
"$ref": "#/components/schemas/BillingDocumentIssuanceFrequencyTerm"
},
{
"$ref": "#/components/schemas/CharacteristicOverrideConfiguration"
},
{
"$ref": "#/components/schemas/CollateralRequired"
},
{
"$ref": "#/components/schemas/ContractMetaData"
},
{
"$ref": "#/components/schemas/ContractedVolumeConfiguration"
},
{
"$ref": "#/components/schemas/DelayerDays"
},
{
"$ref": "#/components/schemas/GuaranteeOfOriginConfiguration"
},
{
"$ref": "#/components/schemas/LatePaymentFees"
},
{
"$ref": "#/components/schemas/MinimumContractLength"
},
{
"$ref": "#/components/schemas/PaysByDirectDebitTerm"
},
{
"$ref": "#/components/schemas/ProductRateOverrideConfiguration"
},
{
"$ref": "#/components/schemas/PromotionAssignmentTerm"
},
{
"$ref": "#/components/schemas/RateGroupEligibilityConfiguration"
},
{
"$ref": "#/components/schemas/TaxAdjustmentConfiguration"
},
{
"$ref": "#/components/schemas/TerminationFee"
}
]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 that the transactions for a voucher do not exceed its value",
"description": "Validate that the sum of all transaction values for a voucher is not greater than the value of the voucher.",
"possible_errors": [
"voucher_transactions_sum_greater_than_voucher_value"
]
},
{
"name": "Validate that each voucher charge transaction id has a matching transaction id within a transaction of type CHARGE",
"description": "Validate that each <code>voucher</code> <code>charge_transaction_id</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CHARGE in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_charge_transaction_id_not_found"
]
},
{
"name": "Validate that each voucher redemption credit transaction id has a matching transaction id within a transaction of type CREDIT",
"description": "Validate that every <code>credit_transaction_id</code> in all <code>voucher_redemptions</code> in every <code>voucher</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CREDIT in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_redemption_credit_transaction_id_not_found"
]
},
{
"name": "Validate ledger identifiers are known",
"description": "Validate ledger identifiers are among supply point identifiers.",
"possible_errors": [
"unknown_ledger_identifiers"
]
},
{
"name": "Validate identifiers are unique in ledgers",
"description": "Validate identifier is not declared twice in ledgers.",
"possible_errors": [
"duplicate_identifiers_entries_found"
]
},
{
"name": "Validate agreements cover last statement closing date",
"description": "Validate that there is an agreement for each supply point covering each ledger's <code>last_statement_closing_date</code>.",
"possible_errors": [
"no_agreement_covering_last_statement_closing_date"
]
},
{
"name": "Validate no unbilled period on former supply addresses",
"description": "Validate that if a customer is no longer at the given supply address they have been fully billed. This check is performed if we are importing supply address history.",
"possible_errors": [
"unbilled_former_supply_address"
]
},
{
"name": "Validate that Kraken can calculate when to start billing the account",
"description": "Validate that Kraken can calculate when to start billing the account. This is determined based on the existence of last billed to date, last statement closing date, and agreements.",
"possible_errors": [
"cannot_determine_responsible_for_billing_from_date"
]
},
{
"name": "Validate that only payment schedule or monthly billing frequency is provided",
"description": "Validate that only a <code>payment_schedule</code> or a monthly <code>billing_frequency</code> is provided, but not both.",
"possible_errors": [
"billing_frequency_incompatible_with_payment_schedule"
]
},
{
"name": "Validate that the account type is compatible with agreement's products",
"description": "Validate that the account type is compatible with all of the agreements' product codes. Business products cannot be provided for <code>DOMESTIC</code> accounts and vice versa.",
"possible_errors": [
"account_type_incompatible_with_agreement_product"
]
},
{
"name": "Validates that a supply address is provided for non portfolio lead accounts",
"description": "Validates if an account has account type that is not <code>PORTFOLIO_LEAD</code> then at least one supply address is provided.",
"possible_errors": [
"supply_address_missing"
]
},
{
"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": "Payment preference <code>supply_point_identifier</code> to supply point <code>identifier</code> association is valid.",
"description": "Validates that the association between the payment preference <code>supply_point_identifier</code> and supply point <code>identifier</code> are valid. For example:\nif we have a child collection <code>payment_preference</code> and a parent collection <code>supply_points</code>, this validator will ensure that all <code>payment_preferences</code> have a <code>supply_point_identifier</code> that exists in the <code>supply_points</code> collection.",
"possible_errors": [
"invalid_identifier_types",
"non_unique_parent_identifiers",
"parent_child_identifier_mismatch"
]
}
]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 that the transactions for a voucher do not exceed its value",
"description": "Validate that the sum of all transaction values for a voucher is not greater than the value of the voucher.",
"possible_errors": [
"voucher_transactions_sum_greater_than_voucher_value"
]
},
{
"name": "Validate that each voucher charge transaction id has a matching transaction id within a transaction of type CHARGE",
"description": "Validate that each <code>voucher</code> <code>charge_transaction_id</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CHARGE in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_charge_transaction_id_not_found"
]
},
{
"name": "Validate that each voucher redemption credit transaction id has a matching transaction id within a transaction of type CREDIT",
"description": "Validate that every <code>credit_transaction_id</code> in all <code>voucher_redemptions</code> in every <code>voucher</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CREDIT in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_redemption_credit_transaction_id_not_found"
]
},
{
"name": "Validate ledger identifiers are known",
"description": "Validate ledger identifiers are among supply point identifiers.",
"possible_errors": [
"unknown_ledger_identifiers"
]
},
{
"name": "Validate identifiers are unique in ledgers",
"description": "Validate identifier is not declared twice in ledgers.",
"possible_errors": [
"duplicate_identifiers_entries_found"
]
},
{
"name": "Validate agreements cover last statement closing date",
"description": "Validate that there is an agreement for each supply point covering each ledger's <code>last_statement_closing_date</code>.",
"possible_errors": [
"no_agreement_covering_last_statement_closing_date"
]
},
{
"name": "Validate no unbilled period on former supply addresses",
"description": "Validate that if a customer is no longer at the given supply address they have been fully billed. This check is performed if we are importing supply address history.",
"possible_errors": [
"unbilled_former_supply_address"
]
},
{
"name": "Validate that Kraken can calculate when to start billing the account",
"description": "Validate that Kraken can calculate when to start billing the account. This is determined based on the existence of last billed to date, last statement closing date, and agreements.",
"possible_errors": [
"cannot_determine_responsible_for_billing_from_date"
]
},
{
"name": "Validate that only payment schedule or monthly billing frequency is provided",
"description": "Validate that only a <code>payment_schedule</code> or a monthly <code>billing_frequency</code> is provided, but not both.",
"possible_errors": [
"billing_frequency_incompatible_with_payment_schedule"
]
},
{
"name": "Validate that the account type is compatible with agreement's products",
"description": "Validate that the account type is compatible with all of the agreements' product codes. Business products cannot be provided for <code>DOMESTIC</code> accounts and vice versa.",
"possible_errors": [
"account_type_incompatible_with_agreement_product"
]
},
{
"name": "Validates that a supply address is provided for non portfolio lead accounts",
"description": "Validates if an account has account type that is not <code>PORTFOLIO_LEAD</code> then at least one supply address is provided.",
"possible_errors": [
"supply_address_missing"
]
},
{
"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": "Payment preference <code>supply_point_identifier</code> to supply point <code>identifier</code> association is valid.",
"description": "Validates that the association between the payment preference <code>supply_point_identifier</code> and supply point <code>identifier</code> are valid. For example:\nif we have a child collection <code>payment_preference</code> and a parent collection <code>supply_points</code>, this validator will ensure that all <code>payment_preferences</code> have a <code>supply_point_identifier</code> that exists in the <code>supply_points</code> collection.",
"possible_errors": [
"invalid_identifier_types",
"non_unique_parent_identifiers",
"parent_child_identifier_mismatch"
]
}
]12 May 2026
New
[
{
"name": "Validate <code>\u2068valid_to\u2069</code> not before <code>\u2068valid_from\u2069</code>",
"description": "Validates that <code>\u2068valid_to\u2069</code>, if given, is on or later than <code>\u2068valid_from\u2069</code>.",
"possible_errors": [
"start_date_later_than_end_date"
]
},
{
"name": "Validate each item represents a possible rate for the product",
"description": "Validate each item's rate specification, characteristic values, and scheme labels represent a rate defned on the product.",
"possible_errors": [
"characteristic_code_not_found",
"invalid_characteristic_value",
"invalid_profile_variant_for_specification",
"product_specification_not_found_for_product",
"rate_specification_not_found_for_product",
"shared_rate_not_found",
"shared_rate_not_found_for_product"
]
}
]Old
[
{
"name": "Validate <code>\u2068valid_to\u2069</code> not before <code>\u2068valid_from\u2069</code>",
"description": "Validates that <code>\u2068valid_to\u2069</code>, if given, is on or later than <code>\u2068valid_from\u2069</code>.",
"possible_errors": [
"start_date_later_than_end_date"
]
},
{
"name": "Validate each item represents a possible rate for the product",
"description": "Validate each item's rate specification, characteristic values, and scheme labels represent a rate defned on the product.",
"possible_errors": [
"characteristic_code_not_found",
"invalid_characteristic_value",
"invalid_profile_variant_for_specification",
"product_specification_not_found_for_product",
"rate_specification_not_found_for_product"
]
}
]
No attributes to display
11 May 2026
No attributes to display
8 May 2026
New
{
"x-removal-date": "2026-05-25"
}New
{
"x-removal-date": "2026-05-25"
}7 May 2026
No attributes to display
No attributes to display
No attributes to display
6 May 2026
No attributes to display
New
[
{
"name": "data-import--validation--time-series-exists-for-product",
"description": "Validate that the time series code provided matches the time series for the product with the provided product code.",
"possible_errors": [
"product_specification_not_found_for_product",
"time_series_not_found_for_product"
]
}
]Old
[
{
"name": "data-import--validation--time-series-exists-for-product",
"description": "Validate that the time series code provided matches the time series for the product with the provided product code.",
"possible_errors": [
"time_series_not_found_for_product"
]
}
]4 May 2026
New
{
"x-enum-descriptions": {}
}Old
{
"x-enum-descriptions": {
"METERING_JOB_SMS": "METERING_JOB_SMS",
"GREEN_DEAL_CHARGE": "GREEN_DEAL_CHARGE",
"SOLR_BALANCE_TRANSFER": "SOLR_BALANCE_TRANSFER",
"BUSINESS_ADVANCE_PAYMENT": "BUSINESS_ADVANCE_PAYMENT",
"METERING_JOB_NATIONAL_GRID": "METERING_JOB_NATIONAL_GRID",
"NEST_LEARNING_THERMOSTAT_RENTAL": "NEST_LEARNING_THERMOSTAT_RENTAL"
}
}30 April 2026
New
{
"x-enum-descriptions": {
"is_pgo_compatible": "is_pgo_compatible"
}
}Old
{
"x-enum-descriptions": {}
}29 April 2026
No attributes to display
No attributes to display
28 April 2026
No attributes to display
New
{
"x-enum-descriptions": {
"marketing.winback": "Nous souhaitons pouvoir vous recontacter apr\u00e8s la fin de votre contrat afin de vous proposer de nouvelles offres. Cochez pour \u00eatre inform\u00e9(e)."
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"marketing.winback": "Nous souhaitons pouvoir vous recontacter apr\u00e8s la fin de votre contrat afin de vous proposer de nouvelles offres. Cochez pour \u00eatre inform\u00e9(e)."
}
}Old
{
"x-enum-descriptions": {}
}27 April 2026
No attributes to display
24 April 2026
No attributes to display
No attributes to display
New
[
{
"name": "Promotion assignment discount targets are valid",
"description": "Validates that the promotion exists, discounts are defined in the promotion, target types match the discount target type, and target identifiers are valid.",
"possible_errors": [
"discount_not_in_promotion",
"invalid_input_data",
"promotion_not_registered",
"rate_source_provider_not_registered",
"source_data_not_supported_for_fixed_rate",
"source_data_reference_mismatch",
"target_identifier_invalid",
"target_type_mismatch",
"target_type_not_registered"
]
}
]Old
[
{
"name": "Promotion assignment discount targets are valid",
"description": "Validates that the promotion exists, discounts are defined in the promotion, target types match the discount target type, and target identifiers are valid.",
"possible_errors": [
"discount_not_in_promotion",
"promotion_not_registered",
"target_identifier_invalid",
"target_type_mismatch",
"target_type_not_registered"
]
}
]23 April 2026
No attributes to display
22 April 2026
New
[
{
"name": "Validate that both SIREN and SIRET are provided for a business",
"description": "Validate that <code>siren</code> and <code>siret</code> are provided for a business. <code>siret</code> should be provided in business details.",
"possible_errors": [
"siren_or_siret_not_provided_for_business"
]
},
{
"name": "Validate that the combination of SIREN and SIRET or condominium registration number is provided for SDC (Syndic de Copropri\u00e9t\u00e9) business",
"description": "Validate that either a combination of <code>siren</code> and <code>siret</code> or <code>condominium_registration_number</code> is provided for business, when the business type is SDC. Both <code>siren</code> and <code>condominium_registration_number</code> should be provided in business details.",
"possible_errors": [
"siren_and_siret_or_condominium_registration_number_not_provided_for_sdc"
]
},
{
"name": "Validate that the provided <code>siret</code> is registered with only one business",
"description": "Validate that SIRET provided is registered with only one business. SIRET should be unique.",
"possible_errors": [
"siret_registered_with_another_business"
]
}
]Old
[
{
"name": "Validate that both SIREN and SIRET are provided for a business",
"description": "Validate that <code>siren</code> and <code>siret</code> are provided for a business. <code>siret</code> should be provided in business details.",
"possible_errors": [
"siren_or_siret_not_provided_for_business"
]
},
{
"name": "Validate that the combination of SIREN and SIRET or condominium registration number is provided for SDC (Syndic de Copropri\u00e9t\u00e9) business",
"description": "Validate that either a combination of <code>siren</code> and <code>siret</code> or <code>condominium_registration_number</code> is provided for business, when the business type is SDC. Both <code>siren</code> and <code>condominium_registration_number</code> should be provided in business details.",
"possible_errors": [
"siren_and_siret_or_condominium_registration_number_not_provided_for_sdc"
]
}
]New
{
"x-validators": [
{
"name": "Validate that the provided <code>siret</code> is valid",
"description": "Validate that SIRET provided is valid. SIRET should be a 14 digit number.",
"possible_errors": [
"siret_is_not_valid"
]
}
]
}Old
{
"x-validators": [
{
"name": "Validate that the provided <code>siret</code> is valid",
"description": "Validate that SIRET provided is valid. SIRET should be a 14 digit number.",
"possible_errors": [
"siret_is_not_valid"
]
},
{
"name": "Validate that the provided <code>siret</code> is registered with only one business",
"description": "Validate that SIRET provided is registered with only one business. SIRET should be unique.",
"possible_errors": [
"siret_registered_with_another_business"
]
}
]
}New
[
{
"name": "Validate that both SIREN and SIRET are provided for a business",
"description": "Validate that <code>siren</code> and <code>siret</code> are provided for a business. <code>siret</code> should be provided in business details.",
"possible_errors": [
"siren_or_siret_not_provided_for_business"
]
},
{
"name": "Validate that the combination of SIREN and SIRET or condominium registration number is provided for SDC (Syndic de Copropri\u00e9t\u00e9) business",
"description": "Validate that either a combination of <code>siren</code> and <code>siret</code> or <code>condominium_registration_number</code> is provided for business, when the business type is SDC. Both <code>siren</code> and <code>condominium_registration_number</code> should be provided in business details.",
"possible_errors": [
"siren_and_siret_or_condominium_registration_number_not_provided_for_sdc"
]
},
{
"name": "Validate that the provided <code>siret</code> is registered with only one business",
"description": "Validate that SIRET provided is registered with only one business. SIRET should be unique.",
"possible_errors": [
"siret_registered_with_another_business"
]
}
]Old
[
{
"name": "Validate that both SIREN and SIRET are provided for a business",
"description": "Validate that <code>siren</code> and <code>siret</code> are provided for a business. <code>siret</code> should be provided in business details.",
"possible_errors": [
"siren_or_siret_not_provided_for_business"
]
},
{
"name": "Validate that the combination of SIREN and SIRET or condominium registration number is provided for SDC (Syndic de Copropri\u00e9t\u00e9) business",
"description": "Validate that either a combination of <code>siren</code> and <code>siret</code> or <code>condominium_registration_number</code> is provided for business, when the business type is SDC. Both <code>siren</code> and <code>condominium_registration_number</code> should be provided in business details.",
"possible_errors": [
"siren_and_siret_or_condominium_registration_number_not_provided_for_sdc"
]
}
]New
{
"x-validators": [
{
"name": "Validate that the provided <code>siret</code> is valid",
"description": "Validate that SIRET provided is valid. SIRET should be a 14 digit number.",
"possible_errors": [
"siret_is_not_valid"
]
}
]
}Old
{
"x-validators": [
{
"name": "Validate that the provided <code>siret</code> is valid",
"description": "Validate that SIRET provided is valid. SIRET should be a 14 digit number.",
"possible_errors": [
"siret_is_not_valid"
]
},
{
"name": "Validate that the provided <code>siret</code> is registered with only one business",
"description": "Validate that SIRET provided is registered with only one business. SIRET should be unique.",
"possible_errors": [
"siret_registered_with_another_business"
]
}
]
}21 April 2026
No attributes to display
No attributes to display
20 April 2026
New
{
"x-removal-date": "2026-05-20"
}New
{
"x-removal-date": "2026-05-20"
}Old
{
"nullable": true
}
No attributes to display
No attributes to display
17 April 2026
No attributes to display
16 April 2026
New
{
"x-enum-descriptions": {
"CONSUMPTION_OVER_14_MONTHS_VAT20": "CONSUMPTION_OVER_14_MONTHS_VAT20",
"CONSUMPTION_OVER_14_MONTHS_VAT5_5": "CONSUMPTION_OVER_14_MONTHS_VAT5_5"
}
}Old
{
"x-enum-descriptions": {
"CONSUMPTION_OVER_14_MONTHS": "CONSUMPTION_OVER_14_MONTHS"
}
}New
{
"x-enum-descriptions": {
"CONSUMPTION_OVER_14_MONTHS": "CONSUMPTION_OVER_14_MONTHS"
}
}Old
{
"x-enum-descriptions": {
"OVER_14_MONTHS": "OVER_14_MONTHS"
}
}New
{
"x-enum-descriptions": {
"TEST_GROUP_PAYMENT": "TEST_GROUP_PAYMENT"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"OVER_14_MONTHS": "OVER_14_MONTHS"
}
}Old
{
"x-enum-descriptions": {}
}14 April 2026
New
{
"x-enum-descriptions": {
"GIGAJOULES_CONSUMPTION": "Gigajoules consumed"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"GIGAJOULES_CONSUMPTION": "Gigajoules consumed"
}
}Old
{
"x-enum-descriptions": {}
}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": {}
}
No attributes to display
No attributes to display
7 April 2026
New
{
"x-enum-descriptions": {
"test_vip": "vip test rayan"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"vip test rayan": "vip test rayan"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"testsuppression": "Test Suppression New"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"Test Suppression New": "Test Suppression New"
}
}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": {}
}New
{
"x-enum-descriptions": {
"CUSTOM": "Custom"
}
}Old
{
"x-enum-descriptions": {}
}24 March 2026
New
{
"x-removal-date": "2026-04-29"
}23 March 2026
New
{
"items": {
"x-enum-descriptions": {
"TECHNIQUE_B2B": "TECHNIQUE_B2B"
}
}
}Old
{
"items": {
"x-enum-descriptions": {}
}
}New
{
"items": {
"x-enum-descriptions": {
"TECHNIQUE_B2B": "TECHNIQUE_B2B"
}
}
}Old
{
"items": {
"x-enum-descriptions": {}
}
}New
{
"x-enum-descriptions": {
"TECHNIQUE_B2B": "TECHNIQUE_B2B"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"items": {
"x-enum-descriptions": {
"TECHNIQUE_B2B": "TECHNIQUE_B2B"
}
}
}Old
{
"items": {
"x-enum-descriptions": {}
}
}19 March 2026
New
{
"items": {
"x-enum-descriptions": {
"FACTURATION_B2B": "FACTURATION_B2B"
}
}
}Old
{
"items": {
"x-enum-descriptions": {}
}
}New
{
"items": {
"x-enum-descriptions": {
"FACTURATION_B2B": "FACTURATION_B2B"
}
}
}Old
{
"items": {
"x-enum-descriptions": {}
}
}New
{
"x-enum-descriptions": {
"FACTURATION_B2B": "FACTURATION_B2B"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"items": {
"x-enum-descriptions": {
"FACTURATION_B2B": "FACTURATION_B2B"
}
}
}Old
{
"items": {
"x-enum-descriptions": {}
}
}New
{
"x-enum-descriptions": {
"hsv_pack_pm": "HSV - Pack premium 1",
"hsv_pack_std": "HSV - Pack standard 1",
"hsv_pack_pm_2": "HSV - Pack premium 2",
"hsv_pack_std_2": "HSV - Pack standard 2"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"HSV - Pack premium 1": "HSV - Pack premium 1",
"HSV - Pack premium 2": "HSV - Pack premium 2",
"HSV - Pack standard 1": "HSV - Pack standard 1",
"HSV - Pack standard 2": "HSV - Pack standard 2"
}
}Old
{
"x-enum-descriptions": {}
}13 March 2026
No attributes to display
12 March 2026
New
{
"x-enum-descriptions": {
"SELF_CONSUMPTION_TURPE_ADJUSTMENT": "SELF_CONSUMPTION_TURPE_ADJUSTMENT"
}
}Old
{
"x-enum-descriptions": {}
}10 March 2026
New
{
"x-enum-descriptions": {
"pgo": "PGO"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"PGO": "PGO"
}
}Old
{
"x-enum-descriptions": {}
}6 March 2026
New
{
"x-enum-descriptions": {
"NOT_APPLICABLE": "NOT_APPLICABLE"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"NOT_APPLICABLE": "NOT_APPLICABLE"
}
}Old
{
"x-enum-descriptions": {}
}3 March 2026
New
{
"x-enum-descriptions": {
"AUTO_CHEQUE_DEMAT": "Auto Cheque Demat"
}
}Old
{
"x-enum-descriptions": {}
}27 February 2026
New
{
"TICGN_REDUCED_USAGE": "#/components/schemas/TicgnReducedUsageCharacteristic"
}New
[
{
"$ref": "#/components/schemas/TicfeReducedUsageCharacteristic"
},
{
"$ref": "#/components/schemas/SegmentCharacteristic"
},
{
"$ref": "#/components/schemas/PgoGasStandingcharge-consumptionclassidCharacteristic"
},
{
"$ref": "#/components/schemas/AnnualconsumptionMaxCharacteristic"
},
{
"$ref": "#/components/schemas/B2cGasTest4Characteristic"
},
{
"$ref": "#/components/schemas/TicgnReducedUsageCharacteristic"
},
{
"$ref": "#/components/schemas/SalesChannelCharacteristic"
},
{
"$ref": "#/components/schemas/PgoElecConsumption-providercalendarCharacteristic"
},
{
"$ref": "#/components/schemas/B2cTest2Characteristic"
},
{
"$ref": "#/components/schemas/ElectricityProviderCalendarCharacteristic"
},
{
"$ref": "#/components/schemas/PgoGasConsumptionpricelevelCharacteristic"
},
{
"$ref": "#/components/schemas/GasIndexCharacteristic"
},
{
"$ref": "#/components/schemas/B2cTest3Characteristic"
},
{
"$ref": "#/components/schemas/ElectricityIndexCharacteristic"
},
{
"$ref": "#/components/schemas/PgoGasConsumptionclassCharacteristic"
},
{
"$ref": "#/components/schemas/PgoElecStandingcharge-providercalendarCharacteristic"
},
{
"$ref": "#/components/schemas/ElecPowerRangeCharacteristic"
},
{
"$ref": "#/components/schemas/B2cGasTest3Characteristic"
},
{
"$ref": "#/components/schemas/ServicesTierCharacteristic"
},
{
"$ref": "#/components/schemas/PgoElecConsumption-tempclassCharacteristic"
},
{
"$ref": "#/components/schemas/AnnualconsumptionMinCharacteristic"
},
{
"$ref": "#/components/schemas/B2cGasTest1Characteristic"
},
{
"$ref": "#/components/schemas/ConsumptionClassIdCharacteristic"
},
{
"$ref": "#/components/schemas/PgoCharacteristic"
},
{
"$ref": "#/components/schemas/PgoElecPowerrangeCharacteristic"
},
{
"$ref": "#/components/schemas/B2cTestCharacteristic"
},
{
"$ref": "#/components/schemas/B2cGasTest2Characteristic"
},
{
"$ref": "#/components/schemas/DummyCharacteristic"
}
]Old
[
{
"$ref": "#/components/schemas/PgoGasConsumptionclassCharacteristic"
},
{
"$ref": "#/components/schemas/SalesChannelCharacteristic"
},
{
"$ref": "#/components/schemas/B2cGasTest3Characteristic"
},
{
"$ref": "#/components/schemas/PgoGasConsumptionpricelevelCharacteristic"
},
{
"$ref": "#/components/schemas/PgoElecConsumption-tempclassCharacteristic"
},
{
"$ref": "#/components/schemas/PgoElecStandingcharge-providercalendarCharacteristic"
},
{
"$ref": "#/components/schemas/PgoGasStandingcharge-consumptionclassidCharacteristic"
},
{
"$ref": "#/components/schemas/ElectricityIndexCharacteristic"
},
{
"$ref": "#/components/schemas/PgoElecConsumption-providercalendarCharacteristic"
},
{
"$ref": "#/components/schemas/ElecPowerRangeCharacteristic"
},
{
"$ref": "#/components/schemas/B2cTest2Characteristic"
},
{
"$ref": "#/components/schemas/AnnualconsumptionMaxCharacteristic"
},
{
"$ref": "#/components/schemas/SegmentCharacteristic"
},
{
"$ref": "#/components/schemas/GasIndexCharacteristic"
},
{
"$ref": "#/components/schemas/DummyCharacteristic"
},
{
"$ref": "#/components/schemas/PgoCharacteristic"
},
{
"$ref": "#/components/schemas/PgoElecPowerrangeCharacteristic"
},
{
"$ref": "#/components/schemas/TicfeReducedUsageCharacteristic"
},
{
"$ref": "#/components/schemas/ServicesTierCharacteristic"
},
{
"$ref": "#/components/schemas/AnnualconsumptionMinCharacteristic"
},
{
"$ref": "#/components/schemas/B2cTestCharacteristic"
},
{
"$ref": "#/components/schemas/B2cTest3Characteristic"
},
{
"$ref": "#/components/schemas/B2cGasTest1Characteristic"
},
{
"$ref": "#/components/schemas/B2cGasTest2Characteristic"
},
{
"$ref": "#/components/schemas/B2cGasTest4Characteristic"
},
{
"$ref": "#/components/schemas/ElectricityProviderCalendarCharacteristic"
},
{
"$ref": "#/components/schemas/ConsumptionClassIdCharacteristic"
}
]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"
]
}
]
}New
{
"x-enum-descriptions": {
"AMPERE_MONTHS": "Ampere per month"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"AMPERE_MONTHS": "Ampere per month"
}
}Old
{
"x-enum-descriptions": {}
}25 February 2026
New
{
"TICFE_REDUCED_USAGE": "#/components/schemas/TicfeReducedUsageCharacteristic"
}New
[
{
"$ref": "#/components/schemas/PgoCharacteristic"
},
{
"$ref": "#/components/schemas/DummyCharacteristic"
},
{
"$ref": "#/components/schemas/B2cTest3Characteristic"
},
{
"$ref": "#/components/schemas/B2cGasTest3Characteristic"
},
{
"$ref": "#/components/schemas/B2cGasTest2Characteristic"
},
{
"$ref": "#/components/schemas/ElectricityProviderCalendarCharacteristic"
},
{
"$ref": "#/components/schemas/PgoElecConsumption-providercalendarCharacteristic"
},
{
"$ref": "#/components/schemas/PgoElecPowerrangeCharacteristic"
},
{
"$ref": "#/components/schemas/B2cGasTest1Characteristic"
},
{
"$ref": "#/components/schemas/ElectricityIndexCharacteristic"
},
{
"$ref": "#/components/schemas/ConsumptionClassIdCharacteristic"
},
{
"$ref": "#/components/schemas/PgoGasConsumptionclassCharacteristic"
},
{
"$ref": "#/components/schemas/TicfeReducedUsageCharacteristic"
},
{
"$ref": "#/components/schemas/PgoElecStandingcharge-providercalendarCharacteristic"
},
{
"$ref": "#/components/schemas/B2cTest2Characteristic"
},
{
"$ref": "#/components/schemas/GasIndexCharacteristic"
},
{
"$ref": "#/components/schemas/PgoElecConsumption-tempclassCharacteristic"
},
{
"$ref": "#/components/schemas/ElecPowerRangeCharacteristic"
},
{
"$ref": "#/components/schemas/B2cTestCharacteristic"
},
{
"$ref": "#/components/schemas/PgoGasConsumptionpricelevelCharacteristic"
},
{
"$ref": "#/components/schemas/PgoGasStandingcharge-consumptionclassidCharacteristic"
},
{
"$ref": "#/components/schemas/AnnualconsumptionMinCharacteristic"
},
{
"$ref": "#/components/schemas/AnnualconsumptionMaxCharacteristic"
},
{
"$ref": "#/components/schemas/ServicesTierCharacteristic"
},
{
"$ref": "#/components/schemas/SegmentCharacteristic"
},
{
"$ref": "#/components/schemas/SalesChannelCharacteristic"
},
{
"$ref": "#/components/schemas/B2cGasTest4Characteristic"
}
]Old
[
{
"$ref": "#/components/schemas/DummyCharacteristic"
},
{
"$ref": "#/components/schemas/ElecPowerRangeCharacteristic"
},
{
"$ref": "#/components/schemas/SalesChannelCharacteristic"
},
{
"$ref": "#/components/schemas/AnnualconsumptionMinCharacteristic"
},
{
"$ref": "#/components/schemas/PgoGasStandingcharge-consumptionclassidCharacteristic"
},
{
"$ref": "#/components/schemas/PgoCharacteristic"
},
{
"$ref": "#/components/schemas/SegmentCharacteristic"
},
{
"$ref": "#/components/schemas/ServicesTierCharacteristic"
},
{
"$ref": "#/components/schemas/PgoGasConsumptionpricelevelCharacteristic"
},
{
"$ref": "#/components/schemas/ConsumptionClassIdCharacteristic"
},
{
"$ref": "#/components/schemas/B2cGasTest1Characteristic"
},
{
"$ref": "#/components/schemas/AnnualconsumptionMaxCharacteristic"
},
{
"$ref": "#/components/schemas/B2cTestCharacteristic"
},
{
"$ref": "#/components/schemas/B2cTest3Characteristic"
},
{
"$ref": "#/components/schemas/ElectricityIndexCharacteristic"
},
{
"$ref": "#/components/schemas/PgoGasConsumptionclassCharacteristic"
},
{
"$ref": "#/components/schemas/PgoElecStandingcharge-providercalendarCharacteristic"
},
{
"$ref": "#/components/schemas/B2cTest2Characteristic"
},
{
"$ref": "#/components/schemas/PgoElecPowerrangeCharacteristic"
},
{
"$ref": "#/components/schemas/B2cGasTest3Characteristic"
},
{
"$ref": "#/components/schemas/GasIndexCharacteristic"
},
{
"$ref": "#/components/schemas/ElectricityProviderCalendarCharacteristic"
},
{
"$ref": "#/components/schemas/B2cGasTest4Characteristic"
},
{
"$ref": "#/components/schemas/B2cGasTest2Characteristic"
},
{
"$ref": "#/components/schemas/PgoElecConsumption-tempclassCharacteristic"
},
{
"$ref": "#/components/schemas/PgoElecConsumption-providercalendarCharacteristic"
}
]New
{
"pattern": "^-?\\d{0,7}(?:\\.\\d{0,4})?$"
}Old
{
"pattern": "^-?\\d{0,7}(?:\\.\\d{0,2})?$"
}24 February 2026
New
{
"DUMMY": "#/components/schemas/DummyCharacteristic"
}New
[
{
"$ref": "#/components/schemas/PgoElecConsumption-tempclassCharacteristic"
},
{
"$ref": "#/components/schemas/B2cTest3Characteristic"
},
{
"$ref": "#/components/schemas/B2cGasTest4Characteristic"
},
{
"$ref": "#/components/schemas/SalesChannelCharacteristic"
},
{
"$ref": "#/components/schemas/AnnualconsumptionMaxCharacteristic"
},
{
"$ref": "#/components/schemas/PgoGasConsumptionclassCharacteristic"
},
{
"$ref": "#/components/schemas/DummyCharacteristic"
},
{
"$ref": "#/components/schemas/B2cTest2Characteristic"
},
{
"$ref": "#/components/schemas/ConsumptionClassIdCharacteristic"
},
{
"$ref": "#/components/schemas/GasIndexCharacteristic"
},
{
"$ref": "#/components/schemas/ElectricityIndexCharacteristic"
},
{
"$ref": "#/components/schemas/ElectricityProviderCalendarCharacteristic"
},
{
"$ref": "#/components/schemas/B2cGasTest3Characteristic"
},
{
"$ref": "#/components/schemas/PgoGasConsumptionpricelevelCharacteristic"
},
{
"$ref": "#/components/schemas/ServicesTierCharacteristic"
},
{
"$ref": "#/components/schemas/PgoCharacteristic"
},
{
"$ref": "#/components/schemas/PgoGasStandingcharge-consumptionclassidCharacteristic"
},
{
"$ref": "#/components/schemas/B2cGasTest1Characteristic"
},
{
"$ref": "#/components/schemas/ElecPowerRangeCharacteristic"
},
{
"$ref": "#/components/schemas/B2cTestCharacteristic"
},
{
"$ref": "#/components/schemas/PgoElecConsumption-providercalendarCharacteristic"
},
{
"$ref": "#/components/schemas/AnnualconsumptionMinCharacteristic"
},
{
"$ref": "#/components/schemas/PgoElecStandingcharge-providercalendarCharacteristic"
},
{
"$ref": "#/components/schemas/SegmentCharacteristic"
},
{
"$ref": "#/components/schemas/B2cGasTest2Characteristic"
},
{
"$ref": "#/components/schemas/PgoElecPowerrangeCharacteristic"
}
]Old
[
{
"$ref": "#/components/schemas/PgoElecStandingcharge-providercalendarCharacteristic"
},
{
"$ref": "#/components/schemas/AnnualconsumptionMinCharacteristic"
},
{
"$ref": "#/components/schemas/B2cGasTest1Characteristic"
},
{
"$ref": "#/components/schemas/ElecPowerRangeCharacteristic"
},
{
"$ref": "#/components/schemas/PgoCharacteristic"
},
{
"$ref": "#/components/schemas/AnnualconsumptionMaxCharacteristic"
},
{
"$ref": "#/components/schemas/B2cTest2Characteristic"
},
{
"$ref": "#/components/schemas/GasIndexCharacteristic"
},
{
"$ref": "#/components/schemas/B2cGasTest3Characteristic"
},
{
"$ref": "#/components/schemas/PgoGasConsumptionclassCharacteristic"
},
{
"$ref": "#/components/schemas/PgoGasStandingcharge-consumptionclassidCharacteristic"
},
{
"$ref": "#/components/schemas/SalesChannelCharacteristic"
},
{
"$ref": "#/components/schemas/ConsumptionClassIdCharacteristic"
},
{
"$ref": "#/components/schemas/PgoElecConsumption-tempclassCharacteristic"
},
{
"$ref": "#/components/schemas/ElectricityIndexCharacteristic"
},
{
"$ref": "#/components/schemas/B2cGasTest2Characteristic"
},
{
"$ref": "#/components/schemas/PgoElecPowerrangeCharacteristic"
},
{
"$ref": "#/components/schemas/B2cTestCharacteristic"
},
{
"$ref": "#/components/schemas/B2cTest3Characteristic"
},
{
"$ref": "#/components/schemas/B2cGasTest4Characteristic"
},
{
"$ref": "#/components/schemas/PgoGasConsumptionpricelevelCharacteristic"
},
{
"$ref": "#/components/schemas/ElectricityProviderCalendarCharacteristic"
},
{
"$ref": "#/components/schemas/SegmentCharacteristic"
},
{
"$ref": "#/components/schemas/PgoElecConsumption-providercalendarCharacteristic"
},
{
"$ref": "#/components/schemas/ServicesTierCharacteristic"
}
]
No attributes to display
20 February 2026
New
{
"x-enum-descriptions": {
"HSV_PACK_PM": "Plenicoach D\u00e9pannage Premium",
"HSV_PACK_STD": "Plenicoach D\u00e9pannage",
"HSV_PACK_PM_2": "Plenicoach D\u00e9pannage Premium",
"HSV_PACK_STD_2": "Plenicoach D\u00e9pannage"
}
}Old
{
"x-enum-descriptions": {
"HSV_PACK_PM": "Pack Premium D\u00e9pannage",
"HSV_PACK_STD": "Pack Standard D\u00e9pannage",
"HSV_PACK_PM_2": "Pack Premium D\u00e9pannage",
"HSV_PACK_STD_2": "Pack Standard D\u00e9pannage"
}
}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 that the transactions for a voucher do not exceed its value",
"description": "Validate that the sum of all transaction values for a voucher is not greater than the value of the voucher.",
"possible_errors": [
"voucher_transactions_sum_greater_than_voucher_value"
]
},
{
"name": "Validate that each voucher charge transaction id has a matching transaction id within a transaction of type CHARGE",
"description": "Validate that each <code>voucher</code> <code>charge_transaction_id</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CHARGE in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_charge_transaction_id_not_found"
]
},
{
"name": "Validate that each voucher redemption credit transaction id has a matching transaction id within a transaction of type CREDIT",
"description": "Validate that every <code>credit_transaction_id</code> in all <code>voucher_redemptions</code> in every <code>voucher</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CREDIT in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_redemption_credit_transaction_id_not_found"
]
},
{
"name": "Validate ledger identifiers are known",
"description": "Validate ledger identifiers are among supply point identifiers.",
"possible_errors": [
"unknown_ledger_identifiers"
]
},
{
"name": "Validate identifiers are unique in ledgers",
"description": "Validate identifier is not declared twice in ledgers.",
"possible_errors": [
"duplicate_identifiers_entries_found"
]
},
{
"name": "Validate agreements cover last statement closing date",
"description": "Validate that there is an agreement for each supply point covering each ledger's <code>last_statement_closing_date</code>.",
"possible_errors": [
"no_agreement_covering_last_statement_closing_date"
]
},
{
"name": "Validate no unbilled period on former supply addresses",
"description": "Validate that if a customer is no longer at the given supply address they have been fully billed. This check is performed if we are importing supply address history.",
"possible_errors": [
"unbilled_former_supply_address"
]
},
{
"name": "Validate that Kraken can calculate when to start billing the account",
"description": "Validate that Kraken can calculate when to start billing the account. This is determined based on the existence of last billed to date, last statement closing date, and agreements.",
"possible_errors": [
"cannot_determine_responsible_for_billing_from_date"
]
},
{
"name": "Validate that only payment schedule or monthly billing frequency is provided",
"description": "Validate that only a <code>payment_schedule</code> or a monthly <code>billing_frequency</code> is provided, but not both.",
"possible_errors": [
"billing_frequency_incompatible_with_payment_schedule"
]
},
{
"name": "Validate that the account type is compatible with agreement's products",
"description": "Validate that the account type is compatible with all of the agreements' product codes. Business products cannot be provided for <code>DOMESTIC</code> accounts and vice versa.",
"possible_errors": [
"account_type_incompatible_with_agreement_product"
]
},
{
"name": "Validates that a supply address is provided for non portfolio lead accounts",
"description": "Validates if an account has account type that is not <code>PORTFOLIO_LEAD</code> then at least one supply address is provided.",
"possible_errors": [
"supply_address_missing"
]
},
{
"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": "Payment preference <code>supply_point_identifier</code> to supply point <code>identifier</code> association is valid.",
"description": "Validates that the association between the payment preference <code>supply_point_identifier</code> and supply point <code>identifier</code> are valid. For example:\nif we have a child collection <code>payment_preference</code> and a parent collection <code>supply_points</code>, this validator will ensure that all <code>payment_preferences</code> have a <code>supply_point_identifier</code> that exists in the <code>supply_points</code> collection.",
"possible_errors": [
"invalid_identifier_types",
"non_unique_parent_identifiers",
"parent_child_identifier_mismatch"
]
}
]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 that the transactions for a voucher do not exceed its value",
"description": "Validate that the sum of all transaction values for a voucher is not greater than the value of the voucher.",
"possible_errors": [
"voucher_transactions_sum_greater_than_voucher_value"
]
},
{
"name": "Validate that each voucher charge transaction id has a matching transaction id within a transaction of type CHARGE",
"description": "Validate that each <code>voucher</code> <code>charge_transaction_id</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CHARGE in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_charge_transaction_id_not_found"
]
},
{
"name": "Validate that each voucher redemption credit transaction id has a matching transaction id within a transaction of type CREDIT",
"description": "Validate that every <code>credit_transaction_id</code> in all <code>voucher_redemptions</code> in every <code>voucher</code> has a matching <code>transaction_id</code> within a transaction of <code>type</code> CREDIT in <code>current_statement_transactions</code>, <code>historical_statement_transactions</code> or <code>historical_billing_documents</code>.",
"possible_errors": [
"voucher_redemption_credit_transaction_id_not_found"
]
},
{
"name": "Validate ledger identifiers are known",
"description": "Validate ledger identifiers are among supply point identifiers.",
"possible_errors": [
"unknown_ledger_identifiers"
]
},
{
"name": "Validate identifiers are unique in ledgers",
"description": "Validate identifier is not declared twice in ledgers.",
"possible_errors": [
"duplicate_identifiers_entries_found"
]
},
{
"name": "Validate agreements cover last statement closing date",
"description": "Validate that there is an agreement for each supply point covering each ledger's <code>last_statement_closing_date</code>.",
"possible_errors": [
"no_agreement_covering_last_statement_closing_date"
]
},
{
"name": "Validate no unbilled period on former supply addresses",
"description": "Validate that if a customer is no longer at the given supply address they have been fully billed. This check is performed if we are importing supply address history.",
"possible_errors": [
"unbilled_former_supply_address"
]
},
{
"name": "Validate that Kraken can calculate when to start billing the account",
"description": "Validate that Kraken can calculate when to start billing the account. This is determined based on the existence of last billed to date, last statement closing date, and agreements.",
"possible_errors": [
"cannot_determine_responsible_for_billing_from_date"
]
},
{
"name": "Validate that only payment schedule or monthly billing frequency is provided",
"description": "Validate that only a <code>payment_schedule</code> or a monthly <code>billing_frequency</code> is provided, but not both.",
"possible_errors": [
"billing_frequency_incompatible_with_payment_schedule"
]
},
{
"name": "Validate that the account type is compatible with agreement's products",
"description": "Validate that the account type is compatible with all of the agreements' product codes. Business products cannot be provided for <code>DOMESTIC</code> accounts and vice versa.",
"possible_errors": [
"account_type_incompatible_with_agreement_product"
]
},
{
"name": "Validates that a supply address is provided for non portfolio lead accounts",
"description": "Validates if an account has account type that is not <code>PORTFOLIO_LEAD</code> then at least one supply address is provided.",
"possible_errors": [
"supply_address_missing"
]
},
{
"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": "Payment preference <code>supply_point_identifier</code> to supply point <code>identifier</code> association is valid.",
"description": "Validates that the association between the payment preference <code>supply_point_identifier</code> and supply point <code>identifier</code> are valid. For example:\nif we have a child collection <code>payment_preference</code> and a parent collection <code>supply_points</code>, this validator will ensure that all <code>payment_preferences</code> have a <code>supply_point_identifier</code> that exists in the <code>supply_points</code> collection.",
"possible_errors": [
"invalid_identifier_types",
"non_unique_parent_identifiers",
"parent_child_identifier_mismatch"
]
}
]New
{
"x-validators": [
{
"name": "Validate agreements are continuous and non-overlapping",
"description": "Validate that there are no gaps or overlaps between agreements for the same supply point.",
"possible_errors": [
"gaps_or_overlaps_in_agreement_dates"
]
},
{
"name": "Validate the supply point's market is compatible with the agreements",
"description": "Validate the supply point's agreements are on products with the same market as the supply point.",
"possible_errors": [
"tariff_code_not_compatible_with_supply_point_market"
]
}
]
}Old
{
"x-validators": [
{
"name": "Validate agreements are continuous and non-overlapping",
"description": "Validate that there are no gaps or overlaps between agreements for the same supply point.",
"possible_errors": [
"gaps_or_overlaps_in_agreement_dates"
]
},
{
"name": "Validate the supply point's market is compatible with the contracts",
"description": "Validate the supply point's contracts are on products with the same market as the supply point.",
"possible_errors": [
"tariff_code_not_compatible_with_supply_point_market"
]
}
]
}New
{
"x-validators": [
{
"name": "Validate agreements are continuous and non-overlapping",
"description": "Validate that there are no gaps or overlaps between agreements for the same supply point.",
"possible_errors": [
"gaps_or_overlaps_in_agreement_dates"
]
},
{
"name": "Validate the supply point's market is compatible with the agreements",
"description": "Validate the supply point's agreements are on products with the same market as the supply point.",
"possible_errors": [
"tariff_code_not_compatible_with_supply_point_market"
]
}
]
}Old
{
"x-validators": [
{
"name": "Validate agreements are continuous and non-overlapping",
"description": "Validate that there are no gaps or overlaps between agreements for the same supply point.",
"possible_errors": [
"gaps_or_overlaps_in_agreement_dates"
]
},
{
"name": "Validate the supply point's market is compatible with the contracts",
"description": "Validate the supply point's contracts are on products with the same market as the supply point.",
"possible_errors": [
"tariff_code_not_compatible_with_supply_point_market"
]
}
]
}18 February 2026
New
{
"x-validators": [
{
"name": "Validate line item periods",
"description": "Validate that no line items overlap (checked per supply point, product, and rate band combination) or have gaps (checked per supply point only) in supply charge transactions.",
"possible_errors": [
"gaps_or_overlaps_in_periods"
]
}
]
}Old
{
"x-validators": [
{
"name": "Validate line item periods",
"description": "Validate that no line items overlap (checked per supply point, product, and rate band combination) or have gaps (checked per supply point only) in supply charge transactions.",
"possible_errors": [
"zero_length_periods",
"gaps_or_overlaps_in_periods"
]
}
]
}New
{
"x-validators": [
{
"name": "Validate line item periods",
"description": "Validate that no line items overlap (checked per supply point, product, and rate band combination) or have gaps (checked per supply point only) in supply charge transactions.",
"possible_errors": [
"gaps_or_overlaps_in_periods"
]
}
]
}Old
{
"x-validators": [
{
"name": "Validate line item periods",
"description": "Validate that no line items overlap (checked per supply point, product, and rate band combination) or have gaps (checked per supply point only) in supply charge transactions.",
"possible_errors": [
"zero_length_periods",
"gaps_or_overlaps_in_periods"
]
}
]
}New
{
"x-enum-descriptions": {
"HSV_PACK_PM": "Pack Premium D\u00e9pannage",
"HSV_PACK_STD": "Pack Standard D\u00e9pannage",
"HSV_PACK_PM_2": "Pack Premium D\u00e9pannage",
"HSV_PACK_STD_2": "Pack Standard D\u00e9pannage"
}
}Old
{
"x-enum-descriptions": {}
}16 February 2026
New
{
"x-enum-descriptions": {
"cabot_pic1": "CABOT PIC1"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"CABOT PIC1": "CABOT PIC1"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"loss_waiting": "LOSS WAITING",
"softcall_inactive": "SOFTCALL INACTIVE"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"LOSS WAITING": "LOSS WAITING",
"SOFTCALL INACTIVE": "SOFTCALL INACTIVE"
}
}Old
{
"x-enum-descriptions": {}
}13 February 2026
New
{
"x-enum-descriptions": {
"KW_DEMAND_DAYS": "kW Demand per day"
}
}Old
{
"x-enum-descriptions": {}
}New
{
"x-enum-descriptions": {
"KW_DEMAND_DAYS": "kW Demand per day"
}
}Old
{
"x-enum-descriptions": {}
}Use instead
consents