Skip to main content
GET
/
api
/
v1
/
ops
/
company-credit-account
Get Company Credit Account
curl --request GET \
  --url https://api.example.com/api/v1/ops/company-credit-account \
  --header 'Authorization: Bearer <token>'
{
  "companyCreditAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "purchasedAmount": 123,
  "allocatedAmount": 123,
  "availableAmount": 123,
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

Conta de saldo corporativo comprado pela empresa

​
companyCreditAccountId
string<uuid>
required

Identificador único

​
organizationId
string<uuid>
required

Organização da Company

​
companyId
string<uuid>
required

Company dona do saldo

​
purchasedAmount
integer
required

Total comprado em centavos

​
allocatedAmount
integer
required

Total concedido a Customers em centavos

​
availableAmount
integer
required

Saldo disponível para novas concessões

​
status
enum<string>
required

Status da conta

Available options:
ACTIVE,
SUSPENDED,
CLOSED
​
createdBy
string<uuid> | null
required

Usuário que criou o registro, quando aplicável

​
createdAt
string<date-time>
required

Data de criação

​
updatedBy
string<uuid> | null
required

Usuário que fez a última atualização, quando aplicável

​
updatedAt
string<date-time>
required

Data da última atualização