---
title: "companyCredit"
description: "Company credit limit inquiry"
doc_type: graphql
doc_category: adminGraphQL
doc_version: v20270301
source_url:
  html: 'https://developer.shopline.com/docs/admin-graph-ql-api/b-2-b/queries/company-credit'
  md: 'https://developer.shopline.com/docs/admin-graph-ql-api/b-2-b/queries/company-credit.md'
---
# companyCredit

Company credit limit inquiry

- **Required Scopes:** `read_customers`
- **API Version:** v20270301
- **API Type:** Admin
- **API Protocol:** GraphQL
- **Operation Type:** Query

## Type Signature

`CompanyCredit`

## Required Permissions

* `read_customers`

An access token is required to call this API. Refer to [Authorization](https://developer.shopline.com/docs/apps/api-instructions-for-use/graph-ql-admin-api/overview.md) for more information about how to obtain the token.

## Arguments

* `companyId`

  [String!](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  Company ID

## Returns

* `availableCreditAmount`

  [String](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  Remaining available credit

* `consumedCreditAmount`

  [String](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  
  Used credit amount

* `creditLimitAmount`

  [String](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  credit limit amount

* `currency`

  [String](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  
  Store currency

* `enable`

  [Boolean](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/boolean.md)

  Whether to enable true or false

## Code Example

```graphql
 {
	companyCredit(companyId ) 
		 {
			# CompanyCredit fields
		}
}
```

## Error Handling

For detailed information about common codes, see [Status and error codes](https://developer.shopline.com/docs/apps/api-instructions-for-use/graph-ql-admin-api/overview.md#status-and-error-codes).