List Broker Commissions By Periods

GET 
/brokers/:brokerId/commissions-by-periods

List Broker Commissions By Periods

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.period_type string

Period_type

filter.period string

Period

filter.status string

Status

filter.institutionId string

Institution

filter.value number

Value

filter.payments number

Payments

filter.bookings number

Bookings

filter.createdAt string

Created At

include string[]

Possible values: [brokerId, campaignId, period_type, period, status, institutionId, value, payments, bookings, createdAt]

Responses

200

List of Broker Commissions By Periods

application/json

Schema

Schema

• Array [

brokerId string

Broker

campaignId string

Campaign

period_type string

Period_type

period string

Period

status string

Status

institutionId string

Institution

value number

Value

payments number

Payments

bookings number

Bookings

createdAt string

Created At

• ]

Example (from schema)

[
  {
    "brokerId": "string",
    "campaignId": "string",
    "period_type": "string",
    "period": "string",
    "status": "string",
    "institutionId": "string",
    "value": 0,
    "payments": 0,
    "bookings": 0,
    "createdAt": "string"
  }
]

Loading...