GET v1/Business/PeerAnalysis?Year={Year}&Quarter={Quarter}&SICCode={SICCode}&SICPrimary={SICPrimary}&FolderId={FolderId}&TargetCountry={TargetCountry}&RiskLevelFilter={RiskLevelFilter}&ZScoreFilter={ZScoreFilter}&PayceScoreFilter={PayceScoreFilter}&DBTFilter={DBTFilter}&id={id}&CustomerId={CustomerId}&SupplierId={SupplierId}
Gets the Peer Analysis for a Business.
Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Year |
Year to get data for |
integer |
Optional |
| Quarter |
Quarter to get data for |
integer |
Optional |
| SICCode |
SIC Code to filter by |
string |
Optional |
| SICPrimary |
Filter by Primary SIC Code only or Primary and Secondary SIC Codes (Y/N) |
string |
Optional Default value is N |
| FolderId |
Portfolio FolderId |
integer |
Optional |
| TargetCountry |
Two Letter country code |
string |
Optional |
| RiskLevelFilter |
Risk Level (NS - Non-Scored / FS - Non-FRISK Scored / H1 - Risk Level 1 / H2 - Risk Level 1 and 2 / H3 - Risk Level 1, 2 and 3 / H4 - Risk Level 1, 2, 3 and 4 / H5 - Risk Level 1, 2, 3, 4 and 5 / FS - FRISK Scored / FH - FRISK High Risk / FM - FRISK Medium Risk / FL - FRISK Low Risk / F1 - FRISK 1 (Highest Risk) / F2 - FRISK 2 / F3 - FRISK 3 / F4 - FRISK 4 / F5 - FRISK 5 / F6 - FRISK 7 / F8 - FRISK 8 / F9 - FRISK 9 / F10 - FRISK 10 (Lowest Risk)) |
string |
Optional |
| ZScoreFilter |
Filter by ZScore (N - Non Scored/ S - Scored / H - High Risk / M - Medium Risk / L - Low Risk) |
string |
Optional |
| PayceScoreFilter |
Filter by PAYCE Score (N - Non - PAYCE Scored / S - PAYCE Scored / H - PAYCE Score High Risk / M - PAYCE Score Medium Risk / L - PAYCE Score Low Risk) |
string |
Optional |
| DBTFilter |
Filter by DBT (S - Scored Customers / N - Non-Scored Customers / D - Delinquent / W - Slow / P - Prompt / 1 - (160+ days beyond terms) / 2 - (91 - 105 days beyond terms) / 3 - (76 - 90 days beyond terms) / 4 - (61 - 75 days beyond terms) / 5 - (46 - 60 days beyond terms) / 6 - (31 - 45 days beyond terms) / 7 - 2(1 - 30 days beyond terms) / 8 - (11 - 20 days beyond terms) / 9 - (0 - 10 days beyond terms) / 10 - (no past due balances for six periods)) |
string |
Optional |
| id |
Business ID |
integer |
Optional |
| CustomerId |
If you are a Trade Provider you can use your CustomerId to idenfity a Business with the CustomerId parameter. |
string |
Optional |
| SupplierId |
If you have a Supplier List you can use your SupplierId to identify a Business with the SupplierId parameter. |
string |
Optional |
Response
APIPeerAnalysis| Name | Description | Type | Additional information |
|---|---|---|---|
| PeerYear |
Year for this analysis |
integer |
None. |
| PeerQuarter |
Financial Quarters for this analysis |
integer |
None. |
| SIC |
SIC Code for the Business |
string |
None. |
| IndustryName |
Industry Code for the Business |
string |
None. |
| PeerCount |
Peer Count for the Business |
integer |
None. |
| Ratios |
Peer Review Data |
Collection of APIPeerRatio |
None. |
Example
curl -H "Authorization: Bearer {SessionKey}" -X GET https://api.creditriskmonitor.com/v1/Business/PeerAnalysis?id={BusinessId}