Sign in

v10

latestOpenAPI 3.0.1raw.githubusercontent.com2025-12-033223581.2 MB
BillGroupingKey

Update BillGroupingKey

Update a BillGroupingKey for the given UUID.

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

Path parameters

orgIdstring required

UUID of the organization

idstring required

The UUID of the BillGroupingKey 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 is exclusively to be used by one entity.

Example request

{
  "code": "code"
}

Response

Return 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 is exclusively to be used by one entity.

dtCreatedstring date-time

The DateTime when the grouping key was created.

dtLastModifiedstring date-time

The DateTime when the grouping key was last modified.

createdBystring

The id of the user who created this grouping key.

lastModifiedBystring

The id of the user who last modified this grouping key.