GET request/report/summaryDetails/{agentId}?from={from}&to={to}

Provides a Dashboard

Request Information

URI Parameters

Name	Type	Additional information
agentId	integer	Required
from	date	None.
to	date	None.

Body Parameters

None.

Response Information

Resource Description

ReportDetailResponse

Name	Type	Additional information
agentName	string	None.
brokerId	string	None.
details	Collection of SummaryDetails	None.
partnerBrokerId	string	None.

Response Formats

application/json, text/json

Sample:

{
  "brokerId": "sample string 1",
  "partnerBrokerId": "sample string 2",
  "agentName": "sample string 3",
  "details": [
    {
      "contractDetailId": 1,
      "companyName": "sample string 1",
      "pid": 1,
      "fuelType": "sample string 2",
      "registrationStatusId": 1,
      "registrationStatus": "sample string 3",
      "totalCommissionAmount": 1.0,
      "totalCommissionPaid": 1.0,
      "totalToBeClawedback": 1.0,
      "totalToBePaid": 1.0,
      "totalClawedback": 1.0,
      "commissionType": "sample string 4",
      "estimatedConsumption": 1,
      "upliftRate": 1.0,
      "contractlengthId": 1,
      "contractlengthValue": "sample string 5",
      "contractLength": "sample string 6",
      "commissionDue": 1.0,
      "brokerId": "sample string 7",
      "agentName": "sample string 8",
      "agentId": 1,
      "uplift": [
        {
          "month": "sample string 1",
          "updated": 1.0,
          "commissionDue": 1.0,
          "commissionPaid": 1.0,
          "commissionToBePaid": 1.0,
          "clawedBack": 1.0,
          "toBeClawedBack": 1.0,
          "originalCommissionDue": 1.0,
          "pid": 1
        },
        {
          "month": "sample string 1",
          "updated": 1.0,
          "commissionDue": 1.0,
          "commissionPaid": 1.0,
          "commissionToBePaid": 1.0,
          "clawedBack": 1.0,
          "toBeClawedBack": 1.0,
          "originalCommissionDue": 1.0,
          "pid": 1
        }
      ],
      "submittedDate": "2025-06-29T03:01:19.6479459+00:00",
      "estimatedContractStartDate": "2025-06-29T03:01:19.6479459+00:00",
      "actualContractStartDate": "2025-06-29T03:01:19.6479459+00:00",
      "contractLossDate": "2025-06-29T03:01:19.6479459+00:00",
      "cotFlag": "sample string 9",
      "complaintFlag": "sample string 10",
      "etFlag": "sample string 11",
      "cotCompleteFlag": "sample string 12",
      "firstPaymentFlag": "sample string 13",
      "cotDate": "2025-06-29T03:01:19.6479459+00:00",
      "contractType": "sample string 14"
    },
    {
      "contractDetailId": 1,
      "companyName": "sample string 1",
      "pid": 1,
      "fuelType": "sample string 2",
      "registrationStatusId": 1,
      "registrationStatus": "sample string 3",
      "totalCommissionAmount": 1.0,
      "totalCommissionPaid": 1.0,
      "totalToBeClawedback": 1.0,
      "totalToBePaid": 1.0,
      "totalClawedback": 1.0,
      "commissionType": "sample string 4",
      "estimatedConsumption": 1,
      "upliftRate": 1.0,
      "contractlengthId": 1,
      "contractlengthValue": "sample string 5",
      "contractLength": "sample string 6",
      "commissionDue": 1.0,
      "brokerId": "sample string 7",
      "agentName": "sample string 8",
      "agentId": 1,
      "uplift": [
        {
          "month": "sample string 1",
          "updated": 1.0,
          "commissionDue": 1.0,
          "commissionPaid": 1.0,
          "commissionToBePaid": 1.0,
          "clawedBack": 1.0,
          "toBeClawedBack": 1.0,
          "originalCommissionDue": 1.0,
          "pid": 1
        },
        {
          "month": "sample string 1",
          "updated": 1.0,
          "commissionDue": 1.0,
          "commissionPaid": 1.0,
          "commissionToBePaid": 1.0,
          "clawedBack": 1.0,
          "toBeClawedBack": 1.0,
          "originalCommissionDue": 1.0,
          "pid": 1
        }
      ],
      "submittedDate": "2025-06-29T03:01:19.6479459+00:00",
      "estimatedContractStartDate": "2025-06-29T03:01:19.6479459+00:00",
      "actualContractStartDate": "2025-06-29T03:01:19.6479459+00:00",
      "contractLossDate": "2025-06-29T03:01:19.6479459+00:00",
      "cotFlag": "sample string 9",
      "complaintFlag": "sample string 10",
      "etFlag": "sample string 11",
      "cotCompleteFlag": "sample string 12",
      "firstPaymentFlag": "sample string 13",
      "cotDate": "2025-06-29T03:01:19.6479459+00:00",
      "contractType": "sample string 14"
    }
  ]
}

text/html

Sample:

{"brokerId":"sample string 1","partnerBrokerId":"sample string 2","agentName":"sample string 3","details":[{"contractDetailId":1,"companyName":"sample string 1","pid":1,"fuelType":"sample string 2","registrationStatusId":1,"registrationStatus":"sample string 3","totalCommissionAmount":1.0,"totalCommissionPaid":1.0,"totalToBeClawedback":1.0,"totalToBePaid":1.0,"totalClawedback":1.0,"commissionType":"sample string 4","estimatedConsumption":1,"upliftRate":1.0,"contractlengthId":1,"contractlengthValue":"sample string 5","contractLength":"sample string 6","commissionDue":1.0,"brokerId":"sample string 7","agentName":"sample string 8","agentId":1,"uplift":[{"month":"sample string 1","updated":1.0,"commissionDue":1.0,"commissionPaid":1.0,"commissionToBePaid":1.0,"clawedBack":1.0,"toBeClawedBack":1.0,"originalCommissionDue":1.0,"pid":1},{"month":"sample string 1","updated":1.0,"commissionDue":1.0,"commissionPaid":1.0,"commissionToBePaid":1.0,"clawedBack":1.0,"toBeClawedBack":1.0,"originalCommissionDue":1.0,"pid":1}],"submittedDate":"2025-06-29T03:01:19.6479459+00:00","estimatedContractStartDate":"2025-06-29T03:01:19.6479459+00:00","actualContractStartDate":"2025-06-29T03:01:19.6479459+00:00","contractLossDate":"2025-06-29T03:01:19.6479459+00:00","cotFlag":"sample string 9","complaintFlag":"sample string 10","etFlag":"sample string 11","cotCompleteFlag":"sample string 12","firstPaymentFlag":"sample string 13","cotDate":"2025-06-29T03:01:19.6479459+00:00","contractType":"sample string 14"},{"contractDetailId":1,"companyName":"sample string 1","pid":1,"fuelType":"sample string 2","registrationStatusId":1,"registrationStatus":"sample string 3","totalCommissionAmount":1.0,"totalCommissionPaid":1.0,"totalToBeClawedback":1.0,"totalToBePaid":1.0,"totalClawedback":1.0,"commissionType":"sample string 4","estimatedConsumption":1,"upliftRate":1.0,"contractlengthId":1,"contractlengthValue":"sample string 5","contractLength":"sample string 6","commissionDue":1.0,"brokerId":"sample string 7","agentName":"sample string 8","agentId":1,"uplift":[{"month":"sample string 1","updated":1.0,"commissionDue":1.0,"commissionPaid":1.0,"commissionToBePaid":1.0,"clawedBack":1.0,"toBeClawedBack":1.0,"originalCommissionDue":1.0,"pid":1},{"month":"sample string 1","updated":1.0,"commissionDue":1.0,"commissionPaid":1.0,"commissionToBePaid":1.0,"clawedBack":1.0,"toBeClawedBack":1.0,"originalCommissionDue":1.0,"pid":1}],"submittedDate":"2025-06-29T03:01:19.6479459+00:00","estimatedContractStartDate":"2025-06-29T03:01:19.6479459+00:00","actualContractStartDate":"2025-06-29T03:01:19.6479459+00:00","contractLossDate":"2025-06-29T03:01:19.6479459+00:00","cotFlag":"sample string 9","complaintFlag":"sample string 10","etFlag":"sample string 11","cotCompleteFlag":"sample string 12","firstPaymentFlag":"sample string 13","cotDate":"2025-06-29T03:01:19.6479459+00:00","contractType":"sample string 14"}]}

application/xml, text/xml

Sample:

<ReportDetailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CCSCommercialAPI.Models.Report">
  <agentName>sample string 3</agentName>
  <brokerId>sample string 1</brokerId>
  <details>
    <SummaryDetails>
      <ComplaintFlag>sample string 10</ComplaintFlag>
      <ContractType>sample string 14</ContractType>
      <CotCompleteFlag>sample string 12</CotCompleteFlag>
      <CotDate>2025-06-29T03:01:19.6479459+00:00</CotDate>
      <CotFlag>sample string 9</CotFlag>
      <ETFlag>sample string 11</ETFlag>
      <FirstPaymentFlag>sample string 13</FirstPaymentFlag>
      <PID>1</PID>
      <TotalToBePaid>1</TotalToBePaid>
      <actualContractStartDate>2025-06-29T03:01:19.6479459+00:00</actualContractStartDate>
      <agentId>1</agentId>
      <agentName>sample string 8</agentName>
      <brokerId>sample string 7</brokerId>
      <commissionDue>1</commissionDue>
      <commissionType>sample string 4</commissionType>
      <companyName>sample string 1</companyName>
      <contractDetailId>1</contractDetailId>
      <contractLength>sample string 6</contractLength>
      <contractLossDate>2025-06-29T03:01:19.6479459+00:00</contractLossDate>
      <contractlengthId>1</contractlengthId>
      <contractlengthValue>sample string 5</contractlengthValue>
      <estimatedConsumption>1</estimatedConsumption>
      <estimatedContractStartDate>2025-06-29T03:01:19.6479459+00:00</estimatedContractStartDate>
      <fuelType>sample string 2</fuelType>
      <registrationStatus>sample string 3</registrationStatus>
      <registrationStatusId>1</registrationStatusId>
      <submittedDate>2025-06-29T03:01:19.6479459+00:00</submittedDate>
      <totalClawedback>1</totalClawedback>
      <totalCommissionAmount>1</totalCommissionAmount>
      <totalCommissionPaid>1</totalCommissionPaid>
      <totalToBeClawedback>1</totalToBeClawedback>
      <uplift>
        <Uplift>
          <OriginalCommissionDue>1</OriginalCommissionDue>
          <clawedBack>1</clawedBack>
          <commissionDue>1</commissionDue>
          <commissionPaid>1</commissionPaid>
          <commissionToBePaid>1</commissionToBePaid>
          <month>sample string 1</month>
          <pid>1</pid>
          <toBeClawedBack>1</toBeClawedBack>
          <updated>1</updated>
        </Uplift>
        <Uplift>
          <OriginalCommissionDue>1</OriginalCommissionDue>
          <clawedBack>1</clawedBack>
          <commissionDue>1</commissionDue>
          <commissionPaid>1</commissionPaid>
          <commissionToBePaid>1</commissionToBePaid>
          <month>sample string 1</month>
          <pid>1</pid>
          <toBeClawedBack>1</toBeClawedBack>
          <updated>1</updated>
        </Uplift>
      </uplift>
      <upliftRate>1</upliftRate>
    </SummaryDetails>
    <SummaryDetails>
      <ComplaintFlag>sample string 10</ComplaintFlag>
      <ContractType>sample string 14</ContractType>
      <CotCompleteFlag>sample string 12</CotCompleteFlag>
      <CotDate>2025-06-29T03:01:19.6479459+00:00</CotDate>
      <CotFlag>sample string 9</CotFlag>
      <ETFlag>sample string 11</ETFlag>
      <FirstPaymentFlag>sample string 13</FirstPaymentFlag>
      <PID>1</PID>
      <TotalToBePaid>1</TotalToBePaid>
      <actualContractStartDate>2025-06-29T03:01:19.6479459+00:00</actualContractStartDate>
      <agentId>1</agentId>
      <agentName>sample string 8</agentName>
      <brokerId>sample string 7</brokerId>
      <commissionDue>1</commissionDue>
      <commissionType>sample string 4</commissionType>
      <companyName>sample string 1</companyName>
      <contractDetailId>1</contractDetailId>
      <contractLength>sample string 6</contractLength>
      <contractLossDate>2025-06-29T03:01:19.6479459+00:00</contractLossDate>
      <contractlengthId>1</contractlengthId>
      <contractlengthValue>sample string 5</contractlengthValue>
      <estimatedConsumption>1</estimatedConsumption>
      <estimatedContractStartDate>2025-06-29T03:01:19.6479459+00:00</estimatedContractStartDate>
      <fuelType>sample string 2</fuelType>
      <registrationStatus>sample string 3</registrationStatus>
      <registrationStatusId>1</registrationStatusId>
      <submittedDate>2025-06-29T03:01:19.6479459+00:00</submittedDate>
      <totalClawedback>1</totalClawedback>
      <totalCommissionAmount>1</totalCommissionAmount>
      <totalCommissionPaid>1</totalCommissionPaid>
      <totalToBeClawedback>1</totalToBeClawedback>
      <uplift>
        <Uplift>
          <OriginalCommissionDue>1</OriginalCommissionDue>
          <clawedBack>1</clawedBack>
          <commissionDue>1</commissionDue>
          <commissionPaid>1</commissionPaid>
          <commissionToBePaid>1</commissionToBePaid>
          <month>sample string 1</month>
          <pid>1</pid>
          <toBeClawedBack>1</toBeClawedBack>
          <updated>1</updated>
        </Uplift>
        <Uplift>
          <OriginalCommissionDue>1</OriginalCommissionDue>
          <clawedBack>1</clawedBack>
          <commissionDue>1</commissionDue>
          <commissionPaid>1</commissionPaid>
          <commissionToBePaid>1</commissionToBePaid>
          <month>sample string 1</month>
          <pid>1</pid>
          <toBeClawedBack>1</toBeClawedBack>
          <updated>1</updated>
        </Uplift>
      </uplift>
      <upliftRate>1</upliftRate>
    </SummaryDetails>
  </details>
  <partnerBrokerId>sample string 2</partnerBrokerId>
</ReportDetailResponse>