Ana içeriğe geç

setEbookXBRLWithSignature

Genel Bilgi

Özellik Değer
Endpoint Adı setEbookXBRLWithSignature
SOAPAction urn:WebticariService#setEbookXBRLWithSignature
Açıklama Mali mühür veya e-imza ile imzalanmış e-defter XBRL verisini sisteme gönderir. GİB'e bildirim öncesi imzalama adımı için kullanılır.
Kimlik Doğrulama Gerektirir Evet (token)

İstek Parametreleri

Parametre Tip Zorunlu Açıklama
token xsd:string Evet login endpoint'inden alınan oturum token'ı
id xsd:string Evet E-Defter kaydının ID'si
data xsd:string Evet İmzalanmış XBRL verisi
defterTuru xsd:string Evet Defter türü: YD veya DD
donem xsd:string Hayır Dönem bilgisi (örn. 2024-01); boş bırakılırsa aktif dönem kullanılır

Yanıt Parametreleri

Parametre Tip Açıklama
return xsd:string İşlem sonucu

Örnek SOAP İstek

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:tns="urn:WebticariService">
  <soapenv:Header/>
  <soapenv:Body>
    <tns:setEbookXBRLWithSignature>
      <token>abc123tokendeğeri</token>
      <id>1001</id>
      <data><!-- İmzalanmış XBRL içeriği --></data>
      <defterTuru>YD</defterTuru>
      <donem>2024-01</donem>
    </tns:setEbookXBRLWithSignature>
  </soapenv:Body>
</soapenv:Envelope>


Ortak Yanıt XML Yapısı (Tüm eBook Set Endpoint'leri)

<result>
  <success>0|1</success>
  <transactions>
    <transaction>
      <sequenceNumber>1</sequenceNumber>
      <success>0|1</success>
      <message>Açıklama</message>
      <details>
        <detail>Detay</detail>
      </details>
    </transaction>
  </transactions>
</result>
Alan Açıklama
success (kök) Tüm işlemlerin başarı durumu (herhangi biri başarısız ise 0)
sequenceNumber İşlem sıra numarası
success (transaction) Bu adımın başarı durumu
message Sonuç mesajı
details Opsiyonel ek detaylar

Notlar

  • data parametresi imzalı XBRL içeriğinin Base64 kodlanmış halidir.
  • Hata durumunda eDefter::eDefterRollBack($id) otomatik çalıştırılır; rollback da başarısız olursa ek hata mesajı eklenir.
  • E-Defter akışı: getEBookXBRL → imzalama → setEbookXBRLWithSignature → GİB onayı → setEbookXBRLWithGIBConfirmation
  • ZIP sıkıştırılmış veri için setEbookXBRLWithSignatureZip kullanın.
  • Token geçersizse Invalid Token döner.