--- title: "Get a user's open banking report" method: GET path: "/data/monthly-report/{userId}" --- # Get a user's open banking report `GET /data/monthly-report/{userId}` ## Path parameters - `userId` string, required ## Response `200` Response - OpenBankingReport - `openBankingReportId` string — A unique identifier for the report - `openBankingReportBalances` object - `incomes` object - `total` number — The total amount of incomes - `incomeFromSalary` number — The total amount of incomes from salary - `incomeFromChecks` number — The total amount of incomes from checks - `regularIncomesSum` number — The total amount of regular incomes - `expenses` object - `total` number — The total amount of expenses - `expensesFromMortgage` number — The total amount of expenses on mortgage - `expensesFromChecks` number — The total amount of expenses from checks - `regularExpensesSum` number — The total amount of regular expenses - `canceledChecks` number — Number of times checks were canceled - `standingOrdersReturns` number — Number of times standing orders were returned - `irregularWarnings` number — Number of irregular warnings - `accountForeclosure` number — Number of account foreclosures - `nsf` number — Number of NSF times - `transfersForFallingBehind` number — Number of times money was transferred to cover falling behind - `limitationAlert` number — Number of limitation alerts - `fallingBehindWarnings` number — Number of falling behind warnings - `MonthlyReportGeneralDetails` object - `loans` object - `totalLoansAmount` number — Current total loans amount - `bankLoans` object - `creditCardLoans` object - `savings` object - `totalSavingsAmount` number — Current total savings amount - `savingsDetails` object - `accounts` object - `checking` Account[] - `PK` string — Primary key of the account, combining organization and customer IDs - `SK` string — Sort key of the account, unique per account within the customer - `orgId` string — The ID of the organization that owns the account - `customerId` string — The ID of the customer associated with the account - `userId` string — The ID of the user who owns the account - `fileId` string — The ID of the file associated with the account - `connectionId` string — The ID of the connection associated with the account - `accountId` string — Unique identifier for the account - `providerId` string — The ID of the provider associated with the account - `providerLabel` object - `en` string — Provider name in English - `he` string — Provider name in Hebrew - `accountResourceId` string — Resource identifier for the account provided by the financial institution - `accountNumber` string — Account number associated with the account - `accountDetails` string — Additional details about the account - `accountType` 'CHECKING' | 'CARD' | 'LOAN' | 'SAVINGS' — Type of the account (e.g., CHECKING, CARD, LOAN, SAVINGS) - `accountOwnerInfo` object - `fullName` string — Full name of the account owner - `nationalId` string — National ID of the account owner - `accountTransactionNumber` number — Number of transactions associated with the account - `accountCurrency` string — Currency of the account - `accountBalances` object[] - `balanceType` string — Type of balance (e.g., available, current) - `balanceAmount` object - `currency` string — Currency of the balance amount - `amount` string — Amount of the balance - `creditLimitIncluded` boolean — Indicates if the credit limit is included in the balance - `referenceDate` string, date — Reference date for the balance - `lastChangeDateTime` string, date-time — The last date and time when the balance was changed - `accountProduct` string — Product associated with the account - `accountCashAccountType` string — Type of cash account (e.g., checking, savings) - `accountCreditLimit` object - `amount` number — Credit limit amount - `currency` string — Currency of the credit limit - `createdAt` string, date-time — Date when the account was created - `updatedAt` string, date-time — Date when the account was last updated - `savings` Account[] - `PK` string — Primary key of the account, combining organization and customer IDs - `SK` string — Sort key of the account, unique per account within the customer - `orgId` string — The ID of the organization that owns the account - `customerId` string — The ID of the customer associated with the account - `userId` string — The ID of the user who owns the account - `fileId` string — The ID of the file associated with the account - `connectionId` string — The ID of the connection associated with the account - `accountId` string — Unique identifier for the account - `providerId` string — The ID of the provider associated with the account - `providerLabel` object - `en` string — Provider name in English - `he` string — Provider name in Hebrew - `accountResourceId` string — Resource identifier for the account provided by the financial institution - `accountNumber` string — Account number associated with the account - `accountDetails` string — Additional details about the account - `accountType` 'CHECKING' | 'CARD' | 'LOAN' | 'SAVINGS' — Type of the account (e.g., CHECKING, CARD, LOAN, SAVINGS) - `accountOwnerInfo` object - `fullName` string — Full name of the account owner - `nationalId` string — National ID of the account owner - `accountTransactionNumber` number — Number of transactions associated with the account - `accountCurrency` string — Currency of the account - `accountBalances` object[] - `balanceType` string — Type of balance (e.g., available, current) - `balanceAmount` object - `currency` string — Currency of the balance amount - `amount` string — Amount of the balance - `creditLimitIncluded` boolean — Indicates if the credit limit is included in the balance - `referenceDate` string, date — Reference date for the balance - `lastChangeDateTime` string, date-time — The last date and time when the balance was changed - `accountProduct` string — Product associated with the account - `accountCashAccountType` string — Type of cash account (e.g., checking, savings) - `accountCreditLimit` object - `amount` number — Credit limit amount - `currency` string — Currency of the credit limit - `createdAt` string, date-time — Date when the account was created - `updatedAt` string, date-time — Date when the account was last updated - `loans` Account[] - `PK` string — Primary key of the account, combining organization and customer IDs - `SK` string — Sort key of the account, unique per account within the customer - `orgId` string — The ID of the organization that owns the account - `customerId` string — The ID of the customer associated with the account - `userId` string — The ID of the user who owns the account - `fileId` string — The ID of the file associated with the account - `connectionId` string — The ID of the connection associated with the account - `accountId` string — Unique identifier for the account - `providerId` string — The ID of the provider associated with the account - `providerLabel` object - `en` string — Provider name in English - `he` string — Provider name in Hebrew - `accountResourceId` string — Resource identifier for the account provided by the financial institution - `accountNumber` string — Account number associated with the account - `accountDetails` string — Additional details about the account - `accountType` 'CHECKING' | 'CARD' | 'LOAN' | 'SAVINGS' — Type of the account (e.g., CHECKING, CARD, LOAN, SAVINGS) - `accountOwnerInfo` object - `fullName` string — Full name of the account owner - `nationalId` string — National ID of the account owner - `accountTransactionNumber` number — Number of transactions associated with the account - `accountCurrency` string — Currency of the account - `accountBalances` object[] - `balanceType` string — Type of balance (e.g., available, current) - `balanceAmount` object - `currency` string — Currency of the balance amount - `amount` string — Amount of the balance - `creditLimitIncluded` boolean — Indicates if the credit limit is included in the balance - `referenceDate` string, date — Reference date for the balance - `lastChangeDateTime` string, date-time — The last date and time when the balance was changed - `accountProduct` string — Product associated with the account - `accountCashAccountType` string — Type of cash account (e.g., checking, savings) - `accountCreditLimit` object - `amount` number — Credit limit amount - `currency` string — Currency of the credit limit - `createdAt` string, date-time — Date when the account was created - `updatedAt` string, date-time — Date when the account was last updated ## Other responses - `400` — The user has no connections - `401` — Unauthorized access - Invalid access token - `403` — Forbidden - Access token missing the required permissions to preform this action - `404` — The user has no report, refreshing it's data and creating the report - `500` — Internal server error --- [API](https://skmtc.net/open-finance/apis/auth.md) · [All operations](https://skmtc.net/open-finance/apis/auth/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/open-finance/auth/versions/b4d401b65c3d/schema)