GET_N25_LIST

Aprašymas

Pardavimų / Pirkimų kodų sąrašas.

Specifikacija

Address

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

  • 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_N25_LIST
  • params :
    • fil : filtravimo sąlyga. T-SQL tipo where sąlygos užklausa iš lentelės N25 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 į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ų atsakymas apribotas 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_N25_LIST</method>
    <params>
        <fil>n25_kodas_bs='004'</fil>
    </params>
</body>

pvz application/json:

{
    "method": "GET_N25_LIST",
    "params": {
        "fil": "n25_kodas_bs='004'"
    }
}
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ą N25_KODAS_BS

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

pvz:

<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
    <N25>
        <Row_number>1</Row_number>
        <N25_KODAS_BS>5006        </N25_KODAS_BS>
        <N25_KODAS_GS>           </N25_KODAS_GS>
        <N25_PAV>Laiptinių valymas</N25_PAV>                                 
        <N25_TIPAS>2</N25_TIPAS>
        <N25_KODAS_SS>5001        </N25_KODAS_SS>
        <N25_KODAS_DS>PR001       </N25_KODAS_DS>
        <N25_KODAS_US>M*2         </N25_KODAS_US>
        <N25_FRAKCIJA>100</N25_FRAKCIJA>
        <N25_SUMA>0.00</N25_SUMA>
        <N25_MOKESTIS>1</N25_MOKESTIS>
        <N25_TAX>1</N25_TAX>
        <N25_KODAS_OS>           </N25_KODAS_OS>
        <N25_PROCENT>0.00</N25_PROCENT>
        <N25_POZ_DATE>0</N25_POZ_DATE>
        <N25_BEG_DATE>2019-08-12T00:00:00</N25_BEG_DATE>
        <N25_END_DATE>2019-08-12T00:00:00</N25_END_DATE>
        <N25_USERIS>MASTER      </N25_USERIS>
        <N25_R_DATE>2019-08-13T10:55:42</N25_R_DATE>
        <N25_ADDUSR>MASTER      </N25_ADDUSR>
        <N25_ADD_TIME>2019-08-13T00:00:00</N25_ADD_TIME>
        <N25_OP_RUSIS>1</N25_OP_RUSIS>
        <N25_KODAS_SS_CT>           </N25_KODAS_SS_CT>
        <N25_KURAS_PAP>0.000</N25_KURAS_PAP>
        <N25_AMOR_H>0</N25_AMOR_H>
        <N25_KURAS_H>0</N25_KURAS_H>
        <N25_MOK_H>0.0000</N25_MOK_H>
        <N25_MOK_KM>0.0000</N25_MOK_KM>
        <N25_MOK_T>0.0000</N25_MOK_T>
        <N25_MOK_TKM>0.0000</N25_MOK_TKM>
        <N25_MOK_S>0.0000</N25_MOK_S>
        <N25_KODAS_LP>000000000000</N25_KODAS_LP>
        <N25_KODAS_VL>           </N25_KODAS_VL>
    </N25>
</RET_DOK>
Response (status 400)

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

<RET_DOK>
    <id>5654648301.7d5481b2.1639560726893</id>
    <durationMs>46</durationMs>
    <errorMessage>Invalid column name 'N25_KODAS_BSs'.</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_N25_LIST",
    "params": {
        "fil": "n25_kodas_bs=\'004\'"
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

N25

Pardavimų / Pirkimų kodų lentelė.

Laukas Tipas Aprašymas Pastabos naudojant EDIT metodus
N25_KODAS_BS C(12) Kodas
N25_KODAS_GS C(12) Grupės kodas
N25_PAV C(150) Pavadinimas
N25_TIPAS N(1) Tipas:1-pirkimų,2-pardavimų,3-Komplektavimų,4-,5-atsargų,6-TR.atskaitomybės,7-TR.darbai
N25_KODAS_SS C(12) Sąskaitos kodas
N25_KODAS_DS C(12) Sąskaitos ryšio kodas parduodant
N25_KODAS_US C(12) Matavimo vieneto kodas
N25_FRAKCIJA N(4) Frakcija
N25_SUMA N(12,2) Suma pagal nutylėjimą
N25_MOKESTIS N(1) Ar apmokestinamas:0-ne,1-taip
N25_TAX N(1) PVM mokestis:1-A,2-B,3-C,4-D
N25_KODAS_OS C(12) Objekto kodas
N25_PROCENT N(6,2) Nuolaidos procentas
N25_POZ_DATE N(1) Terminuotas:0-ne,1-taip
N25_BEG_DATE T(8) Pradžios data
N25_END_DATE T(8) Pabaigos data
N25_USERIS C(12) Kas koregavo
N25_R_DATE T(8) Koregavimo laikas
N25_ADDUSR C(12) Kas sukūrė
N25_ADD_TIME T(8) Sukūrimo laikas
N25_OP_RUSIS N(1) Operacijos rūšis:1-Avansas vairuotojui,2-Vairuotojo atsiskaitymas,3-kitos(ne vairuotojo)
N25_KODAS_SS_CT C(12) Kredito sąskaita transporto modulyje
N25_KURAS_PAP N(8,3) Papildomas kuras
N25_AMOR_H N(1) Ar skaičiuoti amortizacija nuo laiko?
N25_KURAS_H N(1) Ar skaičiuoti kurą nuo laiko?
N25_MOK_H N(12,4) Valandos įkainis
N25_MOK_KM N(12,4) Kilometro įkainis
N25_MOK_T N(12,4) Pervežamos tonos įkainis
N25_MOK_TKM N(12,4) Tonkilometrio įkainis
N25_MOK_S N(12,4) Sutartinė suma
N25_KODAS_LP C(12) Priskaitymo kodas Algose
N25_KODAS_VL C(12) Valiutos kodas
N25_PAV_K1 C(100) Pavadinimas kita kalba 1
N25_PAV_K2 C(100) Pavadinimas kita kalba 2
N25_PAV_K3 C(100) Pavadinimas kita kalba 3