We are using cookies to improve your experience!

By clicking "Allow all", you agree to use of all cookies. Visit our Privacy Policy to learn more.

List Invoice Reminders

GET /api/v1/invoices/{invoiceid}/invoicesreminders

Retrieve all reminders configured for a specific invoice. Supports Ransack for filtering if multiple reminders exist.

Path Parameters

Parameter Type Required Description
invoice_id integer Yes The unique ID of the invoice.

Ransack Parameters

Similar to invoices, e.g., q[count_eq]=28, q[interval_eq]=days, q[condition_cont]=due.

Request Example

GET /api/v1/invoices/123/invoices_reminders?q[condition_eq]=after_due_date HTTP/1.1
Host: koteshen.com
Authorization: Bearer {access_token}
Content-Type: application/json
Accept: application/json

Response

Status Codes:

  • 200 OK - Success.
  • 401 Unauthorized - Invalid or missing token.
  • 404 Not Found - Invoice not found.
  • 422 Unprocessable Entity - Invalid Ransack query.

Success Response (200)

{
  "data": [
    {
      "id": 789,
      "invoice_id": 123,
      "count": 28,
      "interval": "days",
      "condition": "after_due_date",
      "sent_at": "2025-10-21T00:00:00.000Z",
      "created_at": "2025-10-12T00:00:00.000Z"
    }
  ]
}