POST api/CommodityEstimation/GetEstimatedInvoice

Request Information

URI Parameters

None.

Body Parameters

ApiParamOfEstimatedInvoiceCriteriaAndEstimatedInvoice
NameDescriptionTypeAdditional information
AuthKey

AuthenticationKey

Required

Criteria

EstimatedInvoiceCriteria

Required

Data

EstimatedInvoice

Required

Request Formats

application/json, text/json

Sample:
{
  "AuthKey": {
    "WebServiceKey": "sample string 1",
    "CompanyID": 1,
    "AppSource": "sample string 2",
    "AppSourceTeam": "sample string 3"
  },
  "Criteria": {
    "CompanyID": 1,
    "RefID": "sample string 1",
    "CustomerID": "sample string 2"
  },
  "Data": {
    "ElectricCurrentEstimatedAmount": 1.0,
    "ElectricCurrentEstimatedUsage": 1.0,
    "ElectricCurrentEstimatedYear": 1,
    "ElectricCurrentEstimatedMonth": "sample string 1",
    "ElectricCurrentEstimatedServiceStart": "2025-05-01T16:24:59.1699283-04:00",
    "ElectricCurrentEstimatedServiceEnd": "2025-05-01T16:24:59.1699283-04:00",
    "ElectricPromptEstimatedAmount": 1.0,
    "ElectricPromptEstimatedUsage": 1.0,
    "ElectricPromptEstimatedYear": 1,
    "ElectricPromptEstimatedMonth": "sample string 2",
    "ElectricPromptEstimatedServiceStart": "2025-05-01T16:24:59.1699283-04:00",
    "ElectricPromptEstimatedServiceEnd": "2025-05-01T16:24:59.1699283-04:00",
    "MeasurementUnitsElectric": "sample string 3",
    "HasElectricEstimation": true,
    "GasCurrentEstimatedAmount": 1.0,
    "GasCurrentEstimatedUsage": 1.0,
    "GasCurrentEstimatedYear": 1,
    "GasCurrentEstimatedMonth": "sample string 4",
    "GasCurrentEstimatedServiceStart": "2025-05-01T16:24:59.1699283-04:00",
    "GasCurrentEstimatedServiceEnd": "2025-05-01T16:24:59.1699283-04:00",
    "GasPromptEstimatedAmount": 1.0,
    "GasPromptEstimatedUsage": 1.0,
    "GasPromptEstimatedYear": 1,
    "GasPromptEstimatedMonth": "sample string 5",
    "GasPromptEstimatedServiceStart": "2025-05-01T16:24:59.1699283-04:00",
    "GasPromptEstimatedServiceEnd": "2025-05-01T16:24:59.1699283-04:00",
    "MeasurementUnitsGas": "sample string 6",
    "HasGasEstimation": true,
    "ID": 1,
    "ContractID": "sample string 7",
    "CompanyID": 1,
    "CustomerID": "sample string 8",
    "RefID": "sample string 9",
    "IsActive": true,
    "UpdatedBy": "sample string 10",
    "UpdatedDate": "2025-05-01T16:24:59.1699283-04:00",
    "CreatedBy": "sample string 11",
    "CreatedDate": "2025-05-01T16:24:59.1699283-04:00"
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiOutputCommonOfListOfEstimatedInvoice
NameDescriptionTypeAdditional information
ResponseCode

string

None.

ResponseMessage

string

None.

Data

Collection of EstimatedInvoice

None.

Response Formats

application/json, text/json

Sample:
{
  "ResponseCode": "sample string 1",
  "ResponseMessage": "sample string 2",
  "Data": [
    {
      "ElectricCurrentEstimatedAmount": 1.0,
      "ElectricCurrentEstimatedUsage": 1.0,
      "ElectricCurrentEstimatedYear": 1,
      "ElectricCurrentEstimatedMonth": "sample string 1",
      "ElectricCurrentEstimatedServiceStart": "2025-05-01T16:24:59.1699283-04:00",
      "ElectricCurrentEstimatedServiceEnd": "2025-05-01T16:24:59.1699283-04:00",
      "ElectricPromptEstimatedAmount": 1.0,
      "ElectricPromptEstimatedUsage": 1.0,
      "ElectricPromptEstimatedYear": 1,
      "ElectricPromptEstimatedMonth": "sample string 2",
      "ElectricPromptEstimatedServiceStart": "2025-05-01T16:24:59.1699283-04:00",
      "ElectricPromptEstimatedServiceEnd": "2025-05-01T16:24:59.1699283-04:00",
      "MeasurementUnitsElectric": "sample string 3",
      "HasElectricEstimation": true,
      "GasCurrentEstimatedAmount": 1.0,
      "GasCurrentEstimatedUsage": 1.0,
      "GasCurrentEstimatedYear": 1,
      "GasCurrentEstimatedMonth": "sample string 4",
      "GasCurrentEstimatedServiceStart": "2025-05-01T16:24:59.1699283-04:00",
      "GasCurrentEstimatedServiceEnd": "2025-05-01T16:24:59.1699283-04:00",
      "GasPromptEstimatedAmount": 1.0,
      "GasPromptEstimatedUsage": 1.0,
      "GasPromptEstimatedYear": 1,
      "GasPromptEstimatedMonth": "sample string 5",
      "GasPromptEstimatedServiceStart": "2025-05-01T16:24:59.1699283-04:00",
      "GasPromptEstimatedServiceEnd": "2025-05-01T16:24:59.1699283-04:00",
      "MeasurementUnitsGas": "sample string 6",
      "HasGasEstimation": true,
      "ID": 1,
      "ContractID": "sample string 7",
      "CompanyID": 1,
      "CustomerID": "sample string 8",
      "RefID": "sample string 9",
      "IsActive": true,
      "UpdatedBy": "sample string 10",
      "UpdatedDate": "2025-05-01T16:24:59.1699283-04:00",
      "CreatedBy": "sample string 11",
      "CreatedDate": "2025-05-01T16:24:59.1699283-04:00"
    },
    {
      "ElectricCurrentEstimatedAmount": 1.0,
      "ElectricCurrentEstimatedUsage": 1.0,
      "ElectricCurrentEstimatedYear": 1,
      "ElectricCurrentEstimatedMonth": "sample string 1",
      "ElectricCurrentEstimatedServiceStart": "2025-05-01T16:24:59.1699283-04:00",
      "ElectricCurrentEstimatedServiceEnd": "2025-05-01T16:24:59.1699283-04:00",
      "ElectricPromptEstimatedAmount": 1.0,
      "ElectricPromptEstimatedUsage": 1.0,
      "ElectricPromptEstimatedYear": 1,
      "ElectricPromptEstimatedMonth": "sample string 2",
      "ElectricPromptEstimatedServiceStart": "2025-05-01T16:24:59.1699283-04:00",
      "ElectricPromptEstimatedServiceEnd": "2025-05-01T16:24:59.1699283-04:00",
      "MeasurementUnitsElectric": "sample string 3",
      "HasElectricEstimation": true,
      "GasCurrentEstimatedAmount": 1.0,
      "GasCurrentEstimatedUsage": 1.0,
      "GasCurrentEstimatedYear": 1,
      "GasCurrentEstimatedMonth": "sample string 4",
      "GasCurrentEstimatedServiceStart": "2025-05-01T16:24:59.1699283-04:00",
      "GasCurrentEstimatedServiceEnd": "2025-05-01T16:24:59.1699283-04:00",
      "GasPromptEstimatedAmount": 1.0,
      "GasPromptEstimatedUsage": 1.0,
      "GasPromptEstimatedYear": 1,
      "GasPromptEstimatedMonth": "sample string 5",
      "GasPromptEstimatedServiceStart": "2025-05-01T16:24:59.1699283-04:00",
      "GasPromptEstimatedServiceEnd": "2025-05-01T16:24:59.1699283-04:00",
      "MeasurementUnitsGas": "sample string 6",
      "HasGasEstimation": true,
      "ID": 1,
      "ContractID": "sample string 7",
      "CompanyID": 1,
      "CustomerID": "sample string 8",
      "RefID": "sample string 9",
      "IsActive": true,
      "UpdatedBy": "sample string 10",
      "UpdatedDate": "2025-05-01T16:24:59.1699283-04:00",
      "CreatedBy": "sample string 11",
      "CreatedDate": "2025-05-01T16:24:59.1699283-04:00"
    }
  ]
}