GET request/report/SalesForcastingReport

Provides a Sales Forecasting Report

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

ReportResponse

Name	Type	Additional information
agents	Collection of Agents	None.
Aggregator	boolean	None.
brokerId	string	None.
commission	Commission	None.
contracts	Contracts	None.
subBrokerName	string	None.

Response Formats

application/json, text/json

Sample:

{
  "brokerId": "sample string 1",
  "aggregator": true,
  "contracts": {
    "totalGasContracts": 1.0,
    "totalElectricityContracts": 2.0,
    "totalContractsSent": 3.0
  },
  "commission": {
    "totalGasCommission": 1.0,
    "totalElectricityCommission": 2.0,
    "totalGasCommissionPaid": 1.0,
    "totalElectricityCommissionPaid": 1.0,
    "totalCommissionEstimatted": 1.0,
    "totalCommissionAmount": 1.0,
    "totalCommissionPaid": 1.0,
    "totalClawedBack": 1.0,
    "totalToBeClawedBack": 1.0,
    "totalToBePaid": 1.0
  },
  "subBrokerName": "sample string 3",
  "agents": [
    {
      "agentId": 1,
      "brokerId": "sample string 1",
      "agentName": "sample string 2",
      "totalGasContracts": 3.0,
      "totalElectricityContracts": 4.0,
      "totalContractsSent": 5.0,
      "totalGasCommission": 6.0,
      "totalElectricityCommission": 7.0,
      "totalEstimatedCommisionAmount": 8.0,
      "totalElectricityPaid": 1.0,
      "totalGasPaid": 1.0,
      "totalActualCommissionPaid": 1.0,
      "totalClawback": 1.0,
      "totalCommissionPaid": 1.0,
      "totalToBeClawedback": 1.0,
      "totalToBePaid": 1.0,
      "totalCommissionAmount": 9.0,
      "isSubBroker": true,
      "subBrokerName": "sample string 11",
      "cotFlag": "sample string 12",
      "complaintFlag": "sample string 13",
      "firstPaymentFlag": "sample string 14",
      "etFlag": "sample string 15",
      "cotDate": "2025-07-05T05:41:23.4298407+00:00"
    },
    {
      "agentId": 1,
      "brokerId": "sample string 1",
      "agentName": "sample string 2",
      "totalGasContracts": 3.0,
      "totalElectricityContracts": 4.0,
      "totalContractsSent": 5.0,
      "totalGasCommission": 6.0,
      "totalElectricityCommission": 7.0,
      "totalEstimatedCommisionAmount": 8.0,
      "totalElectricityPaid": 1.0,
      "totalGasPaid": 1.0,
      "totalActualCommissionPaid": 1.0,
      "totalClawback": 1.0,
      "totalCommissionPaid": 1.0,
      "totalToBeClawedback": 1.0,
      "totalToBePaid": 1.0,
      "totalCommissionAmount": 9.0,
      "isSubBroker": true,
      "subBrokerName": "sample string 11",
      "cotFlag": "sample string 12",
      "complaintFlag": "sample string 13",
      "firstPaymentFlag": "sample string 14",
      "etFlag": "sample string 15",
      "cotDate": "2025-07-05T05:41:23.4298407+00:00"
    }
  ]
}

text/html

Sample:

{"brokerId":"sample string 1","aggregator":true,"contracts":{"totalGasContracts":1.0,"totalElectricityContracts":2.0,"totalContractsSent":3.0},"commission":{"totalGasCommission":1.0,"totalElectricityCommission":2.0,"totalGasCommissionPaid":1.0,"totalElectricityCommissionPaid":1.0,"totalCommissionEstimatted":1.0,"totalCommissionAmount":1.0,"totalCommissionPaid":1.0,"totalClawedBack":1.0,"totalToBeClawedBack":1.0,"totalToBePaid":1.0},"subBrokerName":"sample string 3","agents":[{"agentId":1,"brokerId":"sample string 1","agentName":"sample string 2","totalGasContracts":3.0,"totalElectricityContracts":4.0,"totalContractsSent":5.0,"totalGasCommission":6.0,"totalElectricityCommission":7.0,"totalEstimatedCommisionAmount":8.0,"totalElectricityPaid":1.0,"totalGasPaid":1.0,"totalActualCommissionPaid":1.0,"totalClawback":1.0,"totalCommissionPaid":1.0,"totalToBeClawedback":1.0,"totalToBePaid":1.0,"totalCommissionAmount":9.0,"isSubBroker":true,"subBrokerName":"sample string 11","cotFlag":"sample string 12","complaintFlag":"sample string 13","firstPaymentFlag":"sample string 14","etFlag":"sample string 15","cotDate":"2025-07-05T05:41:23.4298407+00:00"},{"agentId":1,"brokerId":"sample string 1","agentName":"sample string 2","totalGasContracts":3.0,"totalElectricityContracts":4.0,"totalContractsSent":5.0,"totalGasCommission":6.0,"totalElectricityCommission":7.0,"totalEstimatedCommisionAmount":8.0,"totalElectricityPaid":1.0,"totalGasPaid":1.0,"totalActualCommissionPaid":1.0,"totalClawback":1.0,"totalCommissionPaid":1.0,"totalToBeClawedback":1.0,"totalToBePaid":1.0,"totalCommissionAmount":9.0,"isSubBroker":true,"subBrokerName":"sample string 11","cotFlag":"sample string 12","complaintFlag":"sample string 13","firstPaymentFlag":"sample string 14","etFlag":"sample string 15","cotDate":"2025-07-05T05:41:23.4298407+00:00"}]}

application/xml, text/xml

Sample:

<ReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CCSCommercialAPI.Models.Report">
  <Aggregator>true</Aggregator>
  <agents>
    <Agents>
      <ComplaintFlag>sample string 13</ComplaintFlag>
      <CotDate>2025-07-05T05:41:23.4298407+00:00</CotDate>
      <CotFlag>sample string 12</CotFlag>
      <ETFlag>sample string 15</ETFlag>
      <FirstPaymentFlag>sample string 14</FirstPaymentFlag>
      <TotalElectricityCommission>7</TotalElectricityCommission>
      <TotalElectricityContracts>4</TotalElectricityContracts>
      <TotalElectricityPaid>1</TotalElectricityPaid>
      <TotalGasCommission>6</TotalGasCommission>
      <TotalGasContracts>3</TotalGasContracts>
      <TotalGasPaid>1</TotalGasPaid>
      <agentId>1</agentId>
      <agentName>sample string 2</agentName>
      <brokerId>sample string 1</brokerId>
      <isSubBroker>true</isSubBroker>
      <subBrokerName>sample string 11</subBrokerName>
      <totalActualCommissionPaid>1</totalActualCommissionPaid>
      <totalClawback>1</totalClawback>
      <totalCommissionAmount>9</totalCommissionAmount>
      <totalCommissionPaid>1</totalCommissionPaid>
      <totalContractsSent>5</totalContractsSent>
      <totalEstimatedCommisionAmount>8</totalEstimatedCommisionAmount>
      <totalToBeClawedback>1</totalToBeClawedback>
      <totalToBePaid>1</totalToBePaid>
    </Agents>
    <Agents>
      <ComplaintFlag>sample string 13</ComplaintFlag>
      <CotDate>2025-07-05T05:41:23.4298407+00:00</CotDate>
      <CotFlag>sample string 12</CotFlag>
      <ETFlag>sample string 15</ETFlag>
      <FirstPaymentFlag>sample string 14</FirstPaymentFlag>
      <TotalElectricityCommission>7</TotalElectricityCommission>
      <TotalElectricityContracts>4</TotalElectricityContracts>
      <TotalElectricityPaid>1</TotalElectricityPaid>
      <TotalGasCommission>6</TotalGasCommission>
      <TotalGasContracts>3</TotalGasContracts>
      <TotalGasPaid>1</TotalGasPaid>
      <agentId>1</agentId>
      <agentName>sample string 2</agentName>
      <brokerId>sample string 1</brokerId>
      <isSubBroker>true</isSubBroker>
      <subBrokerName>sample string 11</subBrokerName>
      <totalActualCommissionPaid>1</totalActualCommissionPaid>
      <totalClawback>1</totalClawback>
      <totalCommissionAmount>9</totalCommissionAmount>
      <totalCommissionPaid>1</totalCommissionPaid>
      <totalContractsSent>5</totalContractsSent>
      <totalEstimatedCommisionAmount>8</totalEstimatedCommisionAmount>
      <totalToBeClawedback>1</totalToBeClawedback>
      <totalToBePaid>1</totalToBePaid>
    </Agents>
  </agents>
  <brokerId>sample string 1</brokerId>
  <commission>
    <TotalClawedBack>1</TotalClawedBack>
    <TotalCommissionAmount>1</TotalCommissionAmount>
    <TotalCommissionEstimatted>1</TotalCommissionEstimatted>
    <TotalCommissionPaid>1</TotalCommissionPaid>
    <TotalElectricityCommission>2</TotalElectricityCommission>
    <TotalElectricityCommissionPaid>1</TotalElectricityCommissionPaid>
    <TotalGasCommission>1</TotalGasCommission>
    <TotalGasCommissionPaid>1</TotalGasCommissionPaid>
    <TotalToBeClawedBack>1</TotalToBeClawedBack>
    <TotalToBePaid>1</TotalToBePaid>
  </commission>
  <contracts>
    <totalContractsSent>3</totalContractsSent>
    <totalElectricityContracts>2</totalElectricityContracts>
    <totalGasContracts>1</totalGasContracts>
  </contracts>
  <subBrokerName>sample string 3</subBrokerName>
</ReportResponse>