Get a recurrence by ID

GET

/recurrences/:recurrence_id

Path parameters

recurrence_idstringRequired

Headers

Auth

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 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.

current_iterationinteger

day_of_monthenum

Allowed values: first_daylast_day

end_monthinteger>=1<=12

end_yearinteger<=2077

invoice_idstringformat: "uuid"

iterationslist of objects

start_monthinteger>=1<=12

start_yearinteger<=2077

statusenum

Allowed values: activecanceledcompleted

body_textstringOptional

recipientsobjectOptional

subject_textstringOptional

Errors

GET

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>"

200Retrieved

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

Update a recurrence

Up Next

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	"current_iteration": 1,
6	"day_of_month": "first_day",
7	"end_month": 1,
8	"end_year": 1,
9	"invoice_id": "invoice_id",
10	"iterations": [
11	{
12	"issue_at": "issue_at",
13	"status": "pending",
14	"issued_invoice_id": "issued_invoice_id",
15	"iteration": 1
16	}
17	],
18	"start_month": 1,
19	"start_year": 1,
20	"status": "active",
21	"body_text": "body_text",
22	"recipients": {
23	"bcc": [
24	"bcc"
25	],
26	"cc": [
27	"cc"
28	],
29	"to": [
30	"to"
31	]
32	},
33	"subject_text": "subject_text"
34	}