Sign in

v10

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

Retrieve BalanceTransactionSchedule

Retrieve a BalanceTransactionSchedule for the given UUID.

get/organizations/{orgId}/balances/{balanceId}/balancetransactionschedules/{id}

Path parameters

orgIdstring required

UUID of the organization

balanceIdstring required

UUID of the balance

idstring required

The UUID of the BalanceTransactionSchedule to retrieve.

Response

Return the BalanceTransactionSchedule

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

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.

balanceIdstring

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

namestring

The name of the Balance Transaction Schedule.

codestring

Unique short code of the Balance Transaction Schedule.

amountnumber

The amount of each Balance Transaction created by this Schedule.

transactionDescriptionstring

The description of each Balance Transaction created by this Schedule.

paidnumber

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

currencyPaidstring

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

transactionTypeIdstring

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

startDatestring date-time

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

endDatestring date-time

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

frequency'DAILY' | 'WEEKLY' | 'MONTHLY' | 'ANNUALLY'

Together with frequencyInterval, defines how often BalanceTransactions are generated.

frequencyIntervalinteger

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.

dtCreatedstring date-time

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

dtLastModifiedstring date-time

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

createdBystring

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

lastModifiedBystring

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

nextRunstring date-time

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

previousRunstring date-time

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