Create Invoice Reminder
POST /api/v1/invoices/{invoiceid}/invoicesreminders
Create a new automated reminder for an overdue invoice.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
invoice_id |
integer | Yes | The unique ID of the invoice. |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
invoices_reminder[count] |
integer | Yes | Number of reminders to send. |
invoices_reminder[interval] |
string | Yes | Interval: days, weeks, months. |
invoices_reminder[condition] |
string | Yes | Trigger: after_due_date, before_due_date. |
Request Example
{ "invoices_reminder": { "count": 28, "interval": "days", "condition": "after_due_date" } }
POST /api/v1/invoices/123/invoices_reminders HTTP/1.1
Host: koteshen.com
Authorization: Bearer {access_token}
Content-Type: application/json
Accept: application/json
{request_body}
Response
Status Codes:
201 Created- Reminder created.401 Unauthorized- Invalid or missing token.404 Not Found- Invoice not found.422 Unprocessable Entity- Invalid parameters.
Success Response (201)
Same structure as List Invoice Reminders individual item.