POST v1/Business/CreditLimit?MonitorHi={MonitorHi}&MonitorLo={MonitorLo}&id={id}
Creates a new Credit Limit
Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| AvgTrans |
The average amount you expect to sell to this customer per month. |
decimal number |
Required |
| TransLimit |
The maximum number of months of sales outstanding that you will tolerate from this customer (1 or more). |
decimal number |
Required |
| LossLimit |
Sets an upper limit on the probability-weighted loss from this customer. |
decimal number |
Required |
| ExistingCreditLimit |
Your current credit limit for this customer. |
integer |
Optional |
| MonitorHi |
Alert me if maximum limit goes ABOVE this value. |
integer |
Optional |
| MonitorLo |
Alert me if maximum limit goes BELOW this value. |
integer |
Optional |
| RiskApp |
Select the level of risk that is consistent with your credit strategy. (HIGH, MED, LOW) |
string |
Required |
| CostOfCapital |
Your cost of capital. |
decimal number |
Required |
| SaleGrossMargin |
Your expected Gross Profit Margin from sales to this customer. |
decimal number |
Required |
| MonitorFlag |
Select if you want automatic email alerts on this credit limit. |
string |
Required |
| id |
BusinessId of the Business to get a Credit Limit for. |
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
APICreditLimitResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| MaxLimit |
Maximum Credit Limit |
integer |
None. |
| RecommendedCreditLimit |
Recommended Credit Limit |
integer |
None. |
| ZScore |
ZScore for the Business |
decimal number |
None. |
| StockVolatility |
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 |
decimal number |
None. |
| Leverage |
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. |
decimal number |
None. |
| LatestStatementDate |
The date of the financials used in the credit limit calculations. |
date |
None. |
| Rationale |
Comments/Rational related to the credit limit. |
string |
None. |
| AvgTransaction |
The average amount you expect to sell to this customer per month. |
decimal number |
None. |
| TransactionLimit |
The maximum number of months of sales outstanding that you will tolerate from this customer (1 or more). |
integer |
None. |
| MaxExpectedLossLimit |
Upper limit on the probability-weighted loss from this customer. |
integer |
None. |
| RiskAppetite |
Level of risk that is consistent with your credit strategy (HIGH, MED, or LOW) |
string |
None. |
| CostOfCapital |
Your cost of capital |
decimal number |
None. |
| GrossMargin |
Your expected Gross Profit Margin from sales to this customer |
decimal number |
None. |
| ExistingCreditLimit |
Your current credit limit for this customer. |
integer |
None. |
| MonitorFlag |
Automatic monitoring (A - Automatic, Y - Manual, N - No monitoring) |
character |
None. |
| MonitorHi |
Alert me if maximum limit goes ABOVE this value |
integer |
None. |
| MonitorLo |
Alert me if maximum limit goes BELOW this value |
integer |
None. |
| CurrencyCode |
The Currency Code of this Business (USD, GBP, JPY, etc) |
string |
None. |
| BusinessId |
Id of the Business |
integer |
None. |
| PrimaryBusinessName |
Name of the Business |
string |
None. |