Skip to main content
POST
/
organizations
/
{orgId}
/
scheduledevents
/
configurations
Create ScheduledEventConfiguration
curl --request POST \
  --url https://api.m3ter.com/organizations/{orgId}/scheduledevents/configurations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "scheduled.bill.enddateEvent",
  "entity": "Bill",
  "field": "endDate",
  "offset": 5
}
'
{
  "id": "<string>",
  "name": "10 days after bill due date",
  "entity": "Bill",
  "field": "dueDate",
  "offset": 10,
  "version": 123,
  "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

Body

application/json

Request containing a ScheduledEventConfiguration entity

​
name
string
required

The name of the custom Scheduled Event Configuration.

This must be in the format:

  • scheduled.name of entity.custom event name

For example:

  • scheduled.bill.endDateEvent
Minimum string length: 1
Example:

"10 Days After Bill Due Date"

​
entity
string
required

The referenced configuration or billing entity for which the desired scheduled Event will trigger.

Minimum string length: 1
Example:

"Bill"

​
field
string
required

A DateTime field for which the desired scheduled Event will trigger - this must be a DateTime field on the referenced billing or configuration entity.

Minimum string length: 1
Example:

"dueDate"

​
offset
integer<int32>
required

The offset in days from the specified DateTime field on the referenced entity when the scheduled Event will trigger.

Example:

10

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

Response

Return the created ScheduledEventConfiguration

​
id
string
required

The UUID of the entity.

​
name
string
required

The name of the custom Scheduled Event Configuration.

Minimum string length: 1
Example:

"10 days after bill due date"

​
entity
string
required

The referenced configuration or billing entity for which the desired scheduled Event will trigger.

Minimum string length: 1
Example:

"Bill"

​
field
string
required

A DateTime field for which the desired scheduled Event will trigger - this must be a DateTime field on the referenced billing or configuration entity.

Minimum string length: 1
Example:

"dueDate"

​
offset
integer<int32>
required

The offset in days from the specified DateTime field on the referenced entity when the scheduled Event will trigger.

Example:

10

​
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.
​
dtCreated
string<date-time>

The DateTime when this item was created (in ISO-8601 format).

​
dtLastModified
string<date-time>

The DateTime when this item was last modified (in ISO-8601 format).

​
createdBy
string

The ID of the user who created this item.

​
lastModifiedBy
string

The ID of the user who last modified this item.