Kavramlar

Şirketler ve anahtarlar, alacak durumları, küçük birim tutarlar, yerel vade tarihleri ve sürümler.

Şirketler

Her API anahtarı tam olarak bir şirkete aittir. Bir anahtar yalnızca o şirketin kayıtlarını görebilir ve değiştirebilir. Başka bir şirkete ait bir kimliği istemek 404 not_found döndürür; böylece diğer şirketlerin kayıtları keşfedilemez.

Alacak durumları

Durum	Anlamı
`draft`	Oluşturuldu ancak etkin değil. Hatırlatma planlanmaz veya gönderilmez.
`active`	Hatırlatmalar şirketin planını izler.
`partially_paid`	Tutarın bir kısmı ödendi olarak kaydedildi; hatırlatmalar kalan tutarı kullanır.
`paid`	Tamamen ödendi. Gelecekteki hatırlatmalar durur.
`paused`	Hatırlatmalar sürdürülene kadar bekletilir.
`disputed`	Müşteri tutara itiraz ediyor; hatırlatma gönderilmez.
`cancelled`	Ödeme olmadan kapatıldı. Hatırlatma gönderilmez.

Tutarlar

Tutarları en fazla iki ondalık basamaklı metin olarak gönderin, örneğin "1250.00". Ondalık ayırıcı olarak virgül de kabul edilir ("1250,50"). Tutarlar pozitif olmalıdır.

Yanıtlar tam sayı küçük birimler döndürür: amount_minor: 125000, 1.250,00 demektir. Desteklenen para birimleri EUR, GBP, TRY ve USD’dir. RemindCash para birimleri arasında asla dönüşüm yapmaz.

Tarihler ve saatler

due_date, YYYY-MM-DD biçiminde yerel bir takvim tarihidir, zaman damgası değildir.
recorded_at veya submitted_at gibi anlar UTC cinsinden ISO 8601 zaman damgalarıdır.
Hatırlatma gönderim saatleri, yaz saati değişiklikleri dahil, şirketin (veya müşterinin) IANA saat diliminde hesaplanır.

Sürümler

Her alacak yanıtı bir version içerir — mevcut durumun 64 karakterlik parmak izi. Bir taslağı güncellerken bunu expected_version olarak gönderin. Alacak bu arada değiştiyse güncelleme, daha yeni verinin üzerine yazmak yerine 409 conflict ile reddedilir.

Hatırlatmalar ve güvenlik

API çağrıları asla hatırlatma göndermez. Gönderime, uygulamada etkinleştirmeden sonra hatırlatma motoru karar verir. Motor her gönderimden önce alacak durumunu, ödenen tutarı, müşterinin aboneliği bırakmasını, planı ve kanal hazırlığını yeniden kontrol eder; bu yüzden ödendi veya duraklatıldı olarak işaretlenen bir alacak için hatırlatma yapılmaz.