API Reference

Cashflow Summary

patch
https://app.financekey.com/OData/v_CashflowSummaries()

A summary of the cashflows by cashflow tag.

Path Params
string
required
Body Params
string
required
length between 1 and 32

CashflowTagId: A field that stores a unique identifier (up to 32 characters) associated with specific cash flow tags. This identifier, represented as a string in nvarchar format, is utilized to classify and categorize cash flow entries within the CashflowSummary table, facilitating efficient data retrieval and reporting based on distinct cash flow categories.

double | null

The IntraDayReportingAmount field represents the total cash flow amount recorded within a single business day, capturing all transactions that occur between the start and end of the day. This field is expressed as a decimal to allow for precision in reporting financial figures, facilitating detailed analysis of daily cash movements within the CashflowSummary table.

string
required
length between 1 and 256

The 'Description' field in the CashflowSummary table is an nvarchar data type designed to store textual information with a maximum length of 256 characters. This field is intended to provide a detailed account or commentary related to specific cash flow transactions, summarizing essential details and facilitating clear communication of financial insights within the record. It supports Unicode characters, accommodating diverse languages and special symbols to ensure comprehensive data entry.

int32 | null

IntraDayCount: Represents the total number of cash flow transactions processed within a single day. This integer field is used to track daily activity and fluctuations in cash flow, providing insights into transaction volume and operational efficiency.

string
required
length between 1 and 7

The TagLevel field in the CashflowSummary table is a varchar data type with a maximum length of 7 characters. It is used to categorize or label the cash flow entries with a specific level of detail, providing a way to classify and organize financial data for easier analysis and reporting. This field allows for flexibility in tagging while ensuring concise and manageable input.

double | null

PreviousDayReportingAmount: This field represents the total cash flow amount reported from the previous day, recorded as a decimal value. It provides insights into the financial activities and balances carried over, serving as a critical reference for daily financial analysis and forecasting within the CashflowSummary table.

int32 | null

The PreviousDayCount field represents the total number of transaction entries recorded in the cash flow summary for the day immediately preceding the current reporting date. This integer value aids in analyzing historical cash flow trends and assists in forecasting future financial performance.

double | null

IntraWeekReportingAmount: This field represents the total cash inflow and outflow during the week, recorded as a decimal value. It is used to provide insights into the week-to-week financial performance, allowing for detailed analysis of liquidity and cash management within the specified reporting period.

int32 | null

The IntraWeekCount field represents the total number of cash flow transactions that occurred within a single week, providing insight into the frequency of financial activity during that time period. This integer value is essential for analyzing the liquidity and cash management strategies of the organization.

double | null

PreviousWeekReportingAmount: This field represents the total cash flow amount reported for the previous week, stored as a decimal value. It provides insight into the historical cash flow performance and is used for comparative analysis against current and future reporting periods.

int32 | null

The PreviousWeekCount field represents the total number of cash flow transactions recorded in the previous week. It is represented as an integer value and is used to analyze trends and fluctuations in cash flow activity on a weekly basis.

double | null

IntraMonthReportingAmount: A decimal value representing the total cash inflows and outflows recorded within a single month, used for detailed intra-month financial analysis and reconciliations in the CashflowSummary table.

int32 | null

IntraMonthCount: An integer representing the number of transactions or cash flow events that occur within the same month, providing insights into the frequency of financial activities on a month-to-month basis.

double | null

PreviousMonthReportingAmount: This field represents the monetary amount reported for cash flow activities in the previous month. It is stored as a decimal to account for precise financial figures, including cents. This value is crucial for analyzing trends and comparing cash flow performance from one month to the next within the CashflowSummary table.

int32 | null

PreviousMonthCount: An integer field that represents the total count of cash flow transactions recorded in the previous month, providing insight into historical financial activity and trends within the cash flow summary.

double | null

IntraYearReportingAmount: A decimal field that represents the amount of cash inflow or outflow recorded within a specific year. This value is used for detailed financial analysis and reporting, capturing the fluctuations in cash flow that occur throughout the year, enabling stakeholders to assess the financial performance and liquidity of the organization over short-term intervals.

int32 | null

The IntraYearCount field represents the total number of cash flow transactions recorded within a single fiscal year. This integer value is used for aggregating and analyzing short-term financial activities, enabling users to assess the frequency and volume of cash flow occurrences over the course of a year.

double | null

PreviousYearReportingAmount: This field stores the financial amount reported from the previous fiscal year, represented as a decimal value. It provides a comparison point for assessing changes in cash flow performance year-over-year, aiding in financial analysis and forecasting within the CashflowSummary table.

int32

The Primary Key field 'PreviousYearCount' is of data type integer and serves to uniquely identify each record in the CashflowSummary table. This field represents the count of cash flow entries from the previous year, ensuring that each entry in the table has a distinct reference point for historical financial analysis and reporting. As a primary key, it guarantees the integrity and uniqueness of data within the CashflowSummary table.

Response
200

OK

Updated about 1 year ago

Language
URL
Response 
Click Try It! to start a request and see the response here!
Updated about 1 year ago