--- title: "Create BalanceTransactionSchedule" method: POST path: "/organizations/{orgId}/balances/{balanceId}/balancetransactionschedules" tags: ["BalanceTransactionSchedule"] --- # Create BalanceTransactionSchedule `POST /organizations/{orgId}/balances/{balanceId}/balancetransactionschedules` Create a new BalanceTransactionSchedule. ## Path parameters - `orgId` string, required - `balanceId` string, required ## Request body - BalanceTransactionScheduleRequest - `version` integer — 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` 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](https://www.m3ter.com/docs/guides/creating-and-managing-products/working-with-custom-fields) in the m3ter documentation for more information. - `name` string, required — The name of the Balance Transaction Schedule. - `code` string, required — The unique short code of the Balance Transaction Schedule. - `amount` number, required — The amount of each Balance Transaction created by this Schedule. - `transactionDescription` string, required — The description of each Balance Transaction that will be 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, 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](https://www.m3ter.com/docs/api#tag/TransactionType/operation/ListTransactionTypes) endpoint of this API Reference. - `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` 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'ANNUALLY', required — Together with frequencyInterval, defines how often BalanceTransactions are generated. - `frequencyInterval` integer, 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. ## Response `200` Return the created BalanceTransactionSchedule - BalanceTransactionScheduleResponse - `id` string, required — The UUID of the entity. - `version` integer — 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](https://www.m3ter.com/docs/guides/creating-and-managing-products/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` 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'ANNUALLY' — Together with frequencyInterval, defines how often BalanceTransactions are generated. - `frequencyInterval` integer — 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. ## Other responses - `4XX` — Error message - `5XX` — Error message --- [API](https://skmtc.net/m3ter-com/apis/m3ter-api.md) · [All operations](https://skmtc.net/m3ter-com/apis/m3ter-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/m3ter-com/m3ter-api/revisions/ac93d1a9e6d9/schema)