POST api/commission/save-commission

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CommissionID	integer	None.
JobID	integer	None.
ClientID	integer	None.
SupplierID	integer	None.
SupplierProductID	integer	None.
ProductID	integer	None.
ProductGroupID	integer	None.
CommissionPeriodID	integer	None.
CommissionStatusID	integer	None.
CommissionTypeID	integer	None.
Occurrence	integer	None.
ItemRef	string	None.
SupplierRef	string	None.
MarginPerUnit	decimal number	None.
Clawback	boolean	None.
Deferred	boolean	None.
NoPayout	boolean	None.
ReceivedDate	date	None.
SupplierInvoiceDate	date	None.
PaymentDueDate	date	None.
ContractFrom	date	None.
ContractTo	date	None.
TenderDate	date	None.
BillDate	date	None.
JobSaleCompletedDate	date	None.
SupplierInvoiceDateEnabled	boolean	None.
EstimatedUnits	decimal number	None.
ActualUnits	decimal number	None.
BusinessPartnerCode	string	None.
BusinessPartnerRecruitingBrokerCode	string	None.
IntroBrokerCode	string	None.
IntroBrokerRecruitingBrokerCode	string	None.
WorkingBrokerCode	string	None.
WorkingBrokerRecruitingBrokerCode	string	None.
AdminPercentage	decimal number	None.
NationalAdPercentage	decimal number	None.
BusinessPartnerPercentage	decimal number	None.
BusinessPartnerRecruiterPercentage	decimal number	None.
IntroPercentage	decimal number	None.
IntroBrokerRecruiterPercentage	decimal number	None.
WorkingPercentage	decimal number	None.
WorkingBrokerRecruiterPercentage	decimal number	None.
Signature	boolean	None.
SignatureCommission	decimal number	None.
SignatureLiveCommission	decimal number	None.
SignatureDescription	string	None.
SignatureLiveDescription	string	None.
SaleRenewal	boolean	None.
UpdatedBy	integer	None.
UpfrontPercentage	decimal number	None.
MeterSupplierID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "CommissionID": 1,
  "JobID": 2,
  "ClientID": 3,
  "SupplierID": 4,
  "SupplierProductID": 5,
  "ProductID": 6,
  "ProductGroupID": 7,
  "CommissionPeriodID": 8,
  "CommissionStatusID": 9,
  "CommissionTypeID": 10,
  "Occurrence": 11,
  "ItemRef": "sample string 12",
  "SupplierRef": "sample string 13",
  "MarginPerUnit": 14.0,
  "Clawback": true,
  "Deferred": true,
  "NoPayout": true,
  "ReceivedDate": "2026-10-13T15:40:26.7268347+01:00",
  "SupplierInvoiceDate": "2026-10-13T15:40:26.7268347+01:00",
  "PaymentDueDate": "2026-10-13T15:40:26.7268347+01:00",
  "ContractFrom": "2026-10-13T15:40:26.7268347+01:00",
  "ContractTo": "2026-10-13T15:40:26.7268347+01:00",
  "TenderDate": "2026-10-13T15:40:26.727831+01:00",
  "BillDate": "2026-10-13T15:40:26.727831+01:00",
  "JobSaleCompletedDate": "2026-10-13T15:40:26.727831+01:00",
  "SupplierInvoiceDateEnabled": true,
  "EstimatedUnits": 19.0,
  "ActualUnits": 20.0,
  "BusinessPartnerCode": "sample string 21",
  "BusinessPartnerRecruitingBrokerCode": "sample string 22",
  "IntroBrokerCode": "sample string 23",
  "IntroBrokerRecruitingBrokerCode": "sample string 24",
  "WorkingBrokerCode": "sample string 25",
  "WorkingBrokerRecruitingBrokerCode": "sample string 26",
  "AdminPercentage": 27.0,
  "NationalAdPercentage": 28.0,
  "BusinessPartnerPercentage": 29.0,
  "BusinessPartnerRecruiterPercentage": 30.0,
  "IntroPercentage": 31.0,
  "IntroBrokerRecruiterPercentage": 32.0,
  "WorkingPercentage": 33.0,
  "WorkingBrokerRecruiterPercentage": 34.0,
  "Signature": true,
  "SignatureCommission": 36.0,
  "SignatureLiveCommission": 37.0,
  "SignatureDescription": "sample string 38",
  "SignatureLiveDescription": "sample string 39",
  "SaleRenewal": true,
  "UpdatedBy": 41,
  "UpfrontPercentage": 42.0,
  "MeterSupplierID": 43
}

application/xml, text/xml

Sample:

<CommissionSaveRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PricingWebAPI.Models">
  <ActualUnits>20</ActualUnits>
  <AdminPercentage>27</AdminPercentage>
  <BillDate>2026-10-13T15:40:26.727831+01:00</BillDate>
  <BusinessPartnerCode>sample string 21</BusinessPartnerCode>
  <BusinessPartnerPercentage>29</BusinessPartnerPercentage>
  <BusinessPartnerRecruiterPercentage>30</BusinessPartnerRecruiterPercentage>
  <BusinessPartnerRecruitingBrokerCode>sample string 22</BusinessPartnerRecruitingBrokerCode>
  <Clawback>true</Clawback>
  <ClientID>3</ClientID>
  <CommissionID>1</CommissionID>
  <CommissionPeriodID>8</CommissionPeriodID>
  <CommissionStatusID>9</CommissionStatusID>
  <CommissionTypeID>10</CommissionTypeID>
  <ContractFrom>2026-10-13T15:40:26.7268347+01:00</ContractFrom>
  <ContractTo>2026-10-13T15:40:26.7268347+01:00</ContractTo>
  <Deferred>true</Deferred>
  <EstimatedUnits>19</EstimatedUnits>
  <IntroBrokerCode>sample string 23</IntroBrokerCode>
  <IntroBrokerRecruiterPercentage>32</IntroBrokerRecruiterPercentage>
  <IntroBrokerRecruitingBrokerCode>sample string 24</IntroBrokerRecruitingBrokerCode>
  <IntroPercentage>31</IntroPercentage>
  <ItemRef>sample string 12</ItemRef>
  <JobID>2</JobID>
  <JobSaleCompletedDate>2026-10-13T15:40:26.727831+01:00</JobSaleCompletedDate>
  <MarginPerUnit>14</MarginPerUnit>
  <MeterSupplierID>43</MeterSupplierID>
  <NationalAdPercentage>28</NationalAdPercentage>
  <NoPayout>true</NoPayout>
  <Occurrence>11</Occurrence>
  <PaymentDueDate>2026-10-13T15:40:26.7268347+01:00</PaymentDueDate>
  <ProductGroupID>7</ProductGroupID>
  <ProductID>6</ProductID>
  <ReceivedDate>2026-10-13T15:40:26.7268347+01:00</ReceivedDate>
  <SaleRenewal>true</SaleRenewal>
  <Signature>true</Signature>
  <SignatureCommission>36</SignatureCommission>
  <SignatureDescription>sample string 38</SignatureDescription>
  <SignatureLiveCommission>37</SignatureLiveCommission>
  <SignatureLiveDescription>sample string 39</SignatureLiveDescription>
  <SupplierID>4</SupplierID>
  <SupplierInvoiceDate>2026-10-13T15:40:26.7268347+01:00</SupplierInvoiceDate>
  <SupplierInvoiceDateEnabled>true</SupplierInvoiceDateEnabled>
  <SupplierProductID>5</SupplierProductID>
  <SupplierRef>sample string 13</SupplierRef>
  <TenderDate>2026-10-13T15:40:26.727831+01:00</TenderDate>
  <UpdatedBy>41</UpdatedBy>
  <UpfrontPercentage>42</UpfrontPercentage>
  <WorkingBrokerCode>sample string 25</WorkingBrokerCode>
  <WorkingBrokerRecruiterPercentage>34</WorkingBrokerRecruiterPercentage>
  <WorkingBrokerRecruitingBrokerCode>sample string 26</WorkingBrokerRecruitingBrokerCode>
  <WorkingPercentage>33</WorkingPercentage>
</CommissionSaveRequest>

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.