Data Import REST API Changelog

{
    "enum": [
        "TOTAL_ENERGIES_FR_B2C"
    ],
    "type": "string",
    "x-spec-enum-id": "353a9993b2c3d161",
    "x-enum-descriptions": {
        "TOTAL_ENERGIES_FR_B2C": "TOTAL_ENERGIES_FR_B2C"
    }
}

{
    "x-comment": "<p>Import supplier choices will be available once suppliers are created in the system.</p>",
    "x-spec-enum-id": "4f53cda18c2baa0c"
}

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

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

{
    "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"
    }
}

{
    "x-enum-descriptions": {
        "UNMETERED_ELECTRICITY_DISTRIBUTION": "Unmetered Electricity Distribution"
    }
}

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

{
    "x-enum-descriptions": {
        "UNMETERED_ELECTRICITY_DISTRIBUTION": "Unmetered Electricity Distribution"
    }
}

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

[
    {
        "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"
        ]
    }
]

[
    {
        "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"
        ]
    }
]

{
    "x-removal-date": "2027-01-23"
}

{
    "default": ""
}

{
    "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"
    }
}

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

{
    "x-enum-descriptions": {
        "LEGACY_REFUND": "Legacy Refund"
    }
}

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

{
    "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"
            ]
        }
    ]
}

{
    "x-validators": [
        {
            "name": "Validate required customer details namespaces provided",
            "description": "No required namespaces configured. Validation skipped.",
            "possible_errors": [
                "required_customer_details_namespace_missing"
            ]
        }
    ]
}

{
    "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"
            ]
        }
    ]
}

{
    "x-validators": [
        {
            "name": "Validate required customer details namespaces provided",
            "description": "No required namespaces configured. Validation skipped.",
            "possible_errors": [
                "required_customer_details_namespace_missing"
            ]
        }
    ]
}

{
    "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"
            ]
        }
    ]
}

{
    "x-comment": "Choices for this field are dynamic, once appropriate values have been configured they will be rendered here.",
    "x-spec-enum-id": "4f53cda18c2baa0c"
}

{
    "type": "string",
    "maxLength": 50
}

{
    "x-removal-date": "2027-01-30"
}

{
    "x-removal-date": "2027-01-30"
}

{
    "x-removal-date": "2027-01-30"
}

2027-06-01

market_configs

2027-06-01

market_configs

2027-06-01

market_configs

[
    {
        "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 <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"
        ]
    }
]

{
    "x-removal-date": "2027-01-20"
}

{
    "x-removal-date": "2026-12-10"
}

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

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

{
    "x-enum-descriptions": {
        "INSTANT_BONUS": "Instantbonus",
        "INSTANT_BONUS_PAID_OUT_MIGRATION": "Paid Instant Bonus (Migrated)"
    }
}

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

[
    {
        "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"
        ]
    }
]

[
    {
        "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"
        ]
    }
]

{
    "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"
            ]
        }
    ]
}

2026-10-15

{
    "TRANCHE_TARGET_RESIDUAL_FEE": "#/components/schemas/TrancheTargetFee"
}

{
    "TRANCHE_TARGET_RESIDUAL_FEE": "#/components/schemas/TrancheTargetResidualFee"
}

[
    {
        "$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"
    }
]

[
    {
        "$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"
    }
]

{
    "x-enum-descriptions": {
        "EXCESS_FEE": "EXCESS_FEE",
        "SHORTFALL_FEE": "SHORTFALL_FEE"
    }
}

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

{
    "x-removal-date": "2026-10-11"
}

{
    "x-removal-date": "2026-10-11"
}

2026-12-10

account_type

{
    "x-removal-date": "2026-10-06"
}

[
    {
        "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"
        ]
    }
]

[
    {
        "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"
        ]
    }
]

{
    "required": true
}

{
    "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"
            ]
        }
    ]
}

{
    "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"
            ]
        }
    ]
}

{
    "required": true
}

{
    "required": true
}

[
    {
        "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"
        ]
    }
]

[
    {
        "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"
        ]
    }
]

{
    "x-enum-descriptions": {
        "APP": "APP",
        "WEBSITE": "WEBSITE"
    }
}

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

{
    "x-enum-descriptions": {
        "APP": "App",
        "WEBSITE": "Website"
    }
}

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

{
    "x-enum-descriptions": {
        "APP": "App",
        "WEBSITE": "Website"
    }
}

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