Recurrence service

The Recurrence service is intended to detect recurrent expenses\incomes. Among other things this covers:

• Contract (rent, energy, telephone, internet, water, etc.)
• Insurance (medical, home, liability, travel, life, etc.)
• Subscriptions (streaming services, newspapers, magazines, etc.)
• Contributions (sports, associations, school fees, etc.)
• Taxes and charges (sewage costs, etc.)
• Customer-to-customer (money transfers, etc.)
• Income (salary, etc.)

Recurrence integration into Convert

The Convert Service supports the identification of recurring transactions, which can be enabled on /convert by using the IncludeRecurrence flag in the headers of the request. When set to true, the recurrence algorithm will be executed on the given transaction batch. This algorithm will only run if it is included in your contract.

When the IncludeRecurrence flag is enabled, it will add three properties to each recurrent transaction:

• RecurrenceSequence: Indicates the sequence of the recurrence.

• RecurrenceInterval: A number that states how often the transaction occurs in a given time period.

• RecurrenceType: Defines the type of recurrence. The possible values are:

  • 0 => None
  • 1 => Second
  • 2 => Minute
  • 3 => Hour
  • 4 => Day
  • 5 => Week
  • 6 => Month
  • 7 => Quarter
  • 8 => Semester
  • 9 => Year

For example, if a transaction has a RecurrenceInterval of 3 and a RecurrenceType of 6, it means the transaction recurs every 3 months.

Calling the Recurrence Service

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