SAsaltedge
Reports

Create Financial Insights report

Changed on

Allows you to create a report for a customer for a specific date range.

post/reports

Request

Query parameters

customer_idstring required

the id of the customer that the report will be generated for

report_typesstring[] required

Types of reports that can be generated. Possible values are: balance, expense, income, savings, expense_categories, income_categories, inbound_transfers, outbound_transfers

<strong>Note:</strong> at least one report type should be requested

<strong>Note:</strong> for an extended Financial Insights PDF report, the following types of reports are used: balance, expense, income, savings. For a compact PDF report, the following are mostly used: expense_categories, income_categories, inbound_transfers, outbound_transfers, as well as, some other parameters from the rest of the reports.

include_account_naturesstring[]

Accounts with specified account natures can be included in the report. Possible values are: account, bonus, card, checking, credit, credit_card, debit_card, ewallet, insurance, investment, loan, mortgage, savings

currency_codestring required

main currency code to be used for the report's generation and value conversion

from_datestring date required

the date from which the data in the report will be included

to_datestring date required

the date to which the data in the report will be included

Response

OK

Changes

  • 0f60ddc45fabRevision changes
    • breaking

      for the query request parameter include_account_natures, the type changed from array of strings to array

    • breaking

      for the query request parameter report_types, the type changed from array of strings to array

    • breaking

      the / response's property type changed from array of strings to array for status

  • 16de527b0cc6Revision changes
    • breaking

      for the query request parameter report_types, the type changed from array to array of strings

    • breaking

      removed the required property / from the response with the status

    • info

      added the new optional query request parameter include_account_natures

    • info

      added the optional property / to the response with the status