POST request/report/supplier/commission/list

Provides a Dashboard

Request Information

URI Parameters

None.

Body Parameters

CommissionListRequest
NameDescriptionTypeAdditional information
BrandId

integer

None.
ComparisonTypeId

integer

None.
ContractId

integer

None.
FromDate

date

None.
journeyStatusRefId

integer

None.
Mpxn

string

None.
PaymentTypeId

integer

None.
SupplierId

integer

None.
ToDate

date

None.
UserId

integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "userId": 1,
  "contractId": 1,
  "mpxn": "sample string 1",
  "brandId": 1,
  "supplierId": 1,
  "journeyStatusRefId": 1,
  "comparisonTypeId": 1,
  "paymentTypeId": 1,
  "fromDate": "2026-09-20T09:30:07.9063999+00:00",
  "toDate": "2026-09-20T09:30:07.9063999+00:00"
}

text/html

Sample: 
{"userId":1,"contractId":1,"mpxn":"sample string 1","brandId":1,"supplierId":1,"journeyStatusRefId":1,"comparisonTypeId":1,"paymentTypeId":1,"fromDate":"2026-09-20T09:30:07.9063999+00:00","toDate":"2026-09-20T09:30:07.9063999+00:00"}

application/xml, text/xml

Sample: 
<CommissionListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CCSCommercialAPI.Models.Commission">
  <BrandId>1</BrandId>
  <ComparisonTypeId>1</ComparisonTypeId>
  <ContractId>1</ContractId>
  <FromDate>2026-09-20T09:30:07.9063999+00:00</FromDate>
  <Mpxn>sample string 1</Mpxn>
  <PaymentTypeId>1</PaymentTypeId>
  <SupplierId>1</SupplierId>
  <ToDate>2026-09-20T09:30:07.9063999+00:00</ToDate>
  <UserId>1</UserId>
  <journeyStatusRefId>1</journeyStatusRefId>
</CommissionListRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of ContractCommission
NameDescriptionTypeAdditional information
ActualConsumptionToDate

decimal number

None.
ActualPaidInPeriod

decimal number

None.
BrokerId

integer

None.
BrokerName

string

None.
CommissionPaymentType

string

None.
CompanyPostcode

string

None.
ComparisonTypeId

byte

None.
ContractDetailId

integer

None.
ContractDuration

byte

None.
ContractEndDate

date

None.
ContractID

integer

None.
ContractStartDate

date

None.
ContractStatus

string

None.
ContractType

string

None.
CustomerName

string

None.
EstimatedNextPaymentDueDate

date

None.
ExpectedAmountInPeriod

decimal number

None.
FinalSubBrokerCommissionRate

decimal number

None.
FuelName

string

None.
JourneyStatusRefId

integer

None.
LifetimePaidCommission

decimal number

None.
Mpxn

string

None.
MUGCCommissionRate

decimal number

None.
MUGCEarnedToDate

decimal number

None.
MUGCExpectedCommission

decimal number

None.
PaymentTypeId

byte

None.
QuoteId

integer

None.
RemainingLifetimeCommission

decimal number

None.
RetainedCommissionAmount

decimal number

None.
SiteName

string

None.
SMSCommissionRate

decimal number

None.
SMSEarnedToDate

decimal number

None.
SMSExpectedCommission

decimal number

None.
SubBrokerEarnedToDate

decimal number

None.
SubBrokerExpectedCommission

decimal number

None.
SubmissionDate

date

None.
SupplierId

byte

None.
SupplierName

string

None.
TotalContractConsumption

decimal number

None.
TotalEAC

decimal number

None.
TotalExpectedCommissionAmount

decimal number

None.
UpfrontCommissionAmount

decimal number

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "contractID": 1,
    "contractDetailId": 2,
    "quoteId": 3,
    "brokerId": 1,
    "supplierId": 64,
    "customerName": "sample string 4",
    "siteName": "sample string 5",
    "companyPostcode": "sample string 6",
    "fuelName": "sample string 7",
    "brokerName": "sample string 8",
    "supplierName": "sample string 9",
    "journeyStatusRefId": 1,
    "comparisonTypeId": 64,
    "paymentTypeId": 64,
    "mpxn": "sample string 10",
    "contractStatus": "sample string 11",
    "contractType": "sample string 12",
    "commissionPaymentType": "sample string 13",
    "submissionDate": "2026-09-20T09:30:07.9376313+00:00",
    "contractStartDate": "2026-09-20T09:30:07.9376313+00:00",
    "contractEndDate": "2026-09-20T09:30:07.9376313+00:00",
    "contractDuration": 64,
    "estimatedNextPaymentDueDate": "2026-09-20T09:30:07.9376313+00:00",
    "totalContractConsumption": 1.0,
    "totalEAC": 1.0,
    "actualConsumptionToDate": 1.0,
    "finalSubBrokerCommissionRate": 1.0,
    "smsCommissionRate": 1.0,
    "mugcCommissionRate": 1.0,
    "totalExpectedCommissionAmount": 1.0,
    "upfrontCommissionAmount": 1.0,
    "retainedCommissionAmount": 1.0,
    "subBrokerExpectedCommission": 1.0,
    "smsExpectedCommission": 1.0,
    "mugcExpectedCommission": 1.0,
    "lifetimePaidCommission": 1.0,
    "remainingLifetimeCommission": 1.0,
    "subBrokerEarnedToDate": 1.0,
    "smsEarnedToDate": 1.0,
    "mugcEarnedToDate": 1.0,
    "expectedAmountInPeriod": 1.0,
    "actualPaidInPeriod": 1.0
  },
  {
    "contractID": 1,
    "contractDetailId": 2,
    "quoteId": 3,
    "brokerId": 1,
    "supplierId": 64,
    "customerName": "sample string 4",
    "siteName": "sample string 5",
    "companyPostcode": "sample string 6",
    "fuelName": "sample string 7",
    "brokerName": "sample string 8",
    "supplierName": "sample string 9",
    "journeyStatusRefId": 1,
    "comparisonTypeId": 64,
    "paymentTypeId": 64,
    "mpxn": "sample string 10",
    "contractStatus": "sample string 11",
    "contractType": "sample string 12",
    "commissionPaymentType": "sample string 13",
    "submissionDate": "2026-09-20T09:30:07.9376313+00:00",
    "contractStartDate": "2026-09-20T09:30:07.9376313+00:00",
    "contractEndDate": "2026-09-20T09:30:07.9376313+00:00",
    "contractDuration": 64,
    "estimatedNextPaymentDueDate": "2026-09-20T09:30:07.9376313+00:00",
    "totalContractConsumption": 1.0,
    "totalEAC": 1.0,
    "actualConsumptionToDate": 1.0,
    "finalSubBrokerCommissionRate": 1.0,
    "smsCommissionRate": 1.0,
    "mugcCommissionRate": 1.0,
    "totalExpectedCommissionAmount": 1.0,
    "upfrontCommissionAmount": 1.0,
    "retainedCommissionAmount": 1.0,
    "subBrokerExpectedCommission": 1.0,
    "smsExpectedCommission": 1.0,
    "mugcExpectedCommission": 1.0,
    "lifetimePaidCommission": 1.0,
    "remainingLifetimeCommission": 1.0,
    "subBrokerEarnedToDate": 1.0,
    "smsEarnedToDate": 1.0,
    "mugcEarnedToDate": 1.0,
    "expectedAmountInPeriod": 1.0,
    "actualPaidInPeriod": 1.0
  }
]

text/html

Sample: 
[{"contractID":1,"contractDetailId":2,"quoteId":3,"brokerId":1,"supplierId":64,"customerName":"sample string 4","siteName":"sample string 5","companyPostcode":"sample string 6","fuelName":"sample string 7","brokerName":"sample string 8","supplierName":"sample string 9","journeyStatusRefId":1,"comparisonTypeId":64,"paymentTypeId":64,"mpxn":"sample string 10","contractStatus":"sample string 11","contractType":"sample string 12","commissionPaymentType":"sample string 13","submissionDate":"2026-09-20T09:30:07.9376313+00:00","contractStartDate":"2026-09-20T09:30:07.9376313+00:00","contractEndDate":"2026-09-20T09:30:07.9376313+00:00","contractDuration":64,"estimatedNextPaymentDueDate":"2026-09-20T09:30:07.9376313+00:00","totalContractConsumption":1.0,"totalEAC":1.0,"actualConsumptionToDate":1.0,"finalSubBrokerCommissionRate":1.0,"smsCommissionRate":1.0,"mugcCommissionRate":1.0,"totalExpectedCommissionAmount":1.0,"upfrontCommissionAmount":1.0,"retainedCommissionAmount":1.0,"subBrokerExpectedCommission":1.0,"smsExpectedCommission":1.0,"mugcExpectedCommission":1.0,"lifetimePaidCommission":1.0,"remainingLifetimeCommission":1.0,"subBrokerEarnedToDate":1.0,"smsEarnedToDate":1.0,"mugcEarnedToDate":1.0,"expectedAmountInPeriod":1.0,"actualPaidInPeriod":1.0},{"contractID":1,"contractDetailId":2,"quoteId":3,"brokerId":1,"supplierId":64,"customerName":"sample string 4","siteName":"sample string 5","companyPostcode":"sample string 6","fuelName":"sample string 7","brokerName":"sample string 8","supplierName":"sample string 9","journeyStatusRefId":1,"comparisonTypeId":64,"paymentTypeId":64,"mpxn":"sample string 10","contractStatus":"sample string 11","contractType":"sample string 12","commissionPaymentType":"sample string 13","submissionDate":"2026-09-20T09:30:07.9376313+00:00","contractStartDate":"2026-09-20T09:30:07.9376313+00:00","contractEndDate":"2026-09-20T09:30:07.9376313+00:00","contractDuration":64,"estimatedNextPaymentDueDate":"2026-09-20T09:30:07.9376313+00:00","totalContractConsumption":1.0,"totalEAC":1.0,"actualConsumptionToDate":1.0,"finalSubBrokerCommissionRate":1.0,"smsCommissionRate":1.0,"mugcCommissionRate":1.0,"totalExpectedCommissionAmount":1.0,"upfrontCommissionAmount":1.0,"retainedCommissionAmount":1.0,"subBrokerExpectedCommission":1.0,"smsExpectedCommission":1.0,"mugcExpectedCommission":1.0,"lifetimePaidCommission":1.0,"remainingLifetimeCommission":1.0,"subBrokerEarnedToDate":1.0,"smsEarnedToDate":1.0,"mugcEarnedToDate":1.0,"expectedAmountInPeriod":1.0,"actualPaidInPeriod":1.0}]

application/xml, text/xml

Sample: 
<ArrayOfContractCommission xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CCSCommercialAPI.Models.Commission">
  <ContractCommission>
    <ActualConsumptionToDate>1</ActualConsumptionToDate>
    <ActualPaidInPeriod>1</ActualPaidInPeriod>
    <BrokerId>1</BrokerId>
    <BrokerName>sample string 8</BrokerName>
    <CommissionPaymentType>sample string 13</CommissionPaymentType>
    <CompanyPostcode>sample string 6</CompanyPostcode>
    <ComparisonTypeId>64</ComparisonTypeId>
    <ContractDetailId>2</ContractDetailId>
    <ContractDuration>64</ContractDuration>
    <ContractEndDate>2026-09-20T09:30:07.9376313+00:00</ContractEndDate>
    <ContractID>1</ContractID>
    <ContractStartDate>2026-09-20T09:30:07.9376313+00:00</ContractStartDate>
    <ContractStatus>sample string 11</ContractStatus>
    <ContractType>sample string 12</ContractType>
    <CustomerName>sample string 4</CustomerName>
    <EstimatedNextPaymentDueDate>2026-09-20T09:30:07.9376313+00:00</EstimatedNextPaymentDueDate>
    <ExpectedAmountInPeriod>1</ExpectedAmountInPeriod>
    <FinalSubBrokerCommissionRate>1</FinalSubBrokerCommissionRate>
    <FuelName>sample string 7</FuelName>
    <JourneyStatusRefId>1</JourneyStatusRefId>
    <LifetimePaidCommission>1</LifetimePaidCommission>
    <MUGCCommissionRate>1</MUGCCommissionRate>
    <MUGCEarnedToDate>1</MUGCEarnedToDate>
    <MUGCExpectedCommission>1</MUGCExpectedCommission>
    <Mpxn>sample string 10</Mpxn>
    <PaymentTypeId>64</PaymentTypeId>
    <QuoteId>3</QuoteId>
    <RemainingLifetimeCommission>1</RemainingLifetimeCommission>
    <RetainedCommissionAmount>1</RetainedCommissionAmount>
    <SMSCommissionRate>1</SMSCommissionRate>
    <SMSEarnedToDate>1</SMSEarnedToDate>
    <SMSExpectedCommission>1</SMSExpectedCommission>
    <SiteName>sample string 5</SiteName>
    <SubBrokerEarnedToDate>1</SubBrokerEarnedToDate>
    <SubBrokerExpectedCommission>1</SubBrokerExpectedCommission>
    <SubmissionDate>2026-09-20T09:30:07.9376313+00:00</SubmissionDate>
    <SupplierId>64</SupplierId>
    <SupplierName>sample string 9</SupplierName>
    <TotalContractConsumption>1</TotalContractConsumption>
    <TotalEAC>1</TotalEAC>
    <TotalExpectedCommissionAmount>1</TotalExpectedCommissionAmount>
    <UpfrontCommissionAmount>1</UpfrontCommissionAmount>
  </ContractCommission>
  <ContractCommission>
    <ActualConsumptionToDate>1</ActualConsumptionToDate>
    <ActualPaidInPeriod>1</ActualPaidInPeriod>
    <BrokerId>1</BrokerId>
    <BrokerName>sample string 8</BrokerName>
    <CommissionPaymentType>sample string 13</CommissionPaymentType>
    <CompanyPostcode>sample string 6</CompanyPostcode>
    <ComparisonTypeId>64</ComparisonTypeId>
    <ContractDetailId>2</ContractDetailId>
    <ContractDuration>64</ContractDuration>
    <ContractEndDate>2026-09-20T09:30:07.9376313+00:00</ContractEndDate>
    <ContractID>1</ContractID>
    <ContractStartDate>2026-09-20T09:30:07.9376313+00:00</ContractStartDate>
    <ContractStatus>sample string 11</ContractStatus>
    <ContractType>sample string 12</ContractType>
    <CustomerName>sample string 4</CustomerName>
    <EstimatedNextPaymentDueDate>2026-09-20T09:30:07.9376313+00:00</EstimatedNextPaymentDueDate>
    <ExpectedAmountInPeriod>1</ExpectedAmountInPeriod>
    <FinalSubBrokerCommissionRate>1</FinalSubBrokerCommissionRate>
    <FuelName>sample string 7</FuelName>
    <JourneyStatusRefId>1</JourneyStatusRefId>
    <LifetimePaidCommission>1</LifetimePaidCommission>
    <MUGCCommissionRate>1</MUGCCommissionRate>
    <MUGCEarnedToDate>1</MUGCEarnedToDate>
    <MUGCExpectedCommission>1</MUGCExpectedCommission>
    <Mpxn>sample string 10</Mpxn>
    <PaymentTypeId>64</PaymentTypeId>
    <QuoteId>3</QuoteId>
    <RemainingLifetimeCommission>1</RemainingLifetimeCommission>
    <RetainedCommissionAmount>1</RetainedCommissionAmount>
    <SMSCommissionRate>1</SMSCommissionRate>
    <SMSEarnedToDate>1</SMSEarnedToDate>
    <SMSExpectedCommission>1</SMSExpectedCommission>
    <SiteName>sample string 5</SiteName>
    <SubBrokerEarnedToDate>1</SubBrokerEarnedToDate>
    <SubBrokerExpectedCommission>1</SubBrokerExpectedCommission>
    <SubmissionDate>2026-09-20T09:30:07.9376313+00:00</SubmissionDate>
    <SupplierId>64</SupplierId>
    <SupplierName>sample string 9</SupplierName>
    <TotalContractConsumption>1</TotalContractConsumption>
    <TotalEAC>1</TotalEAC>
    <TotalExpectedCommissionAmount>1</TotalExpectedCommissionAmount>
    <UpfrontCommissionAmount>1</UpfrontCommissionAmount>
  </ContractCommission>
</ArrayOfContractCommission>