Ana içeriğe geç

Cari Hesap Listeleme

  • Endpoint: /vendor/currentAccount
  • HTTP Method: GET
  • Request Content-Type: application/json
  • Response Content-Type: application/json
  • Yetkilendirme: Geçerli AccessToken zorunludur.
    (Bkz: 2. Kimlik Doğrulama – AccessToken Alınması)

Açıklama

Bu servis, sistemde tanımlı tüm cari hesap kayıtlarını listelemek için kullanılır. İsteğe bağlı olarak dealerCode parametresi gönderilerek belirli bir bayiye ait hesaplar filtrelenebilir.

Sonuçlar sayfalandırma (pagination) desteğiyle döndürülür.

Not: Bu endpoint yalnızca listeleme amaçlıdır. Yeni kayıt oluşturma veya güncelleme işlemi bu servis üzerinden yapılamaz.

Header Bilgileri

Header AdıZorunluAçıklama
AuthorizationEvetBearer {AccessToken} formatında geçerli token
Content-TypeEvetapplication/json

Query Parametreleri

ParametreTipZorunluAçıklama
dealerCodestringHayırBelirtilirse sadece ilgili bayiye ait cari hesaplar listelenir.
pageintegerHayırGetirilecek sayfa numarası (varsayılan: 1).
pageSizeintegerHayırSayfa başına kayıt sayısı (varsayılan: 10, maksimum: 100).

Örnek Request
GET /vendor/currentAccounts?dealerCode=VEND001&page=1&pageSize=20

Başarılı Response (200 OK)

{  
"isSuccess": true,
"message": "Kayıtlar başarıyla listelendi.",
"totalCount": 2,
"page": 1,
"pageSize": 20,
"data": [
{
"code": "CA-001",
"currencyCode": "USD",
"currentAccountType": "Müşteri",
"customerOrDealerCode": "CUST-123",
"customerOrDealerName": "ABC Ltd.",
"description": "Yurt dışı müşteri hesabı",
"erpCode": "ERP-ACC-001",
"isVisibleOnPayment": true,
"accountName": "ABC Ltd. Dış Ticaret",
"taxNumber": "00000000000",
"tcknNumber": null,
"title": "Ana Müşteri Hesabı"
},
{
"code": "CA-002",
"currencyCode": "TRY",
"currentAccountType": "Bayi",
"customerOrDealerCode": "VEND-456",
"customerOrDealerName": "XYZ Bayi",
"description": "İç piyasa bayi hesabı",
"erpCode": "ERP-ACC-002",
"isVisibleOnPayment": false,
"accountName": "XYZ Ticaret",
"taxNumber": "00000000000",
"tcknNumber": null,
"title": "Bayi Hesabı"
}
]
}

Notlar & En İyi Uygulamalar

  • dealerCode gönderilmezse, sistemdeki tüm cari hesaplar listelenir.
  • page ve pageSize parametreleri ile sayfalandırma yapılabilir; büyük veri setlerinde performans için önerilir.
  • totalCount değeri, filtrelenmiş toplam kayıt sayısını döndürür.
  • isVisibleOnPayment = true olan hesaplar, ödeme ekranlarında görüntülenebilir.
  • Her yanıt, isSuccess ve message alanlarını içerir.
  • Token süresi dolmuşsa istek 401 Unauthorized döner; yeni token alınmalıdır.