GET request/contract/{Id}/details/multiple
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
ContractMultipleCommission| Name | Description | Type | Additional information |
|---|---|---|---|
| CommissionPerMeter | decimal number |
None. |
|
| CommissionRateType | string |
None. |
|
| CommissionType | string |
None. |
|
| CompanyName | string |
None. |
|
| FuelId | byte |
None. |
|
| FuelType | string |
None. |
|
| meters | Collection of ContractMultipleCommissionMeters |
None. |
|
| SupplierId | byte |
None. |
|
| SupplierName | string |
None. |
|
| TotalAnnualConsumption | decimal number |
None. |
Response Formats
application/json, text/json
Sample:
{
"companyName": "sample string 1",
"supplierId": 64,
"supplierName": "sample string 2",
"fuelId": 64,
"fuelType": "sample string 3",
"commissionType": "sample string 4",
"commissionRateType": "sample string 5",
"totalAnnualConsumption": 6.0,
"meters": [
{
"siteName": "sample string 1",
"mpxn": "sample string 2",
"hasStandingChargeCommission": true,
"isCommissionPercent": true,
"brokerCommission": 1.0,
"totalCommissionPerMeter": 1.0,
"commissionPerMeter": 1.0,
"commissionMUG": 1.0,
"commissionBrand": 1.0,
"annualConsumption": 1.0,
"commissionPercent": 1.0
},
{
"siteName": "sample string 1",
"mpxn": "sample string 2",
"hasStandingChargeCommission": true,
"isCommissionPercent": true,
"brokerCommission": 1.0,
"totalCommissionPerMeter": 1.0,
"commissionPerMeter": 1.0,
"commissionMUG": 1.0,
"commissionBrand": 1.0,
"annualConsumption": 1.0,
"commissionPercent": 1.0
}
],
"commissionPerMeter": 7.0
}
text/html
Sample:
{"companyName":"sample string 1","supplierId":64,"supplierName":"sample string 2","fuelId":64,"fuelType":"sample string 3","commissionType":"sample string 4","commissionRateType":"sample string 5","totalAnnualConsumption":6.0,"meters":[{"siteName":"sample string 1","mpxn":"sample string 2","hasStandingChargeCommission":true,"isCommissionPercent":true,"brokerCommission":1.0,"totalCommissionPerMeter":1.0,"commissionPerMeter":1.0,"commissionMUG":1.0,"commissionBrand":1.0,"annualConsumption":1.0,"commissionPercent":1.0},{"siteName":"sample string 1","mpxn":"sample string 2","hasStandingChargeCommission":true,"isCommissionPercent":true,"brokerCommission":1.0,"totalCommissionPerMeter":1.0,"commissionPerMeter":1.0,"commissionMUG":1.0,"commissionBrand":1.0,"annualConsumption":1.0,"commissionPercent":1.0}],"commissionPerMeter":7.0}
application/xml, text/xml
Sample:
<ContractMultipleCommission xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CCSCommercialAPI.Models.CustomerUpdate">
<CommissionPerMeter>7</CommissionPerMeter>
<CommissionRateType>sample string 5</CommissionRateType>
<CommissionType>sample string 4</CommissionType>
<CompanyName>sample string 1</CompanyName>
<FuelId>64</FuelId>
<FuelType>sample string 3</FuelType>
<SupplierId>64</SupplierId>
<SupplierName>sample string 2</SupplierName>
<TotalAnnualConsumption>6</TotalAnnualConsumption>
<meters>
<ContractMultipleCommissionMeters>
<AnnualConsumption>1</AnnualConsumption>
<BrokerCommission>1</BrokerCommission>
<CommissionBrand>1</CommissionBrand>
<CommissionMUG>1</CommissionMUG>
<CommissionPerMeter>1</CommissionPerMeter>
<CommissionPercent>1</CommissionPercent>
<HasStandingChargeCommission>true</HasStandingChargeCommission>
<IsCommissionPercent>true</IsCommissionPercent>
<Mpxn>sample string 2</Mpxn>
<SiteName>sample string 1</SiteName>
<TotalCommissionPerMeter>1</TotalCommissionPerMeter>
</ContractMultipleCommissionMeters>
<ContractMultipleCommissionMeters>
<AnnualConsumption>1</AnnualConsumption>
<BrokerCommission>1</BrokerCommission>
<CommissionBrand>1</CommissionBrand>
<CommissionMUG>1</CommissionMUG>
<CommissionPerMeter>1</CommissionPerMeter>
<CommissionPercent>1</CommissionPercent>
<HasStandingChargeCommission>true</HasStandingChargeCommission>
<IsCommissionPercent>true</IsCommissionPercent>
<Mpxn>sample string 2</Mpxn>
<SiteName>sample string 1</SiteName>
<TotalCommissionPerMeter>1</TotalCommissionPerMeter>
</ContractMultipleCommissionMeters>
</meters>
</ContractMultipleCommission>