M3m3ter-com
BillGroupingKey

Update BillGroupingKey

Changed on

Update a Bill Grouping Key for the given UUID.

put/organizations/{orgId}/picklists/billgroupingkeys/{id}

Request

Path parameters

orgIdstring required

UUID of the Organization. The Organization represents your company as a direct customer of the m3ter service.

idstring required

The UUID of the Bill Grouping Key to update.

Request body

versioninteger

The version number of the entity:

  • Create entity: Not valid for initial insertion of new entity - do not use for Create. On initial Create, version is set at 1 and listed in the response.
  • Update Entity: On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed in the response.
codestring

The short code for the entity.

namestring required

The name of the entity.

archivedboolean

A Boolean TRUE / FALSE flag indicating whether the entity is archived. An entity can be archived if it is obsolete.

  • TRUE - the entity is in the archived state.
  • FALSE - the entity is not in the archived state.
exclusiveboolean required

Whether or not the Bill Grouping Key will be used exclusively by one entity.

Example request

{
  "code": "code"
}

Response

Returns the updated BillGroupingKey

idstring required

The UUID of the entity.

versioninteger

The version number:

  • Create: On initial Create to insert a new entity, the version is set at 1 in the response.
  • Update: On successful Update, the version is incremented by 1 in the response.
codestring

The short code of the data entity.

namestring

The name of the data entity.

archivedboolean

TRUE / FALSE flag indicating whether the data entity is archived. An entity can be archived if it is obsolete.

exclusiveboolean

Whether or not the Bill Grouping Key will be used exclusively by one entity.

dtCreatedstring date-time

The DateTime when the Bill Grouping Key was created.(in ISO 8601 format)

dtLastModifiedstring date-time

The DateTime when the Bill Grouping Key was last modified.(in ISO 8601 format)

createdBystring

The id of the user who created this Bill Grouping Key.

lastModifiedBystring

The id of the user who last modified this Bill Grouping Key.

Changes

  • 85c514abc692Revision changes
    • breaking

      the //// request property type changed from no type to object

    • breaking

      the request property type changed from no type to object

    • breaking

      the //// response's property type changed from no type to object for status

    • breaking

      the response's property type changed from no type to object for status

  • ac93d1a9e6d9Revision changes
    • info

      endpoint added