###GET /bourse/v2/clients/{clientId}/ProfitableFinancialRatio
* **شرح:** این وبسرویس، اطلاعات شاخصهای سودآوری، مشتمل بر حاشیهی سود ناخالص، حاشیه سود عملیاتی، حاشیه ی سود خالص، بازده دارایی ها، بازده ی حقوق صاحبان سهام، وجه نقد عملیاتی به سود عملیاتی، گردش داراییها و اهرم مالی برای شرکت های فعال در بورس و فرابورس در بازهی زمانی 5 سال گذشته در مقایسه با شرکت های هم گروه، هم صنعت، بازار و شرکت انتخابی ارائه میدهد.
* اگر شرکت از صنعت بانکداری باشد؛ شاخصهای کفایت سرمایه، تسهیلات به سپرده ها، گستردگی سود، بازده دارایی ها و بازده ی حقوق صاحبان سهام ارائه می شود.
* اگر شرکت از صنعت بیمه یا سرمایهگذاری باشد؛ شاخصهای حاشیه سود عملیاتی، حاشیه ی سود خالص، بازده دارایی ها، بازده ی حقوق صاحبان سهام، وجه نقد عملیاتی به سود عملیاتی، گردش داراییها و اهرم مالی ارائه میشود.
* اگر شناسهی شرکت مشخص نشود، شاخصهای سودآوری تمام شرکتها ارائه خواهد شد.
* برای محاسبهی مقادیر سال جاری از آخرین صورتهای مالی 3، 6، 9 یا 12 ماهه ی ارائه شده استفاده میشود.
* بالاتر و پایین تر از مقیاس گروه، صنعت، بازار و شرکت با رنگ زمینه سبز و قرمز مشخص میشود.
* **اسکوپ:** ```bourse:profitable-financial-ratio:get```
* **رویکرد:** ```Client_Credential```
````````````````
{address}/bourse/v2/clients/{clientId}/profitableFinancialRatio?trackId={trackId}&comId={comId}&type={type}&compareByComId={compareByComId}&yearCount={yearCount}
````````````````
https://sandboxapi.finnotech.ir :address
https://apibeta.finnotech.ir :address
#### Headers
مقادیر زیر باید در هدر قرار بگیرد
````````````````
Authorization : Bearer {Token}
````````````````
* در صورتی که کلاینت توکن های کلاینت کردنشیال مختلفی بر روی حسابهای متعدد خود ساخته باشد , با استفاده از هر یک از آنها میتواند این سرویس را فراخوانی کند.
* برای فراخوانی این سرویس نیازی به افزودن حساب نمی باشد و میتوانید با توکن بدون حساب نیز، سرویس را فراخوانی کنید.
#### URI Parameters
* **clientId: ** شناسه کلاینت
#### Query Parameters
* **trackId:** (اختیاری) کد پیگیری، رشته ای اختیاری با طول حداکثر ۴۰ کاراکتر شامل حرف و عدد. در صورت ارسال trackId، فراخوانی سرویس خود را با همین مقدار استعلام و پیگیری کنید.(در گزارش فراخوانی سرویس ها با همین رشته نتیجه را ببینید). در صورتیکه که این فیلد را ارسال نکنید یک رشته UUID برای این فراخوانی در نظر گرفته میشود و در پاسخ فراخوانی برگردانده میشود.
* example: ```c0aadbb7-a7b9-4f07-987e-409eba06cfdf```
* **comId:** (اجباری) شناسه شرکت
* **type:** (اجباری) متغیر type در ورودی تعیین میکند که فیلدهای نسبی، نسبت به چه محاسبه شود.
* Category : میانگین گروه
* Industry : میانگین صنعت
* Company: میانگین شرکت دیگر
* Default : خودکار تصمیم میگیرد (اول category ، اگر وجود نداشت Industry, اگر وجود نداشت Market )
* **compareByComId:** (اجباری) اگر مقدار type=Company باشد باید شناسه شرکت را برای این پارامتر تنظیم کرد. در غیر این صورت compareByComId=null وارد شود
* **yearCount:** (اجباری) تعداد سال (تا ۵ سال)
#### Request Example
``````````````
https://apibeta.finnotech.ir/oak/v1/clients/testClient/profitableFinancialRatio?trackId=c0aadbb7-a7b9-4f07-987e-409eba06cfdf&comId=4&compareByComId=null&type=Default&yearCount=5
``````````````
####Results Format
##### Successful result format (status code 200)
{ "result": [{ "Com_ID": 4
, "ActST_ID": 4
, "PeriodEndDate": "2018/03/20"
, "LocalPeriodEndDate": "۱۳۹۶/۱۲/۲۹"
, "OperatingProfitMargin": 37.42
, "PeerOperatingProfitMargin": 31.81
, "OperatingProfitMarginColor": "LightGreen"
, "GrossProfitMargin": 42.76
, "PeerGrossProfitMargin": 16.25
, "GrossProfitMarginColor": "LightGreen"
, "ReturnOnAssets": 24.05
, "PeerReturnOnAssets": 16.25
, "ReturnOnAssetsColor": "LightGreen"
, "ReturnOnEquity": 42.65
, "PeerReturnOnEquity": 27.01
, "ReturnOnEquityColor": "LightGreen"
, "NetProfitMargin": 40.7
, "PeerNetProfitMargin": 33.11
, "NetProfitMarginColor": "LightGreen"
, "CashflowFromOperations": 67.2
, "PeerCashflowFromOperations": 95.56
, "CashflowFromOperationsColor": "LightRed"
, "CapitalAdequacy": null
, "PeerCapitalAdequacy": null
, "CapitalAdequacyColor": "Normal"
, "LoansToDeposits": null
, "PeerLoansToDeposits": null
, "LoansToDepositsColor": "Normal"
, "ProfitExtention": null
, "PeerProfitExtention": null
, "ProfitExtentionColor": "Normal"
, "Type": "Category"
, "AssetTurnoverRatio": 0.59
, "PeerAssetTurnoverRatio": 0.46
, "AssetTurnoverRatioColor": "LightGreen"
, "FinancialLeverageRatio": 1.77
, "PeerFinancialLeverageRatio": 1.63
, "FinancialLeverageRatioColor": "LightGreen"
}
, { "Com_ID": 4
, "ActST_ID": 4
, "PeriodEndDate": "2017/03/20"
, "LocalPeriodEndDate": "۱۳۹۶/۱۲/۲۹"
, "OperatingProfitMargin": 33.07
, "PeerOperatingProfitMargin": 32.16
, "OperatingProfitMarginColor": "LightGreen"
, "GrossProfitMargin": 40.58
, "PeerGrossProfitMargin": 36.48
, "GrossProfitMarginColor": "LightGreen"
, "ReturnOnAssets": 13.98
, "PeerReturnOnAssets": 11.74
, "ReturnOnAssetsColor": "LightGreen"
, "ReturnOnEquity": 27.6
, "PeerReturnOnEquity": 22.23
, "ReturnOnEquityColor": "LightGreen"
, "NetProfitMargin": 33.08
, "PeerNetProfitMargin": 32.57
, "NetProfitMarginColor": "LightGreen"
, "CashflowFromOperations": 68.27
, "PeerCashflowFromOperations": 90.1
, "CashflowFromOperationsColor": "LightRed"
, "CapitalAdequacy": null
, "PeerCapitalAdequacy": null
, "CapitalAdequacyColor": "Normal"
, "LoansToDeposits": null
, "PeerLoansToDeposits": null
, "LoansToDepositsColor": "Normal"
, "ProfitExtention": null
, "PeerProfitExtention": null
, "ProfitExtentionColor": "Normal"
, "Type": "Category"
, "AssetTurnoverRatio": 0.42
, "PeerAssetTurnoverRatio": 0.36
, "AssetTurnoverRatioColor": "LightGreen"
, "FinancialLeverageRatio": 1.97
, "PeerFinancialLeverageRatio": 1.85
, "FinancialLeverageRatioColor": "LightGreen"
}]
, "trackId": "c0aadbb7-a7b9-4f07-987e-409eba06cfdf"
, "state": "DONE"
}
* **result:** آبجکتی از پاسخ سرویس شامل:
* **Com_ID:** شناسه شرکت
* **ActST_ID:** نوع فعالیت
* **PeriodEndDate:** دوره منتهی به
* **LocalPeriodEndDate:** دوره منتهی به (شمسی)
* **OperatingProfitMargin:** حاشیه سود عملیاتی
* **PeerOperatingProfitMargin:** میانگین حاشیه سود عملیاتی نسبت به میانگین دوره
* **OperatingProfitMarginColor:** رنگ زمینه عدد
* **GrossProfitMargin:** حاشیه سود ناخالص
* **PeerGrossProfitMargin:** میانگین حاشیه سود ناخالص نسبت به میانگین گروه
* **GrossProfitMarginColor:** رنگ زمینه عدد
* **ReturnOnAssets:** بازده داراییها
* **PeerReturnOnAssets:** میانگین بازده داراییها نسبت به میانگین گروه
* **ReturnOnAssetsColor:** رنگ زمینه عدد
* **ReturnOnEquity:** یازده حقوق صاحبان سهام
* **PeerReturnOnEquity:** میانگین بازده حقوق صاحبان سهام نسبت به میانگین گروه
* **ReturnOnEquityColor:** رنگ زمینه عدد
* **NetProfitMargin:** حاشیه سود خالص
* **PeerNetProfitMargin:** میانگین حاشیه سود خالص نسبت به میانگین گروه
* **NetProfitMarginColor:** رنگ زمینه عدد
* **CashflowFromOperations:** وجه نقد عملیاتی سود عملیاتی
* **PeerCashflowFromOperations:** میانگین وجه نقد عملیاتی به سود عملیاتی نسبت به میانگین گروه
* **CashflowFromOperationsColors:** رنگ زمینه عدد
* **CapitalAdequacy:** کفایت سرمایه
* **PeerCapitalAdequacy:** میانگین کفایت سرمایه نسبت به میانگین گروه
* **CapitalAdequacyColor:** رنگ زمینه عدد
* **LoansToDeposits:** تسهسلات به سپردهها
* **PeerLoansToDeposits:** میانگین تسهیلات به سپردهها نسبت به میانگین گروه
* **LoansToDepositsColor:** رنگ زمینه عدد
* **ProfitExtention:** گستردگی سود
* **PeerProfitExtention:** میانگین گستردگی سود نسبت به میانگین گروه
* **ProfitExtentionColor:** رنگ زمینه عدد
* **Type:** نسبت به
* **AssetTurnoverRatio:** نسبت گردش داراییها
* **PeerAssetTurnoverRatio:** میانگین نسبت گردش داراییها نسبت به میانگین گروه
* **AssetTurnoverRatioColor:** رنگ زمینه عدد
* **FinancialLeverageRatio:** نسبت اهرم مالی
* **PeerFinancialLeverageRatio:** میانگین نسبت اهرم مالی نسبت به میانگین گروه
* **FinancialLeverageRatioColor:** رنگ زمینه عدد
* **trackId:** کد پیگیری، اگر ارسال شده باشد همان مقدار برگردانده میشود و در غیر اینصورت یک رشته تصادفی تولید و برگردانده میشود
* **state:** وضعیت تراکنش
* **DONE:** در صورت موفق بودن عملیات رخ میدهد
* **FAILED:** در صورت نا موفق بودن عملیات رخ میدهد
* **error**: جزییات خطا (در صورت بروز خطا)
#### UnSuccessful result format
در اینجا میتوانید لیست خطاهای سرویس ها را مشاهده کنید [لیست خطاها](/doc/generic-errors.html/)