Get a list of available commission agents

get/commission-agents
SecuritybearerAuth
Request
query Parameters
page
required
integer <int32> (PageParam) >= 1

Page of results to show

Example: page=1
pageSize
required
integer <int32> (ResultsPerPageParam) [ 1 .. 1000 ]

Results to return per page

Example: pageSize=100
sort
string (SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fields
string (FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
name
string (StringFilterParam)

Filter by name

Example: name=xyz | in:x,y | like:xyz
type
string (StringFilterParam)

Filter by type

Example: type=xyz | in:x,y | like:xyz
Responses
200

OK

400

Bad Request

401

Unauthorized

500

Internal Server Error

Response samples
application/json
[
  • {
    • "id": 1,
    • "name": "string",
    • "contractOwnerId": 1,
    • "accountNumber": "string",
    • "accountsReference": "string",
    • "vatRegNumber": "string",
    • "address": {
      • "id": 1,
      • "businessName": "string",
      • "address1": "string",
      • "address2": "string",
      • "address3": "string",
      • "town": "string",
      • "county": "string",
      • "postcode": "string",
      • "country": "GB"
      },
    • "companyNumber": "string",
    • "type": "INTERNAL",
    • "parentAgentCommissionId": 1,
    • "availableFromDate": "2019-08-24",
    • "availableToDate": "2019-08-24",
    • "usageCommissionPaidOn": "PROFIT",
    • "usageCommissionPercentage": 0,
    • "rentalCommissionPaidOn": "PROFIT",
    • "rentalCommissionPercentage": 0,
    • "adhocCommissionPaidOn": "PROFIT",
    • "adhocCommissionPercentage": 0,
    • "paymentTermsInDays": 400,
    • "paymentMethod": "CHEQUE"
    }
]