generated: '2026-10-08'
method: derived
generator: derive-vocabulary.py
source: openapi/_original/fiskil-openapi.json
vocabulary:
  name: FISKIL Domain Vocabulary
  description: 'Terms declared by FISKIL''s own API contract: its resource groups, objects and enumerations, with the contract''s definitions.
    Derived, not authored.'
  version: '2026-10-08'
  terms:
  - term: Auth
    definition: Consent authorisation sessions.
    tags:
    - Resource Group
    source: openapi/_original/fiskil-openapi.json
  - term: Consent
    definition: Consent arrangements and permissions.
    tags:
    - Resource Group
    source: openapi/_original/fiskil-openapi.json
  - term: End users
    definition: The people whose data is shared.
    tags:
    - Resource Group
    source: openapi/_original/fiskil-openapi.json
  - term: Institutions
    definition: Banks, lenders and energy providers available to connect to.
    tags:
    - Resource Group
    source: openapi/_original/fiskil-openapi.json
  - term: Banking
    definition: Accounts, balances, transactions, income, payees, scheduled payments, direct debits and products.
    tags:
    - Resource Group
    source: openapi/_original/fiskil-openapi.json
  - term: Energy
    definition: Energy accounts, smart-meter usage, billing, invoices, plans, service points, concessions and DER.
    tags:
    - Resource Group
    source: openapi/_original/fiskil-openapi.json
  - term: Common
    definition: Identity and data-freshness endpoints shared across sectors.
    tags:
    - Resource Group
    source: openapi/_original/fiskil-openapi.json
  - term: AddAuthSessionInConsoleResponseBody
    definition: 'Object declared by the contract with fields: auth_url, expires_at, id, session_id.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/AddAuthSessionInConsoleResponseBody
  - term: ConnectionStatus
    definition: 'Object declared by the contract with fields: status.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/ConnectionStatus
  - term: CreateAuthSessionRequestBody
    definition: 'Object declared by the contract with fields: arrangement_id, cancel_uri, end_user_id, institution_id, redirect_uri.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/CreateAuthSessionRequestBody
  - term: CreateEndUserRequestBody
    definition: 'Object declared by the contract with fields: abn, email, name, phone.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/CreateEndUserRequestBody
  - term: Createenduser
    definition: 'Object declared by the contract with fields: end_user_id.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/Createenduser
  - term: Enduser
    definition: 'Object declared by the contract with fields: email, id, name, phone.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/Enduser
  - term: Error
    definition: 'Object declared by the contract with fields: fault, id, message, name, temporary, timeout.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/Error
  - term: InstitutionByClient
    definition: Gets a list of institutions from the perspective of the client.
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/InstitutionByClient
  - term: InstitutionStatus
    definition: The overall status of an institution
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/InstitutionStatus
  - term: Permission
    definition: Information about permissions.
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/Permission
  - term: UpdateEndUserRequestBody
    definition: 'Object declared by the contract with fields: abn, email, phone, session_id.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/UpdateEndUserRequestBody
  - term: authapi.paginationLinks
    definition: 'Object declared by the contract with fields: next, prev.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/authapi.paginationLinks
  - term: front_door.ConsentsBodyV3
    definition: 'Object declared by the contract with fields: consents, links.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/front_door.ConsentsBodyV3
  - term: front_door.EndUsersBodyV3
    definition: 'Object declared by the contract with fields: end_users, links.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/front_door.EndUsersBodyV3
  - term: front_door.ErrorBody
    definition: 'Object declared by the contract with fields: id, message, name.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/front_door.ErrorBody
  - term: server.ConsentResponse
    definition: 'Object declared by the contract with fields: account_ids, active, app_logo, app_name, arrangement_id, created_at, duration, end_user_email,
      end_user_id, expires_at, institution_id, institution_logo. (6 more)'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/server.ConsentResponse
  - term: server.EnduserResponse
    definition: 'Object declared by the contract with fields: email, id, name, phone.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/server.EnduserResponse
  - term: banking.IncomeFrequency
    definition: 'Enumeration declared by the contract with values: UNKNOWN, WEEKLY, BIWEEKLY, MONTHLY.'
    tags:
    - Enumeration
    source: openapi/_original/fiskil-openapi.json#/components/schemas/banking.IncomeFrequency
  - term: banking.IncomeMonthlyAvg
    definition: 'Object declared by the contract with fields: currency, income_monthly.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/banking.IncomeMonthlyAvg
  - term: banking.IncomeMonthlyMedian
    definition: 'Object declared by the contract with fields: currency, income_monthly.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/banking.IncomeMonthlyMedian
  - term: fiskil_banking.AccountV2
    definition: 'Object declared by the contract with fields: account_id, account_number, account_ownership, addresses, arrangement_id, bsb, bundle_name,
      creation_date, credit_card, deposit_rate, deposit_rates, display_name. (15 more)'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.AccountV2
  - term: fiskil_banking.AccountsBodyV2
    definition: 'Object declared by the contract with fields: accounts, links.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.AccountsBodyV2
  - term: fiskil_banking.Balance
    definition: 'Object declared by the contract with fields: account_id, amortised_limit, arrangement_id, available_balance, credit_limit, currency,
      current_balance, fiskil_id, institution_id, purses.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.Balance
  - term: fiskil_banking.BalancesBody
    definition: 'Object declared by the contract with fields: balances, links.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BalancesBody
  - term: fiskil_banking.BankingAccountV4Feature
    definition: 'Object declared by the contract with fields: additional_info, additional_info_uri, additional_value, feature_type, is_activated.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingAccountV4Feature
  - term: fiskil_banking.BankingAccountV4Loan
    definition: 'Object declared by the contract with fields: loan_end_date, max_redraw, max_redraw_currency, min_instalment_amount, min_instalment_currency,
      min_redraw, min_redraw_currency, next_instalment_date, offset_account_enabled, offset_account_ids, original_loan_amount, original_loan_currency.
      (3 more)'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingAccountV4Loan
  - term: fiskil_banking.BankingAuthorisedEntity
    definition: 'Object declared by the contract with fields: abn, acn, arbn, description, financial_institution.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingAuthorisedEntity
  - term: fiskil_banking.BankingBalancePurse
    definition: 'Object declared by the contract with fields: amount, currency.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingBalancePurse
  - term: fiskil_banking.BankingBillerPayee
    definition: 'Object declared by the contract with fields: biller_code, biller_name, crn.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingBillerPayee
  - term: fiskil_banking.BankingCreditCardAccount
    definition: 'Object declared by the contract with fields: min_payment_amount, payment_currency, payment_due_amount, payment_due_date.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingCreditCardAccount
  - term: fiskil_banking.BankingDigitalWalletPayee
    definition: 'Object declared by the contract with fields: identifier, name, provider, type.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingDigitalWalletPayee
  - term: fiskil_banking.BankingDomesticPayee
    definition: 'Object declared by the contract with fields: account, card, pay_id, payee_account_u_type.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingDomesticPayee
  - term: fiskil_banking.BankingDomesticPayeeAccount
    definition: 'Object declared by the contract with fields: account_name, account_number, bsb.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingDomesticPayeeAccount
  - term: fiskil_banking.BankingDomesticPayeeCard
    definition: 'Object declared by the contract with fields: card_number.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingDomesticPayeeCard
  - term: fiskil_banking.BankingDomesticPayeePayId
    definition: 'Object declared by the contract with fields: identifier, name, type.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingDomesticPayeePayId
  - term: fiskil_banking.BankingFeeAmountV2
    definition: 'Object declared by the contract with fields: amount.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingFeeAmountV2
  - term: fiskil_banking.BankingFeeDiscountAmountV2
    definition: 'Object declared by the contract with fields: amount.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingFeeDiscountAmountV2
  - term: fiskil_banking.BankingFeeDiscountRangeV2
    definition: 'Object declared by the contract with fields: discount_maximum, discount_minimum.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingFeeDiscountRangeV2
  - term: fiskil_banking.BankingFeeDiscountRateV2
    definition: 'Object declared by the contract with fields: amount_range, rate, rate_type.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingFeeDiscountRateV2
  - term: fiskil_banking.BankingFeeRangeV2
    definition: 'Object declared by the contract with fields: fee_maximum, fee_minimum.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingFeeRangeV2
  - term: fiskil_banking.BankingFeeRateV2
    definition: 'Object declared by the contract with fields: accrual_frequency, amount_range, rate, rate_type.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingFeeRateV2
  - term: fiskil_banking.BankingInternationalPayee
    definition: 'Object declared by the contract with fields: bank_details, beneficiary_details.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingInternationalPayee
  - term: fiskil_banking.BankingInternationalPayeeBankDetails
    definition: 'Object declared by the contract with fields: account_number, bank_address, beneficiary_bank_bic, chip_number, country, fed_wire_number,
      legal_entity_identifier, routing_number, sort_code.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingInternationalPayeeBankDetails
  - term: fiskil_banking.BankingInternationalPayeeBankDetailsBankAddress
    definition: 'Object declared by the contract with fields: address, name.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingInternationalPayeeBankDetailsBankAddress
  - term: fiskil_banking.BankingInternationalPayeeBeneficiaryDetails
    definition: 'Object declared by the contract with fields: country, message, name.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingInternationalPayeeBeneficiaryDetails
  - term: fiskil_banking.BankingProductAdditionalInformationV2
    definition: 'Object declared by the contract with fields: additional_bundle_uris, additional_eligibility_uris, additional_fees_and_pricing_uris,
      additional_overview_uris, additional_terms_uris, bundle_uri, eligibility_uri, fees_and_pricing_uri, overview_uri, terms_uri.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingProductAdditionalInformationV2
  - term: fiskil_banking.BankingProductAdditionalInformationV2AdditionalInformationUris
    definition: 'Object declared by the contract with fields: additional_info_uri, description.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingProductAdditionalInformationV2AdditionalInformationUris
  - term: fiskil_banking.BankingProductBundle
    definition: 'Object declared by the contract with fields: additional_info, additional_info_uri, description, name, product_ids.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingProductBundle
  - term: fiskil_banking.BankingProductDiscountEligibilityV2
    definition: 'Object declared by the contract with fields: additional_info, additional_info_uri, additional_value, discount_eligibility_type.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingProductDiscountEligibilityV2
  - term: fiskil_banking.BankingProductEligibility
    definition: 'Object declared by the contract with fields: additional_info, additional_info_uri, additional_value, eligibility_type.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingProductEligibility
  - term: fiskil_banking.BankingProductInstalmentsV3
    definition: 'Object declared by the contract with fields: instalments_limit, maximum_concurrent_plans, maximum_plan_value, maximum_split,
      minimum_plan_value, minimum_split.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingProductInstalmentsV3
  - term: fiskil_banking.BankingProductV4CardArt
    definition: 'Object declared by the contract with fields: image_uri, title.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingProductV4CardArt
  - term: fiskil_banking.BankingProductV6CardArt
    definition: 'Object declared by the contract with fields: card_scheme, card_type, image_uri, title.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingProductV6CardArt
  - term: fiskil_banking.BankingProductV6Constraint
    definition: 'Object declared by the contract with fields: additional_info, additional_info_uri, additional_value, constraint_type.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingProductV6Constraint
  - term: fiskil_banking.BankingProductV6DepositRate
    definition: 'Object declared by the contract with fields: additional_info, additional_info_uri, additional_value, applicability_conditions,
      application_frequency, application_type, calculation_frequency, deposit_rate_type, rate, tiers.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingProductV6DepositRate
  - term: fiskil_banking.BankingProductV6Discount
    definition: 'Object declared by the contract with fields: additional_info, additional_info_uri, additional_value, description, discount_method_u_type,
      discount_type, eligibility, fixed_amount, rate_based.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingProductV6Discount
  - term: fiskil_banking.BankingProductV6Feature
    definition: 'Object declared by the contract with fields: additional_info, additional_info_uri, additional_value, feature_type.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingProductV6Feature
  - term: fiskil_banking.BankingProductV6Fee
    definition: 'Object declared by the contract with fields: additional_info, additional_info_uri, additional_value, currency, discounts, fee_cap,
      fee_cap_period, fee_method_u_type, fee_type, fixed_amount, name, rate_based. (1 more)'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingProductV6Fee
  - term: fiskil_banking.BankingProductV6LendingRate
    definition: 'Object declared by the contract with fields: additional_info, additional_info_uri, additional_value, applicability_conditions,
      application_frequency, application_type, calculation_frequency, comparison_rate, interest_payment_due, lending_rate_type, loan_purpose,
      rate. (2 more)'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingProductV6LendingRate
  - term: fiskil_banking.BankingProductV6RateCondition
    definition: 'Object declared by the contract with fields: additional_info, additional_info_uri, additional_value, rate_applicability_type.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingProductV6RateCondition
  - term: fiskil_banking.BankingProductV6RateTier
    definition: 'Object declared by the contract with fields: additional_info, additional_info_uri, applicability_conditions, maximum_value, minimum_value,
      name, rate_application_method, unit_of_measure.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingProductV6RateTier
  - term: fiskil_banking.BankingScheduledPaymentFrom
    definition: 'Object declared by the contract with fields: account_id.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingScheduledPaymentFrom
  - term: fiskil_banking.BankingScheduledPaymentInterval
    definition: 'Object declared by the contract with fields: day_in_interval, interval.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingScheduledPaymentInterval
  - term: fiskil_banking.BankingScheduledPaymentRecurrence
    definition: 'Object declared by the contract with fields: event_based, interval_schedule, last_week_day, next_payment_date, once_off, recurrence_utype.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingScheduledPaymentRecurrence
  - term: fiskil_banking.BankingScheduledPaymentRecurrenceEventBased
    definition: 'Object declared by the contract with fields: description.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingScheduledPaymentRecurrenceEventBased
  - term: fiskil_banking.BankingScheduledPaymentRecurrenceIntervalSchedule
    definition: 'Object declared by the contract with fields: final_payment_date, intervals, non_business_day_treatment, payments_remaining.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingScheduledPaymentRecurrenceIntervalSchedule
  - term: fiskil_banking.BankingScheduledPaymentRecurrenceLastWeekday
    definition: 'Object declared by the contract with fields: final_payment_date, interval, last_week_day, non_business_day_treatment, payments_remaining.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingScheduledPaymentRecurrenceLastWeekday
  - term: fiskil_banking.BankingScheduledPaymentRecurrenceOnceOff
    definition: 'Object declared by the contract with fields: payment_date.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingScheduledPaymentRecurrenceOnceOff
  - term: fiskil_banking.BankingScheduledPaymentSetV2
    definition: 'Object declared by the contract with fields: amount, currency, is_amount_calculated, to.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingScheduledPaymentSetV2
  - term: fiskil_banking.BankingScheduledPaymentToV2
    definition: 'Object declared by the contract with fields: account_id, biller, digital_wallet, domestic, international, nickname, payee_id,
      payee_reference, to_utype.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingScheduledPaymentToV2
  - term: fiskil_banking.BankingTermDepositAccount
    definition: 'Object declared by the contract with fields: lodgement_date, maturity_amount, maturity_currency, maturity_date, maturity_instructions.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingTermDepositAccount
  - term: fiskil_banking.BankingTransactionDetailAllOfExtendedDataV2
    definition: 'Object declared by the contract with fields: extension_u_type, npp_payload, payee, payer.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingTransactionDetailAllOfExtendedDataV2
  - term: fiskil_banking.BankingTransactionDetailV2AllOfExtendedDataNppPayload
    definition: 'Object declared by the contract with fields: end_to_end_id, extended_description, purpose_code, service, service_version.'
    tags:
    - Object
    source: openapi/_original/fiskil-openapi.json#/components/schemas/fiskil_banking.BankingTransactionDetailV2AllOfExtendedDataNppPayload