--- title: "Show a report." method: GET path: "/reports/{report_id}" tags: ["Reports"] --- # Show a report. `GET /reports/{report_id}` Shows the generated report with all the details. ## Path parameters - `report_id` string, required — the `id` of the report generated based on the [customer's](#customers) data ## Response `200` OK - ReportResponse - `data` FullReport - `id` string, required — the `id` of the general report generated based on the customer's data - `customer_id` string, required — the `id` of the [customer](#customers) for which the report has been requested - `customer_identifier` string, required — unique [customer](#customers) identifier - `status` 'initialized' | 'calculating' | 'success' | 'failed', required — current report's status. - `connection_ids` string[], required — `ids` of [connections](#connections) included in the report Note: We do not include the duplicated accounts in the report's calculation. If any connection is not included in the report, that means that this connection contains only duplicated account data. Also the connection will not be included in the report, if there are no successful attempts to fetch the data for this connection. - `include_account_natures` string[] — Accounts with specified [account natures](#accounts-nature) are included in the report. Possible values are: `account`, `bonus`, `card`, `checking`, `credit`, `credit_card`, `debit_card`, `ewallet`, `insurance`, `investment`, `loan`, `mortgage`, `savings` - `currency_code` string, required — main [currency code](#currencies) used for the report's generation and value conversion - `from_date` string, date, required — the date from which the data in the report are included - `to_date` string, date, required — the date to which the data in the report are included - `report_types` string[], required — Types of reports. Possible values are: `balance`, `expense`, `income`, `savings`, `expense_categories`, `income_categories`, `inbound_transfers`, `outbound_transfers`. Note: 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. - `data` Report, required - `result` object, required — report result - `accounts` object[], required — The report data per each account - `id` string, required — The `id` of the [account](#accounts) - `name` string, required — the unique name of the account - `nature` 'account' | 'bonus' | 'card' | 'checking' | 'credit' | 'credit_card' | 'debit_card' | 'ewallet' | 'insurance' | 'investment' | 'loan' | 'mortgage' | 'savings', required — The type of the account. - `connection_id` string, required — `id` of the [connection](#connections) to which the account belongs - `start_date` string, date, required — the date of the first transaction - `end_date` string, date, required — the date of the last transaction - `whole_months_count` integer, required — number of full months covered by the report - `days_count` integer, required — number of days covered by the report - `monthly_average_transactions_count` object, required — average number of transactions per month - `total` integer, required — average number of expense and income transactions per month - `income` integer, required — average number of income transactions per month - `expense` integer, required — average number of expense transactions per month - `balance` BalanceReport, required - `start_date_amount` number, required — opening balance. The balance before the first [transaction](#transactions) was imported - `end_date_amount` number, required — closing balance. The balance after the last [transaction](#transactions) was imported - `minimum` number, required — The minimum balance registered for the report's date range - `maximum` number, required — The maximum balance registered for the report's date range - `average` object, required — Average balance - … - `forecasted_average` object, required — forecasted average balance - … - `income` IncomeReport, required - `start_date` string, date, required — the date of the first income/expense [transaction](#transactions) - `end_date` string, date, required — the date of the last income/expense [transaction](#transactions) - `transactions_count` integer, required — number of income/expense [transactions](#transactions) - `last_year_amount` number, required — total amount of income/expense for the last fully covered 12 months - `total` number, required — total amount of income/expense per the calculated period - `total_per_month` object[], required — total amount of income/expense per each month - … - `average` object, required — average amount of income/expense - … - `forecasted_average` object, required — forecasted average amount of income/expense - … - `streams` object, required — Information on income/expense a customer receives/spends on a regular/irregular basis - … - `expense` ExpenseReport, required - `start_date` string, date, required — the date of the first income/expense [transaction](#transactions) - `end_date` string, date, required — the date of the last income/expense [transaction](#transactions) - `transactions_count` integer, required — number of income/expense [transactions](#transactions) - `last_year_amount` number, required — total amount of income/expense for the last fully covered 12 months - `total` number, required — total amount of income/expense per the calculated period - `total_per_month` object[], required — total amount of income/expense per each month - … - `average` object, required — average amount of income/expense - … - `forecasted_average` object, required — forecasted average amount of income/expense - … - `streams` object, required — Information on income/expense a customer receives/spends on a regular/irregular basis - … - `savings` SavingsReport, required - `total` number, required — Total amount of savings per the calculated period - `per_month` object[], required — information related to net savings per each month - … - `average` object, required — average savings - … - `forecasted_average` object, required — forecasted average savings - … - `runway` number, required — provides an estimate (number of months) on how long the current balance will be sufficient until the customer runs out of money. The customer's income and expenses are taken into account. Note: This indicator is calculated only for cases when the customer has positive current balance and the amount of expenses exceeds the amount of income - `expense_to_savings_rate` number, required — shows whether the customer increases or loses capital. Taking into account the customer's income and expenses, this indicator shows the number of months during which the customer's savings are either increased or reduced by an amount equal to 1 month of expenses. Note: This indicator is calculated only for cases when the customer has both savings/dissavings and expenses - `stress_runway` number, required — provides an estimate (number of months) on how long the current balance will be sufficient to cover the customer's regular expenses in case income unexpectedly stops. Note: This indicator is calculated for all cases, except the one, when the customer has no expenses - `income_stability` number, required — average weighted stability of income from all the sources Note: it is close to `1`, if customer has stable income - `income_regularity` number, required — average weighted regularity of income from all the sources Note: it is close to `1`, if customer has regular income - `income_to_expense_rate` number, required — ratio of average monthly income to average monthly expense" - `expense_categories` ExpenseCategoriesReport, required - `categories` object[], required — Information on expense categories a customer spends money on. Note: outbound transfers are not considered. - … - `income_categories` IncomeCategoriesReport, required - `streams` object[], required — Information on the income a customer receives on a regular/irregular basis. Note: inbound transfers and other categories of incoming transactions are not considered. - … - `inbound_transfers` InboundTransfersReport, required - `streams` object[], required — Information on the transfers a customer receives on a regular/irregular basis. Note: all transfers incoming from one account to another are considered as inbound transfers, no matter if those accounts belong to the same customer or different. - … - `outbound_transfers` OutboundTransfersReport, required - `streams` object[], required — Information on transfers a customer sends on a regular/irregular basis. Note: all transfers outgoing from one account to another are considered as outbound transfers, no matter if those accounts belong to the same customer or different. - … - `accounts_summary` object, required — the report with the summary data for all accounts - `start_date` string, date, required — the date of the first transaction - `end_date` string, date, required — the date of the last transaction - `whole_months_count` integer, required — number of full months covered by the report - `days_count` integer, required — number of days covered by the report - `transactions_count` integer, required — total number of transactions - `monthly_average_transactions_count` object, required — average number of transactions per month - `total` integer, required — average number of expense and income transactions per month - `income` integer, required — average number of income transactions per month - `expense` integer, required — average number of expense transactions per month - `balance` BalanceReport, required - `start_date_amount` number, required — opening balance. The balance before the first [transaction](#transactions) was imported - `end_date_amount` number, required — closing balance. The balance after the last [transaction](#transactions) was imported - `minimum` number, required — The minimum balance registered for the report's date range - `maximum` number, required — The maximum balance registered for the report's date range - `average` object, required — Average balance - … - `forecasted_average` object, required — forecasted average balance - … - `income` IncomeReport, required - `start_date` string, date, required — the date of the first income/expense [transaction](#transactions) - `end_date` string, date, required — the date of the last income/expense [transaction](#transactions) - `transactions_count` integer, required — number of income/expense [transactions](#transactions) - `last_year_amount` number, required — total amount of income/expense for the last fully covered 12 months - `total` number, required — total amount of income/expense per the calculated period - `total_per_month` object[], required — total amount of income/expense per each month - … - `average` object, required — average amount of income/expense - … - `forecasted_average` object, required — forecasted average amount of income/expense - … - `streams` object, required — Information on income/expense a customer receives/spends on a regular/irregular basis - … - `expense` ExpenseReport, required - `start_date` string, date, required — the date of the first income/expense [transaction](#transactions) - `end_date` string, date, required — the date of the last income/expense [transaction](#transactions) - `transactions_count` integer, required — number of income/expense [transactions](#transactions) - `last_year_amount` number, required — total amount of income/expense for the last fully covered 12 months - `total` number, required — total amount of income/expense per the calculated period - `total_per_month` object[], required — total amount of income/expense per each month - … - `average` object, required — average amount of income/expense - … - `forecasted_average` object, required — forecasted average amount of income/expense - … - `streams` object, required — Information on income/expense a customer receives/spends on a regular/irregular basis - … - `savings` SavingsReport, required - `total` number, required — Total amount of savings per the calculated period - `per_month` object[], required — information related to net savings per each month - … - `average` object, required — average savings - … - `forecasted_average` object, required — forecasted average savings - … - `runway` number, required — provides an estimate (number of months) on how long the current balance will be sufficient until the customer runs out of money. The customer's income and expenses are taken into account. Note: This indicator is calculated only for cases when the customer has positive current balance and the amount of expenses exceeds the amount of income - `expense_to_savings_rate` number, required — shows whether the customer increases or loses capital. Taking into account the customer's income and expenses, this indicator shows the number of months during which the customer's savings are either increased or reduced by an amount equal to 1 month of expenses. Note: This indicator is calculated only for cases when the customer has both savings/dissavings and expenses - `stress_runway` number, required — provides an estimate (number of months) on how long the current balance will be sufficient to cover the customer's regular expenses in case income unexpectedly stops. Note: This indicator is calculated for all cases, except the one, when the customer has no expenses - `income_stability` number, required — average weighted stability of income from all the sources Note: it is close to `1`, if customer has stable income - `income_regularity` number, required — average weighted regularity of income from all the sources Note: it is close to `1`, if customer has regular income - `income_to_expense_rate` number, required — ratio of average monthly income to average monthly expense" - `expense_categories` ExpenseCategoriesReport, required - `categories` object[], required — Information on expense categories a customer spends money on. Note: outbound transfers are not considered. - … - `income_categories` IncomeCategoriesReport, required - `streams` object[], required — Information on the income a customer receives on a regular/irregular basis. Note: inbound transfers and other categories of incoming transactions are not considered. - … - `inbound_transfers` InboundTransfersReport, required - `streams` object[], required — Information on the transfers a customer receives on a regular/irregular basis. Note: all transfers incoming from one account to another are considered as inbound transfers, no matter if those accounts belong to the same customer or different. - … - `outbound_transfers` OutboundTransfersReport, required - `streams` object[], required — Information on transfers a customer sends on a regular/irregular basis. Note: all transfers outgoing from one account to another are considered as outbound transfers, no matter if those accounts belong to the same customer or different. - … - `customer_id` integer, required — The `id` of the [customer](#customers) - `connection_ids` string[], required — `ids` of [connections](#connections) included in the report Note: We do not include the duplicated accounts in the report's calculation. If any connection is not included in the report, that means that this connection contains only duplicated account data. Also the connection will not be included in the report, if there are no successful attempts to fetch the data for this connection. - `connections` object[], required — information related to connections included in report - `id` string, required — The `id` of the [connection](#connections) - `customer_id` integer, required — The `id` of the [customer](#customers) - `provider_code` string, required — the code of the [Provider](#providers) the connection belongs to - `provider_name` string, required — the name of the [Provider](#providers) the connection belongs to - `accounts` object[], required — information related to accounts, which belong to this connection - `id` string, required — the `id` of the [account](#accounts) - `name` string, required — the unique name of the account - `nature` 'account' | 'bonus' | 'card' | 'checking' | 'credit' | 'credit_card' | 'debit_card' | 'ewallet' | 'insurance' | 'investment' | 'loan' | 'mortgage' | 'savings', required — The type of the account. - `balance` number, required — the account's current balance in currency used for report's generation - `original_balance` number, required — the account's current balance in account's original currency - `original_currency_code` string, required — the account's original currency code - `transactions` object, required — transactions related information - `start_date` string, date, required — the date of the first transaction - `end_date` string, date, required — the date of the last transaction - `first_id` string, required — the `id` of the first [transaction](#transactions) - `last_id` string, required — the `id` of the last [transaction](#transactions) - `count` integer, required — total number of transactions - `holder_info` object, required — essential [information](#know_your_customer) about the account holder fetched from the connected provider - `client_name` string, required — Name of the Salt Edge Client, who requested the Financial Insights report - `currency_code` string, required — main [currency code](#currencies) used for report's generation and value conversion - `exchange_rates` object, required — a list of exchange rates at the time of report creation - `report_id` integer, required — the `id` of the generated report - `report_types` string[], required — types of generated reports. Possible values are: `balance`, `expense`, `income`, `savings`, `expense_categories`, `income_categories`, `inbound_transfers`, `outbound_transfers`. - `status` 'initialized' | 'calculating' | 'success' | 'failed', required — current report's status. - `from_date` string, date, required — the date from which the data in the report are included - `to_date` string, date, required — the date to which the data in the report are included - `created_at` string, date-time, required — the date when the report was created - `updated_at` string, date-time, required — the date when the report was last updated ## Other responses - `404` — The requested Financial Insights `id` was not found - `406` — The client has been disabled. You can find out more about the disabled status on [Disabled](<%= general_link('disabled') %>) guides page --- [API](https://skmtc.net/saltedge/apis/salt-edge-account-information-api.md) · [All operations](https://skmtc.net/saltedge/apis/salt-edge-account-information-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/saltedge/salt-edge-account-information-api/revisions/f18f4f36d0b3/schema)