Accounts receivableRecurrences

Update a recurrence

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.

Request

This endpoint expects an object.
automation_levelenumOptional

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:
body_textstringOptional
day_of_monthenumOptional
Allowed values:
end_monthintegerOptional>=1<=12
end_yearintegerOptional<=2077
recipientsobjectOptional
subject_textstringOptional

Response

Successful Response

idstringformat: "uuid"
created_atdatetime

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

updated_atdatetime

Time at which the receivable 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
day_of_monthenum
Allowed values:
end_monthinteger>=1<=12
end_yearinteger<=2077
invoice_idstringformat: "uuid"
iterationslist of objects
start_monthinteger>=1<=12
start_yearinteger<=2077
statusenum
Allowed values:
body_textstringOptional
recipientsobjectOptional
subject_textstringOptional

Errors