> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://infonite.dev/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://infonite.dev/_mcp/server. # Accounts **Where it lives:** at `accounts` in the **Financial Position**, and on its own from the accounts endpoint. The account is the centre of a banking extraction: it carries the balances, and it carries the movements that everything else is inferred from — income, rent, recurring commitments, unusual activity. ### Schema (`CurrentAccountSchema`) ```yaml components: schemas: CurrentAccountSchemaDataEnrichment: type: string enum: - skipped - pending - processing - ready - failed description: >- Data enrichment status. Indicates whether the product has been enriched with additional data. If not, the product will be filled with generic data. title: CurrentAccountSchemaDataEnrichment CurrentAccountSchemaIdentifier: oneOf: - type: object properties: type: type: string enum: - clabe description: 'Discriminator value: clabe' value: type: string format: clabe description: Clave Bancaria Estandarizada masked: type: string minLength: 1 maxLength: 19 description: Partial Clabe entity_country: type: string description: Bank Country entity_code: type: string description: Bank code entity_office: type: string description: Bank office control_digits: type: string description: Control digit required: - type - value - masked - entity_country - entity_code - entity_office - control_digits description: Clave Bancaria Estandarizada - type: object properties: type: type: string enum: - generic description: 'Discriminator value: generic' value: type: string description: Identifier entity_country: type: string format: country description: Entity country entity_code: type: string description: Entity code entity_office: type: string description: Entity office control_digits: type: string description: Control digits required: - type - value description: Generic account identifier - type: object properties: type: type: string enum: - iban description: 'Discriminator value: iban' value: type: string format: iban description: International Bank Account Number masked: type: string minLength: 1 maxLength: 34 description: Partial IBAN entity_country: type: string description: Bank Country entity_code: type: string description: Bank code entity_office: type: string description: Bank office control_digits: type: string description: Control digits required: - type - value - masked - entity_country - entity_code - entity_office - control_digits description: International Bank Account Number discriminator: propertyName: type description: Account identifier title: CurrentAccountSchemaIdentifier CustomerSegment: type: string enum: - not_assigned - personal - business - corporate - private - retail title: CustomerSegment InfoniteSchemasUtilsCurrencyAmountSchema1Currency: oneOf: - type: string format: currency - type: string enum: - '***' description: >- Three-letter ISO currency code — or `***` when the source did not disclose the currency. title: InfoniteSchemasUtilsCurrencyAmountSchema1Currency infonite__schemas__utils__CurrencyAmountSchema__1: type: object properties: currency: $ref: >- #/components/schemas/InfoniteSchemasUtilsCurrencyAmountSchema1Currency description: >- Three-letter ISO currency code — or `***` when the source did not disclose the currency. amount: type: string format: number description: Decimal number with 2 digits precision required: - currency - amount description: A monetary amount together with its currency. title: infonite__schemas__utils__CurrencyAmountSchema__1 FinancialTransactionType: type: string enum: - unknown - opening - closure - credit - debit - default title: FinancialTransactionType FinancialTransactionStatus: type: string enum: - unknown - pending - booked - cancelled - failed - reversed title: FinancialTransactionStatus FinancialTransactionCategory: type: string enum: - expenses::to categorize::unclassified - expenses::household::other household - expenses::household::rent - expenses::household::mortgage - expenses::household::utilities - expenses::household::communications - expenses::household::insurance & fees - expenses::household::services - expenses::home improvement::other home improvement - expenses::home improvement::renovation & repairs - expenses::home improvement::furniture & interior - expenses::home improvement::garden & outdoor - expenses::food & drinks::other food & drinks - expenses::food & drinks::groceries & supermarket - expenses::food & drinks::dining out - expenses::food & drinks::coffee & snacks - expenses::food & drinks::alcohol & tobacco - expenses::transport::other transport - expenses::transport::car & fuel - expenses::transport::public transport - expenses::transport::flights - expenses::transport::taxi & ride-share - expenses::shopping::other shopping - expenses::shopping::clothes & accessories - expenses::shopping::electronics & gadgets - expenses::shopping::hobby & sports equipment - expenses::shopping::books & games - expenses::shopping::gifts - expenses::leisure & entertainment::other leisure & entertainment - expenses::leisure & entertainment::culture events - expenses::leisure & entertainment::hobbies, sports & fitness - expenses::leisure & entertainment::hotels & vacation - expenses::leisure & entertainment::lottery & betting - expenses::health & beauty::other health & beauty - expenses::health & beauty::pharmacy - expenses::health & beauty::medical - expenses::health & beauty::beauty & personal care - expenses::health & beauty::optician & dentist - expenses::financial & organizations::other financial expenses - expenses::financial & organizations::credit obligations - expenses::financial & organizations::fees & charges - expenses::financial & organizations::public dues - expenses::other::other expenses - expenses::other::education - expenses::other::charity - expenses::other::associations - expenses::other::pets - expenses::other::kids - expenses::other::cash withdrawals - expenses::other::transfers - expenses::other::family pension/alimony - income::to categorize::unclassified - income::income::other income - income::income::salary & payroll - income::income::passive income - income::income::pension - income::income::subsidies & grants - income::income::tax refunds - income::income::transfers - income::income::cash deposit - income::income::received gifts - null::to categorize::unclassified - null::null::other not computable - null::null::card adjustment - null::null::card payment - null::null::investments - null::null::internal & self transfers description: >- Taxonomy of financial transactions for categorization. Values are `family::group::leaf` codes and are what gets stored and served. Each member's docstring is the customer-facing label of that node in the taxonomy. title: FinancialTransactionCategory IdentificationNumberSchemaType: type: string enum: - unknown - es:dni - es:nie - es:cif - es:ssn - co:cc - co:ce - co:nit - co:ti description: >- Kind of document the number belongs to (e.g. a national ID, passport, tax ID, or Social Security number). title: IdentificationNumberSchemaType IdentificationNumberSchema: type: object properties: type: $ref: '#/components/schemas/IdentificationNumberSchemaType' description: >- Kind of document the number belongs to (e.g. a national ID, passport, tax ID, or Social Security number). value: type: string description: The number itself, as reported by the source. validated: type: boolean description: >- True when the value passed the platform's format and check-digit validation. It vouches for the NUMBER being well-formed — not for the official status of the document behind it. country: type: - string - 'null' format: country description: Country that issued the number, as a two-letter ISO code. valid_until: type: string format: date description: Expiry date of the document, when the source reports it. required: - type - value - validated description: >- One identification document: its type, its value, and whether the value passed validation. title: IdentificationNumberSchema EntitySchema: type: object properties: name: type: string description: Name code: type: string description: Code country_code: type: string format: country description: Country Code identifier: $ref: '#/components/schemas/IdentificationNumberSchema' description: Holder identifier title: EntitySchema AccountTransactionSchema: type: object properties: type: $ref: '#/components/schemas/FinancialTransactionType' description: Transaction type status: $ref: '#/components/schemas/FinancialTransactionStatus' description: Transaction status category: $ref: '#/components/schemas/FinancialTransactionCategory' description: >- Transaction category. Transactions are classified based on their context and nature. The categorization is only applied if data enrichment is enabled for your current application. Otherwise, this field will be filled with a generic category based on the transaction amount. Contact support for more information. operation_date: type: string format: date description: >- Represents the exact moment a transaction was initiated or authorized, regardless of when it was recorded or had an effect on the balance. For instance, if a purchase was made using a credit card, the operation_date would be the date of that purchase, even if the transaction was processed or reflected in the account on subsequent dates. value_date: type: string format: date description: >- The date on which the transaction effectively impacts an account balance. It determines when interests or other time-based considerations might commence. Even though a transaction might be logged or authorized on a different date, the value_date signifies the point when it truly reflects on the account’s funds. amount: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: Transaction amount balance: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: Account balance after the transaction descriptions: type: array items: type: string description: Original transaction descriptions provider_id: type: string description: Unique ID for the transaction in the provider system reference: type: string description: Transaction reference payee: $ref: '#/components/schemas/EntitySchema' description: Payee information, if available payer: $ref: '#/components/schemas/EntitySchema' description: Payer information, if available merchant: $ref: '#/components/schemas/EntitySchema' description: Merchant information, if available required: - type - status - category title: AccountTransactionSchema FinancialHolderRole: type: string enum: - unknown - holder - authorized - beneficiary - other title: FinancialHolderRole AccountHolderSchema: type: object properties: role: $ref: '#/components/schemas/FinancialHolderRole' description: Holder Role name: type: string description: Holder name identifier: $ref: '#/components/schemas/IdentificationNumberSchema' description: Holder identifier current_customer: type: boolean description: Is current customer? required: - role title: AccountHolderSchema CurrentAccountSchema: type: object properties: id: type: string format: object-id description: >- Product ID for the current execution. Note: it may change between executions. product: type: string enum: - financial_account sub_family: type: string enum: - financial_account:current fetch_date: type: string format: datetime description: Date this product was fetched data_enrichment: $ref: '#/components/schemas/CurrentAccountSchemaDataEnrichment' description: >- Data enrichment status. Indicates whether the product has been enriched with additional data. If not, the product will be filled with generic data. identifier: $ref: '#/components/schemas/CurrentAccountSchemaIdentifier' description: Account identifier customer_segment: $ref: '#/components/schemas/CustomerSegment' product_name: type: string description: Product name product_alias: type: string description: Product alias product_description: type: string description: Product Description opening_date: type: string format: date description: Account opening date available: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: >- The total accessible funds, considering all cleared and uncleared transactions. This represents the amount a user can use or withdraw immediately. deprecated: true booked: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: >- The net monetary amount without considering pending transactions. It reflects the actual balance at any given moment. deprecated: true transactions: type: array items: $ref: '#/components/schemas/AccountTransactionSchema' description: Account transactions holders: type: array items: $ref: '#/components/schemas/AccountHolderSchema' description: Account holders required: - id - product - sub_family - fetch_date - data_enrichment - identifier - customer_segment - product_name title: CurrentAccountSchema ``` ## Two balances, and they are not interchangeable * **`booked`** — the settled balance: what has actually cleared. This is the figure the institution shows as *"balance"*. * **`available`** — what can be spent right now: the booked balance adjusted for pending movements and any credit line attached to the account. For solvency, `booked` is the honest number. For *"can this payment go through today"*, `available` is. ## Holders Who the account belongs to, and in what capacity — the difference between a sole account and one held with somebody else, which matters for both affordability and identity checks. ### Schema (`AccountHolderSchema`) ```yaml components: schemas: FinancialHolderRole: type: string enum: - unknown - holder - authorized - beneficiary - other title: FinancialHolderRole IdentificationNumberSchemaType: type: string enum: - unknown - es:dni - es:nie - es:cif - es:ssn - co:cc - co:ce - co:nit - co:ti description: >- Kind of document the number belongs to (e.g. a national ID, passport, tax ID, or Social Security number). title: IdentificationNumberSchemaType IdentificationNumberSchema: type: object properties: type: $ref: '#/components/schemas/IdentificationNumberSchemaType' description: >- Kind of document the number belongs to (e.g. a national ID, passport, tax ID, or Social Security number). value: type: string description: The number itself, as reported by the source. validated: type: boolean description: >- True when the value passed the platform's format and check-digit validation. It vouches for the NUMBER being well-formed — not for the official status of the document behind it. country: type: - string - 'null' format: country description: Country that issued the number, as a two-letter ISO code. valid_until: type: string format: date description: Expiry date of the document, when the source reports it. required: - type - value - validated description: >- One identification document: its type, its value, and whether the value passed validation. title: IdentificationNumberSchema AccountHolderSchema: type: object properties: role: $ref: '#/components/schemas/FinancialHolderRole' description: Holder Role name: type: string description: Holder name identifier: $ref: '#/components/schemas/IdentificationNumberSchema' description: Holder identifier current_customer: type: boolean description: Is current customer? required: - role title: AccountHolderSchema ``` ## Transactions Transactions are only retrieved when the feature is configured to read them (`read_transactions`, with a date range). Each one carries its dates, its amount, the running balance after it, and the parties involved. ### Schema (`AccountTransactionSchema`) ```yaml components: schemas: FinancialTransactionType: type: string enum: - unknown - opening - closure - credit - debit - default title: FinancialTransactionType FinancialTransactionStatus: type: string enum: - unknown - pending - booked - cancelled - failed - reversed title: FinancialTransactionStatus FinancialTransactionCategory: type: string enum: - expenses::to categorize::unclassified - expenses::household::other household - expenses::household::rent - expenses::household::mortgage - expenses::household::utilities - expenses::household::communications - expenses::household::insurance & fees - expenses::household::services - expenses::home improvement::other home improvement - expenses::home improvement::renovation & repairs - expenses::home improvement::furniture & interior - expenses::home improvement::garden & outdoor - expenses::food & drinks::other food & drinks - expenses::food & drinks::groceries & supermarket - expenses::food & drinks::dining out - expenses::food & drinks::coffee & snacks - expenses::food & drinks::alcohol & tobacco - expenses::transport::other transport - expenses::transport::car & fuel - expenses::transport::public transport - expenses::transport::flights - expenses::transport::taxi & ride-share - expenses::shopping::other shopping - expenses::shopping::clothes & accessories - expenses::shopping::electronics & gadgets - expenses::shopping::hobby & sports equipment - expenses::shopping::books & games - expenses::shopping::gifts - expenses::leisure & entertainment::other leisure & entertainment - expenses::leisure & entertainment::culture events - expenses::leisure & entertainment::hobbies, sports & fitness - expenses::leisure & entertainment::hotels & vacation - expenses::leisure & entertainment::lottery & betting - expenses::health & beauty::other health & beauty - expenses::health & beauty::pharmacy - expenses::health & beauty::medical - expenses::health & beauty::beauty & personal care - expenses::health & beauty::optician & dentist - expenses::financial & organizations::other financial expenses - expenses::financial & organizations::credit obligations - expenses::financial & organizations::fees & charges - expenses::financial & organizations::public dues - expenses::other::other expenses - expenses::other::education - expenses::other::charity - expenses::other::associations - expenses::other::pets - expenses::other::kids - expenses::other::cash withdrawals - expenses::other::transfers - expenses::other::family pension/alimony - income::to categorize::unclassified - income::income::other income - income::income::salary & payroll - income::income::passive income - income::income::pension - income::income::subsidies & grants - income::income::tax refunds - income::income::transfers - income::income::cash deposit - income::income::received gifts - null::to categorize::unclassified - null::null::other not computable - null::null::card adjustment - null::null::card payment - null::null::investments - null::null::internal & self transfers description: >- Taxonomy of financial transactions for categorization. Values are `family::group::leaf` codes and are what gets stored and served. Each member's docstring is the customer-facing label of that node in the taxonomy. title: FinancialTransactionCategory InfoniteSchemasUtilsCurrencyAmountSchema1Currency: oneOf: - type: string format: currency - type: string enum: - '***' description: >- Three-letter ISO currency code — or `***` when the source did not disclose the currency. title: InfoniteSchemasUtilsCurrencyAmountSchema1Currency infonite__schemas__utils__CurrencyAmountSchema__1: type: object properties: currency: $ref: >- #/components/schemas/InfoniteSchemasUtilsCurrencyAmountSchema1Currency description: >- Three-letter ISO currency code — or `***` when the source did not disclose the currency. amount: type: string format: number description: Decimal number with 2 digits precision required: - currency - amount description: A monetary amount together with its currency. title: infonite__schemas__utils__CurrencyAmountSchema__1 IdentificationNumberSchemaType: type: string enum: - unknown - es:dni - es:nie - es:cif - es:ssn - co:cc - co:ce - co:nit - co:ti description: >- Kind of document the number belongs to (e.g. a national ID, passport, tax ID, or Social Security number). title: IdentificationNumberSchemaType IdentificationNumberSchema: type: object properties: type: $ref: '#/components/schemas/IdentificationNumberSchemaType' description: >- Kind of document the number belongs to (e.g. a national ID, passport, tax ID, or Social Security number). value: type: string description: The number itself, as reported by the source. validated: type: boolean description: >- True when the value passed the platform's format and check-digit validation. It vouches for the NUMBER being well-formed — not for the official status of the document behind it. country: type: - string - 'null' format: country description: Country that issued the number, as a two-letter ISO code. valid_until: type: string format: date description: Expiry date of the document, when the source reports it. required: - type - value - validated description: >- One identification document: its type, its value, and whether the value passed validation. title: IdentificationNumberSchema EntitySchema: type: object properties: name: type: string description: Name code: type: string description: Code country_code: type: string format: country description: Country Code identifier: $ref: '#/components/schemas/IdentificationNumberSchema' description: Holder identifier title: EntitySchema AccountTransactionSchema: type: object properties: type: $ref: '#/components/schemas/FinancialTransactionType' description: Transaction type status: $ref: '#/components/schemas/FinancialTransactionStatus' description: Transaction status category: $ref: '#/components/schemas/FinancialTransactionCategory' description: >- Transaction category. Transactions are classified based on their context and nature. The categorization is only applied if data enrichment is enabled for your current application. Otherwise, this field will be filled with a generic category based on the transaction amount. Contact support for more information. operation_date: type: string format: date description: >- Represents the exact moment a transaction was initiated or authorized, regardless of when it was recorded or had an effect on the balance. For instance, if a purchase was made using a credit card, the operation_date would be the date of that purchase, even if the transaction was processed or reflected in the account on subsequent dates. value_date: type: string format: date description: >- The date on which the transaction effectively impacts an account balance. It determines when interests or other time-based considerations might commence. Even though a transaction might be logged or authorized on a different date, the value_date signifies the point when it truly reflects on the account’s funds. amount: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: Transaction amount balance: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: Account balance after the transaction descriptions: type: array items: type: string description: Original transaction descriptions provider_id: type: string description: Unique ID for the transaction in the provider system reference: type: string description: Transaction reference payee: $ref: '#/components/schemas/EntitySchema' description: Payee information, if available payer: $ref: '#/components/schemas/EntitySchema' description: Payer information, if available merchant: $ref: '#/components/schemas/EntitySchema' description: Merchant information, if available required: - type - status - category title: AccountTransactionSchema ``` ### Every transaction arrives categorised `category` is a two-level classification applied on top of what the bank published, in a fixed vocabulary — `income::income::salary & payroll`, `expenses::household::rent`, `expenses::transport::car & fuel`. It is what lets you compute income, fixed commitments and discretionary spending without writing a rules engine of your own. ### Schema (`FinancialTransactionCategory`) Taxonomy of financial transactions for categorization. Values are `family::group::leaf` codes and are what gets stored and served. Each member's docstring is the customer-facing label of that node in the taxonomy. ```yaml components: schemas: FinancialTransactionCategory: type: string enum: - expenses::to categorize::unclassified - expenses::household::other household - expenses::household::rent - expenses::household::mortgage - expenses::household::utilities - expenses::household::communications - expenses::household::insurance & fees - expenses::household::services - expenses::home improvement::other home improvement - expenses::home improvement::renovation & repairs - expenses::home improvement::furniture & interior - expenses::home improvement::garden & outdoor - expenses::food & drinks::other food & drinks - expenses::food & drinks::groceries & supermarket - expenses::food & drinks::dining out - expenses::food & drinks::coffee & snacks - expenses::food & drinks::alcohol & tobacco - expenses::transport::other transport - expenses::transport::car & fuel - expenses::transport::public transport - expenses::transport::flights - expenses::transport::taxi & ride-share - expenses::shopping::other shopping - expenses::shopping::clothes & accessories - expenses::shopping::electronics & gadgets - expenses::shopping::hobby & sports equipment - expenses::shopping::books & games - expenses::shopping::gifts - expenses::leisure & entertainment::other leisure & entertainment - expenses::leisure & entertainment::culture events - expenses::leisure & entertainment::hobbies, sports & fitness - expenses::leisure & entertainment::hotels & vacation - expenses::leisure & entertainment::lottery & betting - expenses::health & beauty::other health & beauty - expenses::health & beauty::pharmacy - expenses::health & beauty::medical - expenses::health & beauty::beauty & personal care - expenses::health & beauty::optician & dentist - expenses::financial & organizations::other financial expenses - expenses::financial & organizations::credit obligations - expenses::financial & organizations::fees & charges - expenses::financial & organizations::public dues - expenses::other::other expenses - expenses::other::education - expenses::other::charity - expenses::other::associations - expenses::other::pets - expenses::other::kids - expenses::other::cash withdrawals - expenses::other::transfers - expenses::other::family pension/alimony - income::to categorize::unclassified - income::income::other income - income::income::salary & payroll - income::income::passive income - income::income::pension - income::income::subsidies & grants - income::income::tax refunds - income::income::transfers - income::income::cash deposit - income::income::received gifts - null::to categorize::unclassified - null::null::other not computable - null::null::card adjustment - null::null::card payment - null::null::investments - null::null::internal & self transfers title: FinancialTransactionCategory ``` The prefix is the first thing to branch on: `income::`, `expenses::` or `null::` for movements that are neither (internal transfers, card adjustments). Anything the classifier could not place lands in `…::to categorize::unclassified` rather than being guessed at. ### Type and status ### Schema (`FinancialTransactionType`) ```yaml components: schemas: FinancialTransactionType: type: string enum: - unknown - opening - closure - credit - debit - default title: FinancialTransactionType ``` ### Schema (`FinancialTransactionStatus`) ```yaml components: schemas: FinancialTransactionStatus: type: string enum: - unknown - pending - booked - cancelled - failed - reversed title: FinancialTransactionStatus ``` **How far back the transactions go is decided by two things**: the range you asked for in the feature's configuration, and what the institution itself keeps. The engine's `engine_restrictions` state its limit — ask for more and the execution is rejected, unless you set `limits_behaviour: adapt`.