POST api/role/lettings/{id}/saveutility

Add or Update a utility for the letting role Processes this letting role API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The letting role id

integer

Required

Body Parameters

The details of the utility to be added

SaveUtilityDataContract
NameDescriptionTypeAdditional information
UtilityType

The utility type value.

EnumDataContract

None.

SupplierGroupId

The unique identifier of the related supplier group resource.

integer

None.

MeterReading

The meter reading value.

string

None.

ReadingDate

The reading date, expressed as a date and time.

date

None.

BillId

The unique identifier of the related bill resource.

integer

None.

Id

The unique identifier of this resource.

integer

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "UtilityType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "SupplierGroupId": 1,
  "MeterReading": "sample string 2",
  "ReadingDate": "2026-07-23T08:23:13.0293449Z",
  "BillId": 1,
  "Id": 4
}

Response Information

Resource Description

The response returned after the operation completes.

UtilityDataContract
NameDescriptionTypeAdditional information
UtilityType

The utility type value.

EnumDataContract

None.

Supplier

The supplier value.

PeopleGroupDataContract

None.

MeterReading

The meter reading value.

string

None.

ReadingDate

The reading date, expressed as a date and time.

date

None.

Id

The unique identifier of this resource.

integer

None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.