Disabling the transaction pattern results in ignoring the pattern in the forecast. The transaction pattern still exists and relationships to transactions are not modified.
The accessId for which to activate the pattern
The accountId for which to activate the pattern
The patternId to (de)activate
If `true`, the pattern will be used for forecast calculations; `false` will be ignored.
Delete the transaction pattern identified by the patternId. All associated transactions will be updated to {{patternId = null}}.
The accessId for the transaction pattern to delete
The accountId for the transaction pattern to delete
The patternId to delete
Returns the transaction pattern identified by patternId in relation to accountId.
The accessId for the pattern to retrieve
The accoundId for the pattern to retrieve
The patternId for the pattern to retrieve
Returns all transaction patterns for accountId. Transaction patterns are recurring transactions automatically identified by the server or manually created via create transaction pattern.
The accessId for which to retrieve transaction patterns
The accountId for which to retrieve transaction patterns
Create a new pattern for an accountId. The cycle can be MONTHLY
, QUARTERLY
, SEMI_ANNUALLY
or ANNUALLY
. The day can be between 1
and 366
, depending on cycle: | cycle | day range | example | | --- | --- | --- | | MONTHLY
| 1
-31
| every 29th of the month => 29
| | QUARTERLY
| 1
-92
| 23rd of February (23rd of May, etc.) => 54
(31 [complete first month] + 23 [days in second month]) | | SEMI_ANNUALLY
| 1
-184
| 1st of May and 1st of November => 121
(for first half of year: 31 + 28 + 31 + 30 + 1) | | ANNUALLY
| 1
-366
| 24th of December => 358
| If a similar pattern already exists, you will receive an HTTP status code 409.
The accessId with which the newly created pattern is associated
The accountId with which the newly created pattern is associated
The transaction pattern to create
TransactionPatternApi - object-oriented interface
TransactionPatternApi
{BaseAPI}