Ana içeriğe atla
GET
Carileri listele
Sonuçlar Data.Items içinde döner. pageSize en fazla 50 olabilir; daha büyük bir değer gönderilirse 50 kullanılır. search adında metni içeren ya da cari kodu, vergi numarası veya e-posta adreslerinden biri (e-posta tipindeki linkler) metnin tam kendisi olan carileri bulur. Ayrıntılar için Sayfalama ve arama. Her cari, e-posta adresleri (Emails, e-posta tipindeki linkler), telefon numaraları (Telephones) ve grup üyelikleriyle (GroupMembers) birlikte döner. Diğer alt kayıtlar (adres, yetkili, banka hesabı, …) liste yanıtında yer almaz; bunlar için cari detayı kullanılır.

Hata kodları

Bu endpoint’e özel bir hata kodu yoktur. Her endpoint için geçerli olan genel hatalar (kimlik doğrulama, yetki, istek header’ları, istek limitleri) yine geçerlidir.

Yetkilendirmeler

Authorization
string
header
gerekli

Access token obtained from the Noyax auth service with your API key.

Başlıklar

X-UserID
integer<int32>
gerekli

İsteğin adına yapıldığı Noyax kullanıcısının ID'si. Oluşturulan, güncellenen ve silinen kayıtların denetim alanlarına yazılır.

Gerekli aralık: x >= 1
X-CompanyID
integer<int32>
gerekli

Şirketin ID'si. Kullanıcı bu şirkete tanımlı olmalıdır. Bütün okuma ve yazma işlemleri bu şirketle sınırlıdır.

Gerekli aralık: x >= 1
X-PeriodID
integer<int32>

Muhasebe döneminin ID'si. İsteğe bağlıdır; gönderilirse oluşturulan kayıtlara yazılır.

Gerekli aralık: x >= 1

Sorgu Parametreleri

page
integer<int32>
varsayılan:1

Sayfa numarası, 1'den başlar.

pageSize
integer<int32>
varsayılan:50

Sayfa başına kayıt sayısı (en fazla 50).

Name alanında "içerir" araması; CustomerCode, TaxNumber ve carinin e-posta linklerinde tam eşleşme.

Yanıt

OK

Success
boolean
gerekli

İşlemin başarılı olup olmadığı.

Örnek:

true

ResultCode
string
gerekli

Başarıda "0000". Hatada ilk hatanın kodu; hataların tamamı Errors içinde listelenir.

Örnek:

"0000"

Data
object
gerekli

Response data. Null when Success is false.

Message
null | string

Success false olduğunda hata mesajı. Bütün hataların mesajları tek metinde birleştirilir.