e-Defter Rest Api Geliştirici Kılavuzu (1.0)

Download OpenAPI specification:Download

Turkcell e-Şirket e-Defter API uç noktalarını, kullanıcı yönetiminden entegrasyon kullanıcısı oluşturarak kullanamaya başlayabilirsiniz. API kullanımı ve entegrasyon sürecinizdeki sorular için, destek@eplatform.com.tr adresinden iletişime geçebilirsiniz. Turkcell e-Şirket bünyesindeki yer alan diğer uygulamaların dökümantasyonlarına https://developer.turkcellesirket.com adresinden ulaşabilirsiniz. Servis uç noktalarımız authentication mekanizması olarak OAuth 2.0 kullanmaktadır.

Auth servis adresi; https://core.turkcellesirket.com/v1/token

Auth servis adresi; https://core.turkcellesirket.com/v1/token

Örnek token isteği;

{
-X POST https://core.turkcellesirket.com/v1/token / 
 -H 'Cache-Control: no-cache' / 
 -H 'Content-Type: application/x-www-form-urlencoded' / 
 -d 'username=yourUserName&password=yourPassword&client_id=serviceApi' 
 }

e-Defter servis adresi: https://edefterservice.turkcellesirket.com e-Defter servisini kullanarak işlem yapmak için, bu adresi baz alarak işlem gerçekleştirmelisiniz.

e-Defter

e-Defter gönderim ve sorgulama için ortak olan servis uç noktalarını içerir. Dokümanda yazılı olan metotlara ek olarak, oluşan defterin imzalanması için, uzaktan bağlantı ile bilgisayarınıza bağlanıp, e-Defter İmzalama Uygulaması yüklenerek, işlemleriniz yapılacaktır.

Get eDefter List

Oluşturulan eDefterlerin liste olarak getirilmesini sağlayan metotdur.

query Parameters
pageIndex
int

Çekmek istediğiniz başlangıç sayfasını belirtir.

pageSize
int

Çekmek istediğiniz sayfada kaç adet kayıt olması gerektiğini belirtir. Tek seferde max 500 kayıt

sortedColumn
string

Çekmek istediğiniz kayıtları, hangi alan adına göre sıralanmalı. Boş geçilebilir

isDesc
bool

Çekmek istediğiniz kayıtları , belirleyeceğiniz alana göre büyükten küçüğe sıralamak istiyorsanuz, bu alanı 'true' olarak göndermelisiniz. Herhangi bir alan adı belirtmeden, bu alanı 'true' olarak gönderirseniz, defter oluşturma tarihine göre sıralanır.

Responses

200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

Unprocessable entity

get /period/getperiodlist

Live Server

https://edefterservice.turkcellesirket.com/v1/period/getperiodlist

Test Server

https://edefterservicetest.isim360.com/v1/period/getperiodlist

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "PageIndex": null,
  • "PageSize": null,
  • "TotalCount": null,
  • "TotalPages": null,
  • "HasNextPage": null,
  • "HasPreviousPage": null,
  • "Items":
    {
    }
}

Get eDefter Part List

Oluşturulan eDefterin bölümlerini liste olarak getirilmesini sağlayan metotdur.

query Parameters
periodId
int

e-Defterin dönem id'sidir.

pageIndex
int

Çekmek istediğiniz başlangıç sayfasını belirtir.

pageSize
int

Çekmek istediğiniz sayfada kaç adet kayıt olması gerektiğini belirtir. Tek seferde max 500 kayıt

sortedColumn
string

Çekmek istediğiniz kayıtları, hangi alan adına göre sıralanmalı. Boş geçilebilir

isDesc
bool

Çekmek istediğiniz kayıtları , belirleyeceğiniz alana göre büyükten küçüğe sıralamak istiyorsanuz, bu alanı 'true' olarak göndermelisiniz. Herhangi bir alan adı belirtmeden, bu alanı 'true' olarak gönderirseniz, defter oluşturma tarihine göre sıralanır.

Responses

200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

Unprocessable entity

get /part/getlist

Live Server

https://edefterservice.turkcellesirket.com/v1/part/getlist

Test Server

https://edefterservicetest.isim360.com/v1/part/getlist

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "PageIndex": null,
  • "PageSize": null,
  • "TotalCount": null,
  • "TotalPages": null,
  • "HasNextPage": null,
  • "HasPreviousPage": null,
  • "Items":
    {
    }
}

Get eDefter Generalbook List

Oluşan eDefter parçalarında bulunan, kebir ve yevmiye kayıtlarını listeler.

path Parameters
id
int

e-Defter döneminin, parçasının id'sidir.

Responses

200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

Unprocessable entity

get /generalbook/getlistbypartid/{partId}

Live Server

https://edefterservice.turkcellesirket.com/v1/generalbook/getlistbypartid/{partId}

Test Server

https://edefterservicetest.isim360.com/v1/generalbook/getlistbypartid/{partId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "Id": null,
  • "PartId": null,
  • "GeneralbookType": "Yevmiye : 1",
  • "PeriodCoveredStart": null,
  • "PeriodCoveredEnd": null,
  • "EntryNumberStart": null,
  • "EntryNumberEnd": null,
  • "LineNumberStart": null,
  • "LineNumberEnd": null,
  • "Debit": null,
  • "Credit": null,
  • "Status": "Created : 10"
}

Get eDefter Preview

Oluşan e-Defter parçalarında ön izlemesinin yapıldığı metot.

query Parameters
generalBookId
int

e-Defter parçalarında bulunan, yevmiye veya kebir kayıtlarının Id'sidir.

previewType
int
Enum: "Yevmiye Defteri : 1" "Kebir Defteri : 2" "Yevmiye Ve Kebir Beratı : 3" "Gib Onaylı Yevmiye Ve Kebir Beratı : 4"

Hangi parçanın ön izlemesi alınacaksa tip olarak o gönderilmeli.

Responses

200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

Unprocessable entity

get /generalbook/getpreview

Live Server

https://edefterservice.turkcellesirket.com/v1/generalbook/getpreview

Test Server

https://edefterservicetest.isim360.com/v1/generalbook/getpreview

Response samples

Content type
application/json
Copy
Expand all Collapse all
null

Beratları Gib'e Gönder

Beratları Gib'e Gönder.

query Parameters
periodId
int

e-Defterin dönem id'sidir.

isTryAgain
bool

GİB'e gönderim sırasında hata almış period için true, ilk defa gönderilecek period için false değeri gönderilmelidir.

Responses

200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

Unprocessable entity

get /sendletterpattentstogib

Live Server

https://edefterservice.turkcellesirket.com/v1/sendletterpattentstogib

Test Server

https://edefterservicetest.isim360.com/v1/sendletterpattentstogib

Response samples

Content type
application/json
Copy
Expand all Collapse all
null

Post e-Defter

Txt olarak oluşturup, zip formatına çevirdiğiniz defteri,bu metot üzerinden gönderebilirsiniz.

Request Body schema: application/json
StartDate
string

Defter Başlangıç Tarihi (yyyy-mm-dd/ 2020-01-01)

EndDate
string

Defter Bitiş Tarihi (yyyy-mm-dd/ 2020-01-30)

SplitSize
Int

Gönderdiğiniz zip dosyanın boyutu (MegaByte türünden kabul edilir, MAX 150 MB)

TimeStamp
Boolean
Default: false

Bu seçenek GIB'e erişimde problem yaşanması durumunda kullanılabilir.

WithoutTaxDetail
Boolean
Default: false

Bu seçenek GIB'e erişimde problem yaşanması durumunda kullanılabilir.

Files
Multipart/form-data

edefteri zip olarak göndereceğiniz alan.

Responses

200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

Unprocessable entity

post /period

Production

https://edefterservice.turkcellesirket.com/v2/period

Test

https://edefterservicetest.isim360.com/v2/period

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "StartDate": "string",
  • "EndDate": "string",
  • "SplitSize": null,
  • "TimeStamp": false,
  • "WithoutTaxDetail": false,
  • "Files": null
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "Id": null,
  • "FiscalYearStart": null,
  • "FiscalYearEnd": null,
  • "Status": 0,
  • "IsActive": true,
  • "SplitSize": null,
  • "TimeStamp": false,
  • "WithoutTaxDetail": false,
  • "IsLiquidation": false,
  • "Task":
    {
    }
}

Delete e-Defter

Gib'e gönderilmeyen e-defterlerinizi silebileceğiniz metot, Gib'e gönderilen defterlerin silinebilmesi için, önce defterin Gib üzerinden silinmesi gerekiyor.

path Parameters
id
int

e-Defterin dönem id'sidir.

Responses

200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

Unprocessable entity

delete /period/{id}

Live Server

https://edefterservice.turkcellesirket.com/v1/period/{id}

Test Server

https://edefterservicetest.isim360.com/v1/period/{id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
null

e-Defter Format Kılavuzu

e-Defter için istenilen formatın açıklamaları.

  1. Sistemce üretilecek dokümanın ilk satırında:

    Y = Döküman Tip Bilgisi (Yevmiye defteri için “Y”)

    fiscalYearStart = GİB formatında Hesap Dönemi Başlangıcı Tarihi

    fiscalYearEnd = GİB formatında Hesap Dönemi Sonu Tarihi

    batchID = GİB formatında Şube Numarası

    entityIdentifier = VKN/TCKN Numarası

  2. Üretilen dokümanın ikinci satırından itibaren üretilecek yevmiye fişi için:

    H = Header Bilgisi (Doğrudan “H” harfi ile belirtilecektir.)

    enteredBy = GİB formatında Girişi Yapan Kişi Bilgisi

    enteredDate = GİB formatında Kayıt Tarihi Bilgisi

    entryNumber = GİB formatında Kayıt Tanıtıcısı Bilgisi

    entryComment = GİB formatında Kayıt Açıklaması

    totalDebit = GİB formatında Toplam Borç Bilgisi

    totalCredit = GİB formatında Toplam Alacak Bilgisi

    entryNumberCounter = GİB formatında Yevmiye Madde Numarası

  3. Her yevmiye fişine bağlı N adet yevmiye kaydı için aşağıdaki ifade her yeni satıra eklenmelidir:

    lineNumber = GİB formatında Satır Numarası

    lineNumberCounter = GİB formatında Yevmiye Madde Numarası

    accountMainID = GİB formatında Ana Hesap Numarası

    accountMainDescription = GİB formatında Ana Hesap Tanımlaması

    accountSubDescription = GİB formatında Alt Hesap Tanımı

    accountSubID = GİB formatında Alt Hesap

    amount = GİB formatında Parasal Tutar

    debitCreditCode = GİB formatında Borç/Alacak Tanımlayıcısı

    postingDate = GİB formatında Yevmiye Tarihi

    documentType = GİB formatında Belge Tipi

    documentTypeDescription = GİB formatında Belge Tipi Tanımlaması

    documentNumber = GİB formatında Belge Numarası

    documentReference = GİB formatında Belge Referansı

    documentDate = GİB formatında Belge Tarihi

    paymentMethod = GİB formatında Ödeme Yöntemi

    detailComment = GİB formatında Açıklama

    amountCurrency = GİB formatında Para Birimi

    amountOriginalExchangeRateDate = GİB formatında Orijinal Döviz Kuru Tarihi

    amountOriginalAmount = GİB formatında Orijinal Para Birimi Miktarı

    amountOriginalCurrency = GİB formatında Orijinal Para Birimi

    amountOriginalExchangeRate = GİB formatında Orijinal Döviz Kuru

    amountOriginalExchangeRateSource = GİB formatında Orijinal Döviz Kuru Kaynağı

    amountOriginalExchangeRateComment = GİB formatında Orijinal Döviz Kuru Açıklaması

    measurableCode = GİB formatında Ölçülebilir Kod

    measurableCodeDescription = GİB formatında Ölçülebilir Kod Tanımı

    measurableQuantity = GİB formatında Miktar

    measurableQualifier = GİB formatında Niteleyici

    measurableUnitOfMeasure = GİB formatında Ölçü Birimi

    measurableCostPerUnit = GİB formatında Birim Başı Maliyet/Fiyat

    İlk 16 karaktere kadar, üretilen çıktıda ilgili veri alanı için herhangi bir veri bulunmasa dahi ilgili alan için için bir sekme (tab) karakteri uygulanması gerektiği unutulmamalıdır. İlk 16 karakterden sonraki alanlar için zorunluluk bulunmadığı için bu alanlar dolu ise kontrolü ve kullanımı sağlanmaktadır. Eğer dövizli alanlar eklenmek istenirse 17-23 numaralı alanlarda bulunan bilgiler uygun olarak doldurulmalıdır. Eğer ölçü alanları eklenmek istenirse, 24-29 numaralı alanlarda bulunan bilgiler uygun olarak doldurulmalıdır. Ölçü alanların bulunduğu ancak dövizli alanların bulunmadığı durumlarda, dövizli alanlara ait 17-23 numaralı alanlar tab ile boş geçilerek ilerlenmelidir.

    Üretilen çıktıda, ilk 16 tablık kısımda ilgili veri alanı için herhangi bir veri bulunmasa dahi ilgili alan için bir sekme (tab) karakteri uygulanması gerektiği unutulmamalıdır.

    ERP / muhasebe sistemince üretilecek verilerin Gelir İdaresi Başkanlığı’nca ilan edilen ilgili kılavuzlarda yer alan kurallara uygun olarak üretilmesi gerekmektedir. Örneğin; yukarıdaki formatta yer alan “GİB formatında Belge Tipi” alanının formatı konusunda GİB tarafından ilan edilen “e-Defter XBRL-GL Yevmiye Defteri Kılavuzu.pdf” dosyasındaki “3.10.7 documentType” başlığı incelenmeli ve veriler bu şekilde hazırlanmalıdır. Aksi takdirde üretilen veriler ePlatform üzerinde gerçekleştirilen şema ve şematron kontrollerinden geçemeyerek GİB’e gönderimi sağlanamayacaktır.

    Cikti_Yevmiye_Etiket_Bilgisi.txt
    Cikti_Yevmiye_Ornek_Veri.txt