Ana içeriğe atla
POST
İrsaliye oluştur
İrsaliye, satırları, satırların indirimleri ve satırların Lot/seri no girdileri tek bir işlemde (transaction) yazılır: herhangi biri geçersizse hiçbir şey kaydedilmez ve bütün hatalar tek bir Message içinde döner. Satır hataları satır numarasıyla başlar, örneğin Line 2: Quantity must be greater than 0.

Alan kuralları

Zorunlu alanlar, cariden alınan bilgiler, satırlar, Lot/seri no takibi.

Hesaplamalar

Tutar ve toplamların nasıl hesaplandığı (irsaliye satırları sipariş/teklif satırlarıyla aynı alanları kullanır).
API satır tutarlarını hesaplamaz, ama birbirini tuttuğunu denetler (7124); bkz. hesaplamalar. İrsaliye toplamları ve AverageExchangeRate satırlardan doldurulur, her satırın ana birim miktarı API tarafından hesaplanır ve bir satırın Lot/seri no girdilerinin toplamı Quantity’sine eşit olmalıdır. UnitPrice’ı KDV hariç gönderin.
  • DespatchNumber yerine "Next" gönderirseniz numara otomatik üretilir: giriş (ALİRSNO) ya da çıkış (SATİRSNO) serisi, ya da şirket e-irsaliye kullanıyorsa çıkış irsaliyesi için şirketin e-irsaliye numaralandırması.
  • Carinin adresi, unvanı, vergi numarası ve vergi dairesi CustomerCode’dan kopyalanır, istekte gönderilmez.
  • Başarılı yanıt 201 Created’dır; Location header’ı yeni irsaliyeyi gösterir.

Asgari istek

Yalnızca zorunlu alanlarla çalışan bir istek; satır tutarları birbirini tutar (API bunu denetler), başlık toplamları satırlardan doldurulur. Kod ve adları kendi şirketinizdekilerle değiştirin. Lot ya da seri no izlenen bir üründe satır Lots ya da SerialNumbers da taşımalıdır.

Hata kodları

Bu endpoint’in dönebileceği kodlar. Her endpoint için geçerli olan genel hatalar (kimlik doğrulama, yetki, istek header’ları, istek limitleri) burada tekrarlanmaz.

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

Gövde

DespatchType
integer<int32>
gerekli

Zorunlu. 2: Giriş irsaliyesi (mal kabul), -2: Çıkış irsaliyesi (sevk). İrsaliye oluşturulduktan sonra değiştirilemez.

Örnek:

-2

DespatchNumber
null | string
gerekli

Zorunlu. İrsaliye numarası, şirkette aynı DespatchType içinde benzersizdir. Oluştururken "Next" gönderirseniz otomatik üretilir: tipin numara serisinden, ya da çıkış irsaliyesinde şirket e-irsaliye kullanıyorsa e-irsaliye numaralandırmasından. En fazla 20 karakter.

Örnek:

"IRS2026000125"

Date
null | string<date-time>
gerekli

Zorunlu. İrsaliye tarihi. Tarih kısmı irsaliye tarihi olarak kaydedilir; saat gönderilirse irsaliye saati olarak, gönderilmezse o anki saat kullanılır.

Örnek:

"2026-09-21T10:30:00"

CustomerCode
null | string
gerekli

Zorunlu. Cari kodu (GET /api/v1/customers üzerinden carinin CustomerCode değeri). İrsaliyenin adresi, unvanı ve vergi alanları, kaydedildiği anda cariden kopyalanır (carinin fatura adresi varsa o, yoksa ilk adresi) ve istekte gönderilmez.

Örnek:

"C-0001"

Lines
object[]
gerekli

Zorunlu, en az bir satır. Satırlar irsaliye oluşturulduktan sonra değiştirilemez.

DocumentNumber
null | string

Belge numarası (serbest metin). En fazla 100 karakter.

Örnek:

"2026-15"

ActualDispatchDate
null | string<date>

Fiili sevk tarihi. Yalnızca tarih (yyyy-MM-dd), saat içermez.

Örnek:

"2026-10-15"

Description
null | string

Açıklama. En fazla 1000 karakter.

DueDays
integer<int32>

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

Örnek:

30

SharingCode
null | string

İrsaliyeyi kimlerin görebileceğini sınırlayan paylaşım kodu. Boşsa herkes görür; doluysa kullanıcının paylaşım kodlarından biri olmalıdır.

ShipmentDefinitionCode
null | string

GET /api/v1/definitions/shipment-definitions'tan sevkiyat tanımı kodu.

DiscountTotal
number<double>

Toplam indirim: satırların DiscountAmount toplamı. Satırlardan doldurulur; istekte gönderilen değer kullanılmaz.

Örnek:

100

SubTotal
number<double>

Ara toplam: satırların AmountExcludingTax toplamı. Satırlardan doldurulur; istekte gönderilen değer kullanılmaz.

Örnek:

900

VatTotal
number<double>

Tevkifat sonrası toplam KDV: satırların VatAmount toplamından WithholdingTotal düşülür. Satırlardan doldurulur; istekte gönderilen değer kullanılmaz.

Örnek:

225

AdditionalTaxTotal
number<double>

Toplam ek vergi: satırların ek vergi tutarlarının toplamı. Satırlardan doldurulur; istekte gönderilen değer kullanılmaz.

Örnek:

225

WithholdingTotal
number<double>

Toplam tevkif edilen KDV: satırların WithheldVatAmount toplamı. Satırlardan doldurulur; istekte gönderilen değer kullanılmaz.

Örnek:

0

GrandTotal
number<double>

Genel toplam: satırların AmountIncludingTax toplamından WithholdingTotal düşülür. Satırlardan doldurulur; istekte gönderilen değer kullanılmaz.

Örnek:

1350

AverageExchangeRate
number<double>

Ağırlıklı ortalama kur: bütün satırların dövizi aynıysa Σ(AmountExcludingTax × ExchangeRate) / Σ AmountExcludingTax; satırların dövizleri farklıysa 1'dir ve toplamlar her satırın ExchangeRate'iyle varsayılan dövize çevrilir. Satırlardan doldurulur; istekte gönderilen değer kullanılmaz.

Örnek:

1

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.