POST api/commission/search

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
IncludeRecruiter	boolean	None.
JobId	integer	None.
AllocatedUserId	integer	None.
BusinessPartnerCode	string	None.
BrokerCode	string	None.
PaymentStatusId	integer	None.
ProductGroupId	integer	None.
ProductId	integer	None.
InvoiceSupplier	integer	None.
PaymentDueStartDate	date	None.
PaymentDueEndDate	date	None.
InvoiceStartDate	date	None.
InvoiceEndDate	date	None.
SignedStartDate	date	None.
SignedEndDate	date	None.
ReceivedStartDate	date	None.
ReceivedEndDate	date	None.
AmountShown	string	None.
ClientId	string	None.
CommissionId	integer	None.
CommissionTypeId	integer	None.
Deferred	boolean	None.
SupplierInvoiceNumber	string	None.
ItemReference	string	None.
NoPayout	boolean	None.
PaidOut	boolean	None.
RunNumber	integer	None.
SupplierId	integer	None.
OrderBy	string	None.
PageNumber	integer	None.
PageSize	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "IncludeRecruiter": true,
  "JobId": 2,
  "AllocatedUserId": 3,
  "BusinessPartnerCode": "sample string 4",
  "BrokerCode": "sample string 5",
  "PaymentStatusId": 6,
  "ProductGroupId": 7,
  "ProductId": 8,
  "InvoiceSupplier": 9,
  "PaymentDueStartDate": "2026-08-14T17:39:39.0113271+01:00",
  "PaymentDueEndDate": "2026-08-14T17:39:39.0113271+01:00",
  "InvoiceStartDate": "2026-08-14T17:39:39.0113271+01:00",
  "InvoiceEndDate": "2026-08-14T17:39:39.0113271+01:00",
  "SignedStartDate": "2026-08-14T17:39:39.0123156+01:00",
  "SignedEndDate": "2026-08-14T17:39:39.0123156+01:00",
  "ReceivedStartDate": "2026-08-14T17:39:39.0123156+01:00",
  "ReceivedEndDate": "2026-08-14T17:39:39.0123156+01:00",
  "AmountShown": "sample string 18",
  "ClientId": "sample string 19",
  "CommissionId": 20,
  "CommissionTypeId": 21,
  "Deferred": true,
  "SupplierInvoiceNumber": "sample string 23",
  "ItemReference": "sample string 24",
  "NoPayout": true,
  "PaidOut": true,
  "RunNumber": 27,
  "SupplierId": 28,
  "OrderBy": "sample string 29",
  "PageNumber": 30,
  "PageSize": 31
}

application/xml, text/xml

Sample:

<CommissionSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PricingWebAPI.Models">
  <AllocatedUserId>3</AllocatedUserId>
  <AmountShown>sample string 18</AmountShown>
  <BrokerCode>sample string 5</BrokerCode>
  <BusinessPartnerCode>sample string 4</BusinessPartnerCode>
  <ClientId>sample string 19</ClientId>
  <CommissionId>20</CommissionId>
  <CommissionTypeId>21</CommissionTypeId>
  <Deferred>true</Deferred>
  <IncludeRecruiter>true</IncludeRecruiter>
  <InvoiceEndDate>2026-08-14T17:39:39.0113271+01:00</InvoiceEndDate>
  <InvoiceStartDate>2026-08-14T17:39:39.0113271+01:00</InvoiceStartDate>
  <InvoiceSupplier>9</InvoiceSupplier>
  <ItemReference>sample string 24</ItemReference>
  <JobId>2</JobId>
  <NoPayout>true</NoPayout>
  <OrderBy>sample string 29</OrderBy>
  <PageNumber>30</PageNumber>
  <PageSize>31</PageSize>
  <PaidOut>true</PaidOut>
  <PaymentDueEndDate>2026-08-14T17:39:39.0113271+01:00</PaymentDueEndDate>
  <PaymentDueStartDate>2026-08-14T17:39:39.0113271+01:00</PaymentDueStartDate>
  <PaymentStatusId>6</PaymentStatusId>
  <ProductGroupId>7</ProductGroupId>
  <ProductId>8</ProductId>
  <ReceivedEndDate>2026-08-14T17:39:39.0123156+01:00</ReceivedEndDate>
  <ReceivedStartDate>2026-08-14T17:39:39.0123156+01:00</ReceivedStartDate>
  <RunNumber>27</RunNumber>
  <SignedEndDate>2026-08-14T17:39:39.0123156+01:00</SignedEndDate>
  <SignedStartDate>2026-08-14T17:39:39.0123156+01:00</SignedStartDate>
  <SupplierId>28</SupplierId>
  <SupplierInvoiceNumber>sample string 23</SupplierInvoiceNumber>
</CommissionSearchRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.