Skip to main content
Version: v3

Periodical Expenses Service

The Periodical Expenses Service predicts recurring expenses, identifying fixed, frequent costs across multiple categories, including:

  • Contracts: Rent, utilities, internet, phone, etc.
  • Insurance: Health, home, travel, life, etc.
  • Subscriptions: Streaming services, publications, memberships.
  • Contributions: School fees, club dues, donations.
  • Taxes and Charges: Sewage, property taxes, other fees.
  • Internal Transactions: Regular transfers to other accounts.

Key Features​

  • Recurring Expense Detection: Recognizes predictable transactions from patterns in bills, subscriptions, and other routine expenses.
  • Categorization: Automatically organizes each recurring expense into predefined categories.
  • Frequency and Probability Assessment: Evaluates regularity and likelihood of each identified transaction.
  • Comprehensive Metadata: Supplies detailed information on each recurring expense, including account and business-related data where applicable.

How to Use the Periodical Expenses Service​

To call the Periodical Expenses Service, include the following parameters and headers.

Required Headers​

  • ApiKey (string, required): Authentication key for API access.
    • Format: UUID
  • X-Request-ID (string, required): Unique request identifier for tracking.
    • Format: UUID
  • ClientId (string, optional): Identifier for the requesting client or application.
  • ConsentCollectionId (string, optional): Identifier for the associated consent collection, if using PSD2 data.
    • Format: UUID

Request Body​

  • File (binary, optional): Binary data object containing transaction data. Can be omitted if ConsentCollectionId is used.
  • Options (integer, optional): Configurable option flags. Default value: 33.

Response​

On successful completion, the Periodical Expenses Service returns an array of detected recurring expenses, with detailed account and transaction information.

Example Output Structure​

  • Account Details: Information on the account linked to each recurring expense, including identifiers, IBAN, country, and balance data.
  • Items Array:
    • Expense Details:
      • probability (string): Likelihood that the transaction is recurring (e.g., Medium, High).
      • frequenceType (integer): Frequency of the transaction (e.g., monthly, quarterly).
      • amount (decimal): Expected recurring expense amount.
      • category (object): Classification details for the expense category (e.g., rent, insurance).
    • Transaction Metadata:
      • id (string): Unique transaction identifier.
      • bookDate (date): Date the transaction was booked.
      • amount (decimal): Amount of the transaction.
      • beneficiary (object): Details about the payee or business involved.
      • description (string): Text description of the transaction.

Calling the Periodical Expenses Service​

Please refer to the API reference for the Periodical Expenses service for all technical details on how to call this service.