e-İrsaliye

Giden İrsaliye

Giden İrsaliye Entegratör API

Giden irsaliye oluşturma, güncelleme, gönderme, sorgulama, çıktı ve durum endpointleri.

Çağrı Haritası

Entegratör yüzeyi /api/VbtApi altında çalışır. Normal endpointler doğrudan JSON request modelini alır. ByXml varyantları aynı modelin XML serileştirmesini XmlRequestModel.XmlModel içinde alır; hazır UBL dosyası kullanan ByUbl akışı ise ayrı bir sözleşmedir.

Üç giriş biçimi: JSON için AddOutgoingDespatchAdvice, platform model XML'i için AddOutgoingDespatchAdviceByXml, hazır UBL-TR DespatchAdvice dosyası için AddOutgoingDespatchAdviceByUbl kullanılır. Platform XML modeli cac:/cbc: UBL elemanlarını değil, OutgoingDespatchAdviceRequestModel alan adlarını taşır.
AmaçMethod ve endpointRequestResponse / ana çıktı
ÖnizlemePOST /api/VbtApi/OutgoingDespatchAdvicePreviewOutgoingDespatchAdviceRequestModelDoğrulama ve görsel önizleme sonucu
XML model ile önizlemePOST /api/VbtApi/OutgoingDespatchAdvicePreviewByXmlXmlRequestModel; içeride OutgoingDespatchAdviceRequestModel XML'iXML serileştirilmiş önizleme sonucu
Hazır UBL önizlemePOST /api/VbtApi/OutgoingDespatchAdviceUblPreviewDespatchAdviceUblRequestModelUBL doğrulama ve önizleme
JSON ile oluşturmaPOST /api/VbtApi/AddOutgoingDespatchAdviceOutgoingDespatchAdviceRequestModelETTN, belge numarası, hata listesi
XML model ile oluşturmaPOST /api/VbtApi/AddOutgoingDespatchAdviceByXmlXmlRequestModel; içeride OutgoingDespatchAdviceRequestModel XML'iXML serileştirilmiş ETTN, belge numarası ve hata listesi
UBL ile oluşturmaPOST /api/VbtApi/AddOutgoingDespatchAdviceByUblDespatchAdviceUblRequestModelETTN, belge numarası, hata listesi
GüncellemePOST /api/VbtApi/UpdateOutgoingDespatchAdvice / UpdateOutgoingDespatchAdviceByXmlJSON model veya XmlRequestModelGüncelleme sonucu
SilmePOST /api/VbtApi/DeleteOutgoingDespatchAdviceOutgoingDespatchAdviceDeleteRequestModelSilme sonucu
GİB'e göndermePOST /api/VbtApi/SendOutgoingDespatchAdviceToGibOutgoingDespatchAdviceSendToGibRequestModelGönderim kabul sonucu
Fiili sevk tarihiPOST /api/VbtApi/UpdateOutgoingActualDespatchDateOutgoingActualDespatchDateUpdateRequestModelGüncelleme sonucu
Durum özetiPOST /api/VbtApi/GetOutgoingDespatchAdvicesStatusEttnList[]ETTN bazlı durumlar
ListelemePOST /api/VbtApi/GetOutgoingDespatchAdviceListSearchRequestModel<OutgoingDespatchAdviceGetRequestModel>Sayfalı belge listesi
DetayGET /api/VbtApi/GetOutgoingDespatchAdvice?id={id}Query: idGiden irsaliye modeli

JSON ve XML karşılıklarını yan yana kopyalamak için Giden İrsaliye Request Örnekleri sayfasını kullanın. XML panelindeki içerik doğrudan XmlModel değeridir; SOAP istemcisi bunu Request<XmlRequestModel> içindeki alana, REST istemcisi ise XmlRequestModel gövdesine yerleştirir.

Hazır UBL Sözleşmesi

AlanZorunluluk / biçimKontrol
DespatchAdviceExternalIdBoş olmayan, ERP'de tekil dış referansTimeout sonrası aynı belgeyi bulmak için saklayın.
ReceiverIdentifierAlıcının GİB posta kutusu etiketiUBL içindeki alıcı kimliğiyle aynı mükellefe ait olmalıdır.
FileBytesXML veya ZIP dosyasının JSON Base64 değeriDosya UBLVersionID=2.1 ve CustomizationID=TR1.2.1 taşımalıdır.
IsZippedtrue: ZIP, false: doğrudan XMLİşaret gerçek byte biçimiyle aynı olmalıdır.
IsSignedYalnız dosya gerçekten imzalıysa trueOluşturmada imza doğrulanır. Güncelleme ve önizleme aynı imza kabul sözleşmesini sağlamaz; işlem bazındaki sınırları uygulayın.
MailTo, FirmBranchCodeBildirim ve şube ihtiyacına göreŞubeli firmada geçerli şube kodu gönderilmelidir.

Hazır UBL için OutgoingDespatchAdviceUblPreview içeriğin modele dönüştürülüp yeniden üretildiği bir önizlemedir; başarılı sonuç, özgün dosyanın imzasının doğrulandığını göstermez. Oluşturma, güncelleme ve önizleme için JSON / platform XML / UBL örnekleri ve imza davranışı tablosu birlikte kullanılmalıdır.

İDİS gönderimi: Hazır UBL’de sevkiyat numarası DespatchSupplierParty altında SEVKIYATNO kimliğiyle taşınır. Hedef ortamda İDİS UBL giriş desteği teyit edilmediyse JSON veya ByXml kullanın. Veri kaynağı ve gönderim koşulları.

Kritik İşlem Önkoşulları

İşlemÖnkoşulBaşarılı sonuçSonraki kontrol / gözlenebilir hata
AddOutgoingDespatchAdvice / ByXml / ByUblDış referans tekil; içerik, şema ve şematron geçerli olmalıdır.ETTN ve belge numarası döner.ETTN'yi saklayın; durum sorgusuna geçin.
UpdateOutgoingDespatchAdviceBelge GİB'e tamamlanmış biçimde iletilmemiş ve terminal alıcı sonucuna ulaşmamış olmalıdır.Mevcut ETTN, belge numarası ve dış referans korunarak içerik güncellenir.Uygun olmayan durumda DSP0087; ardından önizleme ve durum kontrolü yapın.
DeleteOutgoingDespatchAdviceETTN, dış referans veya belge numarasından biriyle kayıt seçilir. Silme yalnız GİB teslimi tamamlanmadan önce mümkündür.Kayıt silme sonucu true olur.Uygun olmayan durumda DSP0024; aktif gönderim sürerken COM0017 alınabilir.
SendOutgoingDespatchAdviceToGibBelge imzalanmış ve gönderime uygun durumda olmalıdır.Gönderim isteği kabul edilir; kullanıcı durumu Sending olur.İmzasız belgede DSP0101; sonuç için toplu durum endpointini izleyin.
UpdateOutgoingActualDespatchDateETTN ve geçerli tarih bulunmalı; belge henüz GİB teslimi/terminal yanıt aşamasına geçmemiş olmalıdır.UBL içindeki fiili sevk tarihi güncellenir.Uygun olmayan durumda DSP0087; güncel belgeyi yeniden okuyun.
GetOutgoingDespatchAdvicesStatusEn az bir ETTN gönderilmelidir.Her ETTN için teknik ve kullanıcı durumu döner.Terminal olmayan kayıtları kontrollü aralıkla yeniden sorgulayın.

Belge Çıktıları

ÇıktıEndpointRequest alanı
GörselPOST GetOutgoingDespatchAdviceViewEttn, isteğe bağlı IsRead
PDFPOST GetOutgoingDespatchAdvicePdfDespatchAdviceEttns[]
Özel PDFPOST GetOutgoingDespatchAdviceCustomPdfDespatchAdviceEttns[]
UBL XMLPOST GetOutgoingDespatchAdviceXmlListDespatchAdviceEttns[]
İndirme bağlantısıPOST GetOutgoingDespatchAdviceDownloadUrlBelge seçim modeli
KarekodPOST GetQrCodeBelge karekod modeli

Liste Filtreleri

Query içinde düzenleme ve zarf tarihi aralıkları, zarf kimliği, dış referans, ETTN, belge numarası, taraf adı, VKN/TCKN ve kullanıcı durumu gönderilebilir. Dış sarmalda Skip, Take, OrderByName ve OrderByType bulunur; Take en fazla 100'dür.

Durum İzleme Kuralı

Oluşturma ve gönderim cevapları ara sonuçtur. ETTN'yi saklayın, GetOutgoingDespatchAdvicesStatus ile toplu sorgulayın ve yalnız Approved, PartiallyApproved veya Rejected gibi terminal kullanıcı durumlarında ERP iş akışını kapatın. Hata durumlarında aynı belgeyi yeni kimlikle oluşturmadan önce güncel durumu alın.

Tam Endpoint Envanteri

XML sözleşmesini kullanan işlemler, aynı adın ByXml son ekli varyantıdır. Aşağıdaki envanter giden irsaliye yüzeyindeki tüm çağrıları işlem ailesine göre gösterir.

İşlem ailesiJSON / UBL endpointleriXML varyantları
OluşturmaAddOutgoingDespatchAdvice, AddOutgoingDespatchAdviceByUbl, AddOutgoingDespatchAdviceByExcelAddOutgoingDespatchAdviceByXml
GüncellemeUpdateOutgoingDespatchAdvice, UpdateOutgoingDespatchAdviceByUblUpdateOutgoingDespatchAdviceByXml
Detay ve silmeGetOutgoingDespatchAdvice, DeleteOutgoingDespatchAdviceGetOutgoingDespatchAdviceByXml, DeleteOutgoingDespatchAdviceByXml
ListelemeGetOutgoingDespatchAdviceList, GetOutgoingDespatchAdviceNotErpProccessListGetOutgoingDespatchAdviceListByXml, GetOutgoingDespatchAdviceNotErpProccessListByXml
Görsel/PDFGetOutgoingDespatchAdviceView, GetOutgoingDespatchAdvicePdf, GetOutgoingDespatchAdviceCustomPdfGetOutgoingDespatchAdviceViewByXml, GetOutgoingDespatchAdvicePdfByXml, GetOutgoingDespatchAdviceCustomPdfByXml
UBL XMLGetOutgoingDespatchAdviceXmlListGetOutgoingDespatchAdviceXmlListByXml
KalemlerGetOutgoingDespatchAdviceLines, GetOutgoingDespatchAdviceLinesList, GetListOutgoingDespatchAdviceLinesGetListOutgoingDespatchAdviceLinesByXml
GönderimSendOutgoingDespatchAdviceToGibSendOutgoingDespatchAdviceToGibByXml
Fiili sevkUpdateOutgoingActualDespatchDateUpdateOutgoingActualDespatchDateByXml
ÖnizlemeOutgoingDespatchAdvicePreview, OutgoingDespatchAdviceUblPreviewOutgoingDespatchAdvicePreviewByXml
Durum/ERPGetOutgoingDespatchAdviceStatusList, GetOutgoingDespatchAdvicesStatus, UpdateOutgoingDespatchAdviceErpProcessStatusUpdateOutgoingDespatchAdviceErpProcessStatusByXml
İndirme/karekodGetOutgoingDespatchAdviceDownloadUrl, GetQrCode—
Mükellef sorgusuGetGibDespatchAdviceUser, GetGibDespatchAdviceAllUserListZipGetGibDespatchAdviceUserByXml, GetGibDespatchAdviceAllUserListZipByXml

Giden İrsaliyeye Gelen Yanıt

Alıcının gönderdiği irsaliye yanıtını görsel, PDF, UBL ve indirme bağlantısı olarak almak için GetIncomingReceiptAdviceView, GetIncomingReceiptAdvicePdf, GetIncomingReceiptAdviceXmlList ve GetIncomingReceiptAdviceDownloadUrl kullanılır. İlk üç işlemin ByXml varyantları da bulunur.