Ana içeriğe atla
Cari; müşteri, tedarikçi ya da her ikisi olan firma veya kişidir. Cari kartı ana alanlardan ve bunlara bağlı alt kayıtlardan (adres, telefon, banka hesabı, …) oluşur.

Zorunlu alanlar

string
gerekli
Şirket içinde benzersiz cari kodu. Oluştururken "Next" gönderirseniz kod otomatik üretilir.
string
gerekli
Cari adı.
string
gerekli
Sadece rakam: 10 haneli vergi kimlik numarası (VKN) ya da 11 haneli T.C. kimlik numarası (TCKN).

Genel alanlar

Risk

API yalnızca RiskAction 2 olduğunda denetler; 0 ve 1 hiçbir isteği engellemez. 2 iken bu cari için cari hareketli satış siparişi, satış faturası ve alış iade faturası limiti aşıyorsa reddedilir (siparişte 6020, faturada 3028). Limit şirketin varsayılan dövizindedir; diğer dövizlerdeki tutarlar belgenin kuruyla çevrilir.
  • RiskControl 1 (mevcut bakiye): carinin bakiyesi (tüm cari hareketlerin borcu eksi alacağı) ile belgenin tutarının toplamı limiti aşıyorsa reddedilir.
  • RiskControl 2 (satış tutarı): yalnızca belgenin tutarı limiti aşıyorsa reddedilir; bakiyeye bakılmaz.

E-fatura

E-fatura etiketleri (posta kutusu alias’ları) API ile gönderilmez. Oluştururken QueryEInvoiceLabels: true gönderirseniz etiketler entegratörden sorgulanıp kaydedilir. Ayrıntılar aşağıda, E-fatura etiketleri bölümündedir.

Not

Note alanındaki not, aşağıdaki bayraklarla belgelerde gösterilebilir. Bayraklardan biri true ise Note zorunludur. Gönderilmeyen bayraklar false kabul edilir. ShowNoteOnQuote (teklif), ShowNoteOnOrder (sipariş), ShowNoteOnDespatch (irsaliye), ShowNoteOnInvoice (fatura)

Kimlik şemaları

IdentitySchemes, UBL kimlik şemalarına göre ek tanımlayıcılar tutar (e-belgelerde kullanılır).
Her SchemeID en fazla bir kez gönderilebilir ve Value boş olamaz. Geçerli SchemeID değerleri: VKN, TCKN, HIZMETNO, MUSTERINO, TESISATNO, TELEFONNO, DISTRIBUTORNO, TICARETSICILNO, TAPDKNO, BAYINO, ABONENO, SAYACNO, EPDKNO, SUBENO, PASAPORTNO, URETICINO, CIFTCINO, IMALATCINO, DOSYANO, HASTANO, MERSISNO, ARACIKURUMVKN, ARACIKURUMETIKET, GTB_REFNO, GCB_TESCILNO, GTB_FIILI_IHRACAT_TARIHI, ARACKIMLIKNO, PLAKA, SEVKIYATNO

Alt kayıtlar

Carinin alt kayıtları iki şekilde yönetilir:
  • Cari oluştururken: POST /customers gövdesindeki listelerle, cariyle aynı işlemde. Herhangi bir kayıt hatalıysa cari de oluşmaz.
  • Sonradan: Her alt kaydın kendi endpoint’leriyle (/customers/{customerId}/addresses vb.). Bu endpoint’ler listeleme, detay, ekleme, güncelleme ve silme sunar.
Cari güncelleme alt kayıtları değiştirmez. Alt kayıtları kendi endpoint’leriyle güncelleyin. Cari kullanıcıya görünmüyorsa tüm alt kayıt endpoint’leri 404 döner.
Alt kayıtlar da PUT ile tamamen, PATCH ile kısmen güncellenir. Bkz. Kısmi güncelleme.

Adresler

/customers/{customerId}/addresses Yanıttaki FullAddress alanı ilçe, il ve ülkeyle birleştirilmiş tam adrestir ve sadece okunur.

Fatura adresi kuralları

Bir carinin her zaman tam olarak bir fatura adresi vardır.
  • Cari oluştururken tek adres gönderilirse o adres fatura adresi olur. Birden fazla adres gönderilirse tam olarak birinde IsInvoiceAddress: true olmalıdır.
  • Adres eklerken carinin ilk adresi her zaman fatura adresi olur. IsInvoiceAddress: true ile eklenen yeni adres fatura adresi olur ve önceki adresin işareti kaldırılır.
  • Fatura adresinin işareti güncelleme ile kaldırılamaz ve fatura adresi silinemez. Önce başka bir adresi fatura adresi yapın.

Telefonlar

/customers/{customerId}/telephones

Linkler

/customers/{customerId}/links

Yetkililer

/customers/{customerId}/representatives

Banka hesapları

/customers/{customerId}/bank-accounts Iban ya da Branch ile AccountNumber birlikte gönderilmelidir.

Grup üyelikleri

/customers/{customerId}/group-members
  • Bir cari aynı grup detayına yalnızca bir kez üye olabilir.
  • Bazı gruplar zorunlu olarak tanımlanmış olabilir. Cari oluştururken her zorunlu gruptan en az bir detay gönderilmelidir. Bu kontrol yalnızca oluşturmada yapılır; üyelik silinirken kontrol edilmez.

Parametreler

/customers/{customerId}/parameters Yanıttaki ParameterType tanımın tipini, Value bu tipe uygun değeri gösterir.

E-fatura etiketleri

E-fatura etiketleri (GİB posta kutusu alias’ları) API ile gönderilemez, sadece okunur. Cari oluştururken QueryEInvoiceLabels: true gönderirseniz cari kaydedildikten sonra etiketler e-fatura entegratöründen TaxNumber ile sorgulanır:
  • Bulunan etiketler kaydedilir, ilki varsayılan olarak işaretlenir.
  • Sorgu başarısız olursa cari yine de oluşturulur; etiketler boş kalır ve yanıttaki Message etiketlerin sorgulanamadığını bildirir. Vergi numarası için etiket bulunamazsa da Message bunu belirtir.
Etiketler cari detayında EInvoiceLabels listesinde döner.

Örnek

POST /api/v1/customers

Silme

Cari silindiğinde adresleri, telefonları, linkleri, yetkilileri, banka hesapları, e-fatura etiketleri, grup üyelikleri ve parametreleri de tek işlemde silinir. Fatura, sipariş gibi belgeler etkilenmez; silinen cari artık API’de görünmez.