Ana içeriğe atla
Sipariş, bir başlık ve bir ya da daha fazla satırdan oluşur. Alış siparişleri (OrderType 1) ve satış siparişleri (OrderType 2) aynı endpoint’leri kullanır.
API satır tutarlarını hesaplamaz, ama birbirini tuttuğunu denetler. Satır tutarları, indirim tutarları, KDV, ek vergiler ve tevkifat gönderdiğiniz gibi kaydedilir; tutarları Noyax’ın kurallarına uymayan satır reddedilir (6120). Sipariş toplamları ve AverageExchangeRate satırlardan doldurulur; bunlar için gönderilen değerler yok sayılır. Kurallar teklif hesaplamaları sayfasındadır; sipariş satırları teklif satırlarıyla aynı alanlara sahiptir. Satırın ana birim miktarını ve siparişin dövizini (satırlardan türetilir) de API hesaplar. Satırın AdditionalTaxes listesi ürünün ek vergileriyle aynı kurallara uyar: en fazla 3, her Code zorunlu ve listedeki kodlardan biri, bir kod satırda yalnızca bir kez kullanılabilir.

Zorunlu alanlar

  • OrderType: 1 alış siparişi, 2 satış siparişi. Sipariş oluşturulduktan sonra değiştirilemez (6015).
  • OrderNumber: şirkette aynı OrderType içinde benzersiz, en fazla 10 karakter (6002). Oluştururken "Next" gönderilirse numara şirketin numara serisinden üretilir: alış siparişleri için ALSİPNO, satış siparişleri için SATSİPNO. Güncellemede "Next" gönderilemez (6003).
  • Date: sipariş tarihi. Saat de gönderirseniz sipariş saati olarak yazılır, göndermezseniz o anki saat kullanılır.
  • CustomerCode: kullanıcının görebildiği bir cari. Sipariş carinin adresiyle yazılır: carinin fatura adresi varsa o, yoksa ilk adresi.
  • Lines: en az bir satır (6012).
Sipariş dövizi istekte yer almaz: her satır kendi CurrencyCode’unu gönderir. Belgenin dövizi satırlardan türetilir (satırların tek bir dövizi varsa o, birden fazlaysa şirketin varsayılan dövizi) ve yanıtta CurrencyCode olarak döner. AverageExchangeRate de gönderilmez, satırlardan doldurulur (istekte gönderilen değer yok sayılır): satırların hepsi aynı dövizdeyse satır kurlarının tutarla ağırlıklandırılmış ortalaması (AmountExcludingTax × ExchangeRate toplamı / AmountExcludingTax toplamı), dövizler farklıysa 1. Bkz. dövizler. DueDays (vade günü) siparişle birlikte saklanır ve aşağıdaki cari hareketin vadesi için kullanılır; hareketin kuru siparişin satırlardan doldurulan AverageExchangeRate değeridir.

Cari hareket

CreateCustomerMovement alanı siparişin carinin hesabına yansıyıp yansımayacağını belirler. Ayrı bir istek ya da alan göndermeniz gerekmez, hareket siparişle birlikte, aynı işlemde yazılır. true iken sipariş tutarı (satırlardan doldurulan GrandTotal) carinin hesabına şu şekilde yazılır: Hareketin tarihi, saati, belge numarası (sipariş no), açıklaması, dövizi (CurrencyCode) ve kuru (AverageExchangeRate) siparişten alınır. Vade tarihi Date + DueDays’tir; DueDays 0 ise vade tarihi boş kalır. Yanıtta CreateCustomerMovement, siparişin bir cari hareketi olup olmadığını gösterir. Güncellemede hareket, isteğe göre eşitlenir:
Hareket bir tahsilat ya da ödeme ile kapatılmışsa (kısmen olsa bile) bu hareketin carisi, dövizi ve tutarı değiştirilemez, hareket silinemez ve hareketi olan sipariş silinemez. İşlem iptal edilir ve şu hatalardan biri döner: alış siparişi için 6016, satış siparişi için 6017. Tutarı, dövizi ve carisi aynı kalan bir güncelleme kapatılmış hareketi etkilemez, kabul edilir.
Satış siparişinin cari hareketi, carinin RiskAction değeri 2 ise carinin risk limitine karşı da denetlenir; limiti aşacak sipariş 6020 ile reddedilir. Alış siparişleri denetlenmez. Güncellemede denetim yalnızca cari değiştiğinde ya da tutar arttığında çalışır.

Onay ve durum

Sipariş oluşturulurken aşağıdakiler otomatik atanır, bunlar için istekte bir alan yoktur:
  • Onaylar: Şirketin aktif sipariş onay tanımlarından, GrandTotal tutarı tanımın asgari tutarından büyük olan ve sipariş tipine uyan (tanım hem alış hem satış için ya da yalnızca siparişin tipi için geçerli) her biri için sıra numarasına göre “beklemede” bir onay kaydı oluşur.
  • Durum: Şirketin varsayılan sipariş durumu tanımlıysa sipariş bu durumla başlar. Tanımlı değilse durum boş kalır.
Yanıttaki StatusId ve StatusName siparişin güncel durumunu gösterir. Güncelleme ve kısmi güncelleme onayları ve durumu değiştirmez, onaylar GrandTotal değişse bile yeniden hesaplanmaz.

Satırlar

  • Ürün ProductCode (ürün kodu) ya da ECommerceProductCode (e-ticaret entegrasyon kodu) ile verilir; ikisinden biri zorunludur. İkisi de gönderilirse ProductCode kullanılır. UnitCode zorunludur. Birim, ürünün kendi birimlerinden biri olmalıdır (ana birimi ya da 2./3. birimi).
  • Quantity sıfırdan büyük olmalı; UnitPrice negatif olamaz ve KDV hariç olmalıdır. VatIncluded yok sayılır (mevcut istekler çalışmaya devam etsin diye kabul edilir).
  • CurrencyCode her satırda zorunludur. ExchangeRate, satırın dövizi şirketin varsayılan döviziyse 1 olmalı; değilse zorunlu ve 0’dan büyük olmalıdır.
  • Discounts, satırın indirim oranlarının listesidir. Liste sırasıyla art arda uygulanır: 10, 10 ve 10 satırda %27,1’lik indirim eder. Satırda indirim yoksa liste boş bırakılır.
  • LineGroupName isteğe bağlıdır ve satır grupları tanımından gelir.
  • WarehouseName isteğe bağlıdır ve şirketin depolarından biri olmalıdır (6112).
  • Satırların ID’si yoktur: listedeki sıraları siparişteki sıralarıdır ve güncelleme bütün satırları değiştirir.

Ana birim miktarı

Satır miktarı (Quantity) satırın birimindedir. Yanıttaki MainUnitQuantity aynı miktarın ürünün ana birimi cinsinden karşılığıdır ve API tarafından hesaplanır; istekte göndermezsiniz. Satış siparişinde eksi, alış siparişinde artı işaretle döner.
  • UnitCode ürünün ana birimiyse MainUnitQuantity Quantity’ye eşittir.
  • Ürünün 2. ya da 3. birimiyse önce o birimin çarpanı bulunur: üründe o birim için tanımlı miktar, karşı miktara bölünür (karşı miktar 0 ise 1 alınır). MainUnitQuantity = Quantity / çarpan.
Örneğin üründe 2. birim için 100 miktar ve 3 karşı miktar tanımlıysa çarpan 33,33’tür ve 2. birimden 1000 adetlik bir satır 30 ana birim eder. Ürünün ilgili birimi için miktar tanımlı değilse (0) ana birim miktarı hesaplanamaz ve satır 6113 ile reddedilir.

Düzenleme ve silme

Düzenleme ve silme siparişin durumuna ya da başka belgelere (irsaliye, fatura) aktarılmış olmasına göre kısıtlanmaz. Kısıtlar yalnızca şunlardır: kapatılmış cari hareket (yukarıya bakın) ve başka kayıtların (örneğin bir teklif ya da fırsat) bu siparişe bağlı olması (6014).

Paylaşım

SharingCode siparişi kimlerin görebileceğini sınırlar: boşsa herkes görür, doluysa kullanıcının paylaşım kodlarından biri olmalıdır (6011). Kullanıcının göremediği siparişler 404 döner.