# دریافت صورت‌های جریان نقدی

**API:** Data API

**Endpoint:** `GET /v1/beta/financial/financials/cash-flow-statements`

**Tags:** Financial Data

صورت‌های جریان نقدی یک شرکت، حدود 27 فیلد در هر دوره: `net_cash_flow_from_operations`، `net_cash_flow_from_investing`، `net_cash_flow_from_financing`، `capital_expenditure`، `depreciation_and_amortization`، `share_based_compensation`، `issuance_or_repayment_of_debt_securities`، `issuance_or_purchase_of_equity_shares` و `dividends_and_other_cash_distributions`، مهرشده با `report_period`، `fiscal_period` و `currency`. `period` الزامی است. از آن برای دیدن تولید نقد استفاده کنید نه سود حسابداری. بازده جریان نقد آزاد و ارقام مشتق مشابه در `get_financial_financial_metrics` هستند.



### مرجع قیمت‌گذاری

- اندازه‌گیری: مبنای هزینه ثابت برای درخواست موفق.
- برآورد درخواست مرجع: 0.02 دلار آمریکا.
- ضریب مشتری مرجع: 1.0. آن را دوباره روی مبلغ تسویه‌شده مشتری اعمال نکنید.

فقط فراداده مرجع، نه نقل‌قول حساب، نه قیمت تضمین‌شده و نه سقف هزینه. اعتبار منابع، اعتبار Felo نیست. هزینه‌های نهایی تابع سوابق صورت‌حساب Felo است.

## Base URL

- `https://openapi.felo.ai`

## Authentication

- `FeloBearerAuth` (http bearer, bearer format Felo API Key)
- `FeloApiKey` (apiKey in header `X-API-Key`)

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| `cik` | query | no | string | کلید شاخص مرکزی (CIK) شرکت. |
| `cursor` | query | no | string | نشانگر صفحه‌بندی مبهم از next_page_url یک پاسخ قبلی. در صورت ارائه، همه پارامترهای دیگر کوئری نادیده گرفته می‌شوند: نشانگر فیلترهای درخواست اصلی را حمل می‌کند. آن را مبهم در نظر بگیرید؛ آن را نسازید یا تغییر ندهید. |
| `filing_date` | query | no | string, (date) | فیلتر بر اساس تاریخ دقیق ثبت SEC به قالب YYYY-MM-DD. ردیف‌هایی که تاریخ ثبت شناخته‌شده ندارند حذف می‌شوند. |
| `filing_date_gt` | query | no | string, (date) | فیلتر بر اساس تاریخ ثبت SEC بزرگ‌تر از تاریخ به قالب YYYY-MM-DD. ردیف‌هایی که تاریخ ثبت شناخته‌شده ندارند حذف می‌شوند. |
| `filing_date_gte` | query | no | string, (date) | فیلتر بر اساس تاریخ ثبت SEC بزرگ‌تر یا مساوی تاریخ به قالب YYYY-MM-DD. ردیف‌هایی که تاریخ ثبت شناخته‌شده ندارند حذف می‌شوند. |
| `filing_date_lt` | query | no | string, (date) | فیلتر بر اساس تاریخ ثبت SEC کوچک‌تر از تاریخ به قالب YYYY-MM-DD. ردیف‌هایی که تاریخ ثبت شناخته‌شده ندارند حذف می‌شوند. |
| `filing_date_lte` | query | no | string, (date) | فیلتر بر اساس تاریخ ثبت SEC کوچک‌تر یا مساوی تاریخ به قالب YYYY-MM-DD. برای کوئری‌های point-in-time مفید است: فقط داده‌هایی را برمی‌گرداند که تا تاریخ داده‌شده به‌صورت عمومی ثبت شده‌اند. ردیف‌هایی که تاریخ ثبت شناخته‌شده ندارند حذف می‌شوند. |
| `limit` | query | no | integer, (int32) | حداکثر تعداد صورت‌های جریان نقدی برای برگرداندن. این مجموع در همه صفحه‌هاست، نه اندازه صفحه: هر صفحه تا 10 رکورد دارد که با `next_page_url` به هم مرتبط‌اند. |
| `period` | query | yes | string, enum: "annual", "quarterly", "ttm" | بازه زمانی صورت‌های جریان نقدی. |
| `report_period` | query | no | string, (date) | فیلتر بر اساس تاریخ دقیق دوره گزارش به قالب YYYY-MM-DD. |
| `report_period_gt` | query | no | string, (date) | فیلتر بر اساس دوره گزارش بزرگ‌تر از تاریخ در قالب YYYY-MM-DD. |
| `report_period_gte` | query | no | string, (date) | فیلتر بر اساس دوره گزارش بزرگ‌تر یا مساوی تاریخ در قالب YYYY-MM-DD. |
| `report_period_lt` | query | no | string, (date) | فیلتر بر اساس دوره گزارش کوچک‌تر از تاریخ در قالب YYYY-MM-DD. |
| `report_period_lte` | query | no | string, (date) | فیلتر بر اساس دوره گزارش کوچک‌تر یا مساوی تاریخ در قالب YYYY-MM-DD. |
| `ticker` | query | no | string | نماد تیکر. اگر cik ارائه نشود الزامی است. |

## Responses

### 200 — پاسخ صورت‌های جریان نقدی

Headers:
- `X-Request-Id` (string) — شناسه درخواست برای درج هنگام تماس با پشتیبانی Felo.

**application/json**

Schema: `ResponseE40Feb4D3D6B_CashFlowStatementResponse` (`#/components/schemas/ResponseE40Feb4D3D6B_CashFlowStatementResponse`)

### 400 — درخواست پردازش نشد. پارامترهای درخواست را بررسی کنید.

### 401 — یک کلید API معتبر Felo لازم است.

### 402 — درخواست ادامه نمی‌یابد چون یک الزام صورت‌حساب برآورده نشده است.

### 403 — حساب مجاز به انجام این عملیات نیست.

### 429 — به سقف درخواست یا هزینه رسیده‌اید.

### 502 — سرویس نتوانست درخواست را کامل کند.

### 503 — سرویس API یا صورت‌حساب موقتاً در دسترس نیست.

### 504 — سرویس هنگام پردازش درخواست به پایان مهلت رسید.

### default — پاسخ خطا؛ پاسخ‌های عبوری بالادست ممکن است از قالب‌های ارائه‌دهنده استفاده کنند

**application/json**

Schema:

```json
{}
```

## Schema definitions

### ResponseE40Feb4D3D6B_CashFlowStatement

`#/components/schemas/ResponseE40Feb4D3D6B_CashFlowStatement`

```json
{
  "type": "object",
  "properties": {
    "ticker": {
      "type": "string",
      "description": "نماد تیکر."
    },
    "report_period": {
      "type": "string",
      "format": "date",
      "description": "دوره گزارش صورت جریان نقدی."
    },
    "fiscal_period": {
      "type": "string",
      "description": "دوره مالی صورت جریان نقدی."
    },
    "period": {
      "type": "string",
      "enum": [
        "quarterly",
        "ttm",
        "annual"
      ],
      "description": "بازه زمانی صورت جریان نقدی."
    },
    "currency": {
      "type": "string",
      "description": "واحد پولی که داده‌های مالی به آن گزارش می‌شوند."
    },
    "accession_number": {
      "type": [
        "string",
        "null"
      ],
      "description": "شماره الحاق SEC اظهارنامه."
    },
    "form_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "فرم SEC که این ردیف از آن گرفته شده است (`10-K`، `10-Q/A`، `20-F`، `S-1`، ...). فرم دقیق همان‌گونه که ثبت شده، بنابراین اصلاحیه‌ها پسوند `/A` خود را حفظ می‌کنند. Null وقتی `period` برابر `ttm` است: پنجره دوازده ماهه متحرک می‌تواند چند اظهارنامه را در بر بگیرد، پس آن را به یک اظهارنامه نسبت نمی‌دهیم. یک ردیف `quarterly` می‌تواند `10-K` داشته باشد وقتی سه‌ماهه چهارم از اظهارنامه سال مالی استخراج می‌شود."
    },
    "filing_url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "نشانی URL اظهارنامه SEC."
    },
    "filing_date": {
      "type": [
        "string",
        "null"
      ],
      "format": "date",
      "description": "روز تقویمی که SEC اظهارنامه را پذیرفت، به وقت شرقی (منطقه زمانی عملیاتی SEC). جفت روز تقویمی با `filing_datetime`. Null وقتی هیچ اظهارنامه SEC تاریخ‌دار به ردیف مرتبط نیست."
    },
    "filing_datetime": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "مهر زمانی زیرروزانه که زمان پذیرش اظهارنامه توسط SEC را ثبت می‌کند، به وقت شرقی. برگرفته از فیلد `acceptanceDateTime` در EDGAR submissions API مربوط به SEC. همراه با `filing_date` (دقت روز تقویمی برای همان رویداد)."
    },
    "net_income": {
      "type": "number",
      "description": "سود خالص شرکت."
    },
    "depreciation_and_amortization": {
      "type": "number",
      "description": "استهلاک و مستهلک‌سازی شرکت."
    },
    "share_based_compensation": {
      "type": "number",
      "description": "پاداش مبتنی بر سهام شرکت."
    },
    "net_cash_flow_from_operations": {
      "type": "number",
      "description": "جریان نقدی خالص از عملیات شرکت."
    },
    "capital_expenditure": {
      "type": "number",
      "description": "هزینه سرمایه‌ای شرکت."
    },
    "business_acquisitions_and_disposals": {
      "type": "number",
      "description": "تحصیل و واگذاری کسب‌وکارهای شرکت."
    },
    "investment_acquisitions_and_disposals": {
      "type": "number",
      "description": "تحصیل و واگذاری سرمایه‌گذاری‌های شرکت."
    },
    "net_cash_flow_from_investing": {
      "type": "number",
      "description": "جریان نقدی خالص از سرمایه‌گذاری شرکت."
    },
    "issuance_or_repayment_of_debt_securities": {
      "type": "number",
      "description": "انتشار یا بازپرداخت اوراق بدهی شرکت."
    },
    "issuance_or_purchase_of_equity_shares": {
      "type": "number",
      "description": "انتشار یا خرید سهام سرمایه شرکت."
    },
    "dividends_and_other_cash_distributions": {
      "type": "number",
      "description": "سود سهام و سایر توزیع‌های نقدی شرکت."
    },
    "net_cash_flow_from_financing": {
      "type": "number",
      "description": "جریان نقدی خالص از تأمین مالی شرکت."
    },
    "change_in_cash_and_equivalents": {
      "type": "number",
      "description": "تغییر در نقد و معادل نقد شرکت."
    },
    "effect_of_exchange_rate_changes": {
      "type": "number",
      "description": "اثر تغییرات نرخ ارز شرکت."
    },
    "ending_cash_balance": {
      "type": "number",
      "description": "مانده نقد پایان دوره شرکت."
    },
    "free_cash_flow": {
      "type": "number",
      "description": "جریان نقدی آزاد شرکت."
    }
  }
}
```

### ResponseE40Feb4D3D6B_CashFlowStatementResponse

`#/components/schemas/ResponseE40Feb4D3D6B_CashFlowStatementResponse`

```json
{
  "type": "object",
  "properties": {
    "cash_flow_statements": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ResponseE40Feb4D3D6B_CashFlowStatement"
      }
    },
    "next_page_url": {
      "type": "string",
      "description": "نشانی URL مطلق صفحه بعدی نتایج. فقط زمانی وجود دارد که نتایج بیشتری باقی مانده باشد؛ برای ادامه آن را همان‌گونه که هست درخواست کنید. هر صفحه تا 10 رکورد نگه می‌دارد."
    }
  }
}
```
