POST api/customers/{customerId}/contracts/{contractNo}/expenseoverview

Get an expense overview for a customer's contract.

Request Information

URI Parameters

Name	Description	Type	Additional information
customerId	Customer ID	integer	Required
contractNo	Contract number	integer	Required

Body Parameters

Required: FromMonth and ToMonth. The dates must be in separate months.

ExpenseOverviewRequest

Name	Type	Additional information
ContractNo	string	None.
CustomerId	string	None.
FromMonth	date	None.
Realm	string	None.
IncludeLastYear	boolean	None.
ToMonth	date	None.

Request Formats

application/json, text/json

Sample:

{
  "ContractNo": "sample string 1",
  "CustomerId": "sample string 2",
  "FromMonth": "2025-05-19T20:28:28.6307278+00:00",
  "Realm": "sample string 4",
  "IncludeLastYear": true,
  "ToMonth": "2025-05-19T20:28:28.6307278+00:00"
}

text/html

Sample:

{"ContractNo":"sample string 1","CustomerId":"sample string 2","FromMonth":"2025-05-19T20:28:28.6307278+00:00","Realm":"sample string 4","IncludeLastYear":true,"ToMonth":"2025-05-19T20:28:28.6307278+00:00"}

Response Information

Resource Description

Expense overview

ExpenseOverviewResponse

Name	Type	Additional information
CalculationTime	date	None.
ContractNo	string	None.
CustomerId	string	None.
ExpenseOverviewLines	Collection of ExpenseOverviewLine	None.
FromMonth	date	None.
PricesIncludeVat	boolean	None.
Realm	string	None.
ToMonth	date	None.

Response Formats

application/json, text/json

Sample:

{
  "CalculationTime": "2025-05-19T20:28:28.6307278+00:00",
  "ContractNo": "sample string 2",
  "CustomerId": "sample string 3",
  "ExpenseOverviewLines": [
    {
      "Consumption": 1.0,
      "ConsumptionTax": 2.0,
      "ConsumptionTaxVat": 3.0,
      "EnergyExpenses": 4.0,
      "EnergyExpensesVat": 5.0,
      "IsConsumptionReal": true,
      "IsConsumptionTaxSettled": true,
      "IsEnergyExpensesSettled": true,
      "IsNetExpensesSettled": true,
      "IsTotalExpensesSettled": true,
      "Month": "2025-05-19T20:28:28.6307278+00:00",
      "NetExpenses": 12.0,
      "NetExpensesVat": 13.0,
      "TotalExpenses": 14.0,
      "TotalExpensesVat": 15.0
    },
    {
      "Consumption": 1.0,
      "ConsumptionTax": 2.0,
      "ConsumptionTaxVat": 3.0,
      "EnergyExpenses": 4.0,
      "EnergyExpensesVat": 5.0,
      "IsConsumptionReal": true,
      "IsConsumptionTaxSettled": true,
      "IsEnergyExpensesSettled": true,
      "IsNetExpensesSettled": true,
      "IsTotalExpensesSettled": true,
      "Month": "2025-05-19T20:28:28.6307278+00:00",
      "NetExpenses": 12.0,
      "NetExpensesVat": 13.0,
      "TotalExpenses": 14.0,
      "TotalExpensesVat": 15.0
    }
  ],
  "FromMonth": "2025-05-19T20:28:28.6307278+00:00",
  "PricesIncludeVat": true,
  "Realm": "sample string 6",
  "ToMonth": "2025-05-19T20:28:28.6307278+00:00"
}

text/html

Sample:

{"CalculationTime":"2025-05-19T20:28:28.6307278+00:00","ContractNo":"sample string 2","CustomerId":"sample string 3","ExpenseOverviewLines":[{"Consumption":1.0,"ConsumptionTax":2.0,"ConsumptionTaxVat":3.0,"EnergyExpenses":4.0,"EnergyExpensesVat":5.0,"IsConsumptionReal":true,"IsConsumptionTaxSettled":true,"IsEnergyExpensesSettled":true,"IsNetExpensesSettled":true,"IsTotalExpensesSettled":true,"Month":"2025-05-19T20:28:28.6307278+00:00","NetExpenses":12.0,"NetExpensesVat":13.0,"TotalExpenses":14.0,"TotalExpensesVat":15.0},{"Consumption":1.0,"ConsumptionTax":2.0,"ConsumptionTaxVat":3.0,"EnergyExpenses":4.0,"EnergyExpensesVat":5.0,"IsConsumptionReal":true,"IsConsumptionTaxSettled":true,"IsEnergyExpensesSettled":true,"IsNetExpensesSettled":true,"IsTotalExpensesSettled":true,"Month":"2025-05-19T20:28:28.6307278+00:00","NetExpenses":12.0,"NetExpensesVat":13.0,"TotalExpenses":14.0,"TotalExpensesVat":15.0}],"FromMonth":"2025-05-19T20:28:28.6307278+00:00","PricesIncludeVat":true,"Realm":"sample string 6","ToMonth":"2025-05-19T20:28:28.6307278+00:00"}