Skip to main content
POST
/
v1
/
Business
/
CreditLimit
Creates a new Credit Limit
curl --request POST \
  --url https://api.creditriskmonitor.com/v1/Business/CreditLimit
{
  "Success": true,
  "Data": {
    "MaxLimit": 123,
    "RecommendedCreditLimit": 123,
    "ZScore": 123,
    "StockVolatility": 123,
    "Leverage": 123,
    "LatestStatementDate": "2023-11-07T05:31:56Z",
    "Rationale": "<string>",
    "AvgTransaction": 123,
    "TransactionLimit": 123,
    "MaxExpectedLossLimit": 123,
    "RiskAppetite": "<string>",
    "CostOfCapital": 123,
    "GrossMargin": 123,
    "ExistingCreditLimit": 123,
    "MonitorFlag": "<string>",
    "MonitorHi": 123,
    "MonitorLo": 123,
    "CurrencyCode": "<string>",
    "BusinessId": 123,
    "PrimaryBusinessName": "<string>"
  },
  "ErrorCode": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.creditriskmonitor.com/llms.txt

Use this file to discover all available pages before exploring further.

Use the Login endpoint to retrieve the SessionKey, then include it in the Authorization field for authentication.

Query Parameters

​
AvgTrans
number<double>
required

The average amount you expect to sell to this customer per month.

​
TransLimit
number<double>
required

The maximum number of months of sales outstanding that you will tolerate from this customer (1 or more).

​
LossLimit
number<double>
required

Sets an upper limit on the probability-weighted loss from this customer.

​
ExistingCreditLimit
integer<int32>
required

Your current credit limit for this customer.

​
MonitorHi
integer<int64>
required

Alert me if maximum limit goes ABOVE this value.

​
MonitorLo
integer<int64>
required

Alert me if maximum limit goes BELOW this value.

​
RiskApp
string
required

Select the level of risk that is consistent with your credit strategy. (HIGH, MED, LOW)

​
CostOfCapital
number<double>
required

Your cost of capital.

​
SaleGrossMargin
number<double>
required

Your expected Gross Profit Margin from sales to this customer.

​
MonitorFlag
string
required

Select if you want automatic email alerts on this credit limit.

​
id
integer<int32>

BusinessId of the Business to get a Credit Limit for.

​
CustomerId
string

If you are a Trade Provider you can use your CustomerId to idenfity a Business with the CustomerId parameter.

​
SupplierId
string

If you have a Supplier List you can use your SupplierId to identify a Business with the SupplierId parameter.

Response

OK

​
Success
boolean
​
Data
object
​
ErrorCode
string