Get a recurrence by ID

recurrence_idstringRequired

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

1	curl https://api.sandbox.monite.com/v1/recurrences/recurrence_id \
2	-H "x-monite-version: 2024-05-25" \
3	-H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4	-H "Authorization: Bearer <token>"

1	{
2	"id": "id",
3	"created_at": "2024-01-15T09:30:00Z",
4	"updated_at": "2024-01-15T09:30:00Z",
5	"automation_level": "draft",
6	"current_iteration": 1,
7	"day_of_month": "first_day",
8	"end_month": 1,
9	"end_year": 1,
10	"invoice_id": "invoice_id",
11	"iterations": [
12	{
13	"issue_at": "issue_at",
14	"status": "pending",
15	"issued_invoice_id": "issued_invoice_id",
16	"iteration": 1
17	}
18	],
19	"start_month": 1,
20	"start_year": 1,
21	"status": "active",
22	"body_text": "body_text",
23	"recipients": {
24	"bcc": [
25	"bcc"
26	],
27	"cc": [
28	"cc"
29	],
30	"to": [
31	"to"
32	]
33	},
34	"subject_text": "subject_text"
35	}