GET_I06_DEBT

Aprašymas

Neperkeltų pirkimų, pardavimų dokumentų skolos

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_I06_DEBT
  • params :
    • list : H - grąžinama tik pagrindinė informacija. A - grąžinama visa dokumentų informacija. Parametras yra privalomas.
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės I06 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_I06_DEBT</method>
    <params>
        <list>H</list>
        <fil>i06_kodas_ks='121411842'</fil>
    </params>
</body>

pvz application/json:

{
    "method": "GET_I06_DEBT",
    "params": {
        "list": "H",
        "fil": "i06_kodas_ks='121411842'"
    }
}
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ą I06_KODAS_KS

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>
    <I06>
        <Row_number>1</Row_number>
        <I06_KODAS_KS>121411842</I06_KODAS_KS>
        <I06_DOK_NR>DOK-001</I06_DOK_NR>
        <I06_KODAS_VL></I06_KODAS_VL>
        <I06_SUMA_DB_VL>0.00</I06_SUMA_DB_VL>
        <I06_SUMA_CR_VL>0.00</I06_SUMA_CR_VL>
        <I06_SUMA_DB>71.88</I06_SUMA_DB>
        <I06_SUMA_CR>0.00</I06_SUMA_CR>
    </I06>
</RET_DOK>

pvz, kai list='H':

<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
    <I06>
        <Row_number>1</Row_number>
        <I06_KODAS_KS>121411842</I06_KODAS_KS>
        <I06_SUMA_DB_VL>0.00</I06_SUMA_DB_VL>
        <I06_SUMA_CR_VL>0.00</I06_SUMA_CR_VL>
        <I06_SUMA_DB>71.88</I06_SUMA_DB>
        <I06_SUMA_CR>0.00</I06_SUMA_CR>
    </I06>
</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.be556121580908106909</id>
    <durationMs>3</durationMs>
    <errorMessage>Invalid column name 'i06_kodasxx_ks'.</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, '{
    "method": "GET_I06_DEBT",
    "params": {
        "list": "H",
        "fil": "i06_kodas_ks=\'121411842\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

I06

Laukas Tipas Aprašymas Pastabos
I06_KODAS_KS C(12) Kliento kodas
I06_DOK_NR C(12) Dokumento numeris Grąžinamas, kai list=A
I06_KODAS_VL C(12) Valiutos kodas Grąžinamas, kai list=A
I06_SUMA_DB_VL N(12,2) Suma debete valiuta
I06_SUMA_CR_VL N(12,2) Suma kredite valiuta
I06_SUMA_DB N(12,2) Suma debete
I06_SUMA_CR N(12,2) Suma kredite

Nuoroda į pilnos lentelės aprašymą: I06