Hesap Durumu

GET /v1/integrations/account-status

Mükellefin e-belge kurulumunun tamamlanıp tamamlanmadığını ve kontör durumunu döner. Bunu ilk fatura kesiminde 412 ya da 402 alarak öğrenmek zorunda değilsiniz — kesmeden önce sorun.

İstek

curl https://sandbox-api.finansfatura.com/v1/integrations/account-status \
  -H "X-Api-Key: $FF_KEY"

Scope: invoice:read. Hem API anahtarı hem OAuth erişim jetonuyla çağrılır.

Yanıt

200 OK

{
  "data": {
    "email_verified": true,
    "edocument_checked": true,
    "edocument_ready": true,
    "credit_known": true,
    "credit_remaining": 142,
    "can_topup_in_app": true
  }
}

Alan	Açıklama
email_verified	Mükellef e-posta adresini doğruladı mı.
edocument_checked	Aşağıdaki iki alanı okuyabildik mi. false ise "hazır değil" değil, "şu an okuyamadık" demektir — engelleyici saymayın.
edocument_ready	e-Belge bağlantısı kurulmuş, fatura kesilebilir.
credit_known	Kontör bilgisini okuyabildik mi.
credit_remaining	Kalan kontör adedi.
can_topup_in_app	Mükellef kontörü panel üzerinden yükleyebilir mi.

edocument_checked: false bir hata değildir

Bu alan "bilgiye şu an ulaşamadık" demektir, genelde geçici bir durumdur. edocument_ready alanını buna göre yorumlamayın — tekrar sorgulayın.

Ne zaman kullanılır

• Mükellef bağlandıktan hemen sonra, ilk fatura kesiminden önce
• Entegrasyonunuzda "e-belge kurulumu tamamlanmadı, lütfen panelden tamamlayın" gibi bir uyarı göstermek için
• Kontör bitmeden önce mükellefi uyarmak için (credit_remaining düşükse)

Bakiye için ayrıca GET /v1/wallet/me de OAuth jetonuyla çağrılabilir (balance_units, available, remaining_balance, can_topup, active).

Kurulum uçlarının kendisi kapalıdır

Onboarding/kurulum akışının kendisi bilinçli olarak yalnız panel oturumuna açıktır: makine istemcisi kiracı yapılandırmasını okuyamaz/yazamaz (403 feature_not_enabled / ERROR_API_KEY_NOT_ALLOWED). Bu uç yalnız durumu okur, kurulumu başlatmaz veya değiştirmez.

İlgili hatalar

İlk fatura kesiminde bu durumları önceden görmediyseniz karşılaşabileceğiniz kapılar için bkz. Hata Kodları.