Concepts

Companies and keys, receivable statuses, amounts in minor units, local due dates and versions.

Companies

Every API key belongs to exactly one company. A key can only see and change that company's records. Asking for an ID that belongs to another company returns 404 not_found, so other companies' records cannot be discovered.

Receivable statuses

Status	Meaning
`draft`	Created but not active. No reminders are planned or sent.
`active`	Reminders follow the company's schedule.
`partially_paid`	Part of the amount was recorded as paid; reminders use the remaining amount.
`paid`	Fully paid. Future reminders stop.
`paused`	Reminders are on hold until resumed.
`disputed`	The customer disputes the amount; no reminders are sent.
`cancelled`	Closed without payment. No reminders are sent.

Amounts

Send amounts as strings with up to two decimal places, for example "1250.00". A comma is accepted as the decimal separator ("1250,50"). Amounts must be positive.

Responses return integer minor units: amount_minor: 125000 is 1,250.00. Supported currencies are EUR, GBP, TRY and USD. RemindCash never converts between currencies.

Dates and times

due_date is a local calendar date in YYYY-MM-DD format, not a timestamp.
Instants such as recorded_at or submitted_at are ISO 8601 timestamps in UTC.
Reminder send times are calculated in the company's (or customer's) IANA time zone, including daylight-saving changes.

Versions

Every receivable response includes a version — a 64-character fingerprint of its current state. Pass it as expected_version when you update a draft. If the receivable changed in the meantime, the update is rejected with 409 conflict instead of overwriting newer data.

Reminders and safety

API calls never send reminders. Sending is decided by the reminder engine after activation in the app. Before every send it re-checks the receivable status, paid amount, customer opt-out, plan and channel readiness, so a receivable marked paid or paused is not reminded.