For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
API StatusPartner Portal
HomeGuidesAPI ExplorerSDKsGitHubSupport
HomeGuidesAPI ExplorerSDKsGitHubSupport
  • API Concepts
    • Overview
    • Environments and URLs
    • Authentication
    • API versioning
    • Rate limiting
    • HTTP headers
    • Pagination, sorting, and filtering
  • General
  • Common
  • Accounts payable
  • Accounts receivable
      • GETGet recurrences
      • POSTCreate a recurrence
      • GETGet a recurrence by ID
      • PATCHUpdate a recurrence
      • POSTCancel a recurrence
      • POSTPause a recurrence
      • POSTResume a recurrence
  • E-invoicing
  • Payments
  • Accounting integration
  • Expense management
  • Utilities
LogoLogo
API StatusPartner Portal
Accounts receivableRecurrences

Get recurrences

GET
/recurrences
GET
/v1/recurrences
$curl https://api.sandbox.monite.com/v1/recurrences \
>     -H "x-monite-version: 2024-01-31" \
>     -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
>     -H "Authorization: Bearer <token>"
1{
2  "data": [
3    {
4      "id": "id",
5      "created_at": "2024-01-15T09:30:00Z",
6      "updated_at": "2024-01-15T09:30:00Z",
7      "automation_level": "draft",
8      "current_iteration": 1,
9      "frequency": "day",
10      "interval": 1,
11      "invoice_id": "invoice_id",
12      "iterations": [
13        {
14          "issue_at": "issue_at",
15          "status": "pending",
16          "issued_invoice_id": "issued_invoice_id",
17          "iteration": 1
18        }
19      ],
20      "start_date": "start_date",
21      "status": "active",
22      "day_of_month": "first_day",
23      "start_month": 1,
24      "start_year": 1,
25      "body_text": "body_text",
26      "end_date": "end_date",
27      "max_occurrences": 1,
28      "recipients": {
29        "bcc": [
30          "bcc"
31        ],
32        "cc": [
33          "cc"
34        ],
35        "to": [
36          "to"
37        ]
38      },
39      "subject_text": "subject_text",
40      "end_month": 1,
41      "end_year": 1
42    }
43  ]
44}
Was this page helpful?
Previous

Create a recurrence

Next
Built with

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

x-monite-versionstringRequired
x-monite-entity-idstringRequired
The ID of the entity that owns the requested resource.

Response

Successful Response
datalist of objects

Errors

400
Get Recurrences Request Bad Request Error
401
Get Recurrences Request Unauthorized Error
403
Get Recurrences Request Forbidden Error
404
Get Recurrences Request Not Found Error
422
Get Recurrences Request Unprocessable Entity Error
500
Get Recurrences Request Internal Server Error