İçeriğe geç
RemindCash

Alacaklar

Taslak alacakları listeleyin, okuyun, oluşturun ve güncelleyin; alacak nesnesi ve kabul edilen tüm alanlar.

Herkese açık API durumu

Burada anlatılan v1 API uygulanmış ve test edilmiştir, ancak api.remindcash.com henüz herkese açık değildir. Son kabul testlerinden sonra açılacak; o zamana kadar istekler 503 döner. Örneklerde yer tutucular kullanılır — gerçek bir anahtarı asla paylaşılan koda yapıştırmayın.

Uç noktalar

Yöntem Yol Kapsam
GET /v1/receivables receivables:read
GET /v1/receivables/{id} receivables:read
POST /v1/receivables receivables:write
PATCH /v1/receivables/{id} receivables:write

Ödemeler ve durum değişiklikleri Ödeme takibi sayfasında anlatılır.

Alacak nesnesi

Alan Tür Açıklama
id tam sayı Şirketiniz içindeki alacak kimliği.
customer_id tam sayı Alacağın ait olduğu müşteri.
amount_minor tam sayı Küçük birim cinsinden ödenecek tutar.
paid_minor tam sayı Ödendi olarak kaydedilen toplam, küçük birim cinsinden.
currency metin EUR, GBP, TRY veya USD.
due_date metin Yerel vade tarihi, YYYY-MM-DD.
status metin Bkz. durumlar.
external_reference metin veya null Şirketiniz içinde benzersiz kendi referansınız.
description metin veya null En fazla 2.000 karakterlik serbest metin.
version metin Güvenli güncellemeler için kullanılan parmak izi.

Alacakları listeleme

Sonuçlar id’ye göre sıralanır ve sayfalanır (bkz. Sayfalama).

BASH
curl "https://api.remindcash.com/v1/receivables?per_page=25" \
  --header "Authorization: Bearer $REMINDCASH_API_KEY"
JSON
{
    "data": [
        {
            "id": 1,
            "customer_id": 1,
            "amount_minor": 125000,
            "paid_minor": 0,
            "currency": "USD",
            "due_date": "2026-10-15",
            "status": "draft",
            "external_reference": "INV-1042",
            "description": "Website redesign",
            "version": "4e6fea39ae2fab8ccb843657f081d276513739a71787c060a007b65e3acbbbc1"
        }
    ],
    "meta": { "current_page": 1, "per_page": 25, "total": 1 },
    "request_id": "762e599f-c42c-4c49-84fb-9a2f56a3f923"
}

Bir alacağı okuma

BASH
curl https://api.remindcash.com/v1/receivables/1 \
  --header "Authorization: Bearer $REMINDCASH_API_KEY"

Bilinmeyen — ya da başka bir şirkete ait — bir kimlik 404 not_found döndürür.

Taslak alacak oluşturma

POST /v1/receivables, draft durumunda bir alacak oluşturur. Bir Idempotency-Key başlığı gerektirir ve 201 Created döndürür.

Alan Zorunlu Kurallar
customer customer veya customer_id’den biri display_name (zorunlu, en fazla 160) ve email ya da phone_e164’ten en az biri bulunan nesne. İsteğe bağlı preferred_locale (en, tr) ve IANA timezone.
customer_id customer veya customer_id’den biri Şirketinizde var olan bir müşteri.
amount Evet En fazla iki ondalıklı pozitif metin.
currency Evet EUR, GBP, TRY veya USD.
due_date Evet YYYY-MM-DD.
external_reference Hayır En fazla 160 karakter. Şirketinizde zaten kullanılmış bir referans 409 conflict döndürür.
description Hayır En fazla 2.000 karakter.

phone_e164 E.164 biçiminde olmalıdır, örneğin +905321234567. status veya tenant_id gibi alanlar reddedilir.

BASH
curl https://api.remindcash.com/v1/receivables \
  --request POST \
  --header "Authorization: Bearer $REMINDCASH_API_KEY" \
  --header "Idempotency-Key: create-inv-1042-0001" \
  --header "Content-Type: application/json" \
  --data '{
    "customer": { "display_name": "Studio North", "email": "billing@studionorth.example" },
    "amount": "1250.00",
    "currency": "USD",
    "due_date": "2026-10-15",
    "external_reference": "INV-1042"
  }'

Bu şekilde oluşturulan yeni müşterilerin, hatırlatma gönderilebilmesi için yine uygulamada iletişim bilgilerinin doğrulanması ve izninin kaydedilmesi gerekir.

Taslak alacağı güncelleme

PATCH /v1/receivables/{id} bir taslağı değiştirir. expected_version (en son okuduğunuz version) ile birlikte değiştirilecek en az bir alan gönderin: customer_id, amount, currency, due_date, external_reference veya description.

BASH
curl https://api.remindcash.com/v1/receivables/1 \
  --request PATCH \
  --header "Authorization: Bearer $REMINDCASH_API_KEY" \
  --header "Idempotency-Key: update-inv-1042-0001" \
  --header "Content-Type: application/json" \
  --data '{
    "expected_version": "4e6fea39ae2fab8ccb843657f081d276513739a71787c060a007b65e3acbbbc1",
    "due_date": "2026-10-20"
  }'

Yanıt güncellenmiş alacağı ve yeni version değerini içerir. Güncelleme şu durumlarda 409 conflict döndürür:

  • expected_version artık eşleşmiyorsa (başka biri önce değiştirdiyse),
  • alacak artık taslak değilse,
  • bir tekrarlayan serinin dönemiyse,
  • bir ödeme varken müşteriyi, tutarı veya para birimini değiştirmeye çalışırsanız.