Credit Limit Object

The Credit Limit object represents the maximum amount of credit that can be extended to an entity in the Tupel system. Credit limits define lending parameters such as capacity, rate, and duration for each entity's borrowing capability.

Attributes

• uid string
  Unique identifier for the credit limit.

• entity object
  The Entity object representing the organization associated with this credit limit.

• currency string
  Three-letter ISO currency code of the credit limit which can be any of the accepted currency codes. Maximum length: 3 characters. Example: USD.

• capacity decimal
  The maximum amount that can be borrowed under this credit limit.

• outstanding decimal
  The current amount utilized from this credit limit. Default: 0.00.

• balance decimal
  The remaining available credit (capacity minus outstanding).

• rate decimal
  The daily interest rate applied to loans under this credit limit. Default: 0.0005 (0.05%).

• duration array
  An array of two integers that defines the duration parameters for loans under this credit limit. Format: [min_days, max_days]. Example: [30, 90].

• created_at timestamp
  Time at which the credit limit was created.

• updated_at timestamp
  Time at which the credit limit was last updated.

Credit Limit Calculation

The relationship between the key financial fields in a credit limit is:

• balance = capacity - outstanding

As loans are created and utilized against a credit limit, the outstanding amount increases and the balance decreases. When loans are repaid, the outstanding amount decreases and the balance increases.

Using Credit Limits

Credit limits define the parameters for loan creation. When creating loans for an entity, the system checks that the loan amount does not exceed the available balance. If necessary, currency conversions happen automatically here.

Credit Limit Operations

The API provides several endpoints for managing credit limits:

• Get a Specific Credit Limit - Retrieve a single credit limit by its UID
• List All Credit Limits - Retrieve a paginated list of credit limits with filtering options

For detailed information about these operations, refer to the Credit Limits documentation.