GET request/report/summary?from={from}&to={to}

Provides a Summary

Request Information

URI Parameters

Name	Description	Type	Additional information
from		date	None.
to		date	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,
    "totalCommission": 1.0,
    "totalCommissionPaid": 1.0,
    "totalClawBack": 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,
      "totalCommissionAmount": 8.0,
      "totalElectricityPaid": 1.0,
      "totalGasPaid": 1.0,
      "totalCommissionPaid": 1.0,
      "totalClawback": 1.0,
      "totalToBeClawedback": 1.0,
      "totalToBePaid": 1.0,
      "isSubBroker": true,
      "subBrokerName": "sample string 10",
      "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,
          "totalCommissionAmount": 8.0,
          "totalElectricityPaid": 1.0,
          "totalGasPaid": 1.0,
          "totalCommissionPaid": 1.0,
          "totalClawback": 1.0,
          "totalToBeClawedback": 1.0,
          "totalToBePaid": 1.0
        },
        {
          "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,
          "totalCommissionAmount": 8.0,
          "totalElectricityPaid": 1.0,
          "totalGasPaid": 1.0,
          "totalCommissionPaid": 1.0,
          "totalClawback": 1.0,
          "totalToBeClawedback": 1.0,
          "totalToBePaid": 1.0
        }
      ]
    },
    {
      "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,
      "totalCommissionAmount": 8.0,
      "totalElectricityPaid": 1.0,
      "totalGasPaid": 1.0,
      "totalCommissionPaid": 1.0,
      "totalClawback": 1.0,
      "totalToBeClawedback": 1.0,
      "totalToBePaid": 1.0,
      "isSubBroker": true,
      "subBrokerName": "sample string 10",
      "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,
          "totalCommissionAmount": 8.0,
          "totalElectricityPaid": 1.0,
          "totalGasPaid": 1.0,
          "totalCommissionPaid": 1.0,
          "totalClawback": 1.0,
          "totalToBeClawedback": 1.0,
          "totalToBePaid": 1.0
        },
        {
          "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,
          "totalCommissionAmount": 8.0,
          "totalElectricityPaid": 1.0,
          "totalGasPaid": 1.0,
          "totalCommissionPaid": 1.0,
          "totalClawback": 1.0,
          "totalToBeClawedback": 1.0,
          "totalToBePaid": 1.0
        }
      ]
    }
  ]
}

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,"totalCommission":1.0,"totalCommissionPaid":1.0,"totalClawBack":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,"totalCommissionAmount":8.0,"totalElectricityPaid":1.0,"totalGasPaid":1.0,"totalCommissionPaid":1.0,"totalClawback":1.0,"totalToBeClawedback":1.0,"totalToBePaid":1.0,"isSubBroker":true,"subBrokerName":"sample string 10","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,"totalCommissionAmount":8.0,"totalElectricityPaid":1.0,"totalGasPaid":1.0,"totalCommissionPaid":1.0,"totalClawback":1.0,"totalToBeClawedback":1.0,"totalToBePaid":1.0},{"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,"totalCommissionAmount":8.0,"totalElectricityPaid":1.0,"totalGasPaid":1.0,"totalCommissionPaid":1.0,"totalClawback":1.0,"totalToBeClawedback":1.0,"totalToBePaid":1.0}]},{"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,"totalCommissionAmount":8.0,"totalElectricityPaid":1.0,"totalGasPaid":1.0,"totalCommissionPaid":1.0,"totalClawback":1.0,"totalToBeClawedback":1.0,"totalToBePaid":1.0,"isSubBroker":true,"subBrokerName":"sample string 10","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,"totalCommissionAmount":8.0,"totalElectricityPaid":1.0,"totalGasPaid":1.0,"totalCommissionPaid":1.0,"totalClawback":1.0,"totalToBeClawedback":1.0,"totalToBePaid":1.0},{"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,"totalCommissionAmount":8.0,"totalElectricityPaid":1.0,"totalGasPaid":1.0,"totalCommissionPaid":1.0,"totalClawback":1.0,"totalToBeClawedback":1.0,"totalToBePaid":1.0}]}]}

application/xml, text/xml

Sample:

<ReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.Reports">
  <Aggregator>true</Aggregator>
  <agents>
    <Agents>
      <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>
      <agents>
        <SubAgents>
          <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>
          <totalClawback>1</totalClawback>
          <totalCommissionAmount>8</totalCommissionAmount>
          <totalCommissionPaid>1</totalCommissionPaid>
          <totalContractsSent>5</totalContractsSent>
          <totalToBeClawedback>1</totalToBeClawedback>
          <totalToBePaid>1</totalToBePaid>
        </SubAgents>
        <SubAgents>
          <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>
          <totalClawback>1</totalClawback>
          <totalCommissionAmount>8</totalCommissionAmount>
          <totalCommissionPaid>1</totalCommissionPaid>
          <totalContractsSent>5</totalContractsSent>
          <totalToBeClawedback>1</totalToBeClawedback>
          <totalToBePaid>1</totalToBePaid>
        </SubAgents>
      </agents>
      <brokerId>sample string 1</brokerId>
      <isSubBroker>true</isSubBroker>
      <subBrokerName>sample string 10</subBrokerName>
      <totalClawback>1</totalClawback>
      <totalCommissionAmount>8</totalCommissionAmount>
      <totalCommissionPaid>1</totalCommissionPaid>
      <totalContractsSent>5</totalContractsSent>
      <totalToBeClawedback>1</totalToBeClawedback>
      <totalToBePaid>1</totalToBePaid>
    </Agents>
    <Agents>
      <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>
      <agents>
        <SubAgents>
          <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>
          <totalClawback>1</totalClawback>
          <totalCommissionAmount>8</totalCommissionAmount>
          <totalCommissionPaid>1</totalCommissionPaid>
          <totalContractsSent>5</totalContractsSent>
          <totalToBeClawedback>1</totalToBeClawedback>
          <totalToBePaid>1</totalToBePaid>
        </SubAgents>
        <SubAgents>
          <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>
          <totalClawback>1</totalClawback>
          <totalCommissionAmount>8</totalCommissionAmount>
          <totalCommissionPaid>1</totalCommissionPaid>
          <totalContractsSent>5</totalContractsSent>
          <totalToBeClawedback>1</totalToBeClawedback>
          <totalToBePaid>1</totalToBePaid>
        </SubAgents>
      </agents>
      <brokerId>sample string 1</brokerId>
      <isSubBroker>true</isSubBroker>
      <subBrokerName>sample string 10</subBrokerName>
      <totalClawback>1</totalClawback>
      <totalCommissionAmount>8</totalCommissionAmount>
      <totalCommissionPaid>1</totalCommissionPaid>
      <totalContractsSent>5</totalContractsSent>
      <totalToBeClawedback>1</totalToBeClawedback>
      <totalToBePaid>1</totalToBePaid>
    </Agents>
  </agents>
  <brokerId>sample string 1</brokerId>
  <commission>
    <TotalCommission>1</TotalCommission>
    <TotalCommissionPaid>1</TotalCommissionPaid>
    <TotalElectricityCommission>2</TotalElectricityCommission>
    <TotalElectricityCommissionPaid>1</TotalElectricityCommissionPaid>
    <TotalGasCommission>1</TotalGasCommission>
    <TotalGasCommissionPaid>1</TotalGasCommissionPaid>
    <totalClawBack>1</totalClawBack>
    <totalToBeClawedback>1</totalToBeClawedback>
    <totalToBePaid>1</totalToBePaid>
  </commission>
  <contracts>
    <totalContractsSent>3</totalContractsSent>
    <totalElectricityContracts>2</totalElectricityContracts>
    <totalGasContracts>1</totalGasContracts>
  </contracts>
  <subBrokerName>sample string 3</subBrokerName>
</ReportResponse>