> For the complete documentation index, see [llms.txt](https://developer.tokeninc.com/token-developer-portal-1/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.tokeninc.com/token-developer-portal-1/x-platform/z-report-service/gelistirici-dokumani.md). # Geliştirici Dökümanı Bu döküman geliştiriciler için Z-Raporu apilerinin kullanımı için genel bir kılavuz niteliğindedir. Development ortamında ECR üzerinde çalışan servisler için cloud ortamında base url'i tanımlanmıştır. Servislerde kullanılan generic response yapısı şu şekildedir: ```json { "status": 0, (int) "message": "OK", (String) "detail": null (Object) } ``` **Response payload değişkenleri:** **status : Cevabın status kodunu belirten integer değerdir. Başarılı durumlar için 0 hata durumları için uygun status kodunu döner.** **message: Statuse göre dönen string cevap mesajıdır. Başarılı cevaplar için "OK" olarak döner.** **detail: Servisin dönmesi gereken bir detay bilgisi varsa bu alanda döndürülür. Detail alanı herhangi bir obje tipinde olabilir.** ## **Z Raporu Kontrol Servisleri** ### **Get Report Details** Path Variable olarak verilen uuid'li raporun detay bilgilerini döner **Örnek Response Body:** ```json { "status": 0, "message": "OK", "detail": { "dateTime": "1706693610000", (Long-Unix Timestamp in MS) "terminalId": "TestUserTerminal", (String) "ejNo": 1, (short) "zNo": 2, (short) "receiptNo": 3, (short) "documentNum": 4, // Optional (short) "saleReceiptNum": 5, (short) "fiscalReceiptNum": 6, (short) "cumTotal": 3809, (long) "cumTotalVat": 761, (long) "macTotal": 3809, //Optional (long) "macTotalVat": 761, //Optional(long) "total": 3809, (long) "surchargeAmount": 0, // Optional (long) "discountQuantity": 2, // Optional (short) "discountAmount": 200, // Optional (long) "cancelItemQuantity": 1, // Optional (short) "cancelItemAmount": 100, // Optional (long) "cancelReceiptQuantity": 1, // Optional (short) "cancelReceiptAmount": 100, // Optional (long) "cancelReportQuantity": 1, // Optional (short) "cancelReportAmount": 100, // Optional (long) "pharmacyQuantity": 1, // Optional (short) "pharmacyAmount": 100, // Optional (long) "vats": [ // Optional { "rate" : 10, (short) "total":100, (long) "totalVat":10 (long) } ], "sections": [ // Optional { "sectionNo":1 ,(short) "sectionName":Gıda, (String) "quantity":50, (int) "vatRate":10, (short) "amount" : 1000, (long) } ], "payments": [ // Optional { "quantity" : 1, (short) "amount": 100, (int) "type" : 0 (short) } ], "infoReceipts": [ { "quantity": 1000, (short) "amount": 25000, (long) "type": 9000, (short) } ], "totalVat": 761, (long) "cashierRecords": [ // Optional { "quantity": 15, (short) "amount": 15, (long) "name": "Kasiyer A" // Optional }, { "quantity": 30, (short) "amount": 10, (long) "name": "Kasiyer B" // Optional } ] , "terminalId": "TestUserTerminal", "zno": 2 } } ``` | İstek Değişkeni | Tanım | Optional/Zorunlu | | --------------------- | -------------------------------------------- | ---------------- | | dateTime | Rapor tarihi | Zorunlu | | terminalId | Raporun oluşturulduğu cihazın numarası | Zorunlu | | ejNo | Ekü numarası | Zorunlu | | zNo | Z numarası | Zorunlu | | receiptNo | Fiş numarası | Zorunlu | | documentNum | Belge numarası | Optional | | saleReceiptNum | Satış fişi numarası | Optional | | fiscalReceiptNum | Mali fiş numarası | Optional | | cumTotal | Kümülatif toplam değeri | Zorunlu | | cumTotalVat | Kümülatif vergi toplamı değeri | Zorunlu | | macTotal | Kurtarılan KDV Oran Toplamı | Optional | | macTotalVat | Kurtarılan vergi miktarı Toplamı | Optional | | surchargeQuantity | Artırım miktarı | Optional | | surchargeAmount | Artırım değeri | Optional | | discountQuantity | İndirim miktarı | Optional | | discountAmount | İndirim değeri | Optional | | total | Total değer | Zorunlu | | cancelItemQuantity | İptal edilen ürün miktarı | Optional | | cancelItemAmount | İptal edilen ürün değeri | Optional | | cancelReceiptQuantity | İptal fişi miktarı | Optional | | cancelReceiptAmount | İptal fişi değeri | Optional | | cancelReportQuantity | İptal edilen rapor miktarı | Optional | | cancelReportAmount | İptal edilen rapor değeri | Optional | | pharmacyQuantity | Eczane katkı payı miktarı | Optional | | pharmacyAmount | Eczane katkı payı değeri (Matrah dışı tutar) | Optional | | vats | kdv oran ve miktarları | Optional | | sections | kısım listesi | Optional | | payments | [ödeme listesi](#odeme-tipleri) | Optional | | totalVat | toplam kdv | Zorunlu | | cashierRecords | kasiyer kayıtları | Optional | | infoReceipts | bilgi fişleri | Optional | {% hint style="info" %} Dönen detay bilgileri z raporu gönderme servisinde gönderilen değişkenlerin aynılarını kapsar. Kaydedilmemiş optional alanlar null olarak döner. {% endhint %} {% hint style="info" %} Tutar değerleri 100 ile çarpılmış, miktar değerleri ise 1000 ile çarpılmış şekilde kaydedilir. {% endhint %}
Bilgi Fişi TipleriKod
FATURA9005
E-FATURA BİLGİ FİŞİ9006
E-ARŞİV BİLGİ FİŞİ9007
AVANS9000
CARİ TAHSİLAT9002
TAHSİLAT9001
**Status:** **0: Başarılı** **3: Rapor Bulunamadı** **6: UUID Formatı Hatalı** ### **Get Totals Between Dates** İstek parametresinde verilen unix timestamp ms formatındaki tarihler arasındaki rapor toplam bilgilerini döner **Örnek Response Body:** ```json { "status": 0, "message": "OK", "detail": [ { "sum": 3809, "dateTime": "1704067200000" }, { "sum": 3655, "dateTime": "1704153600000" }, { "sum": 3395, "dateTime": "1704240000000" }, { "sum": 3094, "dateTime": "1704326400000" } ] ``` **Status Kodları:** **0: Başarılı** **3: Rapor Bulunamadı** **4: Datetime formatı hatalı** **5: Vkn Bulunamadı** ### **Get Summary By Terminal ID** İstekte path variable olarak verilen terminal id'ye ait tarih parametreleri arasındaki rapor özet bilgilerini döner **Örnek Response Body:** ```json { "status": 0, "message": "OK", "detail": [ { "dateTime": 1704101610000, "total": 3809, "totalVat": 761, "uuid": "85a5da69-8a4c-42d6-9cb1-b3c40e15e2e8", "zNo": 2 }, { "dateTime": 1704188010000, "total": 3655, "totalVat": 731, "uuid": "f079a017-3530-46c1-84c1-fc4db885536a", "zNo": 2 } ] } ``` **total :** O günki total değer **totalVat :** O günki toplam kdv değeri. **uuid :** Rapor uuid'si. **zNo :** Z numarası. **dateTime :** Unix Timestamp ms formatında tarih. **Status Kodları:** **0: Başarılı** **2: İki tarih arasında 32 günden fazla olamaz.** **3: Rapor bulunamadı** **5:Terminal bulunamadı** ### **Get Summary By Tax ID** İstekte path variable olarak verilen tax id'ye ait tarih parametreleri arasındaki rapor özet bilgilerini döner **Örnek Response Body:** ```json { "status": 0, "message": "OK", "detail": [ { "dateTime": 1704101610000, "total": 3809, "totalVat": 761, "uuid": "85a5da69-8a4c-42d6-9cb1-b3c40e15e2e8", "zNo": 2 }, { "dateTime": 1704188010000, "total": 3655, "totalVat": 731, "uuid": "f079a017-3530-46c1-84c1-fc4db885536a", "zNo": 2 } ] } ``` **total :** O günki total değer **totalVat :** O günki toplam kdv değeri. **uuid :** Rapor uuid'si. **zNo :** Z numarası. **dateTime :** Unix Timestamp ms formatında tarih. **Status Kodları:** **0: Başarılı** **2: İki tarih arasında 32 günden fazla olamaz.** **3: Rapor bulunamadı** **5:Tax Id bulunamadı** #### Ödeme Tipleri
Ödeme TipiDeğerAçıklama
PAYMENT_CASH1Nakit
PAYMENT_CHEQUE2Çek
PAYMENT_CREDITCARD3Kredi Kartı
PAYMENT_FOOD7Yemek Kartı
PAYMENT_ODEMESIZ8Ödemesiz
PAYMENT_IKRAM9İkram
PAYMENT_VERESIYE10Veresiye
PAYMENT_PUAN11Puan
PAYMENT_VPOS12EPOS Ödeme
PAYMENT_MOBILE13Mobil Ödeme
PAYMENT_EMONEY14E-Para Ödeme
PAYMENT_CHARITY15Bağış
PAYMENT_BOND16Bond ile Ödeme
PAYMENT_OPENACCOUNT17Açık Hesap
PAYMENT_MONEYTRANSFER18Para Transferi
PAYMENT_TRANSPORTATIONCARD19Ulaşım Kartı
PAYMENT_GIFTCARD20Hediye Kartı
**Yemek Kartı Kodları:**
Yemek Kartı Kod
EDENRED1001
MULTINET1002
SETCARD1003
SODEXO1004
TOKENFLEX1005
**Banka Kodları:**
KodBanka/Özel Finans Kurumu
001Türkiye Cumhuriyet Merkez Bankası A.Ş.
004İller Bankası
010Türkiye Cumhuriyeti Ziraat Bankası A.Ş.
012Türkiye Halk Bankası A.Ş.
013Denizbank
014Türkiye Sınai Kalkınma Bankası A.Ş.
015Türkiye Vakıflar Bankası T.A.O.
016Türkiye İhracat Kredi Bankası A.Ş. (Eximbank)
017Türkiye Kalkınma Bankası A.Ş.
029Birleşik Fon Bankası A.Ş. (Bayındırbank A.Ş.)
032Türk Ekonomi Bankası A.Ş.
034Aktif Yatırım Bankası A.Ş.
046Akbank T.A.Ş.
048HSBC Bank A.Ş.
058Sınai Yatırım Bankası A.Ş.
059Şekerbank T.A.Ş.
062Türkiye Garanti Bankası A.Ş.
064Türkiye İş Bankası A.Ş.
067Yapı ve Kredi Bankası A.Ş.
071Fortis Bank (TEB)
087Banca di Roma
088The Royal Bank of Scotland PLC Merkezi Amsterdam İstanbul Merkez Şubesi
091Arap Türk Bankası A.Ş.
092Citibank N.A.
094Bank Mellat
095BCCI
096Turkish Bank A.Ş.
097Habib Bank Limited
098JP Morgan Chase Bank İstanbul Türkiye Şubesi
099Oyak Bank A.Ş. - ING BANK
100Adabank A.Ş.
101Türk Sakura Bank A.Ş.
103Fiba Bank A.Ş.
104IMPEXBANK
106PORTIGON A.G.
107BNP-Ak-Dresdner Bank A.Ş.
108Turkland Bank A.Ş.
109Tekstil Bankası A.Ş.
110Credit Lyonnais
111Finansbank A.Ş.
113Marbank
115Deutsche Bank A.Ş.
116TAİB Yatırım Bank A.Ş.
117Turizm Yatırım ve Ticaret Bank A.Ş.
118Kıbrıs Kredi Bankası
119Birleşik Yatırım
121Standard Chartered Yatırım Bankası Türk A.Ş.
122Societe Generale
123HSBC Bank A.Ş.
124Alternatifbank A.Ş.
125Burganbank A.Ş.
127KentBank
128Park Yatırım Bankası
129Tat Yatırım Bankası A.Ş.
132IMKB Takas ve Saklama Bankası A.Ş.
133ING BANK
134Denizbank A.Ş.
135Anadolubank A.Ş.
136Okan Yatırım Bankası A Ş
137Rabobank Nederland İstanbul Merkez Şubesi
138Diler Yatırım Bankası A.Ş.
139GSD Yatırım Bankası A.Ş.
140Credit Suisse First Boston İstanbul Şubesi
141Nurol Yatırım Bankası A.Ş.
142Bank Pozitif Kredi ve Kalkınma Bankası A.Ş.
144Atlas Yatırım Bankası A.Ş.
145Morgan Guarenty Trusy Company
146OdeaBank A.Ş.
147Bank of Tokyo -Mitsubishi UFJ Turkey A.Ş.
148Intesa SanPaolo SPA İtalya-İstanbul Merkez Şubesi
203Al Baraka Türk Katılım Bankası A.Ş.
204Family Finans Kurumu
205Kuveyt Türk Katılım Bankası A.Ş.
206Türkiye Finans Katılım Bankası A.Ş.
208Asya Katılım Bankası A.Ş.
210Vakıf Katılım Bankası A.Ş.
223Al Baraka Türk Katılım Bankası A.Ş.