efatura özel entegrasyon platformu

Transkript

Efatura Özel Entegrasyon Platformu Web Servis Arayüzü
EFATURA ÖZEL ENTEGRASYON
PLATFORMU
Web Servis Arayüzü
Versiyon 1.3
TASNİF DIŞI
VAKIFBANK_EFATURA_API_v1.3.doc
Sayfa 1 / 54
İçindekiler
İÇİNDEKİLER ........................................................................................................................ 2
1
1.1
1.2
1.3
1.4
DOKUMANA GENEL BAKIŞ.......................................................................................... 3
KAPSAM & AMAÇ.......................................................................................................... 3
DOKUMAN KİMİN İÇİN FAYDALIDIR............................................................................. 3
TANIMLAMALAR,SEMBOLLER VE KISALTMALAR.....................................................4
REFERANSLAR.............................................................................................................. 4
2 INTERFACE OVERVIEW................................................................................................. 5
2.1 PROTOKOL PERSPEKTİFİ............................................................................................. 5
3 DESTEKLENEN API METODLARI................................................................................. 6
3.1 DESTEKLENEN METODLARA GENEL BAKIŞ..............................................................6
3.1.1 EFATURA ENTEGRASYON PLATFORMU WebService Metodları.......................6
3.2 WEB SERVİS METODLARI DETAYLARI....................................................................... 7
3.2.1 Ortak Kullanılan REQUEST_HEADER Tipi...........................................................7
3.2.2 Login..................................................................................................................... 9
3.2.3 Logout................................................................................................................. 11
3.2.4 SendInvoice......................................................................................................... 12
3.2.5 LoadInvoice......................................................................................................... 14
3.2.6 GetInvoice........................................................................................................... 15
3.2.7 GetInvoiceStatus................................................................................................. 17
3.2.8 MarkInvoice......................................................................................................... 18
3.2.9 PrepareInvoiceResponse.................................................................................... 19
3.2.10 SendInvoiceResponse......................................................................................... 21
3.2.11 GetUserList......................................................................................................... 22
3.2.12 GetUserListBinary……………………………………………………………………….24
3.2.13 CheckUser........................................................................................................... 24
3.3 DESTEKLENEN METODLARA GENEL BAKIŞ(PROXY)
3.3.1 EFATURA ENTEGRASYON PLATFORMU WebService Metodları ................... 27
3.3 SERVİS METODLARI DETAYLARI...............................................................................27
3.3.2 Login ..................................................................................................................27
3.3.3 Logout ................................................................................................................27
3.3.4 SendInvoice .......................................................................................................29
3.3.5 GetInvoiceStatus ................................................................................................30
3.3.6 GetInvoice ..........................................................................................................30
3.3.7 MarkInvoice ........................................................................................................33
3.3.8 SendInvoiceResp ...............................................................................................34
3.3.9 GetUserList ........................................................................................................35
3.3.10 CheckUser ......................................................................................................... 37
TASNİF DIŞI
VAKIFBANK_EFATURA_API_v1.3
.doc
Sayfa 2 / 54
3.4 LOGO CONNECT EFATURA WEBSERVICE INTERFACE.........................................38
3.5 FAULT HANDLİNG........................................................................................................42
3.6 FATURA DURUMLARI..................................................................................................43
3.6.1 Yaygın Karşılaşılan Fatura Durumları..................................................................43
3.7 WSDL-WEBSERVİCE DESCRİPTİON OF OPERATİONS............................................45
3.8 INTERFACE ENTİTY SPECİFİCATİONS..................................................................... 47
DOCUMENT CONTROL.......................................................................................................53
TASNİF DIŞI
.doc
Sayfa 3 / 54
1 Dokumana Genel Bakış
1.1
Kapsam & Amaç
Mevcut doküman VAKIFBANK EFATURA API özelliklerine ve kullanımı hakkında teknik açıklama
vermeyi amaçlamaktadır.
1.2
Dokuman Kimin için Faydalıdır
The document may be read by the below audience;
Bu doküman aşağıdaki role sahip kimselerin okuması için faydalıdır.

Solution/System Architects

Developers
TASNİF DIŞI
.doc
Sayfa 4 / 54
1.3
Tanımlamalar,Semboller ve Kısaltmalar.
KAVRAMLAR
AÇIKLAMA
API
Application Programming Interface
BSS
Business Support System
GUI
Graphical User Interface
HTML
Hyper Text Markup Language.
HTTP
Hyper Text Transfer Protocol. Simple stateless protocol used throughout the
internet.
Java
An object orientated programming language which is portable between platforms.
OSS
Operations Support System
SOAP
Simple Object Access Protocol
SOAP is a simple XML-based protocol to let applications exchange information
over HTTP
Extensible Markup Language. A widely used standard mark-up language.
XML
XSD
XML Schema Definition. XML Schema is an XML based alternative to DTD. An
XML schema describes the structure of an XML document.
WSDL
Web Services Definition Language
1.4
Referanslar
 N/A
TASNİF DIŞI
.doc
Sayfa 5 / 54
2 Interface Overview
Bu dokuman VAKIFBANK EFATURA WEB Servis API lerine ilişkin arayüzlerin detaylarını
açıklamaktadır.
2.1
Protokol Perspektifi
VAKIFBANK EFATURA WEB SERVİS API SOAP tabanlı bir servistir. Aslında Basit Nesne Erişim
Protokolü olarak tanımlanan SOAP, bilgisayar ağları Web Hizmetleri uygulanmasında yapılandırılmış
bilgi alışverişi için bir protokol özelliğidir. Onun ileti biçimi olarak Genişletilebilir İşaretleme Dili (XML)
dayanır ve genellikle mesaj müzakere ve iletimi için diğer Application Layer protokolleri (en önemlisi
Uzaktan Yordam Çağrısı (RPC) ve HTTP) dayanır.
VAKIFBANK EFATURA WEB SERVİS API SOAP 1.2 ile uyumludur. Binding mekanizması olarak
Document/Literal stili ile geliştirilmiştir.
TASNİF DIŞI
.doc
Sayfa 6 / 54
3 Desteklenen API Metodları
3.1
Desteklenen Metodlara Genel Bakış
Aşağıdaki tablo IZIBIZ EFATURA Entegrasyon Platformu tarafından desteklenen işlemler
hakkında bilgi sağlar. Parametrelerinin türleri bölümünde ayrıntılı olarak açıklanmıştır.
3.1.1
EFATURA ENTEGRASYON PLATFORMU WebService Metodları
METOD
AMACI
Login
Web servis istemcisinin(client) EFATURA Entegrasyon
Platformuna kimlik doğrulayarak giriş yapmasını sağlar.
Logout
Platformundan güvenli çıkış yapmasını sağlar.
SendInvoice
EFATURA Entegrasyon Platformu üzerinden 1 yada daha
fazla faturayı GIB (Gelir İdaresi Başkanlığı) EFATURA
sistemine gönderir.
GetInvoice
GIB (Gelir İdaresi Başkanlığı) EFATURA sisteminden
gelen/giden faturalari EFATURA Entegrasyon Platformu
üzerinden getirir.
PrepareInvoiceResponse
Alınan Ticari Faturalara kabul yada red cevabı göndermek
için kullanılacak imzasız uygulama yanıtını yaratır.
Yaratılan bu uygulama yanıtı müşteri tarfındaki uygulama
tarafından müşteri elektronik imzası ile onaylanıp
SendInvoiceResponse metoduyla ticari faturaya kabul
yada red cevabı vermek için kullanılır.
SendInvoiceResponse
için kullanılır.
GetUserList
GIB EFATURA sistemine kayıtlı kullanıcıların listesini ve
bilgilerini getirir.
CheckUser
GIB EFATURA sistemine kayıtlı kullanıcı varmı diye kontrol
eder, varsa bilgilerini getirir.
LoadInvoice
fazla faturayı taslak olarak kaydeder
TASNİF DIŞI
.doc
Sayfa 7 / 54
3.2
3.2.1
WEB Servis Metodları Detayları
Ortak Kullanılan REQUEST_HEADER Tipi
ADI
AÇIKLAMASI
SESSION_ID
Login Metodunda sistem tarafında gönderilen SESSION_ID
bilgisi. Sonraki tüm metod çağrılarında parametre olarak metoda
geçmelidir.
CLIENT_TXN_ID
İstemci uygulama tarafından üretilen her istek için unique olması
beklenen transaction ID. Bu ID bilgisi DB de saklanmaktadır.
Zorunlu değildir ancak gönderilmesi tavsiye edilir.
INT_TXN_ID
İstemci uygulamasında ana modül entitileri ile ilişkilendirelmek
istenen transaction ID. Zorunlu değildir.
INT_PARENT_TXN_ID
İstemci uygulamasında ana modül entitileri ile ilişkilendirelmek
istenen ana transaction ID. Zorunlu değildir.
ACTION_DATE
Metodun çağrılma tarihi
CHANGE_INFO
Bu metod ile eğer verilerde bir değişiklik yapılacak ise o
TASNİF DIŞI
.doc
Sayfa 8 / 54
değişikliği ait bilgi. Zorunlu değildir.
REASON
Aksiyonun çağrılma nedeni. Zorunlu değildir.
APPLICATION_NAME
Metodu çağıran uygulamanın adı. Zorunlu değildir.
HOST_NAME
Metodu çağıran Host’un adı. Zorunlu değildir.
CHANNEL_NAME
Metodun çağrıldığı kanal adı.Zorunlu değildir.
SIMULATION_FLAG
Metod çağrılır ancak arkadaki iş yapılmaz. Zorunlu değildir.
COMPRESSED
İçerikte taşınan bilginin ZIP formatında sıkıştırılmış mı
gönderildiği/talep edildiği bilgisi. Bu parametre aşağıda ki
servislerde kullanılmaktadır:




ATTRIBUTES
LoadInvoice
PrepareInvoiceResponse
SendInvoice
SendInvoiceResponse
Key,Value çifti şeklinde haricen taşınabilecek bilgiler. Key String
tipindedir, value da Object tipindedir. Zorunlu değildir.
TASNİF DIŞI
.doc
Sayfa 9 / 54
3.2.2 Login
Web servis istemcisinin(client) EFATURA Entegrasyon Platformuna kimlik doğrulayarak giriş
yapmasını sağlar. Login komutu sonrası dönen sessionID parametresi login sonrası çağrılacak
tüm metodlarda parameter olarak kullanılmalıdır.
3.2.2.1
Örnek Giriş İsteği
ADI
AÇIKLAMASI
USER_NAME
Sisteme bağlanacak kullanıcı adı
PASSWORD
Kullanıcı şifresi
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:wsdl="http://schemas.i2i.com/ei/wsdl">
<soap:Header/>
<soap:Body>
<wsdl:LoginRequest>
<REQUEST_HEADER>
<SESSION_ID>-1</SESSION_ID>
</REQUEST_HEADER>
<USER_NAME>[email protected]</USER_NAME>
<PASSWORD>123456</PASSWORD>
</wsdl:LoginRequest>
</soap:Body>
</soap:Envelope>
3.2.2.2
Beklenen Cevap
ADI
AÇIKLAMASI
SESSION_ID
Login işlemi kabul edilmiş ise bundan sonraki metod çağrılarında
kullanılacak oturum bilgisi.
INTL_TXN_ID
Metodun işlenmesine sırasında oluşun internal transaction id
bilgisi.
RETURN_CODE
Dönüş codu. 0 BAŞARILI
WARNING
Metod çağrısında uyarı almış ise uyarı bilgileri.
TASNİF DIŞI
.doc
Sayfa 10 / 54
<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope">
<env:Body>
<LoginResponse xmlns="http://schemas.i2i.com/ei/wsdl">
<SESSION_ID xmlns="">3146e936-dd94-43fc-8760-45c47a3abd74
</SESSION_ID>
</LoginResponse>
</env:Body>
</env:Envelope>
TASNİF DIŞI
.doc
Sayfa 11 / 54
3.2.3 Logout
Web servis istemcisinin(client) EFATURA Entegrasyon Platformundan güvenli çıkış yapmasını
sağlar.
3.2.3.1
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap=“http://schemas.xmlsoap.org/soap/envelope/”>
<soap:Header />
<soap:Body>
<LogoutRequest xmlns="http://schemas.i2i.com/ei/wsdl">
<REQUEST_HEADER xmlns="">
<SESSION_ID>099c369d-4af2-4447-b868-9d723a5dfea6</SESSION_ID>
<CLIENT_TXN_ID>fb634096-1a5c-4746-b089-d4a9ecde6ec5</CLIENT_TXN_ID>
<REASON>FATURA_GONDERME_TEST</REASON>
<APPLICATION_NAME>ENTEGRASYON_TEST_CLIENT</APPLICATION_NAME>
<HOSTNAME>OSM-I7</HOSTNAME>
<CHANNEL_NAME>INTERNAL_TEST_CHANNEL</CHANNEL_NAME>
</REQUEST_HEADER>
</LogoutRequest>
</soap:Body>
</soap:Envelope>
3.2.3.2
Beklenen Cevap
<soap:Envelope xmlns:soap=“http://schemas.xmlsoap.org/soap/envelope/”
xmlns:wsdl="http://schemas.i2i.com/ei/wsdl"
xmlns:xm="http://www.w3.org/2005/05/xmlmime">
<soap:Header />
<soap:Body>
<LogoutResponse xmlns="http://schemas.i2i.com/ei/wsdl">
<REQUEST_RETURN xmlns="">
<INTL_TXN_ID>1734</INTL_TXN_ID>
<RETURN_CODE>0</RETURN_CODE>
</REQUEST_RETURN>
</LogoutResponse>
</soap:Body>
</soap:Envelope>
TASNİF DIŞI
.doc
Sayfa 12 / 54
3.2.4 SendInvoice
EFATURA Entegrasyon Platformu üzerinden 1 yada daha fazla faturayı GIB (Gelir İdaresi
Başkanlığı) EFATURA sistemine gönderir.
3.2.4.1
Örnek Fatura Gönderme İsteği
ADI
AÇIKLAMASI
SENDER
Faturayı gönderecek gönderici birimin GIB’de tanımlı urn si
vkn
Faturayı gönderecek gönderici birimin GIB’de tanımlı VKN/TCKN si
alias
Faturayı gönderecek gönderici birimin GIB’de tanımlı alias’i (urn si)
RECEIVER
Faturayı alacak birimin GIB de tanımlı urn’si
vkn
Faturayı alacak birimin GIB de tanımlı VKN/TCKN si
alias
Faturayı alacak birimin GIB de tanımlı GIB’de tanımlı alias’i (urn si)
CONTENT
XML faturanın Base64Binary tipinde standart zip yöntemi ile
sıkıştırılmış/sıkıştırılmamış içeriği.
REQUEST_HEADER
Binary Fatura içeriği sıkıştırılmış/sıkıştırılmamış bilgisi. Sıkıştırılmış ise
TRUE olmalıdır.
:COMPRESSED
xmlns:wsdl="http://schemas.i2i.com/ei/wsdl" xmlns:xm="http://www.w3.org/2005/05/xmlmime">
<soap:Header/>
<soap:Body>
<wsdl:SendInvoiceRequest>
<REQUEST_HEADER>
<SESSION_ID>a9215a9f-e975-4b45-8c9c-2d80286858b5</SESSION_ID>
<CLIENT_TXN_ID>780eef3a-4447-42ee-adeb-17977a80d157</CLIENT_TXN_ID>
<REASON>C# EFATURA GONDERME VE ALMA TEST</REASON>
<APPLICATION_NAME>DATASOFT EFATURA V1.0</APPLICATION_NAME>
<HOSTNAME>UGUR-001</HOSTNAME>
<CHANNEL_NAME>DATASOFT</CHANNEL_NAME>
<COMPRESSED>N</COMPRESSED>
TASNİF DIŞI
.doc
Sayfa 13 / 54
</REQUEST_HEADER>
<SENDER alias="urn:mail:[email protected]" vkn="1234567807"/>
<RECEIVER alias="urn:mail:[email protected]" vkn="4840847211"/>
<INVOICE>
<CONTENT>
<!—CONTENT HERE -->
</CONTENT>
</INVOICE>
</wsdl:SendInvoiceRequest>
</soap:Body>
</soap:Envelope>
3.2.4.2
Beklenen Cevap
<soap:Header />
<soap:Body>
<SendInvoiceResponse xmlns="http://schemas.i2i.com/ei/wsdl">
</REQUEST_RETURN>
</SendInvoiceResponse>
</soap:Body>
</soap:Envelope>
TASNİF DIŞI
.doc
Sayfa 14 / 54
3.2.5 LoadInvoice
EFATURA Entegrasyon Platformu üzerinden 1 yada daha fazla faturayı taslak olarak
kaydeder.
3.2.5.1
ADI
AÇIKLAMASI
INVOICE
Fatura
ID
Faturanın üzerinde yazılı fatura numarası
UUID
Faturanın unique(özgün) id si
HEADER
Fatura özet bilgileri
SENDER
Faturayı gönderecek birimin GIB’de tanımlı VKN/TCKN si
FROM
Faturayı gönderecek birimin GIB’de tanımlı urn’si
RECEIVER
TO
Faturayı alacak birimin GIB de tanımlı posta kutusu urn’si
CONTENT
REQUEST_HEADER
:COMPRESSED
Binary Fatura içeriği sıkıştırılmış/sıkıştırılmamış bilgisi.
Sıkıştırılmış ise Y olmalıdır.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
<soapenv:Header/>
<soapenv:Body>
<wsdl:LoadInvoiceRequest>
<REQUEST_HEADER>
<SESSION_ID>c724e336-34da-4eab-bc2e-0d60776881b3</SESSION_ID>
<COMPRESSED>N</COMPRESSED>
</REQUEST_HEADER>
<INVOICE ID="FYA201300000009" UUID="d314e336-34da-4eab-bc2e-0d60776881d9">
<HEADER>
<SENDER>1234567804</SENDER>
<FROM>urn:mail:[email protected]</FROM>
<RECEIVER>1234567805</RECEIVER>
<TO>urn:mail:[email protected]</TO>
</HEADER>
<CONTENT> BASE64BINARY VALUE STRING </CONTENT>
</INVOICE>
</wsdl:LoadInvoiceRequest>
</soapenv:Body>
</soapenv:Envelope>
TASNİF DIŞI
.doc
Sayfa 15 / 54
3.2.5.2
Beklenen Cevap
<env:Body>
<LoadInvoiceResponse xmlns="http://schemas.i2i.com/ei/wsdl">
</REQUEST_RETURN>
</LoadInvoiceResponse>
</env:Body>
</env:Envelope>
3.2.6 GetInvoice
GIB (Gelir İdaresi Başkanlığı) EFATURA sisteminden gelen/giden faturalari EFATURA
Entegrasyon Platformu üzerinden getirir.
3.2.6.1
Örnek Fatura Getirme İsteği
,
ADI
AÇIKLAMASI
LIMIT
Kaç fatura okunmak istendiği
FROM
Faturayı göndereren gönderici birimin GIB’de tanımlı urn si
TO
Faturayı alan birimin GIB de tanımlı urn’si
ID
UUID
START_DATE
Getirilmek istenen faturaların geliş tarihi
END_DATE
Getirilmek istenen faturaların son tarihi
READ_INCLUDED
Okunmuş olarak işaretlenen faturaları da getirsin mi bilgisi
TASNİF DIŞI
.doc
Sayfa 16 / 54
<soap:Header/>
<soap:Body>
<wsdl:GetInvoiceRequest>
<REQUEST_HEADER>
<SESSION_ID>23a4a275-b101-471b-bda6-a2a30f847fed</SESSION_ID>
<CLIENT_TXN_ID>-1</CLIENT_TXN_ID>
<INTL_TXN_ID>-1</INTL_TXN_ID>
<INTL_PARENT_TXN_ID>-1</INTL_PARENT_TXN_ID>
<ACTION_DATE>2013-09-02T09:00:00</ACTION_DATE>
<REASON>NA</REASON>
<APPLICATION_NAME>SOAPUI</APPLICATION_NAME>
<HOSTNAME>192.168.1.192</HOSTNAME>
<CHANNEL_NAME>I2I</CHANNEL_NAME>
<SIMULATION_FLAG/>
</REQUEST_HEADER>
<INVOICE_SEARCH_KEY>
<LIMIT>1</LIMIT>
</INVOICE_SEARCH_KEY>
</wsdl:GetInvoiceRequest>
</soap:Body>
</soap:Envelope>
3.2.6.2
Beklenen Cevap
ADI
AÇIKLAMASI
INVOICE_ID
INVOICE_UUID
SENDER
Faturayı göndereren birimin VKN’si
RECEIVER
Faturayı alan birimin VKN’si
CUSTOMER
Faturayı alan firma adı
ISSUE_DATE
Fatura tarihi
PAYABLE_AMOUT
Fatura toplam ödenecek tutar
FROM
Faturayı göndereren birimin GIB’de tanımlı etiketi (urn)
TASNİF DIŞI
.doc
Sayfa 17 / 54
TO
Faturayı alan birimin GIB’de tanımlı etiketi (urn)
INVOICE_CONTENT
sıkıştırılmış/sıkıştırılmamış içeriği. Metod çağrılırken
COMPRESSED bilgisi Y ise veya COMPRESSED alanı
gönderilmemişse içerik sıkıştırılmıştır.
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<GetInvoiceResponse xmlns="http://schemas.i2i.com/ei/wsdl">
<INVOICE ID="FYA2013000000023" UUID="6DCD1AED-38B4-44C4-B38B-682FBBC94BF8" xmlns="">
<HEADER>
<SENDER>1234567805</SENDER>
<RECEIVER>1234567804</RECEIVER>
<CUSTOMER>FIRMA 4</CUSTOMER>
<ISSUE_DATE>2013-12-04+02:00</ISSUE_DATE>
<PAYABLE_AMOUNT currencyID="TRL">513</PAYABLE_AMOUNT>
<FROM>urn:mail:[email protected]</FROM>
<TO>urn:mail:[email protected]</TO>
</HEADER>
<CONTENT>--BASE64 INVOICE CONTENT --</CONTENT>
</INVOICE>
</GetInvoiceResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
3.2.7 GetInvoiceStatus
EFATURA Entegrasyon Platformu üzerinden faturaların durumunu sorgulamayı sağlar.
3.2.7.1
Örnek Fatura Durum Sorgulama İsteği
<soapenv:Header/>
<soapenv:Body>
<wsdl:GetInvoiceStatusRequest>
<REQUEST_HEADER>
<SESSION_ID>bf13dc0a-f125-4f4c-b5c0-9ce1bbdc19ef</SESSION_ID>
</REQUEST_HEADER>
<INVOICE ID="MRK2013000000049" UUID="b246a3c8-e0be-496d-90c1-2a764a2f1987" />
</wsdl:GetInvoiceStatusRequest>
</soapenv:Body>
</soapenv:Envelope>
3.2.7.2
Örnek Cevap
TASNİF DIŞI
.doc
Sayfa 18 / 54
<SOAP-ENV:Body>
<GetInvoiceStatusResponse xmlns="http://schemas.i2i.com/ei/wsdl">
<INVOICE_STATUS ID="MRK2013000000049" UUID="b246a3c8-e0be-496d-90c1-2a764a2f1987">
<STATUS>SEND - WAIT_APPLICATION_RESPONSE</STATUS>
<STATUS_DESCRIPTION>SEND</STATUS_DESCRIPTION>
</INVOICE_STATUS>
</GetInvoiceStatusResponse>
</SOAP-ENV:Body>
3.2.8
MarkInvoice
Fatura okundu olarak işeretlenir.
3.2.8.1
Örnek İstek
<soap:Header/>
<soap:Body>
<wsdl:MarkInvoiceRequest>
<REQUEST_HEADER>
<REASON>NA</REASON>
<SIMULATION_FLAG>N</SIMULATION_FLAG>
</REQUEST_HEADER>
<MARK value="READ">
<INVOICE ID="FY001"/>
</MARK>
</wsdl:MarkInvoiceRequest>
</soap:Body>
</soap:Envelope>
3.2.8.2
Örnek Cevap
TASNİF DIŞI
.doc
Sayfa 19 / 54
<env:Body>
<MarkInvoiceResponse xmlns="http://schemas.i2i.com/ei/wsdl">
</REQUEST_RETURN>
</MarkInvoiceResponse>
</env:Body>
</env:Envelope>
3.2.9 PrepareInvoiceResponse
Alınan Ticari Faturalara kabul yada red cevabı göndermek için kullanılacak imzasız uygulama
yanıtını yaratır. Yaratılan bu uygulama yanıtı müşteri tarfındaki uygulama tarafından müşteri
elektronik imzası ile onaylanıp SendInvoiceResponse metoduyla ticari faturaya kabul yada
red cevabı vermek için kullanılır.
Request Header kısmında bulunan Compressed alanı N veya boş gönderilirse, gelen
yanıt sıkıştırılmamış XML dosyası olacaktır. Eğer Compressed alanı Y olarak
gönderilirse gelen cevap zip olarak sıkıştırılacaktır.
3.2.9.1
Örnek Fatura Yanıtı Yaratma İsteği
<soap:Header/>
<soap:Body>
<wsdl:PrepareInvoiceResponseRequest>
<REQUEST_HEADER>
<REASON>NA</REASON>
</REQUEST_HEADER>
<STATUS>RED</STATUS>

<INVOICE UUID="fa943dd2-eee6-484e-9bbf-f4a97c0cf601"/>
TASNİF DIŞI
.doc
Sayfa 19 / 54
</wsdl:PrepareInvoiceResponseRequest>
</soap:Body>
</soap:Envelope>
3.2.9.2
Beklenen Cevap
<env:Body>
<PrepareInvoiceResponseResponse xmlns="http://schemas.i2i.com/ei/wsdl">
<APPRESPONSE xmlns=""><!—INVOICE RESPONSE CONTENT HERE IN BASE64-->
</PrepareInvoiceResponseResponse>
</env:Body>
</env:Envelope>
TASNİF DIŞI
.doc
Sayfa 20 / 54
3.2.10 SendInvoiceResponse
Alınan Ticari Faturalara kabul yada red cevabı göndermek için kullanılır.
3.2.10.1 Örnek Fatura Yanıtı Gönderme İsteği
<soap:Header/>
<soap:Body>
<wsdl:SendInvoiceResponseRequest>
<REQUEST_HEADER>
<REASON>NA</REASON>
</REQUEST_HEADER>
<APPRESPONSE><!—INVOICE RESPONSE CONTENT HERE IN BASE64--></APPRESPONSE>
</wsdl:SendInvoiceResponseRequest>
</soap:Body>
</soap:Envelope>
3.2.10.2 Beklenen Cevap
<env:Body>
<SendInvoiceResponse xmlns="http://schemas.i2i.com/ei/wsdl">
<INVOICE_INFO xmlns="">
</REQUEST_RETURN>
</SendInvoiceResponse>
</env:Body>
</env:Envelope>
TASNİF DIŞI
.doc
Sayfa 21 / 54
3.2.11 GetUserList
GIB EFATURA sistemine kayıtlı kullanıcıların listesini ve bilgilerini getirir.
3.2.11.1 Örnek Kullanıcı Listesi Getirme İsteği
ADI
AÇIKLAMASI
REGISTER_TIME_START
Sorgulanacak kayıtlar için GIB Efatura kayıt başlangıç tarihi.
Tarih verilmez ise tüm kullanıcıları getiririr.
<soapenv:Header/>
<soapenv:Body>
<wsdl:GetUserListRequest>
<REQUEST_HEADER>
<REASON>NA</REASON>
</REQUEST_HEADER>

</wsdl:GetUserListRequest>
</soapenv:Body>
</soapenv:Envelope>
TASNİF DIŞI
.doc
Sayfa 22 / 54
TASNİF DIŞI
.doc
Sayfa 23 / 54
ADI
AÇIKLAMASI
IDENTIFIER
Kullanıcının GIB’de tanımlı ID si
ALIAS
Kullanıcının GIB’de tanımlı Posta Kutusu urn’si
TITLE
Kullanıcının GIB’de tanımlı adı/unvanı
TYPE
Kullanıcının tip bilgisi, Kamu yada Özel olarabilir
REGISTER_TIME
Kullanıcının GIB E-FATURA Sistemine kayit tarihi
UNIT
Kullanıcı kaydının bulundugu birim, PK yada GB olabilir PK(Posta
Kutusu ) mu yoksa GB (Gönderici Birim) için tanımlı oldugunu
gösterir
CSV
FORMAT olarak CSV verildiginde kullanıcı listesi aşagıdaki
formatta base64 ile encode edilerek bu alanda döner.
identifier,"alias ","title.",type,"registerTime"
<env:Body>
<GetUserListResponse xmlns="http://schemas.i2i.com/ei/wsdl">
<USER xmlns="">
<IDENTIFIER>1111111297</IDENTIFIER>
<ALIAS>urn:mail:[email protected]</ALIAS>
<TITLE>Arkas Sigorta Test Kullanıcısı</TITLE>
<TYPE>Özel</TYPE>
<REGISTER_TIME>2013-09-11T11:51:28</REGISTER_TIME>
<UNIT>GB</UNIT>
</USER>
<USER xmlns="">
<TITLE>Arkas Turizm Test Kullanıcısı</TITLE>
<TYPE>Özel</TYPE>
<UNIT>GB</UNIT>
</USER>
...
</GetUserListResponse>
</env:Body>
</env:Envelope>
TASNİF DIŞI
.doc
Sayfa 24 / 54
3.2.12.1 GetUserListBinary
GetUserListBinary servisi GIB EFATURA sistemine kayıtlı kullanıcıların listesini ve bilgilerini zip
dosya içerisinde getirir.
3.2.12.2 Request Parametreleri
ADI
AÇIKLAMASI
TYPE
Kullanıcı listesinin dönülmesi istenilen format. XML veya CSV
3.2.12.3 Response Parametreleri
ADI
AÇIKLAMASI
IDENTIFIER
ALIAS
TITLE
TYPE
REGISTER_TIME
UNIT
Kullanıcı kaydının bulundugu birim, PK yada GB olabilir
PK(Posta Kutusu ) mu yoksa GB (Gönderici Birim) için tanımlı
oldugunu gösterir
3.2.13 CheckUser
GIB EFATURA sistemine kayıtlı kullanıcı var mı diye kontrol eder, varsa bilgilerini getirir.
3.2.12.1 Örnek Kullanıcı Kontrol Etmek İsteği
TASNİF DIŞI
.doc
Sayfa 24 / 54
ADI
AÇIKLAMASI
IDENTIFIER
Kontrol edilmek istenen kullanicinin GIB’de tanımlı ID si
ALIAS
Kontrol edilmek istenen kullanicinin GIB’de tanımlı Posta Kutusu
urn’si
TITLE
Kontrol edilmek istenen kullanicinin GIB’de tanımlı adı/unvanı
TYPE
Kontrol edilmek istenen kullanicinin tip bilgisi
REGISTER_TIME
Kontrol edilmek istenen kullanicinin GIB E-FATURA Sistemine
kayit tarihi
<soapenv:Header/>
<soapenv:Body>
<wsdl:CheckUserRequest>
<REQUEST_HEADER>
<REASON>NA</REASON>
</REQUEST_HEADER>
<USER>

</USER>
</wsdl:CheckUserRequest>
</soapenv:Body>
</soapenv:Envelope>
TASNİF DIŞI
.doc
Sayfa 25 / 54
ADI
AÇIKLAMASI
IDENTIFIER
ALIAS
TITLE
TYPE
Kullanıcının tip bilgisi
REGISTER_TIME
<env:Body>
<CheckUserResponse xmlns="http://schemas.i2i.com/ei/wsdl">
<USER xmlns="">
<ALIAS>defaultpk</ALIAS>
<TITLE>İ.E. Ulagay İlaç Sanayii Türk A.Ş.Test Kullanıcısı</TITLE>
<TYPE>Özel</TYPE>
</USER>
</CheckUserResponse>
</env:Body>
</env:Envelope>
TASNİF DIŞI
.doc
Sayfa 26 / 54
3.3
Desteklenen Metodlara Genel Bakış
Aşağıdaki tablo IZIBIZ EFATURA Entegrasyon Platformu tarafından desteklenen işlemler
hakkında bilgi sağlar. Parametrelerinin türleri bölümünde ayrıntılı olarak açıklanmıştır.
3.3.1 EFATURA ENTEGRASYON PLATFORMU WebService Metodları
METOD
AMACI
Login
Platformuna kimlik doğrulayarak giriş yapmasını sağlar.
Logout
Platformundan güvenli çıkış yapmasını sağlar.
SendInvoice
fazla faturayı GIB (Gelir İdaresi Başkanlığı) EFATURA
sistemine gönderir.
GetInvoice
GIB (Gelir İdaresi Başkanlığı) EFATURA sisteminden
gelen/giden faturalari EFATURA Entegrasyon Platformu
üzerinden getirir.
SendInvoiceResp
için kullanılır.
GetUserList
GIB EFATURA sistemine kayıtlı kullanıcıların listesini ve
bilgilerini getirir.
3.3 PROXY SERVİS METODLARI DETAYLARI
3.3.2
Login
Web servis istemcisinin(client) EFATURA Entegrasyon Platformuna kimlik doğrulayarak giriş
yapmasını sağlar. Login komutu sonrası dönen sessionID parametresi login sonrası çağrılacak tüm
metodlarda parameter olarak kullanılmalıdır.
3.3.2.1
ADI
AÇIKLAMASI
USER_NAME
Sisteme bağlanacak kullanıcı adı
PASSWORD
Kullanıcı şifresi
xmlns:efat="http://efatura.izibiz.com/">
<soapenv:Header/>
<soapenv:Body>
<efat:Login>
<USER_NAME>ofis1-firma4</USER_NAME>
TASNİF DIŞI
.doc
Sayfa 27 / 54
<PASSWORD>123456</PASSWORD>
</efat:Login>
</soapenv:Body>
</soapenv:Envelope
3.3.2.2
Beklenen Cevap
ADI
AÇIKLAMASI
SESSION_ID
Login işlemi kabul edilmiş ise bundan sonraki metod çağrılarında
kullanılacak oturum bilgisi.
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:LoginResponse xmlns:ns2="http://efatura.izibiz.com/"
xmlns:xmime="http://www.w3.org/2005/05/xmlmime" xmlns:ns4="http://schemas.i2i.com/ei/wsdl">
<SESSION_ID>d28c72a6-5992-4ac2-b396-1bdfbf25775e</SESSION_ID>
</ns2:LoginResponse>
</S:Body>
</S:Envelope>
3.3.3
Logout
Web servis istemcisinin(client) EFATURA Entegrasyon Platformundan güvenli çıkış
yapmasını sağlar.
3.3.3.1
<soapenv:Header/>
<soapenv:Body>
<efat:Logout>
<SESSION_ID>e5ad0b4f-5d30-4b6e-b194-8fa84ba87802</SESSION_ID>
</efat:Logout>
</soapenv:Body>
</soapenv:Envelope>
3.3.3.2
Beklenen Cevap
<S:Body>
<ns2:LogoutResponse xmlns:ns2="http://efatura.izibiz.com/"
<REQUEST_RETURN>
</REQUEST_RETURN>
</ns2:LogoutResponse>
</S:Body>
</S:Envelope>
TASNİF DIŞI
.doc
Sayfa 28 / 54
3.3.4
SendInvoice
EFATURA Entegrasyon Platformu üzerinden 1 yada daha fazla faturayı GIB (Gelir İdaresi
Başkanlığı) EFATURA sistemine gönderir.
3.3.4.1
ADI
AÇIKLAMASI
SESSION_ID
Login Metodunda sistem tarafında gönderilen SESSION_ID bilgisi.
SENDER_VKN
Faturayı gönderecek gönderici birimin GIB’de tanımlı VKN/TCKN si
SENDER_ALIAS
Faturayı gönderecek gönderici birimin GIB’de tanımlı urn si
RECEIVER_VKN
RECEIVER_ALIAS
Faturayı gönderecek gönderici birimin GIB’de tanımlı alias’i (urn si)
CONTENT
COMPRESSED
Binary Fatura içeriği sıkıştırılmış/sıkıştırılmamış bilgisi. Sıkıştırılmış ise
Y olmalıdır. Default değer N
<soapenv:Header/>
<soapenv:Body>
<efat:SendInvoice>
<SESSION_ID>b2934a15-d15c-4f68-b866-a99b42b46a3a</SESSION_ID>
<SENDER_VKN>1234567804</SENDER_VKN>
<SENDER_ALIAS>urn:mail:[email protected]</SENDER_ALIAS>
<RECEIVER_VKN>1111111132</RECEIVER_VKN>
<RECEIVER_ALIAS>urn:mail:[email protected]</RECEIVER_ALIAS>
<INVOICE_CONTENT>BASE64 STRING INVOICE CONTEN</INVOICE_CONTENT>
<COMPRESSED>Y</COMPRESSED>
</efat:SendInvoice>
</soapenv:Body>
</soapenv:Envelope>
3.3.4.2
Beklenen Cevap
<S:Body>
<ns2:SendInvoiceResponse xmlns:ns2="http://efatura.izibiz.com/"
<REQUEST_RETURN>
</REQUEST_RETURN>
</ns2:SendInvoiceResponse>
</S:Body>
</S:Envelope>
TASNİF DIŞI
.doc
Sayfa 29 / 54
3.3.5
GetInvoiceStatus
EFATURA Entegrasyon Platformu üzerinden faturaların durumunu sorgulamayı sağlar.
3.3.5.1
Örnek Fatura Durum Sorgulama İsteği
ADI
AÇIKLAMASI
SESSION_ID
INVOICE_UUID
Durumu sorgulanacak Faturanın unique(özgün) id si
xmlns:efat="http://ws.efatura.izibiz.com/">
<soapenv:Header/>
<soapenv:Body>
<efat:GetInvoiceStatus>
<SESSION_ID>8b7a9a81-06cf-4ba8-83b4-480a0e6cb19e</SESSION_ID>
<INVOICE_UUID>c2c95527-e897-4e32-a7c6-7a4335f23803</INVOICE_UUID>
</efat:GetInvoiceStatus>
</soapenv:Body>
</soapenv:Envelope>
3.3.5.2
Beklenen Cevap
<S:Body>
<ns2:GetInvoiceStatusResponse xmlns:ns2="http://ws.efatura.izibiz.com/"
<InvoiceStatusResponse>
<INVOICE_STATUS UUID="3ab23e04-6a71-4827-b26d-6b75fab329c0"
ID="FYA2013000000125">
<STATUS>SEND - WAIT_APPLICATION_RESPONSE</STATUS>
<STATUS_DESCRIPTION>SEND</STATUS_DESCRIPTION>
</INVOICE_STATUS>
</InvoiceStatusResponse>
</ns2:GetInvoiceStatusResponse>
</S:Body>
</S:Envelope>
3.3.6
GetInvoice
GIB (Gelir İdaresi Başkanlığı) EFATURA sisteminden gelen/giden faturalari EFATURA
Entegrasyon Platformu üzerinden getirir.
3.3.6.1
Örnek Fatura Getirme İsteği
ADI
AÇIKLAMASI
SESSION_ID
TASNİF DIŞI
.doc
Sayfa 30 / 54
DIRECTION
Gelen veya Giden fatura yönünü bildirir (OUT/IN)
LIMIT
Kaç fatura okunmak istendiği
SENDER_ALIAS
Faturayı göndereren gönderici birimin GIB’de tanımlı urn si
RECEIVER_ALIAS
Faturayı alan birimin GIB de tanımlı urn’si
INVOICE_UUID
START_DATE
Getirilmek istenen faturaların geliş tarihi
END_DATE
Getirilmek istenen faturaların son tarihi
HEADER_ONLY
Getirilen faturanın özetini kullanmak için girilecek değer (Y/N)
READ_INCLUDED
Okunmuş olarak işaretlenen faturaları da getirsin mi bilgisi
(true/false)
COMPRESSED
Y/N
TASNİF DIŞI
.doc
Sayfa 31 / 54
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
<soapenv:Header/>
<soapenv:Body>
<efat:GetInvoice>
<SESSION_ID>388dd5e2-b2f3-498b-8280-6cdef9e0464b</SESSION_ID>
<DIRECTION>IN</DIRECTION>
<SENDER_ALIAS></SENDER_ALIAS>
<RECEIVER_ALIAS></RECEIVER_ALIAS>
<INVOICE_UUID></INVOICE_UUID>
<START_DATE>2013-09-12T20:55:02+12:00</START_DATE>
<END_DATE> 2013-11-12T20:55:02+12:00</END_DATE>
<HEADER_ONLY></HEADER_ONLY>
<READ_INCLUDED>true</READ_INCLUDED>
<COMPRESSED>Y</COMPRESSED>
</efat:GetInvoice>
</soapenv:Bod
y>
</soapenv:Envelop
e>
3.3.6.2
Beklenen Cevap
<S:Body>
<ns2:GetInvoiceResponse xmlns:ns2="http://efatura.izibiz.com/"
<GetInvoiceResult>
<INVOICE UUID="9f0e1028-5c7f-44f2-877e-7f228bbacff7" ID="FSB2013040011014">
<HEADER>
<SENDER>urn:mail:[email protected]</SENDER>
<RECEIVER>urn:mail:[email protected]</RECEIVER>
<CUSTOMER>Datasoft Test kullanicisi</CUSTOMER>
</HEADER>
<CONTENT>PEludm9pY2UgeHNpOnNjaG</CONTENT>
</INVOICE>
<INVOICE UUID="79fd88a5-49a3-475b-9323-b312950c71d8" ID="FSB2013060011009">
<HEADER>
<SENDER>urn:mail:[email protected]</SENDER>
<RECEIVER>urn:mail:[email protected]</RECEIVER>
<CUSTOMER>Datasoft Test kullanicisi</CUSTOMER>
</HEADER>
<CONTENT>PEludm9pY2UgeHNpOnNjaG</CONTENT>
</INVOICE>
</GetInvoiceResult>
</ns2:GetInvoiceResponse>
</S:Body>
</S:Envelope>
TASNİF DIŞI
.doc
Sayfa 32 / 54
3.3.7
MarkInvoice
Fatura okundu olarak işeretlenir.
3.3.7.1
Örnek İstek
ADI
AÇIKLAMASI
SESSION_ID
INVOICE_UUID
ACTION
Faturanın durumunu okundu veya okunmadı olarak güncelleme
aksiyonu (READ/UNREAD)
<soapenv:Header/>
<soapenv:Body>
<efat:MarkInvoice>
<SESSION_ID>3500cfb2-f5c9-4cb4-b2df-6c36da70e24e</SESSION_ID>
<INVOICE_UUID>7cc69c82-a4cd-4027-b6dd-abc76c20e20c </INVOICE_UUID>
<ACTION>UNREAD</ACTION>
</efat:MarkInvoice>
</soapenv:Body>
</soapenv:Envelope>
3.3.7.2
Örnek Cevap
<S:Body>
<ns2:MarkInvoiceResponse xmlns:ns2="http://efatura.izibiz.com/"
<REQUEST_RETURN>
</REQUEST_RETURN>
</ns2:MarkInvoiceResponse>
</S:Body>
</S:Envelope>
TASNİF DIŞI
.doc
Sayfa 33 / 54
3.3.8
SendInvoiceResp
Alınan Ticari Faturalara kabul yada red cevabı göndermek için kullanılır.
3.3.8.1
Örnek Fatura Yanıtı Gönderme İsteği
ADI
AÇIKLAMASI
SESSION_ID
APP_RESPONSE
Gönderilecek XML cevabın Base64 hali
<soapenv:Header/>
<soapenv:Body>
<efat:SendInvoiceResp>
<SESSION_ID>3500cfb2-f5c9-4cb4-b2df-6c36da70e24e</SESSION_ID>
<APP_RESPONSE>BASE64 STRING</APP_RESPONSE>
</efat:SendInvoiceResp>
</soapenv:Body>
</soapenv:Envelope>
3.3.8.2
Beklenen Cevap
<S:Body>
<ns2:MarkInvoiceResponse xmlns:ns2="http://efatura.izibiz.com/"
<REQUEST_RETURN>
</REQUEST_RETURN>
</ns2:MarkInvoiceResponse>
</S:Body>
</S:Envelope>
TASNİF DIŞI
.doc
Sayfa 34 / 54
3.3.9
GetUserList
GIB EFATURA sistemine kayıtlı kullanıcıların listesini ve bilgilerini getirir.
3.3.9.1
Örnek Kullanıcı Listesi Getirme İsteği
ADI
AÇIKLAMASI
SESSION_ID
bilgisi.
REGISTER_TIME_START
Sorgulanacak kayıtlar için GIB Efatura kayıt başlangıç tarihi.
Tarih verilmez ise tüm kullanıcıları getiririr.
FORMAT
GIB’in döndüğü kullanıcı listesinin alınacağı format. XML/CSV
<soapenv:Header/>
<soapenv:Body>
<efat:GetUserList>
<SESSION_ID>45b9895c-393f-41af-a315-f3011a0d9a78</SESSION_ID>
<REGISTER_TIME_START>2013-11-01T20:55:02</REGISTER_TIME_START>
<FORMAT>XML|CSV</FORMAT>
</efat:GetUserList>
</soapenv:Body>
</soapenv:Envelope>
3.3.9.2
Beklenen Cevap
ADI
AÇIKLAMASI
IDENTIFIER
ALIAS
TITLE
TYPE
REGISTER_TIME
UNIT
Kullanıcı kaydının bulundugu birim, PK yada GB olabilir
PK(Posta Kutusu ) mu yoksa GB (Gönderici Birim) için tanımlı
oldugunu gösterir
CSV
FORMAT olarak CSV verildiginde kullanıcı listesi aşagıdaki
formatta base64 ile encode edilerek bu alanda döner.
identifier,"alias ","title.",type,"registerTime"
TASNİF DIŞI
.doc
Sayfa 35 / 54
XML seçildiğinde dönecek sonuç
<S:Body>
<ns2:GetUserListResponse xmlns:ns2="http://efatura.izibiz.com/"
<GetUserListResult>
<USER>
<TITLE>MNG Reklam Pazarlama Prodüksiyon A.Ş</TITLE>
<TYPE>Özel</TYPE>
<UNIT>GB</UNIT>
</USER>
<USER>
<TITLE>MNG Kargo Yurtiçi ve Yurtdışı Taşımacılık A.Ş.</TITLE>
<TYPE>Özel</TYPE>
<UNIT>GB</UNIT>
</USER>
</GetUserListResult>
</ns2:GetUserListResponse>
</S:Body>
</S:Envelope>
CSV seçildiğinde dönecek sonuç
<S:Body>
<ns2:GetUserListResponse xmlns:ns2="http://efatura.izibiz.com/"
<GetUserListResult>
<CSV>UEsDBBQACAAIANZjbEM</CSV>
</GetUserListResult>
</ns2:GetUserListResponse>
</S:Body>
</S:Envelope>
TASNİF DIŞI
.doc
Sayfa 36 / 54
3.3.10 CheckUser
GIB EFATURA sistemine kayıtlı kullanıcı var mı diye kontrol eder, varsa bilgilerini getirir.
3.3.10.1 Örnek Kullanıcı Kontrol Etmek İsteği
ADI
AÇIKLAMASI
SESSION_ID
bilgisi.
IDENTIFIER
Kontrol edilmek istenen kullanicinin GIB’de tanımlı ID si
TITLE
Kontrol edilmek istenen kullanicinin GIB’de tanımlı adı/unvanı
<soapenv:Header/>
<soapenv:Body>
<efat:CheckUser>
<SESSION_ID>1466c29c-f64d-43c9-b775-d20484ef3fbf</SESSION_ID>
<IDENTIFIER_VKN_TCKN>6450333667</IDENTIFIER_VKN_TCKN>
<TITLE>Orgachem Kimya San. ve Tic. A.Ş</TITLE>
</efat:CheckUser>
</soapenv:Body>
</soapenv:Envelope>
ADI
AÇIKLAMASI
IDENTIFIER
ALIAS
TITLE
TYPE
Kullanıcının tip bilgisi (Ozel/Kamu)
REGISTER_TIME
UNIT
Kullanıcının uniti (PK/GB)
<S:Body>
<ns2:CheckUserResponse xmlns:ns2="http://efatura.izibiz.com/"
<CheckUserResult>
<USER>
<TITLE>Orgachem Kimya San. ve Tic. A.Ş.</TITLE>
<TYPE>Özel</TYPE>
<UNIT>GB</UNIT>
</USER>
TASNİF DIŞI
.doc
Sayfa 37 / 54
<USER>
<TITLE>Orgachem Kimya San. ve Tic. A.Ş.</TITLE>
<TYPE>Özel</TYPE>
<UNIT>PK</UNIT>
</USER>
</CheckUserResul
t>
</ns2:CheckUserRespons
e>
</S:Bod
y>
</S:Envelop
e>
3.4 LogoConnect EFatura Web Servis Arabirimi
LogoConnect programı aşağıda belirtilen koşullara uyan SOAP 1.1 web servislerine eFatura gönderip alabilir.
Metodlar
 Login
 Logout
 Zarf Alma
 Zarf Alındı
 Zarf Gönderme
 Fatura Gönderme
 Uygulama yanıtı gönderme

Login : Zorunlu bir metod değildir. Eğer login altyapısı tanımlanmak istenirse kullanılabilir.
Request için en fazla 3 paremetre geçilebilir. Boolean tipte dönüş değeri olmalıdır. Login
metodundan dönen SessionID değeri diğer metodlara parametre olarak geçilir.
bool Login(LoginType login, out string sessionID);
LoginType
string userName
string passWord
string version
Request parametreleri
userName
passWord
version
string
string
string
Kullanıcı adı
Şifre
Client versionu
Response parametreleri
LoginResult
sessionID
boolean
string
true/false
Diğer metodlarda kullanılacak anahtar
TASNİF DIŞI
.doc
Sayfa 38 / 54

Logout : Eğer login yapısı kullanılmak istenirse logout metodu zorunludur. Login
metodundan dönen session ID değeri parametre olarak geçilir.
Logout(string sessionID);

sessionID
string
Login’den alınan anahtar
LogoutResponse
boolean
true/false
Gelen Zarfı Al :Yeni gelen zarfları (fatura, uygulama yanıtı veya sistem yanıtı) sunucudan
almak için çağrılır. Her çağrıda bir zarf alınır. Sonuç değeri “true” olduğu sürece metod
çağrılmaya devam edilir. Alınacak zarf yoksa “false” dönülmelidir.
bool receiveDocument(out DocumentType document, string sessionID);
DocumentType
string fileName;
public byte[] binaryData
string hash
Session ID
string
receiveDocumentResult
binaryData
boolean
string
true/false
ZIP formatında sıkıştırılmış, Base64 encode
edilmiş binary veri. ZIP içinde xml uzantılı ubl-tr
formatında zarf dosyası (1 adet) olmalıdır.
Dosya adı
MD5 formatında dosya özet değeri
fileName
hash

String
Zarf Alındı : receiveDocument ile bir zarf başarılı alındığında bu bu metod çağrılır. Zarfın
başarılı şekilde alındığı sunucuya bildirilir.
int receiveDone(string fileName, string sessionID);
fileName
SessionID
string
string
Alınan dosya adı
receiveDoneResult
int
0’dan büyük ise başarılı
TASNİF DIŞI
.doc
Sayfa 39 / 54

Zarf Gönder : İçinde “Fatura/Uygulama Yanıtları”nının olduğu zarf sunucuya gönderilir.
İmzalama Client’ta yapıldığı durumlarda bu metod çağrılır. İmzalamanın sunucuda
yapıldığı durumlar için bu metoda gerek yoktur.
bool sendEnvelope(DocumentType envelope, string sessionID);
DocumentType
string fileName;
string hash
SessionID
fileName
binaryData
string
string
string
Gönderilen zarf dosya adı
edilmiş binary veri. İçinde xml uzantılı tek zarf
dosyası vardır.
boolean
true;false
hash
sendEnvelopeResult

Fatura Gönder : UBL formatında fatura verisi sunucuya gönderilir. İmzalamanın sunucuda
yapıldığı durumlarda bu metod çağrılır. Eğer imzalama client’ta yapılacaksa bu metoda
gerek yoktur.
bool sendInvoice(DocumentType invoice, string alias, string sessionID);
DocumentType
string fileName;
string hash
SessionID
alias
fileName
binaryData
hash
string
string
string
string
Alıcının etiket bilgisi
edilmiş binary veri. Birden fazla ubl-tr fatura xml
dosyası içerebilir. (GIB Portal fatura upload
yapısında)
TASNİF DIŞI
.doc
Sayfa 40 / 54
sendEnvelopeResult

boolean
true;false
Uygulama Yanıtı Gönder : UBL formatında Uygulama Yanıtı verisi sunucuya gönderilir.
İmzalamanın sunucuda yapıldığı durumlarda bu metod çağrılır. Eğer imzalama client’ta
yapılacaksa bu metoda gerek yoktur.
bool sendApplicationResponse(DocumentType appResp, string alias, string
sessionID);
DocumentType
string fileName;
string hash
SessionID
alias
fileName
binaryData
string
string
string
string
hash
Alıcının etiket bilgisi
edilmiş binary veri. Birden fazla ubl-tr
uygulama yanıtı xml dosyası içerebilir.
sendApplicationResponseResult boolean
true;false
TASNİF DIŞI
.doc
Sayfa 41 / 54
3.5
Fault Handling
WEB Servis Metodu çağrıldığında hata alması durumunda aşağıdaki formatta Exception
Fırlatacaktır.
Örnek Hata Mesajı
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Server</faultcode>
<faultstring>SISTEM HATASI</faultstring>
<detail>
<RequestFault xmlns="http://schemas.i2i.com/ei/wsdl">
<INTL_TXN_ID xmlns="">63851</INTL_TXN_ID>
<CLIENT_TXN_ID xmlns="" />
<ERROR_CODE xmlns="">2005</ERROR_CODE>
<ERROR_SHORT_DES xmlns="">SISTEM HATASI</ERROR_SHORT_DES>
<ERROR_LONG_DES xmlns="">[SISTEM HATASI ]: Aktif Session bulunamadı. Session
ID:5c637666-e135-4b46-9a2a-ce14ca41ffff</ERROR_LONG_DES>
<STACKTRACE xmlns="">java.lang.RuntimeException: Aktif Session bulunamadı.
Session ID:5c637666-e135-4b46-9a2a-ce14ca41ffff
at com.i2i.efatura.service.EIService.checkSession(EIService.java:215)
...
</STACKTRACE>
</RequestFault>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
TASNİF DIŞI
.doc
Sayfa 42 / 54
3.6 Fatura Durumları
ADI
SUBSTATUS
SUBSTATUS
SUBSTATUS
DEGERI
PROCESSING
FAILED
SUCCEED
Kisa Aciklama
Isleniyor
Basarisiz oldu
Basariyla islendi
SUBSTATUS
WAIT_SYSTEM_RESPONSE
Sistem Yaniti
Bekleniyor
SUBSTATUS
WAIT_APPLICATION_RESPONSE
Fatura Onayi
Bekleniyor
STATUS
LOAD
Fatura Yükleme
STATUS
PACKAGE
Fatura Paketleme
STATUS
SIGN
Fatura Imzalama
STATUS
SEND
Fatura Gönderimi
STATUS
RECEIVE
Fatura Alimi
STATUS
ACCEPTED
STATUS
REJECTED
STATUS
ACCEPT
STATUS
REJECT
Gelen Ticari
Fatura Red
STATUS
CHECK
Fatura Gönderimi
3.6.1
Giden Ticari
Fatura Kabul
Giden Ticari
Fatura Red
Gelen Ticari
Fatura Kabul
Detaylı Açıklama
İşlem yapılıyor
İşlem başarısız oldu
İşlem Başarıyla yapıldı
Gönderen veya alıcı taraf için ticari
faturanın durumumu e-fatura
sisteminden sistem yanıtı bekliyor
Gönderen veya alıcı taraf için ticari
faturanın durum alıcıdan onay bekliyor
Aşama Durumu
Ara Aşama
Nihai aşama
Nihai aşama
Ara Aşama
Nihai aşama
Yükleme Aşamasında (substatus den nihai durum kontrol
edilmeli)
Paketleme Aşamasında (substatus den nihai durum kontrol
edilmeli)
Gönderilecek Fatura İmzalama Aşamasında (substatus den
nihai durum kontrol edilmeli)
Fatura Gönderimi Aşamasında (substatus den nihai durum
kontrol edilmeli)
Fatura Alındı Aşamasında (substatus den nihai durum kontrol
edilmeli)
Gönderilmiş olan ticari fatura alıcı tarafından kabul edilmiştir.
(substatus den nihai durum kontrol edilmeli)
Gönderilmiş olan ticari fatura alıcı reddedilmiştir.(substatus den
nihai durum kontrol edilmeli)
Gelen Ticari Fatura Kabul Edilmiştir (substatus den nihai durum
kontrol edilmeli)
Gelen Ticari Fatura Kabul Reddedilmiştir. (substatus den nihai
durum kontrol edilmeli)
Faturanın Gelirler İdaresindeki Durumu Kontrol Ediliyor.
(substatus den nihai durum kontrol edilmeli)
Yaygın Karşılaşılan Fatura Durumları
STATUS
LOAD
LOAD
SEND
SEND
SEND
SUBSTATUS
SUCCEED
FAILED
PROCESSING
SUCCEED
FAILED
SEND
SEND
WAIT_SYSTEM_RESPONSE
WAIT_APPLICATION_RESPONSE
Detaylı Acıklama
Fatura Yükleme Başarılı
Fatura Yükleme Hatalı
Fatura Gonderımi Yapılıyor
Temel Fatura Gönderimi Başarılı
Fatura Gönderiminde Hata Alındı
Fatura GIB e gönderildi GIB den faturanın alındığına dair sistem
yanıtı bekleniyor
Ticari Fatura Alıcıdan Cevap Bekliyor
ACCEPTED
SUCCEED
Gönderilmiş olan ticari fatura alıcı tarafından kabul edilmiştir ve
alıcının kabul yanıtı gönderen tarafa başarılı şekilde ulaşmıştır.
REJECTED
SUCCEED
ACCEPT
SUCCEED
Gönderilmiş olan ticari fatura alıcı tarafından red edilmiştir ve
alıcının red yanıtı gönderen tarafa başarılı şekilde ulaşmıştır.
Gelen Ticari Fatura Kabul Edilmiştir ve kabul yanıtı göndericiye
başarılı bir şekilde ulaştırılmıştır.
TASNİF DIŞI
.doc
Sayfa 43 / 54
Aşama
Durumu
Nihai Aşama
Nihai Aşama
Ara aşama
Nihai Aşama
Nihai Aşama
Ara aşama
Ara aşama
Nihai Aşama
Nihai Aşama
Nihai Aşama
REJECT
SUCCEED
Gelen Ticari Fatura Red Edilmiştir ve red yanıtı göndericiye başarılı
bir şekilde ulaştırılmıştır.
TASNİF DIŞI
.doc
Sayfa 44 / 54
Nihai Aşama
3.7
WSDL-WebService Description of Operations
Please refer to below for technical description of WSDL.
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<?xml-stylesheet type="text/xsl" href="http://tomi.vanek.sk/xml/wsdl-viewer.xsl"?>
<wsdl:definitions name="EFaturaOIB2"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:tns="http://schemas.i2i.com/ei/wsdl"
targetNamespace="http://schemas.i2i.com/ei/wsdl">

<wsdl:types>
<xsd:schema>
<xsd:import namespace="http://schemas.i2i.com/ei/wsdl" schemaLocation="xsd/i2iefatura-ws.xsd" />
</xsd:schema>
</wsdl:types>
<wsdl:message name="PrepareProcessUserRequestMessage">
<wsdl:part name="parameters" element="tns:PrepareProcessUserRequest" />
</wsdl:message>
<wsdl:message name="PrepareProcessUserResponseMessage">
<wsdl:part name="parameters" element="tns:PrepareProcessUserResponse" />
</wsdl:message>
<wsdl:message name="PrepareCancelUserRequestMessage">
<wsdl:part name="parameters" element="tns:PrepareCancelUserRequest" />
</wsdl:message>
<wsdl:message name="PrepareCancelUserResponseMessage">
<wsdl:part name="parameters" element="tns:PrepareCancelUserResponse" />
</wsdl:message>
<wsdl:message name="ProcessUserRequestMessage">
<wsdl:part name="parameters" element="tns:ProcessUserRequest" />
</wsdl:message>
<wsdl:message name="ProcessUserResponseMessage">
<wsdl:part name="parameters" element="tns:ProcessUserResponse" />
</wsdl:message>
<wsdl:message name="CancelUserRequestMessage">
<wsdl:part name="parameters" element="tns:CancelUserRequest" />
</wsdl:message>
<wsdl:message name="CancelUserResponseMessage">
<wsdl:part name="parameters" element="tns:CancelUserResponse" />
</wsdl:message>

<wsdl:message name="RequestFaultMessage">
<wsdl:part name="parameters" element="tns:RequestFault" />
</wsdl:message>

<wsdl:portType name="EFaturaOIB2Port">
<wsdl:operation name="PrepareProcessUser">
<wsdl:input message="tns:PrepareProcessUserRequestMessage" />
<wsdl:output message="tns:PrepareProcessUserResponseMessage" />
<wsdl:fault name="RequestFault" message="tns:RequestFaultMessage" />
</wsdl:operation>
<wsdl:operation name="PrepareCancelUser">
<wsdl:input message="tns:PrepareCancelUserRequestMessage" />
<wsdl:output message="tns:PrepareCancelUserResponseMessage" />
</wsdl:operation>
<wsdl:operation name="ProcessUser">
TASNİF DIŞI
.doc
Sayfa 45 / 54
<wsdl:input message="tns:ProcessUserRequestMessage" />
<wsdl:output message="tns:ProcessUserResponseMessage" />
</wsdl:operation>
<wsdl:operation name="CancelUser">
<wsdl:input message="tns:CancelUserRequestMessage" />
<wsdl:output message="tns:CancelUserResponseMessage" />
</wsdl:operation>
</wsdl:portType>

<wsdl:binding name="EFaturaOIB2PortBinding" type="tns:EFaturaOIB2Port">
<soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http" />
<wsdl:operation name="PrepareProcessUser">
<soap:operation soapAction="" />
<wsdl:input>
<soap:body use="literal" />
</wsdl:input>
<wsdl:output>
</wsdl:output>
<wsdl:fault name="RequestFault">
<soap:fault name="RequestFault" use="literal" />
</wsdl:fault>
</wsdl:operation>
<wsdl:operation name="ProcessUser">
<wsdl:input>
</wsdl:input>
<wsdl:output>
</wsdl:output>
</wsdl:fault>
</wsdl:operation>
<wsdl:operation name="PrepareCancelUser">
<wsdl:input>
</wsdl:input>
<wsdl:output>
</wsdl:output>
</wsdl:fault>
</wsdl:operation>
<wsdl:operation name="CancelUser">
<wsdl:input>
</wsdl:input>
<wsdl:output>
</wsdl:output>
</wsdl:fault>
</wsdl:operation>
</wsdl:binding>

<wsdl:service name="EFaturaOIB2">
<wsdl:port name="EFaturaOIB2Port" binding="tns:EFaturaOIB2PortBinding">
<soap:address location="http://gosb.i2i-systems.com:3090/EFaturaOIB2" />
</wsdl:port>
</wsdl:service>
TASNİF DIŞI
.doc
Sayfa 46 / 54
</wsdl:definitions>
3.8
Interface Entity Specifications
Since entities are specified very detailed conformed to W3C XML Specification, please refer to
VAKIFBANK EFATURA.xsd attached.
<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns="http://schemas.i2i.com/ei/wsdl"
targetNamespace="http://schemas.i2i.com/ei/wsdl" xmlns:e="http://schemas.i2i.com/ei/entity"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:pck="http://www.efatura.gov.tr/packagenamespace" xmlns:xmime="http://www.w3.org/2005/05/xmlmime"
xmlns:hr="http://www.hr-xml.org/3"
xmlns:udt="urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule:2">
<xsd:import namespace="http://schemas.i2i.com/ei/common" schemaLocation="i2i-efaturacommon.xsd" />
<xsd:import namespace="http://schemas.i2i.com/ei/entity" schemaLocation="i2i-efaturaentity.xsd" />
<xsd:import namespace="http://www.w3.org/2005/05/xmlmime" schemaLocation="i2i-efaturamime.xsd" />
<xsd:import
namespace="urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule:2"
schemaLocation="common/UnqualifiedDataTypeSchemaModule-2.0.xsd" />

<xsd:element name="RequestFault" type="e:REQUEST_ERRORType" />
<xsd:complexType name="INVOICE">
<xsd:sequence>
<xsd:element name="HEADER" minOccurs="0">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="SENDER" type="xsd:token" minOccurs="0" />
<xsd:element name="RECEIVER" type="xsd:token" minOccurs="0" />
<xsd:element name="SUPPLIER" type="xsd:string" minOccurs="0" />
<xsd:element name="CUSTOMER" type="xsd:string" minOccurs="0" />
<xsd:element name="ISSUE_DATE" type="xsd:date" minOccurs="0" />
<xsd:element name="PAYABLE_AMOUNT" type="udt:AmountType" minOccurs="0" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="CONTENT" type="xmime:base64Binary" minOccurs="0" />
</xsd:sequence>
<xsd:attribute name="ID" type="xsd:token" use="optional"></xsd:attribute>
<xsd:attribute name="UUID" type="xsd:token" use="optional"></xsd:attribute>
</xsd:complexType>
<xsd:simpleType name="USERTYPE">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="USER" />
<xsd:enumeration value="ARCHIVE" />
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="SIGNTYPE">
<xsd:enumeration value="HSM_CUSTOMER" />
<xsd:enumeration value="HSM_ENTEGRATOR" />
<xsd:enumeration value="HSM_CLIENT_SIGNED" />
<xsd:enumeration value="TOKEN_CUSTOMER" />
<xsd:enumeration value="TOKEN_ENTEGRATOR" />
</xsd:restriction>
TASNİF DIŞI
.doc
Sayfa 47 / 54
</xsd:simpleType>
<xsd:simpleType name="USERCONTENTTYPE">
<xsd:enumeration value="PROCESSUSER" />
<xsd:enumeration value="CANCELUSER" />
</xsd:restriction>
</xsd:simpleType>

<xsd:element name="LoginRequest" type="LoginRequest" />
<xsd:complexType name="LoginRequest">
<xsd:complexContent>
<xsd:extension base="e:REQUEST">
<xsd:sequence>
<xsd:element name="USER_NAME" type="xsd:string" />
<xsd:element name="PASSWORD" type="xsd:string" />
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:element name="LoginResponse" type="LoginResponse" />
<xsd:complexType name="LoginResponse">
<xsd:sequence>
<xsd:element name="REQUEST_RETURN" type="e:REQUEST_RETURNType" minOccurs="0" />
<xsd:element name="SESSION_ID" type="xsd:token"></xsd:element>
</xsd:sequence>
</xsd:complexType>

<xsd:element name="LogoutRequest" type="LogoutRequest" />
<xsd:complexType name="LogoutRequest">
</xsd:extension>
</xsd:complexType>
<xsd:element name="LogoutResponse" type="LogoutResponse" />
<xsd:complexType name="LogoutResponse">
<xsd:sequence>
<xsd:element name="REQUEST_RETURN" type="e:REQUEST_RETURNType" minOccurs="0">
</xsd:element>
</xsd:sequence>
</xsd:complexType>

<xsd:complexType name="USERCONTENT">
<xsd:extension base="xmime:base64Binary">
<xsd:attribute name="USERID" type="xsd:string" />
<xsd:attribute name="USERTYPE" type="USERTYPE" default="USER" />
<xsd:attribute name="SIGNTYPE" type="SIGNTYPE" use="optional" />
<xsd:attribute name="TYPE" type="USERCONTENTTYPE" use="optional" />
</xsd:extension>
</xsd:complexType>
<xsd:complexType name="UserRequest">
<xsd:sequence>
<xsd:element name="USERCONTENT" type="USERCONTENT" minOccurs="1"
maxOccurs="unbounded" />
</xsd:sequence>
</xsd:extension>
</xsd:complexType>
<xsd:complexType name="UserResponse">
<xsd:sequence>
<xsd:element name="USERCONTENT" type="USERCONTENT" minOccurs="1"
TASNİF DIŞI
.doc
Sayfa 48 / 54
</xsd:sequence>
</xsd:complexType>

<xsd:element name="PrepareProcessUserRequest" type="UserRequest" />
<xsd:element name="PrepareProcessUserResponse" type="UserResponse" />

<xsd:element name="PrepareCancelUserRequest" type="UserRequest" />
<xsd:element name="PrepareCancelUserResponse" type="UserResponse" />

<xsd:element name="ProcessUserRequest" type="UserRequest" />
<xsd:element name="ProcessUserResponse" type="e:REQUEST_RETURNType" />

<xsd:element name="CancelUserRequest" type="UserRequest" />
<xsd:element name="CancelUserResponse" type="e:REQUEST_RETURNType" />

<xsd:element name="SendInvoiceRequest" type="SendInvoiceRequest" />
<xsd:complexType name="SendInvoiceRequest">
<xsd:sequence>
<xsd:element name="SENDER">
<xsd:complexType>
<xsd:attribute name="vkn" type="xsd:string" />
<xsd:attribute name="alias" type="xsd:string" />
</xsd:complexType>
</xsd:element>
<xsd:element name="RECEIVER">
<xsd:complexType>
<xsd:attribute name="vkn" type="xsd:string" />
<xsd:attribute name="alias" type="xsd:string" />
</xsd:complexType>
</xsd:element>
<xsd:element name="INVOICE" type="INVOICE" minOccurs="1" maxOccurs="unbounded"
/>
</xsd:sequence>
</xsd:extension>
</xsd:complexType>
<xsd:element name="SendInvoiceResponse" type="SendInvoiceResponse" />
<xsd:complexType name="SendInvoiceResponse">
<xsd:sequence>
<xsd:element name="REQUEST_RETURN" type="e:REQUEST_RETURNType" minOccurs="0" />
</xsd:sequence>
</xsd:complexType>

<xsd:element name="GetInvoiceRequest" type="GetInvoiceRequest" />
<xsd:complexType name="GetInvoiceRequest">
<xsd:sequence>
<xsd:element name="INVOICE_SEARCH_KEY">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="LIMIT" type="xsd:int" minOccurs="0" />
<xsd:element name="ID" type="xsd:normalizedString" minOccurs="0" />
<xsd:element name="UUID" type="xsd:normalizedString" minOccurs="0" />
<xsd:element name="FROM" type="xsd:token" minOccurs="0" />
<xsd:element name="TO" type="xsd:token" minOccurs="0" />
<xsd:element name="START_DATE" type="xsd:date" minOccurs="0" />
<xsd:element name="END_DATE" type="xsd:date" minOccurs="0" />
<xsd:element name="READ_INCLUDED" type="xsd:boolean" minOccurs="0" />
<xsd:element name="DIRECTION" type="xsd:token" minOccurs="0" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="HEADER_ONLY" type="xsd:token" minOccurs="0" default="N" />
</xsd:sequence>
</xsd:extension>
TASNİF DIŞI
.doc
Sayfa 49 / 54
</xsd:complexType>
<xsd:element name="GetInvoiceResponse" type="GetInvoiceResponse" />
<xsd:complexType name="GetInvoiceResponse">
<xsd:sequence>
<xsd:element name="INVOICE" type="INVOICE" minOccurs="0"
maxOccurs="unbounded"></xsd:element>
</xsd:sequence>
</xsd:complexType>

<xsd:element name="MarkInvoiceRequest" type="MarkInvoiceRequest" />
<xsd:complexType name="MarkInvoiceRequest">
<xsd:sequence>
<xsd:element name="MARK" minOccurs="1">
<xsd:complexType>
<xsd:sequence>
</xsd:sequence>
<xsd:attribute name="value">
<xsd:simpleType>
<xsd:restriction base="xsd:token">
<xsd:enumeration value="READ" />
<xsd:enumeration value="UNREAD" />
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:extension>
</xsd:complexType>
<xsd:element name="MarkInvoiceResponse" type="MarkInvoiceResponse" />
<xsd:complexType name="MarkInvoiceResponse">
<xsd:sequence>
</xsd:element>
</xsd:sequence>
</xsd:complexType>

<xsd:element name="PrepareInvoiceResponseRequest" type="PrepareInvoiceResponseRequest" />
<xsd:complexType name="PrepareInvoiceResponseRequest">
<xsd:sequence>
<xsd:element name="STATUS" type="xsd:token"></xsd:element>
</xsd:sequence>
</xsd:extension>
</xsd:complexType>
<xsd:element name="PrepareInvoiceResponseResponse" type="PrepareInvoiceResponseResponse" />
<xsd:complexType name="PrepareInvoiceResponseResponse">
<xsd:sequence>
<xsd:element name="APPRESPONSE" type="xmime:base64Binary" minOccurs="1"
</xsd:sequence>
</xsd:complexType>

<xsd:element name="SendInvoiceResponseRequest" type="SendInvoiceResponseRequest" />
<xsd:complexType name="SendInvoiceResponseRequest">
<xsd:sequence>
<xsd:element name="APPRESPONSE" type="xmime:base64Binary" minOccurs="1"
TASNİF DIŞI
.doc
Sayfa 50 / 54
</xsd:sequence>
</xsd:extension>
</xsd:complexType>
<xsd:element name="SendInvoiceResponseResponse" type="SendInvoiceResponseResponse" />
<xsd:complexType name="SendInvoiceResponseResponse">
<xsd:sequence>
</xsd:element>
</xsd:sequence>
</xsd:complexType>

<xsd:element name="GetUserListRequest" type="GetUserListRequest" />
<xsd:complexType name="GetUserListRequest">
<xsd:sequence>
<xsd:element name="REGISTER_TIME_START" type="xsd:dateTime" minOccurs="0" />
<xsd:element name="FORMAT" type="xsd:token" minOccurs="0" default="XML" />
</xsd:sequence>
</xsd:extension>
</xsd:complexType>
<xsd:element name="GetUserListResponse" type="GetUserListResponse" />
<xsd:complexType name="GetUserListResponse">
<xsd:choice>
<xsd:element name="USER" type="GIBUSER" minOccurs="0" maxOccurs="unbounded" />
<xsd:element name="CSV" minOccurs="0" maxOccurs="1" type="xmime:base64Binary" />
</xsd:choice>
</xsd:complexType>

<xsd:element name="CheckUserRequest" type="CheckUserRequest" />
<xsd:complexType name="CheckUserRequest">
<xsd:sequence>
<xsd:element name="USER" type="GIBUSER" minOccurs="1" />
</xsd:sequence>
</xsd:extension>
</xsd:complexType>
<xsd:element name="CheckUserResponse" type="CheckUserResponse" />
<xsd:complexType name="CheckUserResponse">
<xsd:sequence>
<xsd:element name="USER" type="GIBUSER" minOccurs="0" maxOccurs="unbounded" />
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="GIBUSER">
<xsd:sequence>
<xsd:element name="IDENTIFIER" type="xsd:string" minOccurs="0"></xsd:element>
<xsd:element name="ALIAS" type="xsd:string" minOccurs="0"></xsd:element>
<xsd:element name="TITLE" type="xsd:string" minOccurs="0"></xsd:element>
<xsd:element name="TYPE" type="xsd:string" minOccurs="0"></xsd:element>
<xsd:element name="REGISTER_TIME" type="xsd:string" minOccurs="0"></xsd:element>
<xsd:element name="UNIT" type="xsd:token" minOccurs="0"></xsd:element>
</xsd:sequence>
</xsd:complexType>

<xsd:element name="GetInvoiceStatusRequest" type="GetInvoiceStatusRequest" />
<xsd:complexType name="GetInvoiceStatusRequest">
<xsd:sequence>
<xsd:element name="INVOICE" type="INVOICE" minOccurs="1" />
</xsd:sequence>
</xsd:extension>
</xsd:complexType>
<xsd:element name="GetInvoiceStatusResponse" type="GetInvoiceStatusResponse" />
TASNİF DIŞI
.doc
Sayfa 51 / 54
<xsd:complexType name="GetInvoiceStatusResponse">
<xsd:sequence>
<xsd:element name="INVOICE_STATUS">
<xsd:complexType>
<xsd:extension base="INVOICE">
<xsd:sequence>
<xsd:element name="STATUS" type="xsd:string" minOccurs="1" />
<xsd:element name="STATUS_DESCRIPTION" type="xsd:string" minOccurs="1"
/>
</xsd:sequence>
</xsd:extension>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>

<xsd:element name="LoadInvoiceRequest" type="LoadInvoiceRequest" />
<xsd:complexType name="LoadInvoiceRequest">
<xsd:sequence>
<xsd:element name="INVOICE" type="INVOICE" minOccurs="1" maxOccurs="unbounded"
/>
</xsd:sequence>
</xsd:extension>
</xsd:complexType>
<xsd:element name="LoadInvoiceResponse" type="LoadInvoiceResponse" />
<xsd:complexType name="LoadInvoiceResponse">
<xsd:sequence>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:schema>
TASNİF DIŞI
.doc
Sayfa 52 / 54
Document Control
Superseded Documents

N/A
Change Control & Distribution
Owner
Ömer Doğan
Reviewer
Osman MERAL, Akif İzgi
Approved By
Distribution
VAKIFBANK EFATURA_WEBSERVICE_API_v1.2.1.doc
File Name
Version History
Version
Change Descriptions
Author
Date
1.0.0
İlk Dokuman
Ömer Doğan
25/07/2013
1.1.0
Güncellemeler
Osman Meral
30/07/2013
1.1.1
Güncellemeler
Ömer Doğan
22/10/2013
1.1.3
mixed=true ozelligi i2i-efatura-ws şemasından
ayıklandı
Ömer Doğan
25/10/2013
1.2.0
LoadInvoice operasyonu eklendi,
Schema complex tipleri sadeleştirildi ve content ara
tipleri tanımlamaları çıkarıldı.
Ömer Doğan
28/10/2013
1.2.1
SOAP v1.2’den SOAP v1.1’e versiyon geçişi
tamamlandı.
Ömer Doğan
04/11/2013
GETINVOICE operasyonu için istek mesajına isteğe
bağlı HEADER_ONLY parametresi eklendi.
GETUSERLIST operasayonu için istek mesajına
isteğe bağlı FORMAT parametresi eklendi, (XML|
CSV) degerleri desteklenmektedir.
GETUSERLIST ve CHECKUSER operasyonları için
cevap mesajı ortak bir tip dönecek şekilde UNIT
parametresi eklenerek güncellenmiştir, UNIT
parameteresi (PK|GB) degerlerinini desteklemektedir
ilgili kaydın Posta Kutusu yada Gonderici Birim’e ait
olup olmadıgını bildirmektedir.
REQUESTFAULT tipi RequestFaultResponse ara
TASNİF DIŞI
.doc
Sayfa 53 / 54
elemanı çıkarılarak sadeleştirildi
GetInvoice servis detayı güncellendi.
1.2.2
Durum bölümü eklendi.
1.2.2
LoadInvoice servisine ait input değerleri güncellendi
Uğur Saykılı
04/12/2013
Uğur Saykılı
07/12/2013
Approvals
This document requires the following approvals:
Name
Title
Date
TASNİF DIŞI
.doc
Signature
Version
Sayfa 54 / 54

efatura özel entegrasyon platformu

Transkript

Benzer belgeler

zibiz SAP E-Fatura V101

Logo E-Defter Uygulaması

acil aydınlatma kiti bağlantı şemaları emergency

İmzalama Aracı Kullanım Kılavuzu-v1.0 - E

Medula Hastane Uygulamasında Yapılacak Değişikliklere İlişkin

MOBILEPAX ENTERPRISE API (WEB SERVİS)

Geliştirici Kılavuzu

BROADG YUVARLAK KANAL MENFEZİ

Diğer Entegrasyonlar - Protel E

web`den başlatma

Sonuç Bildirim Listesi için tıklayınız.

E-Fatura Aktarımı