Recurrences

Update a recurrence

patch/recurrences/{recurrence_id}

Request

  • Base URL: https://api.sandbox.monite.com/v1
  • URL: https://api.sandbox.monite.com/v1/recurrences/{recurrence_id}
  • Auth: HTTP bearer

Path parameters

recurrence_idstring required

Headers

x-monite-versionstring required
x-monite-entity-idstring required

The ID of the entity that owns the requested resource.

Request body

automation_level'draft' | 'issue' | 'issue_and_send'

Automation level for recurrence

day_of_month'first_day' | 'last_day'
end_datestring date

The end date of the recurring invoice, in the yyyy-mm-dd format. The end date is inclusive, that is, the last invoice will be created on this date if the last occurrence falls on this date. end_date is mutually exclusive with max_occurrences. Either end_date or max_occurrences must be specified.

end_monthinteger

Deprecated, use end_date instead

end_yearinteger

Deprecated, use end_date instead

frequency'day' | 'week' | 'month' | 'quarter' | 'year'
intervalinteger

The interval between each occurrence of the invoice. For example, when using monthly frequency, an interval of 1 means invoices will be created every month, an interval of 2 means invoices will be created every 2 months.

max_occurrencesinteger

How many times the recurring invoice will be created. The recurrence will stop after this number is reached. max_occurrences is mutually exclusive with end_date. Either max_occurrences or end_date must be specified.

start_datestring date

The date when the first invoice will be created, in the yyyy-mm-dd format. Cannot be a past date. Subsequent invoice dates will be calculated based on start_date, frequency, and interval.

Response

Successful Response

idstring uuid required
created_atstring date-time required

Time at which the recurrence was created. Timestamps follow the ISO 8601 standard.

updated_atstring date-time required

Time at which the recurrence was last updated. Timestamps follow the ISO 8601 standard.

automation_level'draft' | 'issue' | 'issue_and_send' required

Automation level for recurrence

body_textstring

The body text for the email that will be sent with the recurring invoice.

current_iterationinteger required

Current iteration number

day_of_month'first_day' | 'last_day' required
end_datestring date

The end date of the recurring invoice, in the yyyy-mm-dd format. The end date is inclusive, that is, the last invoice will be created on this date if the last occurrence falls on this date. end_date is mutually exclusive with max_occurrences. Either end_date or max_occurrences must be specified.

end_monthinteger

Deprecated, use end_date instead

end_yearinteger

Deprecated, use end_date instead

frequency'day' | 'week' | 'month' | 'quarter' | 'year' required
intervalinteger required

The interval between each occurrence of the invoice. For example, when using monthly frequency, an interval of 1 means invoices will be created every month, an interval of 2 means invoices will be created every 2 months.

invoice_idstring uuid required

ID of the base invoice that will be used as a template for creating recurring invoices.

max_occurrencesinteger

How many times the recurring invoice will be created. The recurrence will stop after this number is reached. max_occurrences is mutually exclusive with end_date. Either max_occurrences or end_date must be specified.

start_datestring date required

The date when the first invoice will be created, in the yyyy-mm-dd format. Cannot be a past date. Subsequent invoice dates will be calculated based on start_date, frequency, and interval.

start_monthinteger required

Deprecated, use start_date instead

start_yearinteger required

Deprecated, use start_date instead

status'active' | 'paused' | 'canceled' | 'completed' required

Represents the status of a recurrence

Allowed transitions:

  • active -> paused
  • active -> canceled
  • active -> completed
  • paused -> active
  • paused -> canceled
subject_textstring

The subject for the email that will be sent with the recurring invoice.

Changes

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