Create Credit Limits for a Business

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>"
}

POST

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>"
}

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.

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

Success

boolean

Data

object

Show child attributes

Data.MaxLimit

integer<int32>

Maximum Credit Limit

Data.RecommendedCreditLimit

integer<int32>

Recommended Credit Limit

Data.ZScore

number<double>

ZScore for the Business

Data.StockVolatility

number<double>

A measure of the amount by which a company's daily stock price fluctuates over a trailing 6 month period, with greater weighting given to the recent months

Data.Leverage

number<double>

A calculation of Leverage and Debt Coverage. Leverage is Total Liabilities divided by Total Assets, and is typically between 0 and 1.4. A lower value is better.

Data.LatestStatementDate

string<date-time>

The date of the financials used in the credit limit calculations.

Data.Rationale

string

Comments/Rational related to the credit limit.

Data.AvgTransaction

number<double>

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

Data.TransactionLimit

integer<int32>

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

Data.MaxExpectedLossLimit

integer<int32>

Upper limit on the probability-weighted loss from this customer.

Data.RiskAppetite

string

Level of risk that is consistent with your credit strategy (HIGH, MED, or LOW)

Data.CostOfCapital

number<double>

Your cost of capital

Data.GrossMargin

number<double>

Your expected Gross Profit Margin from sales to this customer

Data.ExistingCreditLimit

integer<int32>

Your current credit limit for this customer.

Data.MonitorFlag

string

Automatic monitoring (A - Automatic, Y - Manual, N - No monitoring)

Data.MonitorHi

integer<int64>

Alert me if maximum limit goes ABOVE this value

Data.MonitorLo

integer<int64>

Alert me if maximum limit goes BELOW this value

Data.CurrencyCode

string

The Currency Code of this Business (USD, GBP, JPY, etc)

Data.BusinessId

integer<int32>

Id of the Business

Data.PrimaryBusinessName

string

Name of the Business

ErrorCode

string

Retrieve Credit Limit Retrieve Payment Summary

⌘I

Overview

Business Information

Financial Data

Portfolio Management

News Management

User Management

Trade Receivables

Create Credit Limits for a Business

Query Parameters

Response