Skip to main content
GET
Get Receivable

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

Receivable

receivableId
string<uuid>
required

Receivable identifier

Example:

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

paymentId
string<uuid>
required

Payment identifier

Example:

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

organizationId
string<uuid>
required

Organization identifier

Example:

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

organization
object
required

Organization

cooperativeId
string<uuid>
required

Cooperative identifier

Example:

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

cooperative
object
required

Cooperative

externalProvider
string
required

External provider name

Example:

"mock"

externalProviderId
string
required

External provider payable identifier

Example:

"rcv_a1b2c3d4"

amount
integer
required

Amount in cents

Example:

15000

gatewayFeeRate
integer
required

Gateway fee rate in basis points

Required range: 0 <= x <= 10000
Example:

200

gatewayFee
integer
required

Gateway fee in cents

Example:

300

status
enum<string>
required

Receivable status

Available options:
WAITING_FUNDS,
PREPAID,
PAID,
CANCELLED
Example:

"WAITING_FUNDS"

createdAt
string<date-time>
required

Created at

Example:

"2026-01-01T00:00:00.000Z"

updatedAt
string<date-time>
required

Updated at

Example:

"2026-01-01T00:00:00.000Z"

createdBy
string<uuid> | null

Created by

Example:

null

updatedBy
string<uuid> | null

Updated by

Example:

null