Skip to main content
POST
Cari oluştur
Cari ve gönderilen tüm alt kayıtlar tek transaction içinde yazılır: herhangi bir kayıt hatalıysa hiçbir şey kaydedilmez ve tüm hatalar tek Message içinde döner.

Alan kuralları

Zorunlu alanlar, risk, e-fatura ve not kuralları.

Alt kayıtlar

Adres, telefon, banka, grup ve parametre kuralları.
CustomerCode alanına "Next" gönderirseniz kod, şirketin cari numarası serisinden otomatik üretilir. Bkz. Cari kodu üretimi.
İhtiyacınız olmayan alt kayıt listelerini boş dizi ([]) olarak gönderin. Başarılı yanıt 201 Created ile döner ve Location header’ı yeni carinin adresini içerir.

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. Cari endpoint'lerinde isteğe bağlıdır; gönderilirse oluşturulan kayıtlara yazılır.

Gerekli aralık: x >= 1

Gövde

CustomerCode
null | string

Zorunlu. Şirket içinde benzersizdir. Oluştururken "Next" gönderirseniz kod, şirketin cari numarası serisinden üretilir.

Örnek:

"0000382026"

Name
null | string

Zorunlu. Cari adı.

Örnek:

"Örnek Ticaret A.Ş."

TaxNumber
null | string

Zorunlu. Yalnızca rakam: 10 haneli vergi kimlik numarası (VKN) ya da 11 haneli T.C. kimlik numarası (TCKN).

Örnek:

"1234567890"

TaxOffice
null | string

Vergi dairesi adı.

Örnek:

"Kadıköy"

InvoiceTitle
null | string

Faturalarda kullanılan ünvan. Boş bırakılırsa Name alanı kullanılır.

Örnek:

"Örnek Ticaret Anonim Şirketi"

Note
null | string

Serbest metin not. ShowNoteOn* alanlarından biri true ise zorunludur.

Örnek:

"Deliveries on weekdays only."

DueDays
integer<int32>

Gün olarak vade. 0'dan küçük olamaz.

Örnek:

30

DiscountRate
number<double>

Varsayılan iskonto oranı (%), 0 ile 100 arasında.

Örnek:

5

Blacklisted
boolean

Cariyi kara listeye alır.

Örnek:

false

MovementType
integer<int32>

1: Satıcı, 2: Alıcı, 3: Satıcı ve alıcı. 0 gönderilirse 1 olarak kaydedilir.

Örnek:

2

RiskLimit
number<double>

Risk limiti tutarı. 0'dan küçük olamaz. 0, risk limiti yok demektir.

Örnek:

250000

RiskControl
integer<int32>

Risk limitinin nasıl kontrol edileceği. 1: Mevcut bakiye, 2: Satış tutarı. RiskLimit 0'dan büyükse 1 ya da 2 olmalıdır.

Örnek:

1

RiskAction
integer<int32>

Risk limiti aşıldığında ne olacağı. 0: Devam et, 1: Kullanıcıyı uyar, 2: İşlemi durdur.

Örnek:

1

EInvoiceUser
boolean

Carinin e-fatura mükellefi olup olmadığı.

Örnek:

true

EInvoiceScenario
integer<int32>

E-fatura senaryosu. EInvoiceUser true ise 1-9, değilse 0 olmalıdır. 1: Ticari, 2: Temel, 3: İhracat, 4: Kamu, 5: HKS, 6: Enerji, 7: İlaç/Tıbbi cihaz, 8: Yatırım teşvik, 9: IDIS.

Örnek:

1

ShipmentDefinitionId
null | string<uuid>

GET /api/v1/definitions/shipment-definitions ile dönen bir sevkiyat tanımının ID'si.

SharingCodeId
null | string<uuid>

Cariyi kimlerin görebileceğini sınırlayan paylaşım kodu. Boş bırakılırsa herkes görür; doldurulursa kullanıcının paylaşım kodlarından biri olmalıdır.

ShowNoteOnQuote
boolean

Notu tekliflerde göster.

Örnek:

false

ShowNoteOnOrder
boolean

Notu siparişlerde göster.

Örnek:

false

ShowNoteOnWaybill
boolean

Notu irsaliyelerde göster.

Örnek:

true

ShowNoteOnInvoice
boolean

Notu faturalarda göster.

Örnek:

false

IdentitySchemes
object[]

Ek kimlik numaraları (ör. MERSISNO). Her SchemeID yalnızca bir kez gönderilebilir.

Addresses
object[]

Adresler. Birden fazla gönderilirse tam olarak biri fatura adresi olmalıdır. Tek adres gönderilirse o adres fatura adresi olur.

Telephones
object[]

Telefon numaraları.

E-posta adresleri, web siteleri ve sosyal medya linkleri.

Representatives
object[]

Yetkili kişiler.

BankAccounts
object[]

Banka hesapları.

GroupMembers
object[]

Grup üyelikleri. Zorunlu her gruptan en az bir detay gönderilmelidir.

Parameters
object[]

Özel parametre değerleri.

QueryEInvoiceLabels
boolean

true gönderilirse cari kaydedildikten sonra e-fatura etiketleri entegratörden sorgulanır. Sorgu başarısız olsa bile cari oluşmuş kalır.

Örnek:

true

Yanıt

Created

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.