List Broker Commission Payouts

GET 
/brokers/:brokerId/commission-payouts

List Broker Commission Payouts

Request

Path Parameters

brokerId stringrequired

Query Parameters

limit number

Number of items to return

offset number

Number of items to skip

filter.brokerId string

Broker

filter.campaignId string

Campaign

filter.bookingId string

Booking

filter.type string

Type

filter.value number

Value

filter.effective string

Effective

filter.createdAt string

Created At

filter.memberId string

Member

filter.tripId string

Trip

filter.paymentId string

Payment

filter.status string

Status

include string[]

Possible values: [brokerId, campaignId, bookingId, type, value, effective, createdAt, memberId, tripId, paymentId, status]

Responses

200

List of Broker Commission Payouts

application/json

Schema

Schema

• Array [

brokerId string

Broker

campaignId string

Campaign

bookingId string

Booking

type string

Type

value number

Value

effective string

Effective

memberId string

Member

tripId string

Trip

paymentId string

Payment

status string

Status

createdAt string

Created At

• ]

Example (from schema)

[
  {
    "brokerId": "string",
    "campaignId": "string",
    "bookingId": "string",
    "type": "string",
    "value": 0,
    "effective": "string",
    "memberId": "string",
    "tripId": "string",
    "paymentId": "string",
    "status": "string",
    "createdAt": "string"
  }
]

Loading...