GET_I53_LIST

Aprašymas

Mokėjimo operacijų sąrašas.

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_I53_LIST
  • params :
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės I53 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_I53_LIST</method>
    <params>
        <fil>i53_kodas_oi='000000000001'</fil>
    </params>
</body>

pvz application/json:

{
    "method": "GET_I53_LIST",
    "params": {
        "fil": "i53_kodas_oi='000000000001'"
    }
}
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 lentelės raktinį lauką I53_KODAS_OI

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

pvz, response:

<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
    <I53>
        <Row_number>1</Row_number>
        <I53_KODAS_OI>010000001174</I53_KODAS_OI>
        <I53_OP_RUSIS>1</I53_OP_RUSIS>
        <I53_PAV>                                                           </I53_PAV>
        <I53_DOK_NR>DOC1932708          </I53_DOK_NR>
        <I53_DATA>2021-05-03T00:00:00</I53_DATA>
        <I53_KODAS_KS>123456789   </I53_KODAS_KS>
        <I53_KODAS_SS>2711        </I53_KODAS_SS>
        <I53_KODAS_VL>EUR         </I53_KODAS_VL>
        ...
    </I53>
</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 column name 'i53_kodas_oip'.</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>2020-02-05T12:34:26.890+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: uUCz6UD.sKVrjaWRDJAH1c7l4qL2nOoN2K0jARkvuHDdYsss',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
    "method": "GET_I04_LIST",
    "params": {
        "list": "H",
        "fil": "i04_kodas_ch=\'000000000001\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

I53

Laukas Tipas Aprašymas
I53_KODAS_OI C12 Operacijos numeris
I53_OP_RUSIS N1 Rūšis: 1-įplaukos; 2-išmokos
I53_PAV C60 Aprašymas
I53_DOK_NR C20 Dokumento Nr.
I53_DATA T8 Data
I53_KODAS_KS C12 Kliento kodas
I53_KODAS_SS C12 Mokėjimo sąskaita
I53_KODAS_VL C12 Valiuta
I53_SUMA N12,2 Suma
I53_MOKETOJAS N1 Sudengimo tipas: 1-dokumentai; 2-sąskaitos
I53_KODAS_SS_S C12 Sudengimo sąskaita
I53_PASTABOS M Pastabos
I53_KODAS_LS_1 C12 Logistika 1
I53_KODAS_LS_2 C12 Logistika 2
I53_KODAS_LS_3 C12 Logistika 3
I53_KODAS_LS_4 C12 Logistika 4
I53_KODAS_WS C12 Bankas
I53_KODAS_CH C12 Atsiskaitymo Op.Nr.
I53_SUMA2 N12,2 Rezervas
I53_PERKELTA N1 Perkelimo požymis: 1-nauja; 2-perkelta; 3-klaidinga
I53_USERIS C12 Kas koregavo
I53_R_DATE T8 Kada koregavo
I53_ADDUSR C12 Įrašo autorius
I53_ADD_DATE T8 Kada sukurta
I53_DOK_NR_MOK C20 Sudengiamo dokumento Nr.
I53_KODAS_IS C12 Padalinio kodas
I53_KODAS_OS C12 Objekto kodas
I53_KODAS_OS_C C12 Centro kodas
I53_KODAS_MS C12 Menedžerio kodas
I53_S_KODAS C45 Banko sąskaita
I53_ID C40 Banko operacijos ID
I53_DOK_TIPAS N1 Dokumento tipas:1-Atsiskaitymo Op.;2-Mokėjimas
I53_SUMA_VL N18,2 Suma valiuta
I53_KURSAS N20,15 Kursas
I53_KODAS_KT C12 Sutartis
I53_KODAS_K0 C12 Priedas
I53_BUSENA N3 Būsena
I53_KODAS_SM C12 Asmuo
I53_ATSTOVAS C150 Atstovas
I53_KODAS_ZN C12 Zona