CHcheckhq

Credit Limits

Returns current credit limit usage, configured limits, and remaining capacity for a company within the active weekly window.

get/companies/{company_id}/credit_limit_usages?

Request

Path parameters

company_idstring required

The unique identifier of the company

Query parameters

typestring

Filter by credit limit type. Accepted values: company, employee, contractor. Can be repeated to include multiple types (e.g., ?type=company&type=employee). If omitted, returns all applicable types.

Response

companystring required

The company ID this usage record belongs to.

typestring required

The type of credit limit. One of: company, employee, or contractor. (Company limits are currently the only form of credit limits in function, so this will be returned by default.)

usagestring

Current total cash requirement exposure for accelerated-ACH payrolls within the current weekly window.

limitstring

The configured weekly credit limit. null if credit limits are not enabled for this entity.

remainingstring

Remaining credit available (limit minus usage). null if credit limits are not enabled.

Changes

No recorded changes to this operation across all 2 revisions of this API.