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

idstring

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.

body_textstring

current_iterationinteger

day_of_month"first_day" or "last_day"

Allowed values: first_daylast_day

end_monthinteger>=1<=12

end_yearinteger<=2077

invoice_idstring

iterationslist of objects

start_monthinteger>=1<=12

start_yearinteger<=2077

statusenum

Allowed values: activecanceledcompleted

subject_textstring

recipientsobjectOptional

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

1 {
2   "id": "id",
3   "created_at": "2024-01-15T09:30:00Z",
4   "updated_at": "2024-01-15T09:30:00Z",
5   "body_text": "body_text",
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   "subject_text": "subject_text",
23   "recipients": {
24     "bcc": [
25       "bcc"
26     ],
27     "cc": [
28       "cc"
29     ],
30     "to": [
31       "to"
32     ]
33   }
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	"body_text": "body_text",
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	"subject_text": "subject_text",
23	"recipients": {
24	"bcc": [
25	"bcc"
26	],
27	"cc": [
28	"cc"
29	],
30	"to": [
31	"to"
32	]
33	}
34	}