GET_I04_LIST

Aprašymas

Įplaukų/išmokų registras

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_I04_LIST
params :
- list : H - gražinama tik pagrindinė informacija (I04) (default). Jeigu A - gražinama visa susijusi informacija (I04+I05).
- fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės I04 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_I04_LIST</method>
    <params>
        <list>H</list>
        <fil>i04_kodas_ch='000000000001'</fil>
    </params>
</body>

pvz application/json:

{
    "method": "GET_I04_LIST",
    "params": {
        "list": "A",
        "fil": "i04_kodas_ch='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ą I04_KODAS_CH

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

pvz, kai list='A':

<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
    <I04>
        <Row_number>1</Row_number>
        <I04_KODAS_CH>000000000001</I04_KODAS_CH>
        <I04_DOK_NR>PM-001</I04_DOK_NR>
        <I04_OP_RUSIS>2</I04_OP_RUSIS>
        <I04_OP_TIPAS>0</I04_OP_TIPAS>
        <I04_OP_STORNO>0</I04_OP_STORNO>
        <I04_OP_DATA>2019-12-13T00:00:00</I04_OP_DATA>
        <I04_KODAS_SS>2710</I04_KODAS_SS>
        <I04_MOKETOJAS>2</I04_MOKETOJAS>
        <I04_KODAS_KS></I04_KODAS_KS>
        <I04_PAV>Pajamų mokestis</I04_PAV>
        <I04_ADR></I04_ADR>
        <I04_ATSTOVAS></I04_ATSTOVAS>
        <I04_KODAS_VS></I04_KODAS_VS>
        <I04_SUMA>10.00</I04_SUMA>
        <I04_SUMA_DSK>0.00</I04_SUMA_DSK>
        <I04_SUMA_PLK>0.00</I04_SUMA_PLK>
        <I04_PASTABOS></I04_PASTABOS>
        <I04_PERKELTA>2</I04_PERKELTA>
        <I04_IMP_EXP>0</I04_IMP_EXP>
        <I04_KODAS_VL>EUR         </I04_KODAS_VL>
        <I04_SUMA_VAL>7.00</I04_SUMA_VAL>
        <I04_KOEF>1.000000000000000</I04_KOEF>
        <I04_USERIS>MASTER</I04_USERIS>
        <I04_R_DATE>2017-01-04T11:28:47</I04_R_DATE>
        <I04_ADDUSR>MASTER</I04_ADDUSR>
        <I04_KODAS_SM></I04_KODAS_SM>
        <I04_APRASYMAS></I04_APRASYMAS>
        <I04_SUMA_PER>0.00</I04_SUMA_PER>
        <I04_BUSENA>1</I04_BUSENA>
        <I05>
            <I05_KODAS_CH>000000000001</I05_KODAS_CH>
            <I05_EIL_NR>1</I05_EIL_NR>
            <I05_DOK_NR></I05_DOK_NR>
            <I05_DATA_DOK>2019-12-13T00:00:00</I05_DATA_DOK>
            <I05_DATA_MOK>2019-12-13T00:00:00</I05_DATA_MOK>
            <I05_DATA_DSK>2019-12-13T00:00:00</I05_DATA_DSK>
            <I05_APR></I05_APR>
            <I05_SUMA>10.00</I05_SUMA>
            <I05_SUMA_DSK>0.00</I05_SUMA_DSK>
            <I05_SUMA_PLK>0.00</I05_SUMA_PLK>
            <I05_KODAS_SS>4481</I05_KODAS_SS>
            <I05_KODAS_VL>EUR</I05_KODAS_VL>
            <I05_KODAS_VL_S>EUR</I05_KODAS_VL_S>
            <I05_SUMA_VAL_DSK>0.00</I05_SUMA_VAL_DSK>
            <I05_KOEF>1.000000000000000</I05_KOEF>
            <I05_KOEF_S>1.000000000000000</I05_KOEF_S>
            <I05_SUMA_VAL>10.00</I05_SUMA_VAL>
            <I05_SUMA_VAL_S>10.00</I05_SUMA_VAL_S>
            <I05_KODAS_IS>01</I05_KODAS_IS>
            <I05_KODAS_OS></I05_KODAS_OS>
            <I05_KODAS_OS_C></I05_KODAS_OS_C>
            <I05_KODAS_MS></I05_KODAS_MS>
            <I05_USERIS>MASTER</I05_USERIS>
            <I05_R_DATE>2019-12-13T00:00:00</I05_R_DATE>
            <I05_ADDUSR>MASTER</I05_ADDUSR>
            <I05_KODAS_KT></I05_KODAS_KT>
            <I05_KODAS_K0></I05_KODAS_K0>
            <I05_SUMA_PER>0.00</I05_SUMA_PER>
        </I05>
    </I04>
</RET_DOK>

pvz, kai list='H'

<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
    <I04>
        <Row_number>1</Row_number>
        <I04_KODAS_CH>000000000001</I04_KODAS_CH>
        <I04_DOK_NR>PM-001</I04_DOK_NR>
        <I04_OP_RUSIS>2</I04_OP_RUSIS>
        <I04_OP_TIPAS>0</I04_OP_TIPAS>
        <I04_OP_STORNO>0</I04_OP_STORNO>
        <I04_OP_DATA>2019-12-13T00:00:00</I04_OP_DATA>
        <I04_KODAS_SS>2710</I04_KODAS_SS>
        <I04_MOKETOJAS>2</I04_MOKETOJAS>
        <I04_KODAS_KS></I04_KODAS_KS>
        <I04_PAV>Pajamų mokestis</I04_PAV>
        <I04_ADR></I04_ADR>
        <I04_ATSTOVAS></I04_ATSTOVAS>
        <I04_KODAS_VS></I04_KODAS_VS>
        <I04_SUMA>10.00</I04_SUMA>
        <I04_SUMA_DSK>0.00</I04_SUMA_DSK>
        <I04_SUMA_PLK>0.00</I04_SUMA_PLK>
        <I04_PASTABOS></I04_PASTABOS>
        <I04_PERKELTA>2</I04_PERKELTA>
        ...
    </I04>
</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 'i04_kodas_chb'.</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

I04

Laukas	Tipas	Aprašymas
I04_KODAS_CH	C12	Operacijos numeris
I04_DOK_NR	C20	Dokumento numeris
I04_OP_RUSIS	N1	Rūšis:1-įplaukos,2-išmokos
I04_OP_TIPAS	N1	Reikalavimo požymis:0-ne,1-taip
I04_OP_STORNO	N1	Rezervas
I04_OP_DATA	T8	Operacijos data
I04_KODAS_SS	C12	Sąskaitos kodas
I04_MOKETOJAS	N1	Sudengimo tipas:1-dokumentai,2-sąskaitos
I04_KODAS_KS	C12	Kliento kodas
I04_PAV	C40	Kliento pavadinimas
I04_ADR	C40	Kliento adresas
I04_ATSTOVAS	C40	Atstovas
I04_KODAS_VS	C12	Vietovės kodas
I04_SUMA	N12,2	Operacijos suma
I04_SUMA_DSK	N12,2	Diskonto suma
I04_SUMA_PLK	N12, 2	Palūkanų suma
I04_PASTABOS	C12	Pastabos
I04_PERKELTA	N 1	Perkėlimo požymis:1-neperkelta,2-perkelta,3-koreguota
I04_IMP_EXP	N 1	Rezervas
I04_KODAS_VL	C12	Valiutos kodas
I04_SUMA_VAL	N18,2	Valiutos suma
I04_KOEF	N20,15	Valiutos kursas
I04_USERIS	C12	Kas koregavo
I04_R_DATE	T 8	Kada koregavo
I04_ADDUSR	C12	Kas sukūrė
I04_KODAS_SM	C12	Asmuo
I04_APRASYMAS	C60	Aprašymas
I04_SUMA_PER	N12,2	Valiutos perskaičiavimo suma
I04_SUMA_WK	N12,2	WB įsipareigojimų suma
I04_KODAS_LS_1	C12	Logistika 1
I04_KODAS_LS_2	C12	Logistika 2
I04_KODAS_LS_3	C12	Logistika 3
I04_KODAS_LS_4	C12	Logistika 4
I04_KODAS_ZN	C12	Zona
I04_BUSENA	N3	Būsena

I05

Laukas	Tipas	Aprašymas
I05_KODAS_CH	C 12	Operacijos numeris
I05_EIL_NR	N 6	Eilutės numeris dokumente
I05_DOK_NR	C 20	Dokumento numeris
I05_DATA_DOK	T 8	Dokumento data
I05_DATA_MOK	T 8	Mokėjimo data
I05_DATA_DSK	T 8	Diskonto data
I05_APR	C 12	Pastabos
I05_SUMA	N 12.2	Mokėjimo suma
I05_SUMA_DSK	N 12.2	Suteikiamas diskontas
I05_SUMA_PLK	N 12.2	Palūkanų suma
I05_KODAS_SS	C 12	Sąskaitos kodas
I05_KODAS_VL	C 12	Operacijos valiutos kodas
I05_KODAS_VL_S	C 12	Skolos valiutos kodas
I05_SUMA_VAL_DSK	N 18.2	Valiutos diskontas
I05_KOEF	N 20.15	Konvertavimo koeficientas -> Bazinė valiuta
I05_KOEF_S	N 20.15	Konvertavimo koeficientas <- Bazinė valiuta
I05_SUMA_VAL	N 18.2	Mokėjimo suma valiuta
I05_SUMA_VAL_S	N 18.2	Sudengimo suma valiuta
I05_KODAS_IS	C 12	Padalinio kodas
I05_KODAS_OS	C 12	Objekto kodas
I05_KODAS_OS_C	C 12	Centro kodas
I05_KODAS_MS	C 12	Menedžerio kodas
I05_USERIS	C 12	Kas koregavo
I05_R_DATE	T 8	Kada koregavo
I05_ADDUSR	C 12	Kas sukūrė
I05_KODAS_KT	C 12	Sutartis
I05_KODAS_K0	C 12	Sutarties priedas
I05_SUMA_PER	N 12.2	Valiutos perskaičiavimo suma