getEBookXBRL
Genel Bilgi
| Özellik |
Değer |
| Endpoint Adı |
getEBookXBRL |
| SOAPAction |
urn:WebticariService#getEBookXBRL |
| Açıklama |
E-Defter için GİB standardında XBRL (eXtensible Business Reporting Language) formatlı defter verisini döner. |
| 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 |
belgeTuru |
xsd:string |
Hayır |
Defter türü: Y (Yevmiye Defteri, varsayılan) veya K (Kebir Defteri) |
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 |
XBRL formatında e-defter verisi |
Örnek SOAP İstek
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tns="urn:WebticariService">
<soapenv:Header/>
<soapenv:Body>
<tns:getEBookXBRL>
<token>abc123tokendeğeri</token>
<id>1001</id>
<belgeTuru>Y</belgeTuru>
<donem>2024-01</donem>
</tns:getEBookXBRL>
</soapenv:Body>
</soapenv:Envelope>
Yanıt XML Yapısı
Başarılı durumda:
<result>
<success>1</success>
<ebook>BASE64_ENCODED_XBRL_CONTENT</ebook>
</result>
Hata durumunda:
<result>
<success>0</success>
<errorDescription>Defter dosyası okunamadı > /path/to/file</errorDescription>
</result>
Notlar
belgeTuru varsayılanı Y (Yevmiye Defteri); K gönderilirse Kebir Defteri döner.
donem parametresi boş bırakılırsa aktif dönem kullanılır; farklı dönem için gönderilmesi gerekir.
- Başarılı yanıtta
<ebook> alanı Base64 kodlanmış XBRL içeriği taşır; base64_decode() ile açılır.
- E-Defter akışı:
getEBookXBRL → imzalama (harici) → setEbookXBRLWithSignature → GİB onayı → setEbookXBRLWithGIBConfirmation
- Token geçersizse
Invalid Token döner.