Available from CRM.COM R14.0.0
This method updates a meter reading of an Installed Item. A single Installed Item's meter reading is updated by each call. Applicable only for Installed Items that their Meter Reading Type is classified as ONETIME
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
| installed_item_identifier (mandatory) | Identifier | The identifier of the Installed Item that a meter reading will be updated. The allowed installed item identifier fields are the following:
| ||||||||||||
meter_reading_identifier (mandatory) | Meter Reading Identifier | The identifier of the meter reading. The allowed meter reading identifier fields are the following:
| ||||||||||||
meter_reading_value (mandatory) | Number | The meter reading value that was documented | ||||||||||||
from_date (optional) | Date | The starting date of the period related with the meter reading If not specified, then this parameter will be set as the To date of the previous entry (if any) - otherwise will be set as the current date | ||||||||||||
to_date (optional) | Date | The ending date of the period related with the meter reading |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified
Response Data
Examples
HTTP Method: POST
Request
Body
{
"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c3IiOiJNUEFkbWluaXN0cmF0b3IiLCJvcmciOiJwc19kZXYiLCJvdW4iOiIxIiwiZXhwIjoiMTUwODg1NDU1NSIsImlhdCI6IjE1MDg4NDczNTUiLCJqdGkiOiI2NTlCQTE2MTNEMzY0OUI3ODBBOUJENEIwQzIwMDA2OSJ9.i7632RZEY9eI-iQLLOh5NRorLx4xzqXh6zblZlasbHs",
"meter_reading_identifier":{"id":"0DFEC6DAD3FB4E66A9D484B20A128031"},
"meter_reading_value":"100"
}
Response
{
"data":
{
"udr": null,
"unit_of_measurement": null,
"from_date": "2017-10-24T12:07:44",
"to_date": "2017-10-24T14:00:00",
"log_information":
{
"created_by_unit":
{
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit":
{
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2017-10-24T14:06:17",
"updated_date": "2017-10-24T15:19:47",
"updated_by_user":
{
"person_name": "CRM COM",
"id": "1",
"username": "MPAdministrator"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"accounts_receivable":
{
"number": "ACR0000012788",
"name": "ACR0000012788 Test 7738_06",
"id": "04184E056A24484B9DB306A64A73C696",
"life_cycle_state": "ACTIVE",
"account_owner":
{
"company_profile": null,
"company_name": null,
"name": "Test 7738_06",
"last_name": "7738_06",
"id": "E398A7774D224DE9822C3C067C334274",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Test",
"demographics":
{
"name_day":
{
"month": null,
"day": null
},
"id_number": "7738_06",
"gender": null,
"country_of_residence":
{
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"date_of_birth":
{
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "0DFEC6DAD3FB4E66A9D484B20A128031",
"meter_reading_value": 100
},
"status":
{
"code": "OK",
"description": "",
"message": ""
}
}