GET request/report/commission?date={date}

Get Commission report for given n number of days

Request Information

URI Parameters

Name	Description	Type	Additional information
date		date	Required

Body Parameters

None.

Response Information

Resource Description

CommissionReport

Name	Description	Type	Additional information
Clawback		Collection of AgentsExportClawback	None.
Invoice		Collection of AgentsExportInvoice	None.

Response Formats

application/json, text/json

Sample:

{
  "invoice": [
    {
      "agentId": 1,
      "brokerId": "sample string 1",
      "agentName": "sample string 2",
      "mpxn": "sample string 3",
      "fuelType": "sample string 4",
      "amount": 5.0,
      "accountNumber": "sample string 6",
      "contractDetailId": 1,
      "contractLength": "sample string 7",
      "dateOfSale": "2025-06-29T02:11:44.2392105+00:00",
      "consumption": 8,
      "brokerCode": "sample string 9",
      "supplyStartDate": "2025-06-29T02:11:44.254891+00:00"
    },
    {
      "agentId": 1,
      "brokerId": "sample string 1",
      "agentName": "sample string 2",
      "mpxn": "sample string 3",
      "fuelType": "sample string 4",
      "amount": 5.0,
      "accountNumber": "sample string 6",
      "contractDetailId": 1,
      "contractLength": "sample string 7",
      "dateOfSale": "2025-06-29T02:11:44.2392105+00:00",
      "consumption": 8,
      "brokerCode": "sample string 9",
      "supplyStartDate": "2025-06-29T02:11:44.254891+00:00"
    }
  ],
  "clawback": [
    {
      "originalInvoiceNumber": "sample string 1",
      "agentId": 1,
      "brokerId": "sample string 2",
      "agentName": "sample string 3",
      "mpxn": "sample string 4",
      "fuelType": "sample string 5",
      "amount": 6.0,
      "accountNumber": "sample string 7",
      "contractDetailId": 1,
      "contractLength": "sample string 8",
      "dateOfSale": "2025-06-29T02:11:44.254891+00:00",
      "consumption": 9,
      "brokerCode": "sample string 10",
      "supplyStartDate": "2025-06-29T02:11:44.254891+00:00"
    },
    {
      "originalInvoiceNumber": "sample string 1",
      "agentId": 1,
      "brokerId": "sample string 2",
      "agentName": "sample string 3",
      "mpxn": "sample string 4",
      "fuelType": "sample string 5",
      "amount": 6.0,
      "accountNumber": "sample string 7",
      "contractDetailId": 1,
      "contractLength": "sample string 8",
      "dateOfSale": "2025-06-29T02:11:44.254891+00:00",
      "consumption": 9,
      "brokerCode": "sample string 10",
      "supplyStartDate": "2025-06-29T02:11:44.254891+00:00"
    }
  ]
}

text/html

Sample:

{"invoice":[{"agentId":1,"brokerId":"sample string 1","agentName":"sample string 2","mpxn":"sample string 3","fuelType":"sample string 4","amount":5.0,"accountNumber":"sample string 6","contractDetailId":1,"contractLength":"sample string 7","dateOfSale":"2025-06-29T02:11:44.2392105+00:00","consumption":8,"brokerCode":"sample string 9","supplyStartDate":"2025-06-29T02:11:44.254891+00:00"},{"agentId":1,"brokerId":"sample string 1","agentName":"sample string 2","mpxn":"sample string 3","fuelType":"sample string 4","amount":5.0,"accountNumber":"sample string 6","contractDetailId":1,"contractLength":"sample string 7","dateOfSale":"2025-06-29T02:11:44.2392105+00:00","consumption":8,"brokerCode":"sample string 9","supplyStartDate":"2025-06-29T02:11:44.254891+00:00"}],"clawback":[{"originalInvoiceNumber":"sample string 1","agentId":1,"brokerId":"sample string 2","agentName":"sample string 3","mpxn":"sample string 4","fuelType":"sample string 5","amount":6.0,"accountNumber":"sample string 7","contractDetailId":1,"contractLength":"sample string 8","dateOfSale":"2025-06-29T02:11:44.254891+00:00","consumption":9,"brokerCode":"sample string 10","supplyStartDate":"2025-06-29T02:11:44.254891+00:00"},{"originalInvoiceNumber":"sample string 1","agentId":1,"brokerId":"sample string 2","agentName":"sample string 3","mpxn":"sample string 4","fuelType":"sample string 5","amount":6.0,"accountNumber":"sample string 7","contractDetailId":1,"contractLength":"sample string 8","dateOfSale":"2025-06-29T02:11:44.254891+00:00","consumption":9,"brokerCode":"sample string 10","supplyStartDate":"2025-06-29T02:11:44.254891+00:00"}]}

application/xml, text/xml

Sample:

<CommissionReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CCSCommercialAPI.Models.Report">
  <Clawback>
    <AgentsExportClawback>
      <AccountNumber>sample string 7</AccountNumber>
      <Amount>6</Amount>
      <Consumption>9</Consumption>
      <ContractDetailId>1</ContractDetailId>
      <ContractLength>sample string 8</ContractLength>
      <DateOfSale>2025-06-29T02:11:44.254891+00:00</DateOfSale>
      <FuelType>sample string 5</FuelType>
      <Mpxn>sample string 4</Mpxn>
      <SupplyStartDate>2025-06-29T02:11:44.254891+00:00</SupplyStartDate>
      <agentId>1</agentId>
      <agentName>sample string 3</agentName>
      <brokerCode>sample string 10</brokerCode>
      <brokerId>sample string 2</brokerId>
      <OriginalInvoiceNumber>sample string 1</OriginalInvoiceNumber>
    </AgentsExportClawback>
    <AgentsExportClawback>
      <AccountNumber>sample string 7</AccountNumber>
      <Amount>6</Amount>
      <Consumption>9</Consumption>
      <ContractDetailId>1</ContractDetailId>
      <ContractLength>sample string 8</ContractLength>
      <DateOfSale>2025-06-29T02:11:44.254891+00:00</DateOfSale>
      <FuelType>sample string 5</FuelType>
      <Mpxn>sample string 4</Mpxn>
      <SupplyStartDate>2025-06-29T02:11:44.254891+00:00</SupplyStartDate>
      <agentId>1</agentId>
      <agentName>sample string 3</agentName>
      <brokerCode>sample string 10</brokerCode>
      <brokerId>sample string 2</brokerId>
      <OriginalInvoiceNumber>sample string 1</OriginalInvoiceNumber>
    </AgentsExportClawback>
  </Clawback>
  <Invoice>
    <AgentsExportInvoice>
      <AccountNumber>sample string 6</AccountNumber>
      <Amount>5</Amount>
      <Consumption>8</Consumption>
      <ContractDetailId>1</ContractDetailId>
      <ContractLength>sample string 7</ContractLength>
      <DateOfSale>2025-06-29T02:11:44.2392105+00:00</DateOfSale>
      <FuelType>sample string 4</FuelType>
      <Mpxn>sample string 3</Mpxn>
      <SupplyStartDate>2025-06-29T02:11:44.254891+00:00</SupplyStartDate>
      <agentId>1</agentId>
      <agentName>sample string 2</agentName>
      <brokerCode>sample string 9</brokerCode>
      <brokerId>sample string 1</brokerId>
    </AgentsExportInvoice>
    <AgentsExportInvoice>
      <AccountNumber>sample string 6</AccountNumber>
      <Amount>5</Amount>
      <Consumption>8</Consumption>
      <ContractDetailId>1</ContractDetailId>
      <ContractLength>sample string 7</ContractLength>
      <DateOfSale>2025-06-29T02:11:44.2392105+00:00</DateOfSale>
      <FuelType>sample string 4</FuelType>
      <Mpxn>sample string 3</Mpxn>
      <SupplyStartDate>2025-06-29T02:11:44.254891+00:00</SupplyStartDate>
      <agentId>1</agentId>
      <agentName>sample string 2</agentName>
      <brokerCode>sample string 9</brokerCode>
      <brokerId>sample string 1</brokerId>
    </AgentsExportInvoice>
  </Invoice>
</CommissionReport>