Create a recurrence

POST

/recurrences

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.

Request

This endpoint expects an object.

day_of_month"first_day" or "last_day"Required

Allowed values: first_daylast_day

end_monthintegerRequired>=1<=12

end_yearintegerRequired<=2077

invoice_idstringRequired

start_monthintegerRequired>=1<=12

start_yearintegerRequired<=2077

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.

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

Errors

POST

1 curl -X POST https://api.sandbox.monite.com/v1/recurrences \
2      -H "x-monite-version: 2024-01-31" \
3      -H "x-monite-entity-id: x-monite-entity-id" \
4      -H "Authorization: Bearer <token>" \
5      -H "Content-Type: application/json" \
6      -d '{
7   "day_of_month": "first_day",
8   "end_month": 1,
9   "end_year": 1,
10   "invoice_id": "invoice_id",
11   "start_month": 1,
12   "start_year": 1
13 }'

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 }

Get a recurrence by ID

Up Next

1	curl -X POST https://api.sandbox.monite.com/v1/recurrences \
2	-H "x-monite-version: 2024-01-31" \
3	-H "x-monite-entity-id: x-monite-entity-id" \
4	-H "Authorization: Bearer <token>" \
5	-H "Content-Type: application/json" \
6	-d '{
7	"day_of_month": "first_day",
8	"end_month": 1,
9	"end_year": 1,
10	"invoice_id": "invoice_id",
11	"start_month": 1,
12	"start_year": 1
13	}'

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	}