GET v1/Portfolio/Folders/{FolderId}?FirstRow={FirstRow}&LastRow={LastRow}&FromDate={FromDate}
Gets the Businesses in a Folder
Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| FolderId |
Id of the Folder to get Businesses for |
integer |
Required |
| FirstRow |
First row to return |
integer |
Optional Default value is 1 |
| LastRow |
Last row to return |
integer |
Optional Default value is 100 |
| FromDate |
Results will only include Businesses that have had changes since this date. Leave NULL to return all Businesses. |
date |
Optional |
Response
Collection of APIPortfolioBusiness| Name | Description | Type | Additional information |
|---|---|---|---|
| BusinessId |
Id of the Business |
integer |
None. |
| BusinessName |
Name of the Business |
string |
None. |
| FRISKScore |
FRISKScore for the Business |
byte |
None. |
| FRISKLastChangeDate |
Date when the FRISKScore last changed |
date |
None. |
| ZScore |
Altman Z-score for the Business |
decimal number |
None. |
| ZScoreLastChangeDate |
Date when the ZScore was last changed |
date |
None. |
| FSRScore |
FSRScore for the Business |
integer |
None. |
| FSRScoreLastChangeDate |
Date when the FSRScore was last changed |
date |
None. |
| DBTIndex |
Days Beyond Terms Index of the Business |
byte |
None. |
| PAYCEScore |
PAYCE Score for the Business |
byte |
None. |
| PAYCELastChangeDate |
Date when the PAYCEScore last changed |
date |
None. |
| LatestStatementDate |
Latest Statement Date |
date |
None. |
| CurrentFiscalYear |
Current Fiscal Year |
integer |
None. |
| CurrentFiscalQuarter |
Current Fiscal Quarter |
byte |
None. |
| FinancialsLastChangeDate |
Date when the Financials were last changed |
date |
None. |
| BankruptcyType |
If the Business is in Bankruptcy this flag notates the type of Bankruptcy. When this value is NULL the Business is not in Bankruptcy. F – Filed, E – Emerged, C – Closed, L – Liquidation, A – Administration, R – Receivership, I – Insolvency Proceedings, N – Notice of Intention to Make a Proposal, P – Protection, H – Rehabilitation, J – Judicial Management, O – Reorganization Proceedings, V – Involuntary Bankruptcy, T – Chapter 15 Bankruptcy Petition. |
string |
None. |
Example
curl -H "Authorization: Bearer {SessionKey}" -X GET https://api.creditriskmonitor.com/v1/Portfolio/Folders/{FolderId}