ReDoc documentation

companyCredits/company/{companyId}

companyCredits/company/{companyId}

get/V1/companyCredits/company/{companyId}

Returns data on the credit limit for a specified company.

Request
path Parameters
companyId
required
integer
Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

Response samples
{
  • "id": 0,
  • "company_id": 0,
  • "credit_limit": 0,
  • "balance": 0,
  • "currency_code": "string",
  • "exceed_limit": true,
  • "available_limit": 0,
  • "credit_comment": "string",
  • "extension_attributes": { }
}