Skip to content

Recurring receivables

How weekly and monthly recurring receivables work, and what the v1 API can and cannot do with them.

Public API status

The v1 API described here is implemented and tested, but api.remindcash.com is not yet open to the public. It opens after final acceptance testing; until then requests return 503. Examples use placeholders — never paste a real key into shared code.

Not yet in the API. Recurring series are created and managed in the RemindCash app. The v1 API has no endpoints to create, edit or stop a series.

How recurring receivables work

A recurring receivable is a series that repeats weekly or monthly, either indefinitely or until it is stopped. Each repetition is a separate occurrence with:

  • its own stable ID, due date and amount snapshot,
  • its own reminder plan and paid status.

Paying one occurrence never marks another one as paid, and a paid occurrence is never reminded again. Monthly dates that do not exist in a shorter month follow a consistent last-day-of-month rule.

When you edit a series in the app, you choose whether the change applies to this occurrence only or to future occurrences. Past and paid occurrences are never rewritten.

What you can do through the API

  • Occurrences appear in GET /v1/receivables like any other receivable, with their own id, due_date and status.
  • You can record payments against an occurrence and pause, resume or cancel it.
  • PATCH on an occurrence returns 409 conflict — edit the series in the app instead.