Trigger the creation of a transaction for a specific recurring transaction

Trigger the creation of a transaction for a specific recurring transaction. All recurrences have a set of future occurrences. For those moments, you can trigger the creation of the transaction. That means the transaction will be created NOW, instead of on the indicated date. The transaction will be dated to today.

So, if you recurring transaction that occurs every Monday, you can trigger the creation of a transaction for Monday in two weeks, today. On that Monday two weeks from now, no transaction will be created. Instead, the transaction is created right now, and dated today.

post/v1/recurrences/{id}/trigger

Path parameters

idstring required

Example:123

The ID of the recurring transaction.

Query parameters

datestring date required

A date formatted YYYY-MM-DD. This is the date for which you want the recurrence to fire. You can take the date from the list of occurrences in the recurring transaction.

Headers

X-Trace-Idstring uuid

Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Response

A list of transactions (always just 1) created by the recurrence, or a list of zero (0) when there is nothing to create for this date.

Changes

No recorded changes to this endpoint across all 1 revision of this API.