Update or Add the UsageRate object and optionally make changes to any child objects.

patch

https://{server_address}/ResourceServer/api/v10/Usage/Rate/{id}

Path Params

integer

required

Unique identifier for the UsageRate object.

Body Params

Defines properties for an individual Usage Rate within the system.

usageRateGroupId

number

Unique identifier for the associated UsageRateGroup object.

usageRateGroupName

string

The name of the object associated with the usageRateGroupId property.

usageClassId

number

Unique identifier for the associated UsageClass object.

usageClassName

string

The name of the object associated with the usageClassId property.

amount

number

geoTreeLocationId

number

Unique identifier for the associated GeoTreeLocation object.

geoTreeLocationName

string

The name of the object associated with the geoTreeLocationId property.

additional

boolean

usageRoundingId

number

Unique identifier for the associated UsageRounding object.

usageRoundingName

string

The name of the object associated with the usageRoundingId property.

displayName

string

geoTreeLocationGroupId

number

Unique identifier for the associated GeoTreeLocationGroup object.

geoTreeLocationGroupName

string

The name of the object associated with the geoTreeLocationGroupId property.

minimumCharge

number

usageUnitId

number

Unique identifier for the associated UsageUnit object.

usageUnitName

string

The name of the object associated with the usageUnitId property.

usageRateCalculationTypeId

number

Unique identifier for the associated UsageRateCalculationType object.

usageRateCalculationTypeName

string

The name of the object associated with the usageRateCalculationTypeId property.

generalLedgerId

number

Unique identifier for the associated GeneralLedger object.

generalLedgerName

string

The name of the object associated with the generalLedgerId property.

serviceTaxCategoryId

number

Unique identifier for the associated ServiceTaxCategory object.

serviceTaxCategoryName

string

The name of the object associated with the serviceTaxCategoryId property.

createdByUserId

number

Unique identifier for the associated User object.

createdByUserName

string

The name of the object associated with the createdByUserId property.

updatedByUserId

number

Unique identifier for the associated User object.

updatedByUserName

string

The name of the object associated with the updatedByUserId property.

isDeleted

string

deletedByUserId

string

deletedByUserName

string

Responses

200Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array.

400The request could not be processed.