Skip to main content
POST
/
organizations
/
{orgId}
/
picklists
/
billgroupingkeys
Create BillGroupingKey
curl --request POST \
  --url https://api.m3ter.com/organizations/{orgId}/picklists/billgroupingkeys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "exclusive": true,
  "version": 123,
  "code": "code",
  "archived": true
}
'
{
  "id": "<string>",
  "version": 123,
  "code": "<string>",
  "name": "<string>",
  "archived": true,
  "exclusive": true,
  "dtCreated": "2023-11-07T05:31:56Z",
  "dtLastModified": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "lastModifiedBy": "<string>"
}

Authorizations

​
Authorization
string
header
required

m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.

The authorizationCode flow controls access for human users via the m3ter Console application.

Path Parameters

​
orgId
string
required

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

Body

application/json
​
name
string
required

The name of the entity.

Required string length: 1 - 200
​
exclusive
boolean
required

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

​
version
integer<int64>

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.
​
code
string

The short code for the entity.

Maximum string length: 80
Pattern: ^[\p{L}_$][\p{L}_$0-9]*$
Example:

"code"

​
archived
boolean

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.

Response

Return the created BillGroupingKey

​
id
string
required

The UUID of the entity.

​
version
integer<int64>

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.
​
code
string

The short code of the data entity.

​
name
string

The name of the data entity.

​
archived
boolean

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

​
exclusive
boolean

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

​
dtCreated
string<date-time>

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

​
dtLastModified
string<date-time>

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

​
createdBy
string

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

​
lastModifiedBy
string

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