Skip to main content
PATCH
İrsaliyeyi kısmi güncelle
Gövdede yalnızca değiştirmek istediğiniz alanları gönderirsiniz; gönderilmeyen alanlar mevcut değerini korur. Kurallar ve örnekler: kısmi güncelleme.
  • Gönderilmeyen alan değişmez; null gönderilen alan temizlenir.
  • Doğrulama birleştirilmiş kayıt üzerinde çalışır; zorunlu bir alanı null yaparsanız istek reddedilir.
  • Listeler birleştirilmez: Lines gönderilirse irsaliyenin bütün satırlarını değiştirir, tam güncellemedeki aynı satır kimliği kuralıyla; gönderilmezse satırlar olduğu gibi kalır.
  • API toplamları yeniden hesaplamaz: satırları ya da tutarları değiştirirseniz ilgili toplamları da gönderin.

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

Gerekli aralık: x >= 1

Yol Parametreleri

waybillId
string<uuid>
gerekli

İrsaliye ID'si.

Gövde

WaybillType
integer<int32>

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

Örnek:

-2

WaybillNumber
null | string

Zorunlu. İrsaliye numarası, şirkette aynı WaybillType 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:

"9446A4D834"

DocumentNumber
null | string

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

Örnek:

"2026-15"

Date
null | string<date-time>

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"

ActualDispatchDate
null | string<date-time>

Fiili sevk tarihi.

Description
null | string

Açıklama. En fazla 1000 karakter.

CustomerCode
null | string

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"

CurrencyCode
null | string

Zorunlu. GET /api/v1/definitions/currencies'ten döviz kodu.

Örnek:

"TRY"

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 tutarı. Entegratör tarafından gönderilir, API hesaplamaz.

Örnek:

0

SubTotal
number<double>

Ara toplam (satır tutarlarının vergisiz toplamı). Entegratör tarafından gönderilir, API hesaplamaz.

Örnek:

1000

VatTotal
number<double>

Toplam KDV tutarı. Entegratör tarafından gönderilir, API hesaplamaz.

Örnek:

200

AdditionalTaxTotal
number<double>

Toplam ek vergi tutarı. Entegratör tarafından gönderilir, API hesaplamaz.

Örnek:

0

WithholdingTotal
number<double>

Toplam tevkifat tutarı. Entegratör tarafından gönderilir, API hesaplamaz.

Örnek:

0

GrandTotal
number<double>

Genel toplam. Entegratör tarafından gönderilir, API hesaplamaz.

Örnek:

1200

AverageExchangeRate
number<double>

Satırların ağırlıklı ortalama kuru. Entegratör tarafından gönderilir, API hesaplamaz. Her şey şirketin varsayılan dövizindeyse 1 kullanın.

Örnek:

1

Lines
object[]

Zorunlu, en az bir satır. Güncellemede satırların gönderildiği sıra kimliklerini belirler: mevcut bir satırla aynı sırada gönderilen satır o satır kabul edilir (Lot/seri no ve sipariş bağlantısı kayıtları onunla birlikte taşınır), daha kısa bir liste sondaki satırları kaldırır, daha uzun bir liste sona yeni satırlar ekler.

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.