GET request/report/supplier/commission/contract/{contractDetailId}/payments

Request Information

URI Parameters

Name	Description	Type	Additional information
contractDetailId		integer	Required

Body Parameters

None.

Response Information

Resource Description

CommissionContractPayments

Name	Type	Additional information
ActualCommissionAmount	decimal number	None.
ActualPayments	Collection of ActualCommissionPaymentDetail	None.
ContractCommissionDetailSnapShotId	integer	None.
ContractDetailId	integer	None.
ContractId	integer	None.
ExpectedCommissionAmount	decimal number	None.
ExpectedPayments	Collection of ExpectedCommissionPaymentDetail	None.
IsUpfrontPayment	boolean	None.
VarianceAmount	decimal number	None.

Response Formats

application/json, text/json

Sample:

{
  "contractId": 1,
  "contractDetailId": 2,
  "isUpfrontPayment": true,
  "contractCommissionDetailSnapShotId": 4,
  "expectedPayments": [
    {
      "paymentSequence": 1,
      "expectedPaymentId": 2,
      "expectedPeriodStart": "2026-10-09T19:01:56.3979631+00:00",
      "expectedPeriodEnd": "2026-10-09T19:01:56.3979631+00:00",
      "expectedConsumptionkWh": 5.0,
      "expectedCommissionAmount": 6.0,
      "expectedPaymentDate": "2026-10-09T19:01:56.3979631+00:00",
      "cumulativeCommission": 1.0,
      "cumulativeConsumption": 1.0
    },
    {
      "paymentSequence": 1,
      "expectedPaymentId": 2,
      "expectedPeriodStart": "2026-10-09T19:01:56.3979631+00:00",
      "expectedPeriodEnd": "2026-10-09T19:01:56.3979631+00:00",
      "expectedConsumptionkWh": 5.0,
      "expectedCommissionAmount": 6.0,
      "expectedPaymentDate": "2026-10-09T19:01:56.3979631+00:00",
      "cumulativeCommission": 1.0,
      "cumulativeConsumption": 1.0
    }
  ],
  "actualPayments": [
    {
      "paymentSequence": 1,
      "expectedPaymentSequence": 2,
      "supplierPaymentStatusId": 1,
      "supplierPaymentStatus": "sample string 3",
      "supplierInvoiceStatusId": 1,
      "supplierInvoiceStatus": "sample string 4",
      "supplierPaymentTypeId": 1,
      "supplierPaymentType": "sample string 5",
      "actualConsumptionkWh": 1.0,
      "actualCommissionAmount": 1.0,
      "actualPaymentDate": "2026-10-09T19:01:56.3979631+00:00",
      "varianceAmount": 1.0,
      "supplierTransactionReferenceNo": "sample string 6",
      "brokerInvoiceStatusId": 1,
      "brokerInvoiceStatus": "sample string 7",
      "brokerPaymentTypeId": 1,
      "brokerPaymentType": "sample string 8"
    },
    {
      "paymentSequence": 1,
      "expectedPaymentSequence": 2,
      "supplierPaymentStatusId": 1,
      "supplierPaymentStatus": "sample string 3",
      "supplierInvoiceStatusId": 1,
      "supplierInvoiceStatus": "sample string 4",
      "supplierPaymentTypeId": 1,
      "supplierPaymentType": "sample string 5",
      "actualConsumptionkWh": 1.0,
      "actualCommissionAmount": 1.0,
      "actualPaymentDate": "2026-10-09T19:01:56.3979631+00:00",
      "varianceAmount": 1.0,
      "supplierTransactionReferenceNo": "sample string 6",
      "brokerInvoiceStatusId": 1,
      "brokerInvoiceStatus": "sample string 7",
      "brokerPaymentTypeId": 1,
      "brokerPaymentType": "sample string 8"
    }
  ],
  "expectedCommissionAmount": 5.0,
  "actualCommissionAmount": 6.0,
  "varianceAmount": 1.0
}

text/html

Sample:

{"contractId":1,"contractDetailId":2,"isUpfrontPayment":true,"contractCommissionDetailSnapShotId":4,"expectedPayments":[{"paymentSequence":1,"expectedPaymentId":2,"expectedPeriodStart":"2026-10-09T19:01:56.3979631+00:00","expectedPeriodEnd":"2026-10-09T19:01:56.3979631+00:00","expectedConsumptionkWh":5.0,"expectedCommissionAmount":6.0,"expectedPaymentDate":"2026-10-09T19:01:56.3979631+00:00","cumulativeCommission":1.0,"cumulativeConsumption":1.0},{"paymentSequence":1,"expectedPaymentId":2,"expectedPeriodStart":"2026-10-09T19:01:56.3979631+00:00","expectedPeriodEnd":"2026-10-09T19:01:56.3979631+00:00","expectedConsumptionkWh":5.0,"expectedCommissionAmount":6.0,"expectedPaymentDate":"2026-10-09T19:01:56.3979631+00:00","cumulativeCommission":1.0,"cumulativeConsumption":1.0}],"actualPayments":[{"paymentSequence":1,"expectedPaymentSequence":2,"supplierPaymentStatusId":1,"supplierPaymentStatus":"sample string 3","supplierInvoiceStatusId":1,"supplierInvoiceStatus":"sample string 4","supplierPaymentTypeId":1,"supplierPaymentType":"sample string 5","actualConsumptionkWh":1.0,"actualCommissionAmount":1.0,"actualPaymentDate":"2026-10-09T19:01:56.3979631+00:00","varianceAmount":1.0,"supplierTransactionReferenceNo":"sample string 6","brokerInvoiceStatusId":1,"brokerInvoiceStatus":"sample string 7","brokerPaymentTypeId":1,"brokerPaymentType":"sample string 8"},{"paymentSequence":1,"expectedPaymentSequence":2,"supplierPaymentStatusId":1,"supplierPaymentStatus":"sample string 3","supplierInvoiceStatusId":1,"supplierInvoiceStatus":"sample string 4","supplierPaymentTypeId":1,"supplierPaymentType":"sample string 5","actualConsumptionkWh":1.0,"actualCommissionAmount":1.0,"actualPaymentDate":"2026-10-09T19:01:56.3979631+00:00","varianceAmount":1.0,"supplierTransactionReferenceNo":"sample string 6","brokerInvoiceStatusId":1,"brokerInvoiceStatus":"sample string 7","brokerPaymentTypeId":1,"brokerPaymentType":"sample string 8"}],"expectedCommissionAmount":5.0,"actualCommissionAmount":6.0,"varianceAmount":1.0}

application/xml, text/xml

Sample:

<CommissionContractPayments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.Reports">
  <ActualCommissionAmount>6</ActualCommissionAmount>
  <ActualPayments>
    <ActualCommissionPaymentDetail>
      <ActualCommissionAmount>1</ActualCommissionAmount>
      <ActualConsumptionkWh>1</ActualConsumptionkWh>
      <ActualPaymentDate>2026-10-09T19:01:56.3979631+00:00</ActualPaymentDate>
      <BrokerInvoiceStatus>sample string 7</BrokerInvoiceStatus>
      <BrokerInvoiceStatusId>1</BrokerInvoiceStatusId>
      <BrokerPaymentType>sample string 8</BrokerPaymentType>
      <BrokerPaymentTypeId>1</BrokerPaymentTypeId>
      <ExpectedPaymentSequence>2</ExpectedPaymentSequence>
      <PaymentSequence>1</PaymentSequence>
      <SupplierInvoiceStatus>sample string 4</SupplierInvoiceStatus>
      <SupplierInvoiceStatusId>1</SupplierInvoiceStatusId>
      <SupplierPaymentStatus>sample string 3</SupplierPaymentStatus>
      <SupplierPaymentStatusId>1</SupplierPaymentStatusId>
      <SupplierPaymentType>sample string 5</SupplierPaymentType>
      <SupplierPaymentTypeId>1</SupplierPaymentTypeId>
      <SupplierTransactionReferenceNo>sample string 6</SupplierTransactionReferenceNo>
      <VarianceAmount>1</VarianceAmount>
    </ActualCommissionPaymentDetail>
    <ActualCommissionPaymentDetail>
      <ActualCommissionAmount>1</ActualCommissionAmount>
      <ActualConsumptionkWh>1</ActualConsumptionkWh>
      <ActualPaymentDate>2026-10-09T19:01:56.3979631+00:00</ActualPaymentDate>
      <BrokerInvoiceStatus>sample string 7</BrokerInvoiceStatus>
      <BrokerInvoiceStatusId>1</BrokerInvoiceStatusId>
      <BrokerPaymentType>sample string 8</BrokerPaymentType>
      <BrokerPaymentTypeId>1</BrokerPaymentTypeId>
      <ExpectedPaymentSequence>2</ExpectedPaymentSequence>
      <PaymentSequence>1</PaymentSequence>
      <SupplierInvoiceStatus>sample string 4</SupplierInvoiceStatus>
      <SupplierInvoiceStatusId>1</SupplierInvoiceStatusId>
      <SupplierPaymentStatus>sample string 3</SupplierPaymentStatus>
      <SupplierPaymentStatusId>1</SupplierPaymentStatusId>
      <SupplierPaymentType>sample string 5</SupplierPaymentType>
      <SupplierPaymentTypeId>1</SupplierPaymentTypeId>
      <SupplierTransactionReferenceNo>sample string 6</SupplierTransactionReferenceNo>
      <VarianceAmount>1</VarianceAmount>
    </ActualCommissionPaymentDetail>
  </ActualPayments>
  <ContractCommissionDetailSnapShotId>4</ContractCommissionDetailSnapShotId>
  <ContractDetailId>2</ContractDetailId>
  <ContractId>1</ContractId>
  <ExpectedCommissionAmount>5</ExpectedCommissionAmount>
  <ExpectedPayments>
    <ExpectedCommissionPaymentDetail>
      <CumulativeCommission>1</CumulativeCommission>
      <CumulativeConsumption>1</CumulativeConsumption>
      <ExpectedCommissionAmount>6</ExpectedCommissionAmount>
      <ExpectedConsumptionkWh>5</ExpectedConsumptionkWh>
      <ExpectedPaymentDate>2026-10-09T19:01:56.3979631+00:00</ExpectedPaymentDate>
      <ExpectedPaymentId>2</ExpectedPaymentId>
      <ExpectedPeriodEnd>2026-10-09T19:01:56.3979631+00:00</ExpectedPeriodEnd>
      <ExpectedPeriodStart>2026-10-09T19:01:56.3979631+00:00</ExpectedPeriodStart>
      <PaymentSequence>1</PaymentSequence>
    </ExpectedCommissionPaymentDetail>
    <ExpectedCommissionPaymentDetail>
      <CumulativeCommission>1</CumulativeCommission>
      <CumulativeConsumption>1</CumulativeConsumption>
      <ExpectedCommissionAmount>6</ExpectedCommissionAmount>
      <ExpectedConsumptionkWh>5</ExpectedConsumptionkWh>
      <ExpectedPaymentDate>2026-10-09T19:01:56.3979631+00:00</ExpectedPaymentDate>
      <ExpectedPaymentId>2</ExpectedPaymentId>
      <ExpectedPeriodEnd>2026-10-09T19:01:56.3979631+00:00</ExpectedPeriodEnd>
      <ExpectedPeriodStart>2026-10-09T19:01:56.3979631+00:00</ExpectedPeriodStart>
      <PaymentSequence>1</PaymentSequence>
    </ExpectedCommissionPaymentDetail>
  </ExpectedPayments>
  <IsUpfrontPayment>true</IsUpfrontPayment>
  <VarianceAmount>1</VarianceAmount>
</CommissionContractPayments>