GET v1/Business/ReportPDF?layout={layout}&encoding={encoding}&id={id}&CustomerId={CustomerId}&SupplierId={SupplierId}&Breakpoint={Breakpoint}
Generates and returns a PDF report for the Business
Parameters
Name | Description | Type | Additional information |
---|---|---|---|
layout |
Report layout. Valid values are: Short, Medium, Long. |
string |
Optional Default value is Short |
encoding |
Set to "base64" if Base64 encoding is needed. Leave blank otherwise. |
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 |
Breakpoint |
Sets the Past Due Breakpoint for Payment Analysis. |
integer |
Optional |
Response
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |
Example
curl -H "Authorization: Bearer {SessionKey}" -X GET https://api.creditriskmonitor.com/v1/Business/ReportPDF?id={BusinessId}
Try It Now
If you do not have a Session Key, you can get one by Logging In.
If you are a Trade Provider you can use your CustomerId to idenfity a Business with the CustomerId parameter.
If you have a Supplier List you can use your SupplierId to identify a Business with the SupplierId parameter.