Skip to main content
POST
/
organizations
/
{orgId}
/
balances
/
{balanceId}
/
balancetransactionschedules
Create BalanceTransactionSchedule
curl --request POST \
  --url https://api.m3ter.com/organizations/{orgId}/balances/{balanceId}/balancetransactionschedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "code": "<string>",
  "amount": 1,
  "transactionDescription": "<string>",
  "transactionTypeId": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "frequency": "DAILY",
  "frequencyInterval": 183,
  "version": 123,
  "customFields": "<unknown>",
  "paid": 123,
  "currencyPaid": "<string>"
}
'
{
  "id": "<string>",
  "version": 123,
  "customFields": {},
  "balanceId": "<string>",
  "name": "<string>",
  "code": "<string>",
  "amount": 123,
  "transactionDescription": "<string>",
  "paid": 123,
  "currencyPaid": "<string>",
  "transactionTypeId": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "frequency": "DAILY",
  "frequencyInterval": 123,
  "dtCreated": "2023-11-07T05:31:56Z",
  "dtLastModified": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "lastModifiedBy": "<string>",
  "nextRun": "2023-11-07T05:31:56Z",
  "previousRun": "2023-11-07T05:31:56Z"
}

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

​
balanceId
string
required

UUID of the balance

Body

application/json
​
name
string
required

The name of the Balance Transaction Schedule.

Required string length: 1 - 200
​
code
string
required

The unique short code of the Balance Transaction Schedule.

Required string length: 1 - 80
​
amount
number
required

The amount of each Balance Transaction created by this Schedule.

Required range: x >= 0
​
transactionDescription
string
required

The description of each Balance Transaction that will be created by this Schedule.

Minimum string length: 1
​
transactionTypeId
string
required

The unique identifier (UUID) of the transaction type used to create Transactions by this Schedule. You can obtain a list of Transaction Types created for the Organization. See the the List TransactionTypes endpoint of this API Reference.

Required string length: 1 - 36
​
startDate
string<date-time>
required

The start date (in ISO-8601 format) of the Balance Transaction Schedule.

​
endDate
string<date-time>
required

The end date (in ISO-8601 format) of the Balance Transaction Schedule.

NOTE: End date is exclusive.

​
frequency
enum<string>
required

Specify a daily, weekly, monthly, or yearly interval for when Transactions are generated for the Balance throughout the defined Transaction Schedule time period.

Available options:
DAILY,
WEEKLY,
MONTHLY,
ANNUALLY
​
frequencyInterval
integer<int32>
required

Used in conjunction with frequency to define how often Balance Transactions are generated by the Schedule. For example, if frequency is MONTHLY and frequencyInterval is 3, then Balance Transactions are generated every three months.

Required range: 1 <= x <= 365
​
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.
​
customFields
any
​
paid
number

The payment amount if the payment currency differs from the Balance currency.

​
currencyPaid
string

The currency code of the payment if it differs from the Balance currency. For example: USD, GBP or EUR.

Response

Return the created BalanceTransactionSchedule

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

User defined fields enabling you to attach custom data. The value for a custom field can be either a string or a number.

If customFields can also be defined for this entity at the Organizational level,customField values defined at individual level override values of customFields with the same name defined at Organization level.

See Working with Custom Fields in the m3ter documentation for more information.

​
balanceId
string

The unique identifier (UUID) for the Balance this Balance Transaction Schedule was created for.

​
name
string

The name of the Balance Transaction Schedule.

​
code
string

Unique short code of the Balance Transaction Schedule.

​
amount
number

The amount of each Balance Transaction created by this Schedule.

​
transactionDescription
string

The description of each Balance Transaction created by this Schedule.

​
paid
number

The payment amount if the payment currency differs from the Balance currency.

​
currencyPaid
string

The currency code of the payment if it differs from the Balance currency. For example: USD, GBP or EUR.

​
transactionTypeId
string

The unique identifier (UUID) of the transaction type used for Transactions created by this Schedule.

​
startDate
string<date-time>

The start date (in ISO-8601 format) of the Balance Transaction Schedule.

​
endDate
string<date-time>

The end date (in ISO-8601 format) of the Balance Transaction Schedule.

​
frequency
enum<string>

Specifies a daily, weekly, monthly, or yearly interval for when Transactions are generated for the Balance throughout the defined Transaction Schedule time period.

Available options:
DAILY,
WEEKLY,
MONTHLY,
ANNUALLY
​
frequencyInterval
integer<int32>

Used in conjunction with frequency to define how often Balance Transactions are generated. For example, if frequency is MONTHLY and frequencyInterval is 3, Balance Transactions are generated every three months.

​
dtCreated
string<date-time>

The date and time (in ISO-8601 format) when the Balance Transaction Schedule was created.

​
dtLastModified
string<date-time>

The date and time (in ISO-8601 format) when the Balance Transaction Schedule was last modified.

​
createdBy
string

The unique identifier (UUID) of the user who created this Balance Transaction Schedule.

​
lastModifiedBy
string

The unique identifier (UUID) of the user who last modified this Balance Transaction Schedule.

​
nextRun
string<date-time>

The date and time (in ISO-8601 format) when the next Transaction will be generated by the Balance Transaction Schedule.

​
previousRun
string<date-time>

The date and time (in ISO-8601 format) when the previous Transaction was generated by the Balance Transaction Schedule.