e-Defter SOAP Servis Entegrasyon Kılavuzu

EDefterSend

EDefterSend
Ad: EDefterSend
Açıklama: Hazırlanacak e-Defter'e ilişkin muhasebe / ERP yazılımınca uygun formatta üretilen ham veri çıktısının ePlatform sistemine yüklenebilmesine olanak sağlayan methottur. Format dökümanlarına buradan ulaşabilirsiniz.
No: Parametre Tip Açıklama Örnek Veri Ek Bilgi
1 fileSource string Oluşturulan eDefter text dosyasının ziplenip base64 formatına dönüştürülmüş hali *
2 startDate string Yüklenen defterin verilerini kapsayan dönem başlangıç tarihi. 01.1.2015
3 endDate string Yüklenen defterin verilerini kapsayan dönem bitiş tarihi. 31.1.2015
4 splitSize int Defter bölümlendirme boyutu. 20 **
5 timeStamp bool Üretilecek deftere ait beratlarda zaman damgası istenip istenilmediğini belirleyen parametre bilgisi. true
Return (EDefterServiceResultModel)
1 IsSucceed bool İlgili işlem başarılı / başarısız değeri. true
2 Result string Başarılı durumda ilgili yüklemeye ilişkin periodId değeri, başarısız durumda hata açıklama değeri.
3 CustomerId string ePlatform tarafından üretilen unique müşteri ID bilgisi. F9A87EFF-9B41-46BB-8989-976672665A11
Notlar
* Oluşturulan eDefter text dosyasının ziplenip base64 formatına dönüştürülmüş hali
** İlgili bölümlendirme boyutu minimum 1 MB. ve maximum 100 MB. olabilir.

EDefterGetStatus

EDefterGetStatus
Ad: EDefterGetStatus
Açıklama: Spesifik bir döneme ait olarak sistemde üretilmeye başlanmış e-Defter'in mevcut durumunun sorgulanmasına olanak sağlayan methottur.
No: Parametre Tip Açıklama Örnek Veri Ek Bilgi
1 userName string Mükellef kullanıcı adı bilgisi. admin
2 password string Mükellef şifre bilgisi. 123456
3 periodId int İlgili döneme ait unique dönem ID bilgisi. 1 *
Return (EDefterGetStatusModel)
1 ProgressType int İşlenmekte olan dönemin hangi durumda olduğu bilgisi (Durum Kodu). 60 **
2 ProgressName string İşlenmekte olan dönemin hangi durumda olduğu bilgisi (Durum Açıklaması). Şematron Kontrolü
3 TaskStatus int İşlenmekte olan dönem kapsamında çalışan görevin hangi durumda olduğu bilgisi. 3 ***
4 PeriodStatus int İşlenmekte olan dönem kapsamında çalışan görevin hangi durumda olduğu bilgisi. 0 ****
5 Error string Herhangi bir hata alınması durumunda görüntünebilecek hata mesajı değeri. Period bulunamadı.
6 Percent int Üzerinde çalışılan işlemin tamamlanma yüzde bilgisi. 98
7 TotalPartCount int İlgili dönem e-Defteri kapsamında belirlenen ve splitSize parametresine bağlı olarak üretilecek toplam defter parça sayısı. 8
Notlar
* EDefterUpload methodundan "Result" olarak dönen return değeridir.
** İlgili dönüşe ilişkin enumeration (ProgressType) aşağıda paylaşılmıştır.
*** İlgili dönüşe ilişkin enumeration (TaskStatus) aşağıda paylaşılmıştır.
**** İlgili dönüşe ilişkin enumeration (PeriodStatus) aşağıda paylaşılmıştır. ProgressType ve TaskStatus alanları ek bilgilendirme amacı taşıyıp, defterin şu anki nihai durumu için bu değer baz alınmalıdır.

ProgressType (Enums)

 1 ProgressTypes
 2 {
 3     Undefined = 0,
 4     Controller = 10,
 5     Txt2Xml = 20,
 6     GeneralBooksGenarator = 30,
 7     GeneralBooksSigner = 40,
 8     GeneralBooksSchemaValidator = 50,
 9     GeneralBooksSchematronValidator = 60,
10     LettersPattentsGenerator = 70,
11     LettersPattentsSigner = 80,
12     LettersPattentsSchemaValidator = 90,
13     LettersPattentsSchematronValidator = 100,
14     Done=110
15 }

TaskStatus (Enums)

1 {
2     //Test = 0,
3     Waiting = 1,
4     Queued = 2,
5     Running = 3,
6     Failed = 4,
7     Succeed = 5,
8     Deleted = 6
9 }

PeriodStatus (Enums)

1 {
2     Running = 0,
3     Completed = 1,
4     Failed = 2,
5     Archived = 3,
6     Sending = 4
7 }

EDefterRefreshTask

EDefterRefreshTask
Ad: EDefterRefreshTask
Açıklama: Geçici bir sebepten dolayı hata alan yüklemeye ilişkin sürecin tekrar denenmek üzere çalıştırılması için kullanılabilecek methottur.
No: Parametre Tip Açıklama Örnek Veri Ek Bilgi
1 userName string Mükellef kullanıcı adı bilgisi. admin
2 password string Mükellef şifre bilgisi. 123456
3 periodId int İlgili döneme ait unique dönem ID bilgisi. 1
Return (EDefterServiceResultModel)
1 IsSucceed bool İlgili işlem başarılı / başarısız değeri. true
2 Result string Başarılı durumda ilgili yüklemeye ilişkin periodId değeri, başarısız durumda hata açıklama değeri.
3 CustomerId string ePlatform tarafından üretilen unique müşteri ID bilgisi. F9A87EFF-9B41-46BB-8989-976672665A11

EDefterDelete

EDefterDelete
Ad: EDefterDelete
Açıklama: Sistem üzerinde üretilen ve henüz arşivlenmemiş e-Defter'in silinmesine olanak sağlayan methottur.
No: Parametre Tip Açıklama Örnek Veri Ek Bilgi
1 userName string Mükellef kullanıcı adı bilgisi. admin
2 password string Mükellef şifre bilgisi. 123456
3 periodId int İlgili döneme ait unique dönem ID bilgisi. 1
Return (EDefterServiceResultModel)
1 IsSucceed bool İlgili işlem başarılı / başarısız değeri. true
2 Result string Başarılı durumda ilgili yüklemeye ilişkin periodId değeri, başarısız durumda hata açıklama değeri.
3 CustomerId string ePlatform tarafından üretilen unique müşteri ID bilgisi. F9A87EFF-9B41-46BB-8989-976672665A11

EDefterGetGeneralBooks

EDefterGetGeneralBooks
Ad: EDefterGetGeneralBooks
Açıklama: Sisteme yüklenmiş ve üretimi başarıyla tamamlanmış spesifik bir döneme ait tüm defterlerin listelenmesine olanak sağlayan methottur.
No: Parametre Tip Açıklama Örnek Veri Ek Bilgi
1 userName string Mükellef kullanıcı adı bilgisi. admin
2 password string Mükellef şifre bilgisi. 123456
3 periodId int İlgili döneme ait unique dönem ID bilgisi. 1 *
Return (List)
1 Id int Sistemde üretilen spesifik bir e-Defter'in spesifik bir defter parçasına ait yevmiye ya da büyük defter ID bilgisi. 121
2 PartId int Sistemde üretilen spesifik bir e-Defter'in spesifik bir defter parçasına ait ID bilgisi. 81
3 PartIndex int Sistemde üretilen spesifik bir e-Defter'in spesifik bir defter parçasına ait indis bilgisi. 81
4 GeneralBookType int Sistemde üretilen spesifik bir e-Defter'in spesifik bir defter parçasına ait defter tip bilgisi. 1 *
5 GeneralBookPath string Sistemde üretilen spesifik bir e-Defter'in spesifik bir defter parçasına ait yevmiye ya da büyük deftere ait dosya yolu bilgisi. - **
6 LettersPatentPath string Sistemde üretilen spesifik bir e-Defter'in spesifik bir defter parçasına ait imzasız berata ait dosya yolu bilgisi. - **
7 SignedLettersPatentPath string Sistemde üretilen spesifik bir e-Defter'in spesifik bir defter parçasına ait imzalı berata ait dosya yolu bilgisi. - **
8 PeriodCoveredStart DateTime Sistemde üretilen spesifik bir e-Defter'in spesifik bir defter parçasında yer alan muhasebe kayıtlarının kapsadığı tarihe ilişkin başlangıç tarih bilgisi. 2015-01-01T00:00:00
9 PeriodCoveredEnd DateTime Sistemde üretilen spesifik bir e-Defter'in spesifik bir defter parçasında yer alan muhasebe kayıtlarının kapsadığı tarihe ilişkin bitiş tarih bilgisi. 2015-01-01T00:00:00
Notlar
* İlgili dönüşe ilişkin enumeration (GeneralBookTypes) aşağıda paylaşılmıştır.
** İlgili dönüş değerleri bir sonraki versiyonda yayından kaldırılacağından geliştirilmeye dahil edilmesi önerilmemektedir.

GeneralBookTypes (Enums)

1 {
2     UnDefined = 0,
3     Journal = 1,
4     Ledger = 2
5 }

EDefterGetPreview

EDefterGetPreview
Ad: EDefterGetPreview
Açıklama: Sisteme yüklenmiş ve tamamlanmış defterlerin önizlemesinin görüntülenmesini sağlayan methottur.
No: Parametre Tip Açıklama Örnek Veri Ek Bilgi
1 userName string Mükellef kullanıcı adı bilgisi. admin
2 password string Mükellef şifre bilgisi. 123456
3 generalBookId int Sistemde üretilen spesifik bir e-Defter'in spesifik bir defter parçasına ait yevmiye ya da büyük defter ID bilgisi. 121
4 generalBookType int Sistemde üretilen spesifik bir e-Defter'in spesifik bir defter parçasına ait defter tip bilgisi. (1-Defter, 3-GİB İmzasız Berat, 4-GİB İmzalı Berat) 1
Return (EDefterServiceResultModel)
1 IsSucceed bool İlgili işlem başarılı / başarısız değeri. true
2 Result string Başarılı durumda ilgili yüklemeye ilişkin periodId değeri, başarısız durumda hata açıklama değeri.
3 FileName string Önizleme methodu kapsamında boş dönüş yapacaktır.
4 FileSource string Sistemde üretilen spesifik bir e-Defter'in spesifik bir defter parçasına ait yevmiye, büyük defter ya da beratların XSLT giydirilmiş HTML BASE64 değeri. VEVTVF9CRVJBVF9JQ0VSSUdJX1NUUkVBTUk=

EDefterDownload

EDefterDownload
Ad: EDefterDownload
Açıklama: Sisteme yüklenen ve tamamlanan spesifik bir döneme ait defterlerin ve/veya beratların karşıdan yüklenilmesine olanak sağlayan methottur.
No: Parametre Tip Açıklama Örnek Veri Ek Bilgi
1 userName string Mükellef kullanıcı adı bilgisi. admin
2 password string Mükellef şifre bilgisi. 123456
3 periodId int İlgili döneme ait unique dönem ID bilgisi. 121
4 type int Karşıdan yüklenmek istenen içeriğe ilişkin tip bilgisi (1-Tüm Çıktılar, 2-Sadece Beratlar) 1
Return (EDefterServiceResultModel)
1 IsSucceed bool İlgili işlem başarılı / başarısız değeri. true
2 Result string Başarılı durumda ilgili yüklemeye ilişkin periodId değeri, başarısız durumda hata açıklama değeri.
3 FileName string İlgili çıktıların derlenmiş ve zip formatında sıkıştırılmış haline ilişkin dosya adı.
4 FileSource string Sistemde üretilen spesifik bir döneme ait e-Defter'in (Tüm çıktılar veya sadece beratlar) çıktılarının zip formatında sıkıştırıldıktan sonra alınan BASE64 değeri. VEVTVF9CRVJBVF9JQ0VSSUdJX1NUUkVBTUk=

EdefterUploadLetterPatents

EdefterUploadLetterPatents
Ad: EdefterUploadLetterPatents
Açıklama: GİB tarafından imzalanarak teslim alınan beratların sisteme yüklenerek ilgili dönemin arşivlenmesine olanak sağlayan methottur.
No: Parametre Tip Açıklama Örnek Veri Ek Bilgi
1 userName string Mükellef kullanıcı adı bilgisi. admin
2 password string Mükellef şifre bilgisi. 123456
3 periodId int İlgili döneme ait unique dönem ID bilgisi. 121
4 fileSource string GİB tarafından imzalanan beratların zip formatında sıkıştırıldıktan sonra alınan BASE64 değeri. VEVTVF9CRVJBVA==
Return (EDefterServiceResultModel)
1 IsSucceed bool İlgili işlem başarılı / başarısız değeri. true
2 Result string Başarılı durumda ilgili yüklemeye ilişkin periodId değeri, başarısız durumda hata açıklama değeri.
3 CustomerId string ePlatform tarafından üretilen unique müşteri ID bilgisi. F9A87EFF-9B41-46BB-8989-976672665A11

EdefterCustomerDetailUpdate

EdefterCustomerDetailUpdate
Ad: EdefterCustomerDetailUpdate
Açıklama: Mükellefe ait detay bilgilerin sisteme aktarılmasını veya sistem üzerinde güncellenmesini sağlayan methottur.
No: Parametre Tip Açıklama Örnek Veri Ek Bilgi
1 customerDetailUpdate EDefterCustomerDetailUpdateModel Mükellef detay bilgilerine dair detayları içeren model bilgisi 121
2 userName string Mükellef kullanıcı adı bilgisi. admin
3 password string Mükellef şifre bilgisi. 123456
Return (EDefterServiceResultModel)
1 IsSucceed bool İlgili işlem başarılı / başarısız değeri. true
2 Result string Başarılı durumda ilgili yüklemeye ilişkin periodId değeri, başarısız durumda hata açıklama değeri.
3 CustomerId string ePlatform tarafından üretilen unique müşteri ID bilgisi. F9A87EFF-9B41-46BB-8989-976672665A11

EDefterCustomerDetailUpdateModel (Enums)

1 public class EDefterCustomerDetailUpdateModel {
2 [DataMember]
3 public List<EDefterCustomerAccountantModel> CustomerAccountList { get; set; }
4 [DataMember]
5 public EDefterCustomerDetailModel CustomerDetail { get; set; }
6 }

EDefterCustomerAccountantModel (Enums)

 1 public class EDefterCustomerAccountantModel {
 2     [DataMember] public string AccountantName { get; set; }
 3     [DataMember] public string AccountantEngagementType { get; set; }
 4     [DataMember] public string AccountantEngagementDescription { get; set; }
 5     [DataMember] public string AccountantEngagementDate { get; set; }
 6     [DataMember] public string AccountantEngagementNumber { get; set; }
 7     [DataMember] public string AccountantBuildingNumber { get; set; }
 8     [DataMember] public string AccountantStreet { get; set; }
 9     [DataMember] public string AccountantAddressStreet2 { get; set; }
10     [DataMember] public string AccountantCity { get; set; }
11     [DataMember] public string AccountantCountry { get; set; }
12     [DataMember] public string AccountantZipOrPostalCode { get; set; }
13     [DataMember] public string AccountantContactPhoneNumberDescription { get; set; }
14     [DataMember] public string AccountantContactPhoneNumber { get; set; }
15     [DataMember] public string AccountantContactFaxNumber { get; set; }
16     [DataMember] public string AccountantContactEmailAddress { get; set; }
17 }

EDefterCustomerDetailModel (Enums)

 1 public class EDefterCustomerDetailModel {
 2     [DataMember] public string OrganizationDescription { get; set; }
 3     [DataMember] public string OrganizationIdentifier { get; set; }
 4     [DataMember] public string BusinessDescription { get; set; }
 5     [DataMember] public string PhoneNumberDescription { get; set; }
 6     [DataMember] public string EntityPhoneNumber { get; set; }
 7     [DataMember] public string EntityFaxNumber { get; set; }
 8     [DataMember] public string EntityEmailAddress { get; set; }
 9     [DataMember] public string OrganizationBuildingNumber { get; set; }
10     [DataMember] public string OrganizationAddressStreet { get; set; }
11     [DataMember] public string OrganizationAddressStreet2 { get; set; }
12     [DataMember] public string OrganizationAddressCity { get; set; }
13     [DataMember] public string OrganizationAddressZipOrPostalCode { get; set; }
14     [DataMember] public string OrganizationAddressCountry { get; set; }
15     [DataMember] public string EntityWebSiteUrl { get; set; }
16 }

CreateLettersPatent

CreateLettersPatent
Ad: CreateLettersPatent
Açıklama: Berat oluşturma bekleyen defterlerin beratlarının oluşturmasını sağlayan methottur.
Return (EDefterServiceResultModel)
No: Parametre Tip Açıklama Örnek Veri Ek Bilgi
1 IsSucceed bool İlgili işlem başarılı / başarısız değeri. true
2 Result string Başarısız durumda hata açıklama değeri.
3 CustomerId string ePlatform tarafından üretilen unique müşteri ID bilgisi. F9A87EFF-9B41-46BB-8989-976672665A11