Muhasebe İşlemleri Web Servis Dokümanı
Aşağıdaki web servisler Telekomünikasyon firmalarının Muhasebe işlemeri için kullanılmaktadır.
Her firma için belirtilen IP adreslerinden istek yapılacak şekilde izin tanımlanması gerekmektedir.
Tüm servis çıktıları Json olarak gerçekleşmektedir. Bu web servisin kullanılması için yetki tanımlanması gerekmektedir.
Servis tanımları içerisinde yer alan parametrelerden;
-
Gönderim parametreleri hakkında ( Request )
-
HTTP Post isteği yapılması gerekmektedir.
-
uniq_code : UNIQ_CODE bilgisi her istekte POST parametresi olarak gönderimi zorunludur. Her firma için farklı bir uniq_code bilgisi tahsis edilmektedir.
-
api_code : Her servis URL bilgisinin sonunda olmak zorundadır. Her firma için farklı api_code tahsis edilmektedir.
-
Diğer parametreler backend parametreleridir.
-
-
Dönüş parametreleri hakkında ( Response )
-
Response JSON olarak dönecektir.
-
status : “danger, warning, info, success” değerleri dönecektir. Sadece “success” durumu başarılı işlemler için dönecektir. Diğerleri bilgilendirme, hata parametreleridir.
-
data : JSON veri formatında dönüş sağlamaktadır. Servis çıktısı veri çıktısı veriyor ise JSON formatında veri çıktısı sağlar. Bazı servislerde ise data bilgisi sadece string içerebilir ( Örn : “İşlem başarılı” )
-
Anlaşmalı Geliştirici veya Firma tarafından istek yapılacak IP adreslerinin [email protected] adresine gönderilmesi sonrasında gerekli tanımlar yapılmaktadır. IP adresleri izinli listesine tanımlandıktan sonra servisler kullanıma açık olacaktır.
-
IP Adresi :
-
Kişi , Firma bilgileri :
-
Yetkili e-posta adresi :
-
Erişim süresi :
Eğer bir işletmeci olarak erişim talep ediyorsanız , yetkili işletmeci ye bu servise erişmek istediğinizi ve aşağıdaki bilgileri paylaşmanız gerekmektedir.
-
IP Adresi :
-
Yetkili kişi / Firma bilgileri :
-
Yetkili e-posta adresi :
-
Erişim süresi :
-
İşletmeci Kodu :
Bilgiler gönderildikten sonra test ve gerçek ortam bilgileri yetkili e-posta hesapları ile paylaşılacaktır.
Paylaşılacak Bilgiler ;
-
Endpoint URL / Domain
-
api_code
-
uniq_code
@Wiradius
Web Servisin amacı oluşacak abonelikte abonenin "cari_tipi"ne göre alabileceği değerleri dönüştürmektedir. Bireysel kullanıcılar için bu "Firma Değil" = 1 değeri alır . Diğer firma tipleri için uygun değerin seçilmesi beklenmektedir. Kamu kurumları, Vakıf ve Dernekler için önemlidir. e-fatura , e-arsiv şablonları bu bilgiye göre şekillenmektedir.
| Parametre | Örnek Değer | Tip | Açıklama |
|---|---|---|---|
| page | 1 | number | Her istekte en fazla 1000 adet kayıt listelenecektir. Sayfalama parametresi 1,2,3... diye gönderilebilir. "data" boş ise veri yoktur. |
| uniq_code | {{uniq_code}} | text | Yetkiliden talep ediniz. |
| will_borrow | 2 | number | Borçlu / Alacaklı Filtresi 1 - Borçlu 2 - Alacaklı 3 - Temiz Parametreleri gönderilebilir. Opsiyoneldir, gelen liste Büyükten Küçüğe göre sıralanmaktadır. Borç Alacak filtresi gönderilmez ise ekleme tarihine göre Büyükten Küçüğe göre listelenecektir. |
curl -X POST 'https://ws.wiradius.com/invoice/cari_list/{{api_code}}' \
--form 'page=1' \
--form 'uniq_code={{uniq_code}}' \
--form 'will_borrow=2' \
<?php
$post_fields = array();
$post_fields[ 'page' ] = 1;
$post_fields[ 'uniq_code' ] = '{{uniq_code}}';
$post_fields[ 'will_borrow' ] = 2;
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://ws.wiradius.com/invoice/cari_list/{{api_code}}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => $post_fields,
));
$response = curl_exec( $curl );
curl_close($curl);
echo $response; ?>| Parametre | Örnek Değer | Tip | Açıklama |
|---|---|---|---|
| begin_datetime | 2022-12-12 | text | Başlangıç Tarihi Formatı : YYYY-mm-dd |
| cari_id | 1 | number | "cari_id" Cari Listesinden veya Fatura listesinden dönen cari_id bilgisidir. Zorunlu Parametre |
| end_datetime | 2023-01-01 | text | Bitiş Tarihi Formatı : Y-m-d |
| uniq_code | {{uniq_code}} | text | Yetkiliden talep ediniz. |
curl -X POST 'https://ws.wiradius.com/invoice/cari_trans/{{api_code}}' \
--form 'begin_datetime=2022-12-12' \
--form 'cari_id=1' \
--form 'end_datetime=2023-01-01' \
--form 'uniq_code={{uniq_code}}' \
<?php
$post_fields = array();
$post_fields[ 'begin_datetime' ] = '2022-12-12';
$post_fields[ 'cari_id' ] = 1;
$post_fields[ 'end_datetime' ] = '2023-01-01';
$post_fields[ 'uniq_code' ] = '{{uniq_code}}';
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://ws.wiradius.com/invoice/cari_trans/{{api_code}}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => $post_fields,
));
$response = curl_exec( $curl );
curl_close($curl);
echo $response; ?>İlgili filtrelere göre fatura listenizi döndürmektedir.
| Parametre | Örnek Değer | Tip | Açıklama |
|---|---|---|---|
| begin_datetime | 2022-12-12 | text | Başlangıç Tarihi Formatı : YYYY-mm-dd |
| cari_id | 1 | number | Belirli bir Cari'nin faturaları listelenmek isteniyor ise "cari_id" parametresi gönderilmelidir. "cari_id" parametresi gönderildiğinde Başlangıç ve Bitiş Tarihleri arasındaki fark 6 Ay'a kadar sorgulanabilmektedir. |
| end_datetime | 2023-01-01 | text | Bitiş Tarihi Formatı : Y-m-d |
| page | 1 | number | Her istekte en fazla 1000 adet kayıt listelenecektir. Sayfalama parametresi 1,2,3 diye gönderilebilir. Fatura tarihine göre Küçükten Büyüğe göre sıralanmaktadır. "data" boş ise veri yoktur. |
| type | sell | text | Alış / Satış Filtresi Alış Faturaları Filtresi için "buy", Satış Faturaları Filtresi için "sell" gönderilmelidir Zorunlu Parametre |
| uniq_code | {{uniq_code}} | text | Yetkiliden talep ediniz. |
curl -X POST 'https://ws.wiradius.com/invoice/list/{{api_code}}' \
--form 'begin_datetime=2022-12-12' \
--form 'cari_id=1' \
--form 'end_datetime=2023-01-01' \
--form 'page=1' \
--form 'type=sell' \
--form 'uniq_code={{uniq_code}}' \
<?php
$post_fields = array();
$post_fields[ 'begin_datetime' ] = '2022-12-12';
$post_fields[ 'cari_id' ] = 1;
$post_fields[ 'end_datetime' ] = '2023-01-01';
$post_fields[ 'page' ] = 1;
$post_fields[ 'type' ] = 'sell';
$post_fields[ 'uniq_code' ] = '{{uniq_code}}';
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://ws.wiradius.com/invoice/list/{{api_code}}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => $post_fields,
));
$response = curl_exec( $curl );
curl_close($curl);
echo $response; ?>| Parametre | Örnek Değer | Tip | Açıklama |
|---|---|---|---|
| invoice_id | 1 | number | "Fatura Listesi" servisinden dönen "invoice_id" kullanılmaktadır. Fatura detayında yer alan satırlar dönecektir. |
| uniq_code | {{uniq_code}} | text | Yetkiliden talep ediniz. |
curl -X POST 'https://ws.wiradius.com/invoice/rows/{{api_code}}' \
--form 'invoice_id=1' \
--form 'uniq_code={{uniq_code}}' \
<?php
$post_fields = array();
$post_fields[ 'invoice_id' ] = 1;
$post_fields[ 'uniq_code' ] = '{{uniq_code}}';
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://ws.wiradius.com/invoice/rows/{{api_code}}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => $post_fields,
));
$response = curl_exec( $curl );
curl_close($curl);
echo $response; ?>