Skip to main content
GET
/
api
/
v1
/
bko
/
receivables
/
{receivableId}
Get Receivable
curl --request GET \
  --url https://api.example.com/api/v1/bko/receivables/{receivableId} \
  --header 'Authorization: Bearer <token>'
{
  "receivableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "paymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "externalProvider": "<string>",
  "externalProviderId": "<string>",
  "amount": 123,
  "gatewayFeeRate": 123,
  "gatewayFee": 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.

Path Parameters

​
receivableId
string<uuid>
required

Receivable identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

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

Registros de recebíveis sincronizados do provider de billing

​
receivableId
string<uuid>
required

Identificador único

​
paymentId
string<uuid>
required

Referência ao pagamento que originou o recebível

​
organizationId
string<uuid>
required

Referência à organização da empresa beneficiária

​
companyId
string<uuid>
required

Referência à empresa beneficiária

​
externalProvider
string
required

Nome do provedor externo

​
externalProviderId
string
required

ID da transação no provedor externo

​
amount
integer
required

Valor do recebível em centavos

​
gatewayFeeRate
integer
required

Rate dinâmico inferido do webhook em basis points

​
gatewayFee
integer
required

Valor absoluto em centavos recebido via webhook do gateway

​
status
enum<string>
required

Status do recebível

Available options:
WAITING_FUNDS,
PREPAID,
PAID,
CANCELLED
​
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