GET_I02_LIST_EXT

Aprašymas

Sąskaitų likučių suformavimas datai

Specifikacija

Address

POST https://api.manorivile.lt/client/v2

Header

ApiKey : Privalomas. Unikalus API raktas išduodamas užsakant paslaugą
Content-Type : Privalomas. Kokiu formatu paduodami parametrai ir duomenys (request):
- application/xml
- application/json
Accept: Neprivalomas. Gražinamo rezultato (response) formatas
- application/xml(default)
- application/json (veikia nuo Manorivile-Gateway-1.1.0 versijos)

Body

method : GET_I02_LIST_EXT
params :
- beg_date : periodo pradžios data. Neprivaloma - nenurodžius traukiama šiai dienai.
- end_date : periodo pabaigos data. Neprivaloma - nenurodžius traukiama šiai dienai.
- group : likučių grupavimas / sumavimas pagal: kodas_ss, kodas_zs, kodas_sm, kodas_is, kodas_os, kodas_os_c, dim01, dim02, dim03, dim04, dim05, dim06, dim07, dim08, dim09, dim10, dim11, dim12, dim13, dim14, dim15. Parametro nenurodžius rodomi visi laukai - grupavimo nevyksta. Nurodžius tuščią grupuoja pagal: kodas_ss.
- list : H - gražinama detalių sąskaitų informacija. Jeigu A - rodoma ir grupinių sąskaitų informacija.
- fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės I02 nenurodant pačio where tag'o. Neprivaloma
- pagenumber: įrašų puslapio numeris. GET_LIST metodai rezultatus grąžina puslapiais po 100 įrašų, pagenumber parametras nurodo kelintą puslapį grąžinti. Jei nenurodomas, tuomet grąžinamas pirmas puslapis su 100 naujausių įrašų. Neprivaloma

Sąraše su daugiau nei 1 įrašu informacija visada grąžinama surūšiuota pagal atitinkamos lentelės raktą (Primary Key)

GET_LIST metodų apribojima 100 įrašų, todėl norint gauti visą sąrašą, turite naudoti filtrus, kurie grąžins rezultatą dalimis per kelis kartus, filtruojant pagal paskutinio gauto įrašo rakto reikšmę.

pvz application/xml:

<body>
    <method>GET_I02_LIST_EXT</method>
    <params>
        <beg_date>2020-01-01</beg_date>
        <end_date>2020-06-30</end_date>
        <group>kodas_is</group>
        <fil>i02_kodas_dh='010000000001'</fil>
        <list>H</list>
    </params>
</body>

pvz application/json:

{
    "method": "GET_I02_LIST_EXT",
    "params": {
        "beg_date": "2020-01-01",
        "end_date": "2020-06-30",
        "group": "kodas_is",
        "fil": "i02_kodas_dh='010000000001'",
        "list": "H"
    }
}

Response (status 200 OK)

Grąžinama informacija XML formate tarp tag'ų <RET_DOK>..</RET_DOK>. Esant daugiau nei vienam įrašui informacija rūšiuojama (order) pagal lauką kodas_ss ir tai, kas paduota parametre group

Jeigu įrašų nerasta pagal užduotas sąlygas, tuomet gražinama status=200 bei tuščias tag'as

<RET_DOK>
    <I02>
        <row_num>1</row_num>
        <pav>Pirktų prekių, skirtų perparduoti, įsigijimo savikaina                                                                                                </pav>
        <tipas>2</tipas>
        <kodas_ss>2040        </kodas_ss>
        <kodas_zs>SS_ATSARGOS </kodas_zs>
        <kodas_sm>           </kodas_sm>
        <kodas_is>999999999999</kodas_is>
        <kodas_os>           </kodas_os>
        <kodas_os_c>           </kodas_os_c>
        <lik_beg_deb>0.00</lik_beg_deb>
        <lik_beg_cre>0.00</lik_beg_cre>
        <suma_deb>2100216.00</suma_deb>
        <suma_cre>5639.76</suma_cre>
        <lik_end_deb>2100216.00</lik_end_deb>
        <lik_end_cre>5639.76</lik_end_cre>
    </I02>
    <I02>
        ...
    </I02>
    ...
</RET_DOK>

Response (status 400)

Klaida paduodant duomenis / SQL sintaksės klaidos / kitos DB klaidos

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id>3451ded.be556121580910178112</id>
    <durationMs>25</durationMs>
    <errorMessage>Invalid data</errorMessage>
</RET_DOK

Response (status 401)

Blogai nurodytas adresas / neteisingai nurodytas API raktas / nenurodytas API raktas / pasibaigęs API rakto galiojimas, pvz

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id/>
    <durationMs>0</durationMs>
    <errorMessage>Api key is not valid</errorMessage>
</RET_DOK>

Response (status 502)

Nepaleistas MANO Rivile Gateway arba kitaip sutrikusi jo veikla

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id/>
    <durationMs>0</durationMs>
    <errorMessage>Rivile GAMA database is unavailable. Please check if the gateway is running and is set up correctly.</errorMessage>
</RET_DOK>

Response (status 504)

Laiku nebuvo gautas Rivile API užklausos atsakymas, pavyzdžiui, apkrauta GAMA duomenų bazė

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id/>
    <durationMs>0</durationMs>
    <errorMessage>No response received from client gateway</errorMessage>
</RET_DOK>

Response (status 500)

Bendrinė sistemos klaida, pvz

<?xml version='1.0' encoding='UTF-8'?>
<Map>
    <timestamp>2024-01-01T00:00:01.001+0000</timestamp>
    <status>500</status>
    <error>Internal Server Error</error>
    <message>No message available</message>
    <path>/v1</path>
</Map>

PHP pvz

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'ApiKey: 1234567.sKVrjWWRDJAH1c7l4LL2nOoN2K0jARkvuHDdYsss',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
    "method": "GET_I02_LIST_EXT",
    "params": {
        "beg_date": "2020-01-01",
        "end_date": "2020-06-30",
        "group": "kodas_is",
        "fil": "i02_kodas_dh='010000000001'",
        "list": "H"
    }
}');
$response = curl_exec($ch);
curl_close($ch);