recurring-transactions

Update Recurring Transaction

Changed on
patch/api/recurring-transactions/{recurring_id}

Request

Path parameters

recurring_idstring uuid required

Headers

X-Workspace-Idstring nullable

Request body

descriptionstring nullable
currencystring nullable
typestring nullable
frequency'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'semiannual' | 'yearly' nullable
weekend_adjustment'none' | 'previous_friday' | 'next_monday' nullable
day_of_monthinteger nullable
start_datestring date nullable
end_datestring date nullable
account_idstring uuid nullable
category_idstring uuid nullable
is_activeboolean nullable
auto_generateboolean nullable

Response

Successful Response

idstring uuid required
user_idstring uuid required
account_idstring uuid nullable
category_idstring uuid nullable
descriptionstring required
amountstring required
currencystring required
typestring required
frequencystring required
weekend_adjustment'none' | 'previous_friday' | 'next_monday'
day_of_monthinteger nullable
start_datestring date required
end_datestring date nullable
is_activeboolean required
auto_generateboolean
next_occurrencestring date required
amount_primarynumber nullable
fx_rate_usednumber nullable

Changes

    • breaking

      request property / was restricted to a list of enum values

    • warning

      the / request property's max was set to 31.00

    • warning

      the / request property's min was set to 1.00

    • info

      added the new optional request property

    • info

      added the new biweekly enum value to the request property /

    • info

      added the new monthly enum value to the request property /

    • info

      added the new quarterly enum value to the request property /

    • info

      added the new semiannual enum value to the request property /

    • info

      added the new weekly enum value to the request property /

    • info

      added the new yearly enum value to the request property /

    • info

      removed the pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ from the request property /

    • info

      added the optional property to the response with the status

    • info

      the response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was removed for the status