Giriş

E-Mutabakat Web API bir Restful Web API'dir.

Bu API ile yapabileceğiniz işlemler aşağıda listelenmiştir.

  1. Aktarım Servisleri
    1. Aktarım İsteği Sorgulama
    2. Aktarım İsteği Oluşturma
    3. Aktarım Durumu Güncelleme
    4. Aktarım ID Oluşturma
    5. Cari Kart Aktarımı
    6. Form BA/BS Aktarımı
    7. Cari Hesap Aktarımı
    8. E-Tahsilat Aktarımı

Servis Authentication

API'mize yapılacak isteklerden önce bir token alınması gerekilmesi gerekmektedir. Bunun için /token URL'si kullanılarak size verilen API KEY'inizi kullanabilirsiniz.

URL /token
METHOD POST
URL Parametreleri Bu serviste URL Parametresi kullanılmamaktadır.
Request Header Content-Type=application/x-www-form-urlencoded
Accept=application/json
Request Body Zorunlu:
grant_type=password
username=[string]
Response Body (Success) access_token=[string]
token_type=[string]
expires_in=[integer]
Response Body (Error) error=[string]
error_description=[string]
Örnek Request (ajax) 

$.ajax({
    type: 'POST',
    url: '/Token',
    dataType: 'json',
    data: { "grant_type": "password", "username": "EEFBD-162EF-SDAB-1533" },
    success: function (response) {
        console.log('Access Token: '+ response.access_token);
    }
});

Servisler

Web API'mizin sağladığı servisler ile bir çok işlemi gerçekleştirebilirsiniz. Bunlardan bazıları; Aktarım gerçekleştirme, Dışarıya veri alma, Veri doğrulama gibi.

Aktarım Servisleri

API'mizin sunduğu aktarım servisleri ile e-mutabakat portalına veri aktarımları sağlayabilirsiniz.

Aktarım İsteği Sorgulama

Size verilen API KEY ile yapacağınız bu sorgulama ile e-mutabakat portal üzerinden bir "Servis Aktarımı" isteği yapılıp yapılmadığını -yani portal kullanıcısının aktarım emri verip vermediğini- sorgulayabilirsiniz.

URL /aktarim/sorgulama
METHOD GET
URL Parametreleri Zorunlu:
api_key=[string]
Request Header Content-Type=application/json
Accept=application/json
Request Body Bu serviste request body alanında herhangi bir veri gönderilmez.
Response Body (Success) 

[
    {
        "api_key": "EEFBD-162EF-SDAB-1533",
        "aktarilacak_tur": "1",
        "yil": "",
        "ay": "",
        "kosul": "0",
        "kosul_borc_tutar": 0,
        "kosul_alacak_tutar": 0,
        "aktarim_id": "1001",
        "aktarim_durum": "0"
    },
    {
        "api_key": "EEFBD-162EF-SDAB-1533",
        "aktarilacak_tur": "2",
        "yil": "2017",
        "ay": "1",
        "kosul": "0",
        "kosul_borc_tutar": 0,
        "kosul_alacak_tutar": 0,
        "aktarim_id": "1002",
        "aktarim_durum": "1"
    }
]

Response Parametre Açıklamaları:
api_key: Aktarılması istenen ilgili API KEY.
aktarilacak_tur: Aktarılması istenen veri kümesi türünü belirtir. (1 ise Cari Kartlar, 2 ise Form BA/BS Bilgileri, 3 ise Cari Hesap Bakiyeleri anlamına gelir)
yil: Aktarılması istenen Yıl bilgisidir. (bu parametre sadece Form BA/BS ve Cari Hesap Bakiye aktarımlarında kullanılır)
ay: Aktarılması istenen Ay bilgisidir. (bu parametre sadece Form BA/BS ve Cari Hesap Bakiye aktarımlarında kullanılır)
kosul: Aktarılması istenen verilerin koşul kırılımının olup olmadığı belirtir. (bu parametre sadece Cari Hesap Bakiye aktarımlarında kullanılır. 1 ise koşul uygulanacak, 2 ise koşul uygulanmayacak anlamına gelir)
kosul_borc_tutar: Aktarılması istenen cari hesap bakiyelerinin borç tutarının bu parametrede verilen tutarın altında olanların aktarılması istendiği bilgisidir.
kosul_alacak_tutar: Aktarılması istenen cari hesap bakiyelerinin alacak tutarının bu parametrede verilen tutarın altında olanların aktarılması istendiği bilgisidir.
aktarim_id: Aktarılması istenen verilerin tekrar API'ye iletilirken kullanılacak olan aktarım ID bilgisidir. Bu aktarım ID'ye istinaden aktarım gerçekleştirilmesi gereklidir.
aktarim_durum: İlgili aktarım bloğunun aktarım sonucu durum bilgisidir. (0 ise aktarım bekliyor, 1 ise aktarılıyor, 2 ise aktarım tamamlandı anlamına gelir)

Response Body (Error) 
                                            null
Örnek Request (ajax) 

$.ajax({
    type: 'GET',
    url: '/aktarim/sorgulama?api_key=EEFBD-162EF-SDAB-1533',
    dataType: 'json',
    data: {  },
    success: function (response) {
        console.log('RESPONSE: '+ response);
    }
});

Aktarım İsteği Oluşturma

Bu servis ile e-mutabakat portal kullanıcısının herhangi bir aktarım isteğini oluşturmasını beklemeksizin manuel olarak bir aktarım isteği oluşturulabilir. Ancak bu işlemden önce aktarım ID oluşturma servisi kullanılarak bir aktarım ID alınmalıdır.

URL /aktarim/istek-olusturma
METHOD POST
URL Parametreleri Bu serviste URL alanında herhangi bir veri gönderilmez.
Request Header Content-Type=application/json
Accept=application/json
Request Body Zorunlu:
api_key=[string]
aktarilacak_tur=[string]
yil=[string]
ay=[string]
kosul=[string]
kosul_borc_tutar=[string]
kosul_alacak_tutar=[string]
aktarim_id=[string]
Response Body (Success) 

{
    "sonuc": true,
    "aciklama": "Aktarım isteği başarıyla oluşturuldu."
}

Response Parametre Açıklamaları:
sonuc: Yapılan isteğin sonucunun başarılı olup olmadığının bilgisidir. (true ise başarılı, false ise başarısız anlamına gelir)
aciklama: Yapılan isteğin sonucunun kısa bir açıklamasıdır.
Response Body (Error) 

{
    "sonuc": false,
    "aciklama": "Aktarım isteği oluşturulumadı: Aynı aktarım ID ile bir istek kaydı olduğundan işlem gerçekleştirilemedi."
}
Örnek Request (ajax) 

$.ajax({
    type: 'POST',
    url: '/aktarim/istek-olusturma',
    dataType: 'json',
    data: {
        "api_key": "EEFBD-162EF-SDAB-1533",
        "aktarilacak_tur: "1",
        "yil": "0",
        "ay": "0",
        "kosul": "0",
        "kosul_borc_tutar": "0",
        "kosul_alacak_tutar": "0",
        "aktarim_id": "1001"
    },
    success: function (response) {
        console.log('RESPONSE: '+ response);
    }
});

Aktarım Durumu Güncelleme

Gerçekleştirilen bir aktarımın durumu bu servis ile değiştirilebilir.

URL /aktarim/durum-guncelleme
METHOD PUT
URL Parametreleri Bu serviste URL alanında herhangi bir veri gönderilmez.
Request Header Content-Type=application/json
Accept=application/json
Request Body Zorunlu:
api_key=[string]
aktarim_id=[string]
aktarim_durum=[string]
Response Body (Success) 

{
    "sonuc": true,
    "aciklama": "Aktarım durumu güncellendi."
}

Response Parametre Açıklamaları:
sonuc: Yapılan isteğin sonucunun başarılı olup olmadığının bilgisidir. (true ise başarılı, false ise başarısız anlamına gelir)
aciklama: Yapılan isteğin sonucunun kısa bir açıklamasıdır.
Response Body (Error) 

{
    "sonuc": false,
    "aciklama": "Aktarım durumu güncellenemedi: Gönderilen aktarım ID ile eşleşen bilgi olmadığından güncelleme yapılamadı."
}
Örnek Request (ajax) 

$.ajax({
    type: 'PUT',
    url: '/aktarim/durum-guncelleme',
    dataType: 'json',
    data: {
        "api_key": "EEFBD-162EF-SDAB-1533",
        "aktarim_id: "1001",
        "aktarim_durum": "2"
    },
    success: function (response) {
        console.log('RESPONSE: '+ response);
    }
});

Aktarım ID Oluşturma

Bu servis manuel bir aktarım gerçekleştirmek için sistem üzerinden yeni bir aktarım ID almak için kullanılır.

URL /aktarim/id-olusturma
METHOD POST
URL Parametreleri Bu serviste URL alanında herhangi bir veri gönderilmez.
Request Header Content-Type=application/json
Accept=application/json
Request Body Zorunlu:
api_key=[string]
aktarilacak_tur=[string]
yil=[string]
ay=[string]
kosul=[string]
kosul_borc_tutar=[string]
kosul_alacak_tutar=[string]
aktarim_id=[string]
aktarim_durum=[string]
Response Body (Success) 

{
    "sonuc": true,
    "aciklama": "1001"
}

Response Parametre Açıklamaları:
sonuc: Yapılan isteğin sonucunun başarılı olup olmadığının bilgisidir. (true ise başarılı, false ise başarısız anlamına gelir)
aciklama: Sonuç başarılı olduğunda direkt aktarım ID geri dönüşü yapılır.
Response Body (Error) 

{
    "sonuc": false,
    "aciklama": "Aktarım ID oluşturulamadı: Geçersiz API KEY gönderildiğinden işlem iptal edildi."
}
Örnek Request (ajax) 

$.ajax({
    type: 'POST',
    url: '/aktarim/id-olusturma',
    dataType: 'json',
    data: {
        "api_key": "EEFBD-162EF-SDAB-1533",
        "aktarilacak_tur: "1",
        "yil: "0",
        "ay: "0",
        "kosul: "0",
        "kosul_borc_tutar: "0",
        "kosul_alacak_tutar: "0",
        "aktarim_id: "0",
        "aktarim_durum": "0"
    },
    success: function (response) {
        console.log('RESPONSE: '+ response);
    }
});

Cari Kart Aktarımı

Bu servis ile e-mutabakat sistemine cari kartların aktarımı sağlanır.

URL /aktarim/carikart-aktarimi
METHOD POST
URL Parametreleri Zorunlu:
api_key=[string]
aktarim_id=[string]
Request Header Content-Type=application/json
Accept=application/json
Request Body Zorunlu:
aktarim_id=[string]
api_key=[string]
cari_grup=[string]
unvan=[string]
mersis_no=[string]
vergi_no=[string]
vergi_dairesi=[string]
telefon=[string]
telefon_alternatif=[string]
faks=[string]
ulke=[string]
ulke_kod=[string]
adres=[string]
musteri_kod=[string]
muhasebe_kod=[string]
sube=[string]
aciklama=[string]
para_birim=[string]
email=[string]
form_ba_email=[string]
form_bs_email=[string]
cari_hesap_email=[string]
ozel_mutabakat_email=[string]
kep_mail=[string]
bakiye_gonderim_tur=[string]
(bakiye_gonderim_tur parametresi 0 gönderilirse: Müşteri Kodu Bazında Gönderim (Her bir müşteri kodu ayrı ayrı gider.))
(bakiye_gonderim_tur parametresi 1 gönderilirse: Cari Kart Toplam Bakiye Gönderimi (Tüm müşteri kodları tek bir mailde gider.))
(bakiye_gonderim_tur parametresi 2 gönderilirse: Cari Grup Bazında Gönderim (Her bir grup topluca gider.))
Response Body (Success) 

{
    "sonuc": true,
    "aciklama": "Aktarım işlemi tamamlandı"
}

Response Parametre Açıklamaları:
sonuc: Yapılan isteğin sonucunun başarılı olup olmadığının bilgisidir. (true ise başarılı, false ise başarısız anlamına gelir)
aciklama: Yapılan isteğin sonucunun kısa bir açıklamasıdır.
Response Body (Error) 

{
    "sonuc": false,
    "aciklama": "Aktarım gerçekleştirilemedi: Gönderilen API KEY'e ait aktarım isteği bulunmadığından işlem iptal edildi."
}
Örnek Request (ajax) 

$.ajax({
    type: 'POST',
    url: '/aktarim/carikart-aktarimi?api_key=EEFBD-162EF-SDAB-1533&aktarim_id=1001',
    dataType: 'json',
    data: {
        [
            {
                "aktarim_id":"1001",
                "api_key": "EEFBD-162EF-SDAB-1533",
                "cari_grup": "",
                "unvan": "Entegrasyon Firması",
                "mersis_no": "",
                "vergi_no": "541300789512",
                "vergi_dairesi": "KOZYATAĞI",
                "telefon": "",
                "telefon_alternatif": "",
                "faks": "",
                "ulke": "",
                "ulke_kod": "052",
                "adres": "",
                "musteri_kod": "336.00.102",
                "muhasebe_kod": "336.00.102",
                "sube": "",
                "aciklama": "",
                "para_birim": "TRY",
                "email": "",
                "form_ba_email": "",
                "form_bs_email": "",
                "cari_hesap_email": "",
                "ozel_mutabakat_email": "",
                "kep_mail": "",
                "bakiye_gonderim_tur": "0"
            }
        ]
    },
    success: function (response) {
        console.log('RESPONSE: '+ response);
    }
});

Form BA/BS Aktarımı

Bu servis ile e-mutabakat sistemine Form BA/BS aktarımı sağlanır.

URL /aktarim/formbabs-aktarimi
METHOD POST
URL Parametreleri Zorunlu:
api_key=[string]
aktarim_id=[string]
Request Header Content-Type=application/json
Accept=application/json
Request Body Zorunlu:
aktarim_id=[string]
api_key=[string]
cari_grup=[string]
yil=[string]
ay=[string]
vergi_no=[string]
unvan=[string]
musteri_kod=[string]
babs=[string]
belge_adet=[string]
belge_tutar=[string]
Response Body (Success) 

{
    "sonuc": true,
    "aciklama": "Aktarım işlemi tamamlandı"
}

Response Parametre Açıklamaları:
sonuc: Yapılan isteğin sonucunun başarılı olup olmadığının bilgisidir. (true ise başarılı, false ise başarısız anlamına gelir)
aciklama: Yapılan isteğin sonucunun kısa bir açıklamasıdır.
Response Body (Error) 

{
    "sonuc": false,
    "aciklama": "Aktarım gerçekleştirilemedi: Gönderilen API KEY'e ait aktarım isteği bulunmadığından işlem iptal edildi."
}
Örnek Request (ajax) 

$.ajax({
    type: 'POST',
    url: '/aktarim/formbabs-aktarimi?api_key=EEFBD-162EF-SDAB-1533&aktarim_id=1001',
    dataType: 'json',
    data: {
        [
            {
                "aktarim_id":"1001",
                "api_key": "EEFBD-162EF-SDAB-1533",
                "cari_grup": "",
                "yil": "2017",
                "ay": "1",
                "vergi_no": "541300789512",
                "unvan": "Firma Unvanı",
                "musteri_kod": "336.00.102",
                "babs": "BA",
                "belge_adet": "15",
                "belge_tutar": "54827.00"
            },
            {
                "aktarim_id":"1001",
                "api_key": "EEFBD-162EF-SDAB-1533",
                "cari_grup": "",
                "yil": "2017",
                "ay": "1",
                "vergi_no": "98765432105",
                "unvan": "Firma Unvanı",
                "musteri_kod": "336.00.101",
                "babs": "BS",
                "belge_adet": "7",
                "belge_tutar": "9584.00"
            }
        ]
    },
    success: function (response) {
        console.log('RESPONSE: '+ response);
    }
});

Cari Hesap Aktarımı

Bu servis ile e-mutabakat sistemine Cari Hesap aktarımı sağlanır.

URL /aktarim/carihesap-aktarimi
METHOD POST
URL Parametreleri Zorunlu:
api_key=[string]
aktarim_id=[string]
Request Header Content-Type=application/json
Accept=application/json
Request Body Zorunlu:
aktarim_id=[string]
api_key=[string]
cari_grup=[string]
yil=[string]
ay=[string]
vergi_no=[string]
unvan=[string]
musteri_kod=[string]
bakiye=[string]
para_birim=[string]
hareket_kod=[string]
İsteğe Bağlı:
ozel_1=[string]
ozel_2=[string]
ozel_3=[string]
Response Body (Success) 

{
    "sonuc": true,
    "aciklama": "Aktarım işlemi tamamlandı"
}

Response Parametre Açıklamaları:
sonuc: Yapılan isteğin sonucunun başarılı olup olmadığının bilgisidir. (true ise başarılı, false ise başarısız anlamına gelir)
aciklama: Yapılan isteğin sonucunun kısa bir açıklamasıdır.
Response Body (Error) 

{
    "sonuc": false,
    "aciklama": "Aktarım gerçekleştirilemedi: Gönderilen API KEY'e ait aktarım isteği bulunmadığından işlem iptal edildi."
}
Örnek Request (ajax) 

$.ajax({
    type: 'POST',
    url: '/aktarim/carihesap-aktarimi?api_key=EEFBD-162EF-SDAB-1533&aktarim_id=1001',
    dataType: 'json',
    data: {
        [
            {
                "aktarim_id":"1001",
                "api_key": "EEFBD-162EF-SDAB-1533",
                "cari_grup": "",
                "yil": "2017",
                "ay": "1",
                "vergi_no": "541300789512",
                "unvan": "Firma Unvanı",
                "musteri_kod": "336.00.102",
                "bakiye": "54827.00",
                "para_birim": "TRY",
                "hareket_kod": "",
                "ozel_1": "",
                "ozel_2": "",
                "ozel_3": ""
            }
        ]
    },
    success: function (response) {
        console.log('RESPONSE: '+ response);
    }
});

E-Tahsilat Aktarımı

Bu servis ile e-mutabakat sistemine E-Tahsilat bilgi aktarımı sağlanır.

URL /aktarim/etahsilat-aktarimi
METHOD POST
URL Parametreleri Zorunlu:
api_key=[string]
aktarim_id=[string]
Request Header Content-Type=application/json
Accept=application/json
Request Body Zorunlu:
aktarim_id=[string]
api_key=[string]
vergi_no=[string]
musteri_kod=[string]
bakiye=[string]
para_birim=[string]
kur=[string]
tahsilat_para_birim=[string]
İsteğe Bağlı:
ozel_1=[string]
ozel_2=[string]
ozel_3=[string]
Response Body (Success) 

{
    "sonuc": true,
    "aciklama": "Aktarım işlemi tamamlandı"
}

Response Parametre Açıklamaları:
sonuc: Yapılan isteğin sonucunun başarılı olup olmadığının bilgisidir. (true ise başarılı, false ise başarısız anlamına gelir)
aciklama: Yapılan isteğin sonucunun kısa bir açıklamasıdır.
Response Body (Error) 

{
    "sonuc": false,
    "aciklama": "Aktarım gerçekleştirilemedi: Gönderilen API KEY'e ait aktarım isteği bulunmadığından işlem iptal edildi."
}
Örnek Request (ajax) 

$.ajax({
    type: 'POST',
    url: '/aktarim/etahsilat-aktarimi?api_key=EEFBD-162EF-SDAB-1533&aktarim_id=1001',
    dataType: 'json',
    data: {
        [
            {
                "aktarim_id":"1001",
                "api_key": "EEFBD-162EF-SDAB-1533",
                "vergi_no": "541300789512",
                "musteri_kod": "336.00.102",
                "bakiye": "54827.00",
                "para_birim": "TRY",
                "kur": "1.00",
                "tahsilat_para_birim": "TRY"
                "ozel_1": "",
                "ozel_2": "",
                "ozel_3": ""
            }
        ]
    },
    success: function (response) {
        console.log('RESPONSE: '+ response);
    }
});