Customer Migrations Guide: Account Import

This page documents the data import APIs for account creation.

API Endpoints

Validate account

Overview

Use this endpoint to validate account data before creating an account.

Schema

Loading...
POST https://api.ewi-kraken.systems/v2/data-import/accounts/validate/

Responses

The following responses may be returned from the API.

Status codeDescription
200 - OK

If the payload is valid, a 200 OK response will be returned with the empty payload as its body.

400 - Bad Request

If there are validation errors a 400 Bad Request response will be returned detailing the errors. To resolve these errors, refer to the field definitions and validation rules. Response example:

{ "customers": { "0": { "landline": [ "abcde is not a valid phone number" ] } } }

Payloads

Example payload
{ "external_account_number": "EXTERNAL-1234", "import_supplier": "TENTACLE_ENERGY", "unknown_occupier": false, "customers": [ { "given_name": "Johann", "family_name": "Goethe", "email": "g.goethe@polymath.com", "mobile": "+491741721223", "landline": "", "date_of_birth": "1997-07-26", "title": "Herr", "salutation": "Hallo", "consents": [ { "type": "marketing.general-emails", "value": "ACCEPTED", "signed_at": "2021-08-24T14:00:00+09:00" }, { "type": "marketing.physical-letters", "value": "REJECTED", "description": "Some description about obtaining the consent.", "signed_at": "2021-08-24T14:00:00+09:00" } ] } ], "billing_address1": "Fast an der Alster", "billing_address2": "66", "billing_address3": "a", "billing_address4": "Hamburg", "billing_postcode": "20099", "sales_channel": "DIRECT", "sales_subchannel": "Website", "supply_addresses": [ { "supply_address1": "An der Elbe", "supply_address2": "2", "supply_address3": "", "supply_address4": "Jork", "supply_postcode": "21635", "customer_at_supply_address_from_date": "2022-01-01", "supply_points": [ { "identifier": "50203829715", "agreements": [ { "effective_from": "2022-01-01", "effective_to": "2023-01-01", "agreed_at": "2022-01-01T10:00:00Z", "product_code": "GAS_PRODUCT", "sign_up_reward": { "amount": "100.00", "scheme_name": "SAMPLE100" }, "params": { "annual_consumption": "12349", "unit_rate_per_kwh": "0.1025", "net_unit_rate_per_kwh": "0.0830", "monthly_standing_charge": "8.76", "net_monthly_standing_charge": "7.10", "total_estimated_annual_bill_in_euros": "1370.89", "network_charges": {} } } ], "supply_type": "GAS", "supply_start_date": "2021-01-01", "supply_end_date": "2023-01-01", "supply_start_type": "MOVE_IN", "melos": [ { "melo_number": "DE700146823190123456789ABCDEFGHIJ", "meters": [ { "meter_number": "G123456", "meter_type": "EHZ", "meter_sub_type": "G100", "messwerterfassung": "AMR", "active_from": "2021-01-01T00:00:00Z", "active_to": null, "registers": [ { "obis_code": "1-0:1.8.0", "digits": 4, "decimal_places": 2, "is_relevant_for_billing": true, "active_from": "2021-01-01T00:00:00Z", "active_to": null, "readings": [ { "status": "SAVED", "value": "1234.02", "type_of_read": "INTERIM", "origin": "NETWORK_OPERATOR", "qualifier": "READ", "read_at": "2021-05-13T02:00:00+02:00", "is_transfer_reading": false, "edifact_reference_number": "DOC123456789" }, { "status": "SAVED", "value": "1234.02", "type_of_read": "BILLING", "origin": "METER_OPERATOR", "qualifier": "READ", "read_at": "2021-05-13T02:00:00+02:00", "is_transfer_reading": true, "edifact_reference_number": "DOC_TRANSFER_GAS" } ] } ], "conversion_factors": [ { "active_from_date": "2021-01-01", "active_to_date": "2025-01-01", "calorific_value": "11.524", "condition_value": "0.9309", "edifact_reference_number": "DOC987654321" } ] } ] } ], "previous_supplier_id": "1234567890123", "last_billed_to_date": "2022-01-01", "balancing_periods": [ { "valid_from": "2021-01-01T00:00:00", "valid_to": null, "balancing_period_time_slices": [ { "valid_from": "2021-01-01", "valid_to": null, "balancing_group": "11X0-0000-0665-E" } ] } ], "articles": [ { "article_id": "4-02-0-002", "article_type": "Z09", "period_start_at": "2023-10-02T00:00:00+02:00", "period_end_at": "2023-11-02T00:00:00+01:00", "quantity": "10", "municipal_rebate_percent": "5.00", "adjustment_type": "Z34", "adjustment_percent": "2.50", "number_of_individual_assets": "3", "price_per_individual_asset_per_day": "0.12345678901", "time_of_use_definition": "T01", "time_of_use_register": "R01", "custom_price": "12.34567890123", "custom_price_quantity": "100", "custom_price_quantity_unit": "H87" } ], "meter_operators": [ { "code": "9870075000019", "valid_from": "2021-01-01T00:00:00Z", "valid_to": "2022-01-01T00:00:00Z" } ], "network_operators": [ { "code": "9870075000009", "valid_from": "2021-01-01T00:00:00Z", "valid_to": "2022-01-01T00:00:00Z" } ], "gas_supply_point_load_profiles": [ { "valid_from": "2021-01-01T00:00:00", "valid_to": null, "tum_kundenwert": "52.76", "jahresmenge_kwh": "12349", "marktgebiet": "293", "profilname": "R14", "bilanzierungsverfahren": "E01", "druckebene": "Y01", "gas_quality": "Y04", "prognosegrundlage": "ZC0", "fallgruppenzuordnung": "GABi-RLMmT", "netznutzungsvertrag_type": "Z08", "netznutzungszahlung": "Z10", "netznutzungsabrechnungsvariante": "Z15", "tagesparameter_type": "Z99", "tagesparameter_location": "103761", "tagesparameter_provider": "ZT3", "bilanzkreis": "11X0-0000-0665-E" } ] }, { "identifier": "60203829716", "agreements": [ { "effective_from": "2022-01-01", "effective_to": "2023-01-01", "agreed_at": "2022-01-01T10:00:00Z", "product_code": "ELECTRICITY_PRODUCT", "sign_up_reward": { "amount": "100.00", "scheme_name": "SAMPLE100" }, "params": { "annual_consumption": "3000", "annual_nighttime_usage": "382", "unit_rate_per_kwh": "0.3595", "net_unit_rate_per_kwh": "0.2912", "night_unit_rate_per_kwh": "0.273", "net_night_unit_rate_per_kwh": "0.2211", "monthly_standing_charge": "10.76", "net_monthly_standing_charge": "8.72", "total_estimated_annual_bill_in_euros": "1311.91", "network_charges": { "total_network_charges_per_year": "281.21", "eeg_charge_annual": "195.0" } } } ], "supply_type": "ELECTRICITY", "supply_start_date": "2021-01-01", "supply_end_date": "2023-01-01", "supply_start_type": "MOVE_IN", "melos": [ { "melo_number": "DE700146823190123456789KLMNOPQRST", "meters": [ { "meter_number": "E123456", "meter_type": "EHZ", "energierichtung": "ERZ", "fernschaltung": "Z06", "messwerterfassung": "AMR", "registeranzahl": "ETZ", "active_from": "2021-01-01T00:00:00Z", "active_to": null, "registers": [ { "obis_code": "1-1:1.8.1", "digits": 4, "decimal_places": 2, "is_relevant_for_billing": true, "active_from": "2021-01-01T00:00:00Z", "active_to": null, "readings": [ { "status": "SAVED", "value": "1234.02", "type_of_read": "INTERIM", "origin": "NETWORK_OPERATOR", "qualifier": "READ", "read_at": "2021-05-13T02:00:00+02:00", "is_transfer_reading": false, "edifact_reference_number": "DOC567890123" }, { "status": "SAVED", "value": "9876.03", "type_of_read": "BILLING", "origin": "LEGACY_SYSTEM", "qualifier": "ESTIMATED", "read_at": "2021-05-13T02:00:00+02:00", "is_transfer_reading": true, "edifact_reference_number": "DOC_TRANSFER_ELEC" } ], "smgw_configurations": [ { "configuration_id": "123456", "valid_from": "2021-01-01T00:00:00Z" } ] } ], "electricity_meter_gateways": [ { "number": "456321", "communication_method": "LTE", "valid_from": "2021-01-01T00:00:00Z", "valid_to": null } ], "conversion_factors": [ { "active_from_date": "2021-01-01", "active_to_date": "2025-01-01", "factor": "1.5", "edifact_reference_number": "DOC13370815" } ] } ] } ], "previous_supplier_id": "0454567890121", "last_billed_to_date": "2022-01-01", "balancing_periods": [ { "valid_from": "2021-01-01T00:00:00", "valid_to": null, "balancing_period_time_slices": [ { "valid_from": "2021-01-01", "valid_to": null, "balancing_group": "11X0-0000-0665-E" } ] } ], "meter_operators": [ { "code": "9970075000019", "valid_from": "2021-01-01T00:00:00Z", "valid_to": "2022-01-01T00:00:00Z" } ], "network_operators": [ { "code": "9970075000009", "valid_from": "2021-01-01T00:00:00Z", "valid_to": "2022-01-01T00:00:00Z" } ], "transmission_system_operators": [ { "code": "9970075000029", "valid_from": "2021-01-01T00:00:00Z", "valid_to": "2022-01-01T00:00:00Z" } ], "electricity_supply_point_load_profiles": [ { "valid_from": "2021-01-01T00:00:00", "valid_to": null, "bilanzierungsgebiet": "10YDE-TENTACLE-H", "regelzone": "10YAT-APG------L", "aggregationsverantwortung": "ZA8", "lieferrichtung": "Z07", "prognosegrundlage_werte_profile": "ZA6", "prognosegrundlage_slp_tlp": "E14", "slp_profilname": "H0", "slp_bilanzierungsverfahren": "Z10", "slp_jvp_kwh": "1000", "tlp_profilname": "S12", "tlp_bilanzierungsverfahren": "E01", "tlp_profilschar": "SP1", "tlp_jvp_spezifische_arbeit_265_kwhk": "0.42", "tlp_jvp_angepasste_elektrische_arbeit_z08_kwh": "1.2", "tlp_klima_temperatur_typ": "Z99", "tlp_klima_temperatur_kennzeichnung": "NL MKW1", "tlp_klima_temperatur_codeliste": "ZT1", "tlp_klima_temperatur_codepflege": "293", "smgw_wahlrecht": false, "smgw_wahlrecht_grund_ablehnung": "bla", "summenzeitreihentyp": "SLS_TLS", "bilanzkreis": "11X0-0000-0665-E", "spannungsebene": "E03", "umspannung": "E07", "abwicklungsmodell": "ZE9" } ] } ] } ], "transfer_balance": "65.00", "references": [ { "namespace": "tentacle-energy.client-reference-number", "value": "1234567890" } ], "statements": [ { "bill_period_from_date": "2021-01-01", "bill_period_to_date": "2022-01-01", "statement_path": "EXTERNAL-1234/2021-01-01-to-2022-01-01-electricity.pdf", "statement_id": "1", "supply_type": "ELECTRICITY", "annual_consumption": 1234 }, { "bill_period_from_date": "2021-01-01", "bill_period_to_date": "2022-01-01", "statement_path": "EXTERNAL-1234/2021-01-01-to-2022-01-01-gas.pdf", "statement_id": "2", "supply_type": "GAS" } ], "ledgers": [ { "identifiers": [ "50203829715" ], "ledger_code": "GAS_LEDGER", "last_statement_closing_date": "2022-01-01", "last_statement_balance": "-10.00", "ledger_balance": "20.00", "current_statement_transactions": [ { "transaction_id": "1", "transaction_date": "2022-03-01", "amount": "10.00", "type": "REPAYMENT", "reason": "PARTIAL_CREDIT_REFUND", "payment_type": "DIRECT_CREDIT" }, { "transaction_id": "2", "transaction_date": "2022-03-02", "amount": "20.00", "type": "PAYMENT", "reason": "ACCOUNT_CHARGE_PAYMENT", "payment_type": "DD_FIRST_COLLECTION" }, { "transaction_id": "3", "transaction_date": "2022-03-03", "amount": "20.00", "type": "CREDIT", "reason": "CUSTOMER_SERVICE_GESTURE" } ] }, { "identifiers": [ "60203829716" ], "ledger_code": "ELECTRICITY_LEDGER", "last_statement_closing_date": "2022-01-01", "last_statement_balance": "10.00", "ledger_balance": "45.00", "current_statement_transactions": [ { "transaction_id": "4", "transaction_date": "2022-02-01", "amount": "5.00", "type": "REPAYMENT", "reason": "FULL_PREPAYMENT_REFUND", "payment_type": "DIRECT_CREDIT" }, { "transaction_id": "6", "transaction_date": "2022-02-02", "amount": "15.00", "type": "PAYMENT", "reason": "ACCOUNT_CHARGE_PAYMENT", "payment_type": "DD_FIRST_COLLECTION" }, { "transaction_id": "7", "transaction_date": "2022-02-03", "amount": "25.00", "type": "CREDIT", "reason": "BALANCE_ADJUSTMENT" } ] } ], "payment_instructions": [ { "vendor": "GOCARDLESS", "reference": "MD01235CE7A0YNT", "type": "DIRECT_DEBIT", "ledger_code": "GAS_LEDGER", "valid_from": "2022-01-01", "bank_account": { "account_holder": "John Doe", "account_number": "123456789", "iban": "GB82WEST12345698765431" } } ], "payment_schedules": [ { "amount": 20.0, "ledger_code": "GAS_LEDGER", "day_of_month": 5, "frequency": "MONTHLY", "means": "DD", "start_date": "2022-01-01" }, { "amount": 20.0, "ledger_code": "ELECTRICITY_LEDGER", "day_of_month": 5, "frequency": "MONTHLY", "means": "MANUAL", "start_date": "2022-01-01" } ], "account_campaigns": [ { "slug": "super_account", "campaign_note": "Campaign note" } ], "metadata": [ { "key": "metadata_key", "value": { "some_data": "some_value" } } ], "notes": [ { "created_at": "2018-10-10T10:20:00Z", "body": "This is a note", "is_pinned": true } ] }

Create account

Overview

Use this endpoint to process account data into an account in Kraken.

Before an account is created, it is validated according to the same rules as the validate endpoint above. This is an extra safety check to make sure nothing has changed between creating the data and submitting it for account creation in Kraken.

Schema

Loading...
POST https://api.ewi-kraken.systems/v2/data-import/accounts/

Responses

The following responses may be returned from the API.

Status codeDescription
201 - Created

If the payload is valid and an account creation has been scheduled, a 201 Created response will be returned with the empty payload as its body.

400 - Bad Request

If there are validation errors, a 400 Bad Request response will be returned detailing the errors. To resolve these errors, refer to the field definitions and validation rules.

If an account has already been imported, a 400 Bad Request response will be returned with account_id representing existing Kraken account number.

{ "non_field_errors": { "detail": "The account import process with the account number 1234567890 has already been imported.", "code": "account_import_process_already_imported" }, "account_id": "A-12345678" }

Payloads

Example payload
{ "external_account_number": "EXTERNAL-1234", "import_supplier": "TENTACLE_ENERGY", "unknown_occupier": false, "customers": [ { "given_name": "Johann", "family_name": "Goethe", "email": "g.goethe@polymath.com", "mobile": "+491741721223", "landline": "", "date_of_birth": "1997-07-26", "title": "Herr", "salutation": "Hallo", "consents": [ { "type": "marketing.general-emails", "value": "ACCEPTED", "signed_at": "2021-08-24T14:00:00+09:00" }, { "type": "marketing.physical-letters", "value": "REJECTED", "description": "Some description about obtaining the consent.", "signed_at": "2021-08-24T14:00:00+09:00" } ] } ], "billing_address1": "Fast an der Alster", "billing_address2": "66", "billing_address3": "a", "billing_address4": "Hamburg", "billing_postcode": "20099", "sales_channel": "DIRECT", "sales_subchannel": "Website", "supply_addresses": [ { "supply_address1": "An der Elbe", "supply_address2": "2", "supply_address3": "", "supply_address4": "Jork", "supply_postcode": "21635", "customer_at_supply_address_from_date": "2022-01-01", "supply_points": [ { "identifier": "50203829715", "agreements": [ { "effective_from": "2022-01-01", "effective_to": "2023-01-01", "agreed_at": "2022-01-01T10:00:00Z", "product_code": "GAS_PRODUCT", "sign_up_reward": { "amount": "100.00", "scheme_name": "SAMPLE100" }, "params": { "annual_consumption": "12349", "unit_rate_per_kwh": "0.1025", "net_unit_rate_per_kwh": "0.0830", "monthly_standing_charge": "8.76", "net_monthly_standing_charge": "7.10", "total_estimated_annual_bill_in_euros": "1370.89", "network_charges": {} } } ], "supply_type": "GAS", "supply_start_date": "2021-01-01", "supply_end_date": "2023-01-01", "supply_start_type": "MOVE_IN", "melos": [ { "melo_number": "DE700146823190123456789ABCDEFGHIJ", "meters": [ { "meter_number": "G123456", "meter_type": "EHZ", "meter_sub_type": "G100", "messwerterfassung": "AMR", "active_from": "2021-01-01T00:00:00Z", "active_to": null, "registers": [ { "obis_code": "1-0:1.8.0", "digits": 4, "decimal_places": 2, "is_relevant_for_billing": true, "active_from": "2021-01-01T00:00:00Z", "active_to": null, "readings": [ { "status": "SAVED", "value": "1234.02", "type_of_read": "INTERIM", "origin": "NETWORK_OPERATOR", "qualifier": "READ", "read_at": "2021-05-13T02:00:00+02:00", "is_transfer_reading": false, "edifact_reference_number": "DOC123456789" }, { "status": "SAVED", "value": "1234.02", "type_of_read": "BILLING", "origin": "METER_OPERATOR", "qualifier": "READ", "read_at": "2021-05-13T02:00:00+02:00", "is_transfer_reading": true, "edifact_reference_number": "DOC_TRANSFER_GAS" } ] } ], "conversion_factors": [ { "active_from_date": "2021-01-01", "active_to_date": "2025-01-01", "calorific_value": "11.524", "condition_value": "0.9309", "edifact_reference_number": "DOC987654321" } ] } ] } ], "previous_supplier_id": "1234567890123", "last_billed_to_date": "2022-01-01", "balancing_periods": [ { "valid_from": "2021-01-01T00:00:00", "valid_to": null, "balancing_period_time_slices": [ { "valid_from": "2021-01-01", "valid_to": null, "balancing_group": "11X0-0000-0665-E" } ] } ], "articles": [ { "article_id": "4-02-0-002", "article_type": "Z09", "period_start_at": "2023-10-02T00:00:00+02:00", "period_end_at": "2023-11-02T00:00:00+01:00", "quantity": "10", "municipal_rebate_percent": "5.00", "adjustment_type": "Z34", "adjustment_percent": "2.50", "number_of_individual_assets": "3", "price_per_individual_asset_per_day": "0.12345678901", "time_of_use_definition": "T01", "time_of_use_register": "R01", "custom_price": "12.34567890123", "custom_price_quantity": "100", "custom_price_quantity_unit": "H87" } ], "meter_operators": [ { "code": "9870075000019", "valid_from": "2021-01-01T00:00:00Z", "valid_to": "2022-01-01T00:00:00Z" } ], "network_operators": [ { "code": "9870075000009", "valid_from": "2021-01-01T00:00:00Z", "valid_to": "2022-01-01T00:00:00Z" } ], "gas_supply_point_load_profiles": [ { "valid_from": "2021-01-01T00:00:00", "valid_to": null, "tum_kundenwert": "52.76", "jahresmenge_kwh": "12349", "marktgebiet": "293", "profilname": "R14", "bilanzierungsverfahren": "E01", "druckebene": "Y01", "gas_quality": "Y04", "prognosegrundlage": "ZC0", "fallgruppenzuordnung": "GABi-RLMmT", "netznutzungsvertrag_type": "Z08", "netznutzungszahlung": "Z10", "netznutzungsabrechnungsvariante": "Z15", "tagesparameter_type": "Z99", "tagesparameter_location": "103761", "tagesparameter_provider": "ZT3", "bilanzkreis": "11X0-0000-0665-E" } ] }, { "identifier": "60203829716", "agreements": [ { "effective_from": "2022-01-01", "effective_to": "2023-01-01", "agreed_at": "2022-01-01T10:00:00Z", "product_code": "ELECTRICITY_PRODUCT", "sign_up_reward": { "amount": "100.00", "scheme_name": "SAMPLE100" }, "params": { "annual_consumption": "3000", "annual_nighttime_usage": "382", "unit_rate_per_kwh": "0.3595", "net_unit_rate_per_kwh": "0.2912", "night_unit_rate_per_kwh": "0.273", "net_night_unit_rate_per_kwh": "0.2211", "monthly_standing_charge": "10.76", "net_monthly_standing_charge": "8.72", "total_estimated_annual_bill_in_euros": "1311.91", "network_charges": { "total_network_charges_per_year": "281.21", "eeg_charge_annual": "195.0" } } } ], "supply_type": "ELECTRICITY", "supply_start_date": "2021-01-01", "supply_end_date": "2023-01-01", "supply_start_type": "MOVE_IN", "melos": [ { "melo_number": "DE700146823190123456789KLMNOPQRST", "meters": [ { "meter_number": "E123456", "meter_type": "EHZ", "energierichtung": "ERZ", "fernschaltung": "Z06", "messwerterfassung": "AMR", "registeranzahl": "ETZ", "active_from": "2021-01-01T00:00:00Z", "active_to": null, "registers": [ { "obis_code": "1-1:1.8.1", "digits": 4, "decimal_places": 2, "is_relevant_for_billing": true, "active_from": "2021-01-01T00:00:00Z", "active_to": null, "readings": [ { "status": "SAVED", "value": "1234.02", "type_of_read": "INTERIM", "origin": "NETWORK_OPERATOR", "qualifier": "READ", "read_at": "2021-05-13T02:00:00+02:00", "is_transfer_reading": false, "edifact_reference_number": "DOC567890123" }, { "status": "SAVED", "value": "9876.03", "type_of_read": "BILLING", "origin": "LEGACY_SYSTEM", "qualifier": "ESTIMATED", "read_at": "2021-05-13T02:00:00+02:00", "is_transfer_reading": true, "edifact_reference_number": "DOC_TRANSFER_ELEC" } ], "smgw_configurations": [ { "configuration_id": "123456", "valid_from": "2021-01-01T00:00:00Z" } ] } ], "electricity_meter_gateways": [ { "number": "456321", "communication_method": "LTE", "valid_from": "2021-01-01T00:00:00Z", "valid_to": null } ], "conversion_factors": [ { "active_from_date": "2021-01-01", "active_to_date": "2025-01-01", "factor": "1.5", "edifact_reference_number": "DOC13370815" } ] } ] } ], "previous_supplier_id": "0454567890121", "last_billed_to_date": "2022-01-01", "balancing_periods": [ { "valid_from": "2021-01-01T00:00:00", "valid_to": null, "balancing_period_time_slices": [ { "valid_from": "2021-01-01", "valid_to": null, "balancing_group": "11X0-0000-0665-E" } ] } ], "meter_operators": [ { "code": "9970075000019", "valid_from": "2021-01-01T00:00:00Z", "valid_to": "2022-01-01T00:00:00Z" } ], "network_operators": [ { "code": "9970075000009", "valid_from": "2021-01-01T00:00:00Z", "valid_to": "2022-01-01T00:00:00Z" } ], "transmission_system_operators": [ { "code": "9970075000029", "valid_from": "2021-01-01T00:00:00Z", "valid_to": "2022-01-01T00:00:00Z" } ], "electricity_supply_point_load_profiles": [ { "valid_from": "2021-01-01T00:00:00", "valid_to": null, "bilanzierungsgebiet": "10YDE-TENTACLE-H", "regelzone": "10YAT-APG------L", "aggregationsverantwortung": "ZA8", "lieferrichtung": "Z07", "prognosegrundlage_werte_profile": "ZA6", "prognosegrundlage_slp_tlp": "E14", "slp_profilname": "H0", "slp_bilanzierungsverfahren": "Z10", "slp_jvp_kwh": "1000", "tlp_profilname": "S12", "tlp_bilanzierungsverfahren": "E01", "tlp_profilschar": "SP1", "tlp_jvp_spezifische_arbeit_265_kwhk": "0.42", "tlp_jvp_angepasste_elektrische_arbeit_z08_kwh": "1.2", "tlp_klima_temperatur_typ": "Z99", "tlp_klima_temperatur_kennzeichnung": "NL MKW1", "tlp_klima_temperatur_codeliste": "ZT1", "tlp_klima_temperatur_codepflege": "293", "smgw_wahlrecht": false, "smgw_wahlrecht_grund_ablehnung": "bla", "summenzeitreihentyp": "SLS_TLS", "bilanzkreis": "11X0-0000-0665-E", "spannungsebene": "E03", "umspannung": "E07", "abwicklungsmodell": "ZE9" } ] } ] } ], "transfer_balance": "65.00", "references": [ { "namespace": "tentacle-energy.client-reference-number", "value": "1234567890" } ], "statements": [ { "bill_period_from_date": "2021-01-01", "bill_period_to_date": "2022-01-01", "statement_path": "EXTERNAL-1234/2021-01-01-to-2022-01-01-electricity.pdf", "statement_id": "1", "supply_type": "ELECTRICITY", "annual_consumption": 1234 }, { "bill_period_from_date": "2021-01-01", "bill_period_to_date": "2022-01-01", "statement_path": "EXTERNAL-1234/2021-01-01-to-2022-01-01-gas.pdf", "statement_id": "2", "supply_type": "GAS" } ], "ledgers": [ { "identifiers": [ "50203829715" ], "ledger_code": "GAS_LEDGER", "last_statement_closing_date": "2022-01-01", "last_statement_balance": "-10.00", "ledger_balance": "20.00", "current_statement_transactions": [ { "transaction_id": "1", "transaction_date": "2022-03-01", "amount": "10.00", "type": "REPAYMENT", "reason": "PARTIAL_CREDIT_REFUND", "payment_type": "DIRECT_CREDIT" }, { "transaction_id": "2", "transaction_date": "2022-03-02", "amount": "20.00", "type": "PAYMENT", "reason": "ACCOUNT_CHARGE_PAYMENT", "payment_type": "DD_FIRST_COLLECTION" }, { "transaction_id": "3", "transaction_date": "2022-03-03", "amount": "20.00", "type": "CREDIT", "reason": "CUSTOMER_SERVICE_GESTURE" } ] }, { "identifiers": [ "60203829716" ], "ledger_code": "ELECTRICITY_LEDGER", "last_statement_closing_date": "2022-01-01", "last_statement_balance": "10.00", "ledger_balance": "45.00", "current_statement_transactions": [ { "transaction_id": "4", "transaction_date": "2022-02-01", "amount": "5.00", "type": "REPAYMENT", "reason": "FULL_PREPAYMENT_REFUND", "payment_type": "DIRECT_CREDIT" }, { "transaction_id": "6", "transaction_date": "2022-02-02", "amount": "15.00", "type": "PAYMENT", "reason": "ACCOUNT_CHARGE_PAYMENT", "payment_type": "DD_FIRST_COLLECTION" }, { "transaction_id": "7", "transaction_date": "2022-02-03", "amount": "25.00", "type": "CREDIT", "reason": "BALANCE_ADJUSTMENT" } ] } ], "payment_instructions": [ { "vendor": "GOCARDLESS", "reference": "MD01235CE7A0YNT", "type": "DIRECT_DEBIT", "ledger_code": "GAS_LEDGER", "valid_from": "2022-01-01", "bank_account": { "account_holder": "John Doe", "account_number": "123456789", "iban": "GB82WEST12345698765431" } } ], "payment_schedules": [ { "amount": 20.0, "ledger_code": "GAS_LEDGER", "day_of_month": 5, "frequency": "MONTHLY", "means": "DD", "start_date": "2022-01-01" }, { "amount": 20.0, "ledger_code": "ELECTRICITY_LEDGER", "day_of_month": 5, "frequency": "MONTHLY", "means": "MANUAL", "start_date": "2022-01-01" } ], "account_campaigns": [ { "slug": "super_account", "campaign_note": "Campaign note" } ], "metadata": [ { "key": "metadata_key", "value": { "some_data": "some_value" } } ], "notes": [ { "created_at": "2018-10-10T10:20:00Z", "body": "This is a note", "is_pinned": true } ] }

Get account import status

Overview

Use this endpoint to retrieve the current status of an account import.

GET https://api.ewi-kraken.systems/v2/data-import/accounts/<import-supplier-code>/<external-identifier>/

Responses

The following responses may be returned from the API.

Status codeDescription
200 - OK

If the account import process exists, a 200 OK response will be returned, detailing the status.

For example when there is no error in processing:

{ "status": "PROCESSED | DRY_RUN_SUCCEEDED | IN_PROGRESS | PENDING | CANCELLED", "kraken_identifier": null, "created_at": "2025-10-07T09:00:21.179194+02:00", "modified_at": "2025-10-07T09:06:38.078396+02:00", "latest_error": null }

For example when the import process is processed we have an internal kraken id:

{ "status": "PROCESSED", "kraken_identifier": "INTERNAL-KRAKEN-IDENTIFIER", "created_at": "2025-10-07T09:00:21.179194+02:00", "modified_at": "2025-10-07T09:06:38.078396+02:00", "latest_error": null }

For example when there is an error in processing:

{ "status": "ERRORED | DRY_RUN_ERRORED", "kraken_identifier": null, "created_at": "2025-10-07T09:00:21.179194+02:00", "modified_at": "2025-10-07T09:06:38.078396+02:00", "latest_error": { "code": "some_error_code", "detail": "A detailed error message", "domain": "account_import" } }
404 - Not Found

If the account import process does not exist, a 404 Not Found response will be returned.

{ "detail": "The requested resource was not found.", "code": "not_found" }