Accounts receivableRecurrences

Get a recurrence by ID

Path parameters

recurrence_idstringRequired

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-monite-versionstringRequired
x-monite-entity-idstringRequired
The ID of the entity that owns the requested resource.

Response

Successful Response
idstringformat: "uuid"
created_atdatetime
Time at which the recurrence was created. Timestamps follow the ISO 8601 standard.
updated_atdatetime
Time at which the recurrence was last updated. Timestamps follow the ISO 8601 standard.
automation_levelenum

Controls how invoices are processed when generated:

  • “draft”: Creates invoices in draft status, requiring manual review, issuing, and sending
  • “issue”: Automatically issues invoices but requires manual sending
  • “issue_and_send”: Fully automates the process (creates, issues, and sends invoices)

Default: “issue” (or “issue_and_send” if subject_text and body_text are provided)

Note: When using “issue_and_send”, both subject_text and body_text must be provided.

Allowed values:
current_iterationinteger>=1
Current iteration number
frequencyenum
How often the invoice will be created.
Allowed values:
intervalinteger>=1<=100
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_idstringformat: "uuid"
ID of the base invoice that will be used as a template for creating recurring invoices.
iterationslist of objects
List of iterations for the recurrence
start_datestringformat: "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.

statusenum
Status of the recurrence
Allowed values:
day_of_monthenumDeprecated

Deprecated, use start_date instead

Allowed values:
start_monthinteger>=1<=12Deprecated

Deprecated, use start_date instead

start_yearinteger<=2077Deprecated

Deprecated, use start_date instead

body_textstringOptional
The body text for the email that will be sent with the recurring invoice.
end_datestringOptionalformat: "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.

max_occurrencesintegerOptional>=1<=1000

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.

recipientsobjectOptional

An object containing the recipients (To, CC, BCC) of the recurring invoices. Can be omitted if the base invoice has the counterpart contact email specified in the counterpart_contact.email field.

subject_textstringOptional
The subject for the email that will be sent with the recurring invoice.
end_monthintegerOptional>=1<=12Deprecated

Deprecated, use end_date instead

end_yearintegerOptional<=2077Deprecated

Deprecated, use end_date instead

Errors