Skip to main content
GET
/
api
/
v1
/
bko
/
receivables
List Receivables
curl --request GET \
  --url https://api.example.com/api/v1/bko/receivables \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 125,
    "totalPages": 7
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
number
default:10

Items per page

Example:

10

​
page
number
default:1

Page number

Example:

1

​
status
enum<string>

Receivable status

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

"WAITING_FUNDS"

​
organizationId
string<uuid>

Organization identifier

Example:

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

​
sortBy
enum<string>
default:createdAt

Field to sort by

Available options:
createdAt,
amount
Example:

"createdAt"

​
sortOrder
enum<string>
default:desc

Sort order

Available options:
asc,
desc
Example:

"desc"

​
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

​
data
object[]
required
​
meta
object
required

Pagination metadata