GET_T03_LIST

Aprašymas

Suminių klientų/tiekėjų skolų informacija

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_T03_LIST
  • params :
    • list: gražinamų duomenų detalumas
      • H - kliento lygyje
      • A - kliento, dok.nr., datos, valiutos lygyje
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės T03 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ą „porcijomis“ per kelis kartus, filtruojant pagal paskutinio gauto įrašo rakto reikšmę.

pvz application/xml:

<body>
    <method>GET_T03_LIST</method>
    <params>
        <list>H</list>
        <fil>t03_kodas_ks=' 110065392 '</fil>
    </params>
</body>

pvz application/json:

{
    "method": "GET_T03_LIST",
    "params": {
        "list":"H",
        "fil": "t03_kodas_ks=' 110065392 '"
    }
}
Response (status 200 OK)

Grąžinama informacija XML formate tarp tag'ų <RET_DOK>..</RET_DOK>. Jeigu įrašų nerasta pagal užduotas sąlygas, tuomet gražinama status=200 bei tuščias tag'as

pvz, kai list='A':

Esant daugiau nei vienam įrašui informacija rūšiuojama (order) pagal lentelės raktinį lauką t03_kodas_ks,t03_dok_nr,t03_data_mok,t03_kodas_vl

<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
    <T03>
        <Row_number>1</Row_number>
        <t03_kodas_ks> 110065392 </t03_kodas_ks>
        <t03_dok_nr>LIKUTIS </t03_dok_nr>
        <t03_data_mok>2008-12-31T00:00:00</t03_data_mok>
        <t03_kodas_vl>LIT </t03_kodas_vl>
        <t03_suma_db_vl>0.00</t03_suma_db_vl>
        <t03_suma_cr_vl>7200.00</t03_suma_cr_vl>
        <t03_suma_db>0.00</t03_suma_db>
        <t03_suma_cr>7200.00</t03_suma_cr>
    </T03>
</RET_DOK>

pvz, kai list='H':

Esant daugiau nei vienam įrašui informacija rūšiuojama (order) pagal lentelės raktinį lauką t03_kodas_ks

<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
    <T03>
        <Row_number>1</Row_number>
        <t03_kodas_ks> 110065392 </t03_kodas_ks>
        <t03_suma_db_vl>0.00</t03_suma_db_vl>
        <t03_suma_cr_vl>7200.00</t03_suma_cr_vl>
        <t03_suma_db>0.00</t03_suma_db>
        <t03_suma_cr>7200.00</t03_suma_cr>
    </T03>
</RET_DOK>
Response (status 400)

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

<RET_DOK type="error">
    <id>2552c6d.dd81a1c1580324646507</id>
    <durationMs>53</durationMs>
    <errorMessage>Invalid column name 't03_kodas_k'.</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 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, $body );
$response = curl_exec($ch);
curl_close($ch);

Lentelės

T03

Suminė skolų klientų/tiekėjų informacija.

Laukas Tipas Aprašymas Pastabos
T03_KODAS_KS C(12) Kliento kodas
T03_DOK_NR C(20) Dokumento numeris Gražinamas, kai list=A
T03_DATA_MOK T(8) Mokėjimo data Gražinamas, kai list=A
T03_KODAS_VL C(12) Valiutos kodas Gražinamas, kai list=A
T03_SUMA_DB_VL N(18,2) Suma debete valiuta
T03_SUMA_CR_VL N(18,2) Suma kredite valiuta
T03_SUMA_DB N(12,2) Suma debete
T03_SUMA_CR N(12,2) Suma kredite