EDF Energy Post Account Import API

openapi: 3.2.0
info:
  title: Kraken Post Account Import API
  version: v1
  description: APIs for importing additional data after an account has been imported.
servers:
- url: https://api.edfgb-kraken.energy/v1/
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: post_account_import
  x-title: Post Account Import
  description: APIs for importing additional data after an account has been imported.
  x-documentation-order: 6
paths:
  /v1/data-import/historical-statements/create/:
    post:
      operationId: V1 Create Historical Statements
      description: Use this endpoint to import historical PDF statements onto an account.
      summary: Use this endpoint to import historical PDF statements onto an account.
      tags:
      - post_account_import
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HistoricalStatements'
            examples:
              ExamplePayload:
                value:
                  import_supplier: TENTACLE_ENERGY
                  external_account_number: EXTERNAL-1234
                  statements:
                  - bill_period_from_date: '2022-01-01'
                    bill_period_to_date: '2022-01-31'
                    statement_id: '1'
                    issued_date: '2022-02-02'
                    number: '1'
                    gross_amount: 100
                    statement_path: path/to/statement-1.pdf
                summary: Example payload
        required: true
      security:
      - DataImportViewerAPIKeyAuthentication: []
      - DRFKrakenTokenAuthentication: []
      responses:
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NonFieldErrors'
              examples:
                AccountNumberOrExternalAccountNumberMustBeProvided:
                  value:
                    non_field_errors:
                    - Either account_number or external_account_number must be provided.
                  summary: account_number or external_account_number must be provided
          description: Validation error.
        '404':
          description: The account import process or account have not been found. To resolve the error, check that the account has been imported (not just staged) and that the `import_supplier code` and `external_account_number` are correct.
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HistoricalStatements'
          description: If the payload is valid, the validated data will be returned in the body of the response.
      x-doc-alerts: []
  /v1/data-import/notes/create/:
    post:
      operationId: V1 Create Account Notes
      description: 'Some points to note:

        - A note must contain at least one of the fields `body` or `document_paths`.

        - A `created_at` datetime may optionally be provided. Otherwise, it will default to the current local time.

        - The `document_paths` refer to the locations in S3 where attached documents are stored.

        - An optional `is_pinned` boolean can be passed in the payload to control whether this note will be pinned to the top of the Kraken account support site page.'
      summary: Use this endpoint to add notes to an account.
      tags:
      - post_account_import
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountNote'
            examples:
              ExamplePayload:
                value:
                  import_supplier: TENTACLE_ENERGY
                  external_account_number: EXTERNAL-1234
                  notes:
                  - body: Some important pinned note.
                    is_pinned: true
                    unpin_at: '2020-06-01T12:00:00Z'
                  - created_at: '2020-02-01T12:00:00Z'
                    body: Some important note with an attachment.
                    document_paths:
                    - document_path: some/path/to/a/document.pdf
                summary: Example payload
        required: true
      security:
      - DataImportViewerAPIKeyAuthentication: []
      - DRFKrakenTokenAuthentication: []
      responses:
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NonFieldErrors'
              examples:
                AccountNumberOrExternalAccountNumberMustBeProvided:
                  value:
                    non_field_errors:
                    - Either account_number or external_account_number must be provided.
                  summary: account_number or external_account_number must be provided
          description: Validation error.
        '404':
          description: The account import process or account have not been found. To resolve the error, check that the account has been imported (not just staged) and that the `import_supplier code` and `external_account_number` are correct.
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAccountNotesResponse'
              examples:
                CreateNoteSuccessExample:
                  value:
                  - created_at: '2020-01-01T12:00:00Z'
                    body: Something very important to import.
                    status: NOTE_CREATION_SUCCESS
                  - created_at: '2020-02-01T12:00:00Z'
                    body: Something else very important to import.
                    status: NOTE_ALREADY_EXISTS
                  summary: Create note success example
          description: If the payload is valid, a list of the posted notes and their creation status will be returned in the response. A new note will only be created if a note on the account with the same body (and `created_at`, if provided) does not already exist.
      x-doc-alerts: []
  /v1/data-import/payment-instruction/create/:
    post:
      operationId: V1 Create Payment Instruction
      description: Create a payment instruction.
      summary: Create a payment instruction.
      tags:
      - post_account_import
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LegacyPaymentInstruction'
            examples:
              ExamplePayload:
                value:
                  import_supplier: TENTACLE_ENERGY
                  external_account_number: EXTERNAL-1234
                  vendor: STRIPE
                  reference: THIS-IS-A-FAKE-REFERENCE
                  type: CARD
                summary: Example payload
        required: true
      security:
      - DataImportViewerAPIKeyAuthentication: []
      - DRFKrakenTokenAuthentication: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePaymentInstructionResponse'
              examples:
                CreatedPaymentInstruction.:
                  value:
                    kraken_account_number: A-C90DC431
                    reference: THIS-IS-A-FAKE-REFERENCE
                  summary: Created payment instruction.
          description: If the payload is valid, the Kraken account number and the reference will be returned.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePaymentInstructionError'
              examples:
                AccountAlreadyHasAnActiveInstructionError.:
                  value:
                    error_detail: Account already has an active instruction
                    external_account_number: '7654321'
                    import_supplier: SOME_IMPORT_SUPPLIER
                    reference: THIS-IS-A-FAKE-REFERENCE
                  summary: Account already has an active instruction error.
          description: '

            If there are validation errors, the errors will be detailed in the body of the response. To

            resolve the error, refer to the field definitions and validation rules.


            This error can be returned if we have persistent issues communicating with the upstream payment

            vendor (we call their API to verify the instruction exists, and retrieve the details to store in

            Kraken). In this case, **the request should not be retried in its current form**.

            '
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePaymentInstructionError'
          description: '

            This error can be returned if we have intermittent issues communicating with the upstream payment

            vendor (we call their API to verify the instruction exists, and retrieve the details to store in

            Kraken). In this case, **the request should be retried as-is**.

            '
      x-doc-alerts: []
  /v1/data-import/send-registration-flows/{import_supplier_code}/{external_account_number}/:
    post:
      operationId: V1 Send Registration Flows
      description: Use this endpoint to submit registration flows for meter points on an existing imported account. Note that this endpoint marks meter points to be registered. Kraken will then pick up these meter points and attempt to register them. Given a successful response from this API, it is still possible for the registration process to fail downstream.
      summary: Submit registration flows for meter points
      parameters:
      - in: path
        name: external_account_number
        schema:
          type: string
        description: The account number in the source system.
        required: true
      - in: path
        name: import_supplier_code
        schema:
          type: string
        description: The code of an existing Import Supplier.
        required: true
      tags:
      - post_account_import
      security:
      - DataImportViewerAPIKeyAuthentication: []
      - DRFKrakenTokenAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GbrMeterPointRegistrationStatuses'
              examples:
                SuccessfulRegistrationFlowRequest:
                  value:
                    external_account_number: A-1234
                    import_supplier_code: TENTACLE_ENERGY
                    meter_points:
                    - mpxn: '1013004420117'
                      status: REGISTRATION_FLOW_SUCCESS
                    - mpxn: '3406086401'
                      status: REGISTRATION_FLOW_ERROR
                      error_detail: TEN not current supplier
                  summary: Successful Registration Flow Request
          description: If the request is successful, a 200 OK response will be returned with an array of objects detailing the status of each of the meter points marked for enrolment. If a meter point was successfully marked for enrolment then a REGISTRATION_FLOW_SUCCESS status will be returned along with the MPAN or MPRN (mpxn). If there was an error in marking the meter point for enrolment then a REGISTRATION_FLOW_ERROR status will be returned along with the MPAN or MPRN and an additional error_detail field with more information on the reason for failure.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GbrRegistrationFlowError'
              examples:
                AccountNotFound:
                  value:
                    external_account_number: A-1234
                    import_supplier_code: TENTACLE_ENERGY
                    error_detail: Account not found for A-1234.
                  summary: Account not found
          description: If an account is not found, or no meter points are found on the account to register, then a 404 Not Found response will be returned. To resolve the error, check that the account has been imported (not just staged) and that the `import_supplier` code and `external_account_number` in the request are correct.
      x-doc-alerts: []
  /v1/data-import/transactions/create/:
    post:
      operationId: V1 Create Transactions
      description: Use this endpoint to import financial transactions to an account.
      summary: Use this endpoint to import financial transactions to an account.
      parameters:
      - in: query
        name: check_previously_added
        schema:
          type: boolean
          default: true
        description: Boolean flag indicating whether to check if a transaction has already been added.
      - in: query
        name: force_add_to_current_statement
        schema:
          type: boolean
          default: true
        description: boolean flag. If set to true and the payload contains a transaction that is outside the currently-open statement period, this will modify the transaction date so that it is within the currently-open statement period. This then allows the transaction to be added to the statement instead of throwing an error. A description is added to the transaction to explain this, and a note is pinned to the account.
      tags:
      - post_account_import
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Transactions'
            examples:
              ExamplePayload:
                value:
                  import_supplier: TENTACLE_ENERGY
                  external_account_number: EXTERNAL-1234
                  transactions:
                  - transaction_id: '1'
                    transaction_date: '2019-10-01'
                    amount: 10.0
                    type: CHARGE
                    reason: IMPORTED_CHARGE
                    display_note: Some customer facing note about the charge.
                    reference: charge-reference-1
                    note: Some internal note about the charge.
                  - transaction_id: '2'
                    transaction_date: '2019-10-01'
                    amount: 10.0
                    type: CHARGE
                    reason: PREPAY_DEBT_ADJUSTMENT
                    display_note: Some customer facing note about the prepay charge.
                    reference: prepay-charge-reference-1
                    note: Some internal note about the prepay charge.
                    to_prepay_meter_serial_number: Z16N389556
                  - transaction_id: '3'
                    transaction_date: '2019-10-01'
                    amount: 10.0
                    type: CREDIT
                    reason: IMPORTED_CREDIT
                    display_note: Some customer facing note about the credit.
                    reference: credit-reference-1
                    note: Some internal note about the credit.
                  - transaction_id: '4'
                    transaction_date: '2019-10-01'
                    amount: 10.0
                    type: PAYMENT
                    reason: ACCOUNT_CHARGE_PAYMENT
                    reference: payment-reference-1
                    payment_type: DD_REGULAR_COLLECTION
                    note: Some internal note about the payment.
                  - transaction_id: '5'
                    transaction_date: '2019-10-01'
                    amount: 10.0
                    type: REPAYMENT
                    reason: FULL_CREDIT_REFUND
                    reference: repayment-reference-1
                    payment_type: DIRECT_CREDIT
                    note: Some internal note about the repayment.
                  - transaction_id: '6'
                    transaction_date: '2019-10-01'
                    amount: 53.24
                    type: SUPPLY_CHARGE
                    display_note: Some customer facing note about the supply charge.
                    reference: supply-charge-reference-1
                    product_code: SOME-PRODUCT-CODE-4321
                    line_items:
                    - rate_band: CONSUMPTION_STANDARD
                      start_date: '2019-10-01'
                      end_date: '2019-11-01'
                      number_of_units: 4.0
                      net_amount: 44.0
                      price_per_unit: 11.0
                      units:
                      - 4.0
                      - 8.0
                    tax_items:
                    - amount: 9.24
                      tax_type: VAT
                      value_taxed: 44.0
                      rate: 0.21
                      unit_type: PROPORTION
                summary: Example payload
        required: true
      security:
      - DataImportViewerAPIKeyAuthentication: []
      - DRFKrakenTokenAuthentication: []
      responses:
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadCreateTransactionsRequest'
              examples:
                BadTransactionPayload:
                  value:
                    transactions:
                      '0':
                        reason:
                        - Not a valid string.
                  summary: Bad transaction payload
                ErrorCreatingTheTransaction:
                  value:
                    status: TRANSACTION_IMPORT_ERROR
                    error_detail: 'UnableToCreateTransaction - 2019-09-28 of Payment #1 of 7100 on 2019-09-28 (ThirdParty) is not within the statement A-00000001 2019-10-01 - 2019-10-15 (OPEN) period'
                    transaction_data:
                      transaction_id: '1'
                      transaction_date: '2019-09-28'
                      amount: '71.00'
                      type: PAYMENT
                      reason: GENERAL_CREDIT
                      reference: reference 1
                      payment_type: DEBIT_CARD
                  summary: Error creating the transaction
          description: Could not create transactions
        '404':
          description: The account import process or account have not been found. To resolve the error, check that the account has been imported (not just staged) and that the `import_supplier code` and `external_account_number` are correct.
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionsCreated'
              examples:
                TransactionCreationResponseExample:
                  value:
                    results:
                    - status: TRANSACTION_ALREADY_EXISTS
                      transaction_data:
                        transaction_id: '1'
                        transaction_date: '2019-10-01'
                        amount: '71.00'
                        type: PAYMENT
                        reason: GENERAL_CREDIT
                        reference: reference 1
                        payment_type: DEBIT_CARD
                        status: TRANSACTION_IMPORT_SUCCESS
                    - status: TRANSACTION_ADDED_TO_ACCOUNT
                      transaction_data:
                        transaction_id: '2'
                        transaction_date: '2019-10-04'
                        amount: '180.00'
                        type: PAYMENT
                        reason: GENERAL_CREDIT
                        reference: reference 2
                        payment_type: DEBIT_CARD
                  summary: Transaction creation response example
          description: If the payload is valid, and there were no errors while importing the transactions, an object will be returned with a list of transactions that were passed in along with their creation statuses.
      x-doc-alerts: []
components:
  schemas:
    TransactionsCreated:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/TransactionAnnotatedWithStatus'
          description: <p>The response when the transaction was created successfully.</p>
      required:
      - results
    NoteDocument:
      type: object
      properties:
        document_path:
          type: string
          description: <p>The S3 relative path to the document to be attached to the note.</p>
          x-validators:
          - name: Validate path exists in file store
            description: Validate that the given path corresponds to a file that has previously been uploaded to the migration file store. Note that this validation is disabled by default and can be enabled using the relevant feature flag.
            possible_errors:
            - path_does_not_exist_in_file_store
      required:
      - document_path
    EnergyTransaction:
      oneOf:
      - $ref: '#/components/schemas/EnergyCredit'
      - $ref: '#/components/schemas/EnergyCharge'
      - $ref: '#/components/schemas/EnergyPayment'
      - $ref: '#/components/schemas/EnergyRepayment'
      - $ref: '#/components/schemas/EnergySupplyCharge'
      discriminator:
        propertyName: type
        mapping:
          CREDIT: '#/components/schemas/EnergyCredit'
          CHARGE: '#/components/schemas/EnergyCharge'
          PAYMENT: '#/components/schemas/EnergyPayment'
          REPAYMENT: '#/components/schemas/EnergyRepayment'
          SUPPLY_CHARGE: '#/components/schemas/EnergySupplyCharge'
    TransactionData:
      oneOf:
      - $ref: '#/components/schemas/EnergyCredit'
      - $ref: '#/components/schemas/EnergyCharge'
      - $ref: '#/components/schemas/EnergyPayment'
      - $ref: '#/components/schemas/EnergyRepayment'
      - $ref: '#/components/schemas/EnergySupplyCharge'
      discriminator:
        propertyName: type
        mapping:
          CREDIT: '#/components/schemas/EnergyCredit'
          CHARGE: '#/components/schemas/EnergyCharge'
          PAYMENT: '#/components/schemas/EnergyPayment'
          REPAYMENT: '#/components/schemas/EnergyRepayment'
          SUPPLY_CHARGE: '#/components/schemas/EnergySupplyCharge'
    NonFieldErrors:
      type: object
      properties:
        non_field_errors:
          type: array
          items:
            type: string
            description: Description of the error.
          description: Validation error messages.
      required:
      - non_field_errors
    EnergyCharge:
      type: object
      properties:
        type:
          enum:
          - CHARGE
          - PAYMENT
          - REPAYMENT
          - CREDIT
          - SUPPLY_CHARGE
          type: string
          x-spec-enum-id: 06d6aba5cee32f9a
          description: <p>The type of the transaction.</p>
          x-enum-descriptions:
            CHARGE: Charge
            PAYMENT: Payment
            REPAYMENT: Repayment
            CREDIT: Credit
            SUPPLY_CHARGE: Supply Charge
        amount:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,10})?$
          description: <p>The amount of the transaction. e.g. if the customer has a consumption charge worth 23.43, this equates to a transaction of type <code>CHARGE</code> of 23.43. Payments and repayments must be positive numbers. Generally charges and credits are also positive, but may be negative to represent reversed charges or credits, or if an incorrect estimated reading has resulted in a negative consumption charge. Provide this amount in the currency's major unit rather than its minor unit (for example euros rather than cents, or pounds rather than pence). These examples are illustrative only; the same applies to any currency that has a major and minor unit. For currencies without a minor unit, such as the Japanese yen, pass the value as-is.</p>
        billing_document_identifier:
          type: string
          description: <p>The identifier from the source system that groups a set of transactions together. This will be used in Kraken during the migration of historical statement transactions to create an archived billing document. For now this field is only required if <code>HISTORICAL_STATEMENT_REQUIRE_SINGLE_BILLING_DOCUMENT_IDENTIFIER</code> settings is ON and is meant for only <code>historical_statements_transactions</code>. Passing this to other transactions like <code>current_statement_transactions</code> or <code>transactions_in_open_settlement_period</code> will raise validation error.</p>
        display_note:
          type: string
          description: <p>The customer-facing note that can be displayed in a statement or email to the customer.</p>
        note:
          type: string
          description: <p>Any additional notes about the transaction.</p>
        reason:
          enum:
          - DEFAULT
          - BALANCE_TRANSFER
          - CONTRIBUTION_TAX_FREE
          - DATA_IMPORT_BALANCE_TRANSFER
          - DEPOSIT
          - BALANCE_TRANSFER_FOR_FINAL_BILLED_ACCOUNT
          - IMPORTED_CHARGE
          - SUPPLEMENTARY_LEDGER_BALANCE_TRANSFER
          - REVERSED_ACCOUNT_CREDIT
          - LATE_PAYMENT_FEE_CHARGE
          - PREPAY_BALANCE_ADJUSTMENT
          - PREPAY_IMBALANCE_WRITE_OFF
          - PREPAY_MIGRATION_IMBALANCE
          - AC_ADJUSTMENT
          - ADJUSTED_CREDIT_TO_ALLOW_REFUND
          - AUTO_RECONCILIATION
          - BUSINESS_ADVANCE_PAYMENT
          - BUSINESS_PREPAYMENT
          - CARBON_OFFSET
          - CREDIT_BALANCE_DONATED_TO_CHARITY
          - DCA_CHARGE
          - DEBT_ASSIGNMENT_GAINING_SUPPLIER
          - DIRECT_DEBIT_REFUND_BALANCING
          - FEED_IN_TARIFF_PAYMENT_TRANSFER_TO_NOMINATED_RECIPIENT
          - GREEN_DEAL_CHARGE
          - INCORRECT_PAYMENT_REVERSAL
          - METERING_JOB_BUSINESS
          - METERING_JOB_NATIONAL_GRID
          - METERING_JOB_SMS
          - NEST_LEARNING_THERMOSTAT_RENTAL
          - OUTGOING_BALANCE_TRANSFER
          - OVER_THE_COUNTER_PAYMENT_FEE
          - PAPER_BILL_FEE
          - PENALTY_CHARGE
          - PREPAY_DEBT_ADJUSTMENT
          - REASON_EARLY_EXIT_FEE
          - REFUND
          - SERVICE_ORDER
          - SOLR_BALANCE_TRANSFER
          - WATER
          - WRITE_BACK
          - EBSS_CHARGE_REVERSAL
          - LATE_PAYMENT_FEE
          - RPS_INVESTIGATION_CHARGE
          - RPS_WARRANT_CHARGE
          - RPS_DAMAGE
          - RPS_RESEAL_FEE
          - SAP_MIGRATED_DEBITS
          - ADDITIONAL_CHARGES_0
          - ADDITIONAL_CHARGES_20
          - ADDITIONAL_CHARGES_5
          - RECONNECTION_CHARGE
          - GREENDEALCHARGE
          - OPUS_FINAL_BALANCE_TRANSFER
          - REASON_EARLY_EXIT_FEE_5
          - TEMP_REFUND
          - MIGRATION_ADJUSTMENT
          - WELFARE_VISIT_FEE
          - WARRANT_FEES_COSTS
          - WARRANT_EXECUTION_FEE
          - TERM_DCA_FEE
          - POST_OFFICE_PAYMENT_CORRECTION
          - RPS_LOSS_5
          - RPS_ADJUSTMENT_20
          - RPS_CCL_ADJUSTMENT
          - METERING_APPOINTMENT_FAILURE
          - REASON_EARLY_EXIT_FEE_0
          - PAYMENT_CORRECTION
          - OPUS_FINAL_BALANCE_ADJUSTMENT
          - LATE_PAYMENT_RESI
          - LATE_PAYMENT_SME
          - EARLY_TERMINATION_FEE
          - TRANSFERRED_DEBT_BILL_ADJUSTMENT
          - INDEMNITY_CLAIM
          - SAP_WRITE_OFF_RECOVER
          - DEBTSOLD_PAYMENTREVERSAL
          - CHAPS_REFUND
          type: string
          x-spec-enum-id: dce8c95be7b5e343
          description: <p>The reason for the transaction.</p>
          x-enum-descriptions:
            DEFAULT: DEFAULT
            BALANCE_TRANSFER: BALANCE_TRANSFER
            CONTRIBUTION_TAX_FREE: CONTRIBUTION_TAX_FREE
            DATA_IMPORT_BALANCE_TRANSFER: DATA_IMPORT_BALANCE_TRANSFER
            DEPOSIT: DEPOSIT
            BALANCE_TRANSFER_FOR_FINAL_BILLED_ACCOUNT: BALANCE_TRANSFER_FOR_FINAL_BILLED_ACCOUNT
            IMPORTED_CHARGE: IMPORTED_CHARGE
            SUPPLEMENTARY_LEDGER_BALANCE_TRANSFER: SUPPLEMENTARY_LEDGER_BALANCE_TRANSFER
            REVERSED_ACCOUNT_CREDIT: REVERSED_ACCOUNT_CREDIT
            LATE_PAYMENT_FEE_CHARGE: LATE_PAYMENT_FEE_CHARGE
            PREPAY_BALANCE_ADJUSTMENT: PREPAY_BALANCE_ADJUSTMENT
            PREPAY_IMBALANCE_WRITE_OFF: PREPAY_IMBALANCE_WRITE_OFF
            PREPAY_MIGRATION_IMBALANCE: PREPAY_MIGRATION_IMBALANCE
            AC_ADJUSTMENT: AC_ADJUSTMENT
            ADJUSTED_CREDIT_TO_ALLOW_REFUND: ADJUSTED_CREDIT_TO_ALLOW_REFUND
            AUTO_RECONCILIATION: AUTO_RECONCILIATION
            BUSINESS_ADVANCE_PAYMENT: BUSINESS_ADVANCE_PAYMENT
            BUSINESS_PREPAYMENT: BUSINESS_PREPAYMENT
            CARBON_OFFSET: CARBON_OFFSET
            CREDIT_BALANCE_DONATED_TO_CHARITY: CREDIT_BALANCE_DONATED_TO_CHARITY
            DCA_CHARGE: DCA_CHARGE
            DEBT_ASSIGNMENT_GAINING_SUPPLIER: DEBT_ASSIGNMENT_GAINING_SUPPLIER
            DIRECT_DEBIT_REFUND_BALANCING: DIRECT_DEBIT_REFUND_BALANCING
            FEED_IN_TARIFF_PAYMENT_TRANSFER_TO_NOMINATED_RECIPIENT: FEED_IN_TARIFF_PAYMENT_TRANSFER_TO_NOMINATED_RECIPIENT
            GREEN_DEAL_CHARGE: GREEN_DEAL_CHARGE
            INCORRECT_PAYMENT_REVERSAL: INCORRECT_PAYMENT_REVERSAL
            METERING_JOB_BUSINESS: METERING_JOB_BUSINESS
            METERING_JOB_NATIONAL_GRID: METERING_JOB_NATIONAL_GRID
            METERING_JOB_SMS: METERING_JOB_SMS
            NEST_LEARNING_THERMOSTAT_RENTAL: NEST_LEARNING_THERMOSTAT_RENTAL
            OUTGOING_BALANCE_TRANSFER: OUTGOING_BALANCE_TRANSFER
            OVER_THE_COUNTER_PAYMENT_FEE: OVER_THE_COUNTER_PAYMENT_FEE
            PAPER_BILL_FEE: PAPER_BILL_FEE
            PENALTY_CHARGE: PENALTY_CHARGE
            PREPAY_DEBT_ADJUSTMENT: PREPAY_DEBT_ADJUSTMENT
            REASON_EARLY_EXIT_FEE: REASON_EARLY_EXIT_FEE
            REFUND: REFUND
            SERVICE_ORDER: SERVICE_ORDER
            SOLR_BALANCE_TRANSFER: SOLR_BALANCE_TRANSFER
            WATER: WATER
            WRITE_BACK: WRITE_BACK
            EBSS_CHARGE_REVERSAL: EBSS_CHARGE_REVERSAL
            LATE_PAYMENT_FEE: LATE_PAYMENT_FEE
            RPS_INVESTIGATION_CHARGE: RPS_INVESTIGATION_CHARGE
            RPS_WARRANT_CHARGE: RPS_WARRANT_CHARGE
            RPS_DAMAGE: RPS_DAMAGE
            RPS_RESEAL_FEE: RPS_RESEAL_FEE
            SAP_MIGRATED_DEBITS: SAP_MIGRATED_DEBITS
            ADDITIONAL_CHARGES_0: ADDITIONAL_CHARGES_0
            ADDITIONAL_CHARGES_20: ADDITIONAL_CHARGES_20
            ADDITIONAL_CHARGES_5: ADDITIONAL_CHARGES_5
            RECONNECTION_CHARGE: RECONNECTION_CHARGE
            GREENDEALCHARGE: GREENDEALCHARGE
            OPUS_FINAL_BALANCE_TRANSFER: OPUS_FINAL_BALANCE_TRANSFER
            REASON_EARLY_EXIT_FEE_5: REASON_EARLY_EXIT_FEE_5
            TEMP_REFUND: TEMP_REFUND
            MIGRATION_ADJUSTMENT: MIGRATION_ADJUSTMENT
            WELFARE_VISIT_FEE: WELFARE_VISIT_FEE
            WARRANT_FEES_COSTS: WARRANT_FEES_COSTS
            WARRANT_EXECUTION_FEE: WARRANT_EXECUTION_FEE
            TERM_DCA_FEE: TERM_DCA_FEE
            POST_OFFICE_PAYMENT_CORRECTION: POST_OFFICE_PAYMENT_CORRECTION
            RPS_LOSS_5: RPS_LOSS_5
            RPS_ADJUSTMENT_20: RPS_ADJUSTMENT_20
            RPS_CCL_ADJUSTMENT: RPS_CCL_ADJUSTMENT
            METERING_APPOINTMENT_FAILURE: METERING_APPOINTMENT_FAILURE
            REASON_EARLY_EXIT_FEE_0: REASON_EARLY_EXIT_FEE_0
            PAYMENT_CORRECTION: PAYMENT_CORRECTION
            OPUS_FINAL_BALANCE_ADJUSTMENT: OPUS_FINAL_BALANCE_ADJUSTMENT
            LATE_PAYMENT_RESI: LATE_PAYMENT_RESI
            LATE_PAYMENT_SME: LATE_PAYMENT_SME
            EARLY_TERMINATION_FEE: EARLY_TERMINATION_FEE
            TRANSFERRED_DEBT_BILL_ADJUSTMENT: TRANSFERRED_DEBT_BILL_ADJUSTMENT
            INDEMNITY_CLAIM: INDEMNITY_CLAIM
            SAP_WRITE_OFF_RECOVER: SAP_WRITE_OFF_RECOVER
            DEBTSOLD_PAYMENTREVERSAL: DEBTSOLD_PAYMENTREVERSAL
            CHAPS_REFUND: CHAPS_REFUND
        tax_items:
          type: array
          items:
            $ref: '#/components/schemas/TaxItem'
          description: <p>For <code>SUPPLY_CHARGE</code> and <code>CHARGE</code> transactions only, tax items contain details about the tax. If not provided will be set to default zero tax.</p>
        to_prepay_meter_serial_number:
          type: string
          description: "<p>The serial number of the prepay meter that this transaction has been \"sent to\" (via a PPMIP).</p>\n    <p>In the case of prepay vends, this \"sending\" was carried out by the customer paying\n    at an outlet; as such, this field should always be populated for prepay vend transactions.</p>\n    <p>In the case of credits and non-consumption charges applied to the customer's account\n    pre-migration, this field should be populated only where a request to add the corresponding\n    credit or debt t

# --- truncated at 32 KB (113 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/edf-energy/refs/heads/main/openapi/edf-energy-post-account-import-api-openapi.yml