Redaguoti

Pradžia Internetiniai moduliai Rivile API v2 (REST web servisai) EDIT_N08

EDIT_N08

Aprašymas

Kliento sukūrimas, koregavimas, trynimas

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 : EDIT_N08
params :
- oper :
  - I - naujo kliento sukūrimas
  - U - kliento koregavimas
  - D - kliento įrašo išmetimas
data: perduodami duomenys:
- N08 -Kliento pagrindinė informacija (n08)

Vienu metu veiksmai atliekami tik su vienu įrašu.

Pirmi 7 ApiKey simboliai (pvz USERABC.JQKPG1d7Pkjxj37ObsgdfEkvfEfvF1oL7h7UMOLo -> USERABC) yra vartotojo vardas Rivile GAMA programoje, kuriuo bus kuriami ar koreguojami įrašai.

Naujo kliento sukūrime galima nenurodyti N08_KODAS_KS - tuomet bus naudojamas Rivile GAMA skaitliukas.

Nenurodytas kliento kodas

pvz application/xml:

<body>
    <method>EDIT_N08</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <N08>
            <N08_KODAS_KS>121411842</N08_KODAS_KS>
            <N08_PAV>UAB "Rivilė"</N08_PAV>
            <N08_RUSIS>3</N08_RUSIS>
            <N08_IM_KODAS>121411842</N08_IM_KODAS>
            <N08_PVM_KODAS>LT214118411</N08_PVM_KODAS>
            <N08_KODAS_XS_P>PVM</N08_KODAS_XS_P>
            <N08_KODAS_XS_T>PVM</N08_KODAS_XS_T>
            <N08_KODAS_DS>PT001</N08_KODAS_DS>
        </N08>
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_N08",
    "params": {
        "oper": "I"
    },
    "data": {
        "N08": {
            "N08_KODAS_KS": "121411842",
            "N08_PAV": "UAB \"Rivilė\"",
            "N08_RUSIS": "3",
            "N08_IM_KODAS": "121411842",
            "N08_PVM_KODAS": "LT214118411",
            "N08_KODAS_XS_P": "PVM",
            "N08_KODAS_XS_T": "PVM",
            "N08_KODAS_DS": "PT001"
        }
    }
}

Response (status 200 OK)

Grąžinama informacija XML formate tarp tag'ų <RET_DOK>..</RET_DOK>.

pvz:

<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
    <N08>
        <N08_KODAS_KS>121411842</N08_KODAS_KS>
        <N08_RUSIS>3</N08_RUSIS>
        <N08_PVM_KODAS>LT214118411</N08_PVM_KODAS>
        <N08_IM_KODAS>121411842</N08_IM_KODAS>
        <N08_PAV>UAB "Rivilė"</N08_PAV>
        <N08_ADR></N08_ADR>
        <N08_KODAS_VS></N08_KODAS_VS>
        <N08_PASTAS></N08_PASTAS>
        <N08_ATSTOVAS></N08_ATSTOVAS>
        <N08_E_MAIL></N08_E_MAIL>
        <N08_FAX_NUM></N08_FAX_NUM>
        <N08_TEL></N08_TEL>
        <N08_MOB_TEL></N08_MOB_TEL>
        <N08_KODAS_LS_1></N08_KODAS_LS_1>
        <N08_KODAS_LS_2></N08_KODAS_LS_2>
        <N08_KODAS_LS_3></N08_KODAS_LS_3>
        <N08_KODAS_LS_4></N08_KODAS_LS_4>
        <N08_TIPAS_PIRK>1</N08_TIPAS_PIRK>
        <N08_TIPAS_TIEK>1</N08_TIPAS_TIEK>
        <N08_KODAS_GS></N08_KODAS_GS>
        <N08_CREDIT_LIM>0.00</N08_CREDIT_LIM>
        <N08_KODAS_DS>PT001</N08_KODAS_DS>
        <N08_DELSPINIGIAI>0.00</N08_DELSPINIGIAI>
        <N08_KODAS_QS></N08_KODAS_QS>
        <N08_NUOL_GR></N08_NUOL_GR>
        <N08_KODAS_XS_T>PVM</N08_KODAS_XS_T>
        <N08_KODAS_XS_P>PVM</N08_KODAS_XS_P>
        <N08_KODAS_TS_T></N08_KODAS_TS_T>
        <N08_KODAS_TS_P></N08_KODAS_TS_P>
        <N08_ADD_DATE>2020-02-25T19:32:59</N08_ADD_DATE>
        <N08_SUTARTIS>0</N08_SUTARTIS>
        <N08_KAIN_ABC>0</N08_KAIN_ABC>
        <N08_DIENOS>0</N08_DIENOS>
        <N08_TIEK_DIEN>0</N08_TIEK_DIEN>
        <N08_KRED_LIM>0</N08_KRED_LIM>
        <N08_PRIEDAI>0</N08_PRIEDAI>
        <N08_KODAS_IS></N08_KODAS_IS>
        <N08_KODAS_OS_P></N08_KODAS_OS_P>
        <N08_KODAS_OS></N08_KODAS_OS>
        <N08_KODAS_MS_P></N08_KODAS_MS_P>
        <N08_KODAS_MS_T></N08_KODAS_MS_T>
        <N08_VAL_POZ>0</N08_VAL_POZ>
        <N08_KODAS_VL_1></N08_KODAS_VL_1>
        <N08_KODAS_VL_2></N08_KODAS_VL_2>
        <N08_KODAS_VL_3></N08_KODAS_VL_3>
        <N08_KODAS_VL_4></N08_KODAS_VL_4>
        <N08_KODAS_VL_5></N08_KODAS_VL_5>
        <N08_KODAS_VL_6></N08_KODAS_VL_6>
        <N08_POZ_DATE>0</N08_POZ_DATE>
        <N08_BEG_DATE>2020-02-25T00:00:00</N08_BEG_DATE>
        <N08_END_DATE>2020-02-25T00:00:00</N08_END_DATE>
        <N08_ADDUSR>B1NOONQ</N08_ADDUSR>
        <N08_USERIS>B1NOONQ</N08_USERIS>
        <N08_R_DATE>2020-02-25T19:32:59</N08_R_DATE>
        <N08_GER_POZ>0</N08_GER_POZ>
        <N08_KODAS_LS_5></N08_KODAS_LS_5>
        <N08_KODAS_LS_6></N08_KODAS_LS_6>
        <N08_KODAS_LS_7></N08_KODAS_LS_7>
        <N08_KODAS_LS_8></N08_KODAS_LS_8>
        <N08_T_LIM_POZ>0</N08_T_LIM_POZ>
        <N08_T_KRED_LIM>0.00</N08_T_KRED_LIM>
        <N08_KODAS_VL_LIM></N08_KODAS_VL_LIM>
        <N08_KAINYNAS></N08_KAINYNAS>
        <N08_AR_REIK_P>0</N08_AR_REIK_P>
        <N08_AR_REIK_T>0</N08_AR_REIK_T>
        <N08_REZERVAS></N08_REZERVAS>
        <N08_INTRASTAT>0</N08_INTRASTAT>
        <N08_WB_KR>0</N08_WB_KR>
        <N08_WB_KR_GR>0</N08_WB_KR_GR>
        <N08_SUMA_WK_LIMIT>0.00</N08_SUMA_WK_LIMIT>
        <N08_SUMA_WK>0.00</N08_SUMA_WK>
        <N08_KODAS_VL_U></N08_KODAS_VL_U>
        <N08_busena>1</N08_busena>
        <N08_tipas>1</N08_tipas>
        <N08_pvm_skol_t>1</N08_pvm_skol_t>
        <N08_pvm_skol_p>1</N08_pvm_skol_p>
    </N08>
</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>14433105830.a90f1a25.1584209037451</id>
    <durationMs>125</durationMs>
    <errorMessage>nepavyko įvykdyti metodo</errorMessage>
    <errors>
        <error>
            <data>&lt;N08>&lt;N08_KODAS_DS>PT001&lt;/N08_KODAS_DS>&lt;N08_RUSIS>3&lt;/N08_RUSIS>&lt;N08_KODAS_XS_T>PVM&lt;/N08_KODAS_XS_T>&lt;N08_PAV>UAB &amp;quot;Rivilė&amp;quot;&lt;/N08_PAV>&lt;N08_PVM_KODAS>LT214118411&lt;/N08_PVM_KODAS>&lt;N08_KODAS_KS>121411842&lt;/N08_KODAS_KS>&lt;N08_KODAS_XS_P>PVM&lt;/N08_KODAS_XS_P>&lt;N08_IM_KODAS>121411842&lt;/N08_IM_KODAS>&lt;/N08></data>
            <dataErrors>
                <dataError>
                    <tag>N08_KODAS_KS</tag>
                    <code>2011</code>
                    <message>Egzistuoja toks kliento kodas</message>
                </dataError>
            </dataErrors>
        </error>
    </errors>
</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>

Koregavimas ir trynimas

Koregavimas, trynimas vykdomas pagal lentelės raktą (Primary Key)

Koreguojant informaciją bus koreguojami tik perduodami laukai.

pvz trynimas:

<body>
    <method>EDIT_N08</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <N08>
            <N08_KODAS_KS>121411842</N08_KODAS_KS>
        </N08>
    </data>
</body>

pvz koregavimas:

<body>
    <method>EDIT_N08</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <N08>
            <N08_KODAS_KS>121411842</N08_KODAS_KS>
            <N08_PAV>UAB "Rivilė"</N08_PAV>
            <N08_RUSIS>2</N08_RUSIS>
        </N08>
    </data>
</body>

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": "EDIT_N08",
    "params": {
        "oper": "I"
    },
    "data": {
        "N08": {
            "N08_KODAS_KS": "121411842",
            "N08_PAV": "UAB \"Rivilė\"",
            "N08_RUSIS": "3",
            "N08_IM_KODAS": "121411842",
            "N08_PVM_KODAS": "LT214118411",
            "N08_KODAS_XS_P": "PVM",
            "N08_KODAS_XS_T": "PVM",
            "N08_KODAS_DS": "PT001"
        }
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

N08

Kliento kortelės lentelė.

Laukas	Tipas	Aprašymas	Pastabos naudojant EDIT metodus
N08_KODAS_KS	C(12)	Kliento kodas	Privalomas
N08_RUSIS	N(1)	Rūšis:1-pirkėjas,2-tiekėjas,3-pirkėjas/tiekėjas,4-įmonė	Privalomas
N08_PVM_KODAS	C(25)	Kliento PVM kodas
N08_IM_KODAS	C(13)	Kliento įmonės kodas	Kuriant naują klientą (oper=`I`), jeigu nurodomas įmonės kodas - jis tikrinamas ar yra unikalus. Norint netikrinti unikalumo tai galima nustatyti parametre RGI_N08_UNIK
N08_PAV	C(150)	Kliento pavadinimas
N08_ADR	C(150)	Adresas
N08_KODAS_VS	C(12)	Vietovės kodas
N08_PASTAS	C(9)	Pašto indeksas
N08_ATSTOVAS	C(150)	Atstovas
N08_E_MAIL	C(150)	E-mail adresas
N08_FAX_NUM	C(40)	Fax-o numeriai
N08_TEL	C(40)	Telefonų numeriai
N08_MOB_TEL	C(40)	Mobilus telefonas
N08_KODAS_LS_1	C(12)	Logistikos 1 kodas
N08_KODAS_LS_2	C(12)	Logistikos 2 kodas
N08_KODAS_LS_3	C(12)	Logistikos 3 kodas
N08_KODAS_LS_4	C(12)	Logistikos 4 kodas
N08_TIPAS_PIRK	N(1)	Pirkėjo tipas:1-pagal dokumentus,2-pagal sąskaitas
N08_TIPAS_TIEK	N(1)	Tiekėjo tipas:1-pagal dokumentus,2-pagal sąskaitas
N08_KODAS_GS	C(12)	Klientų grupės kodas
N08_CREDIT_LIM	N(12,2)	Pirkėjo kredito limitas
N08_KODAS_DS	C(12)	Sąskaitų ryšio kodas	Privalomas (jeigu tipas pirkėjas arba tiekėjas)
N08_DELSPINIGIAI	N(5,2)	Pirkėjo delspinigių procentas
N08_KODAS_QS	C(12)	Pranešimo kodas
N08_NUOL_GR	C(6)	Pirkėjo nuolaidos grupė
N08_KODAS_XS_T	C(12)	Tiekėjo mokesčių lentelės kodas	Privalomas (jeigu tipas tiekėjas)
N08_KODAS_XS_P	C(12)	Pirkėjo mokesčių lentelės kodas	Privalomas (jeigu tipas pirkėjas)
N08_KODAS_TS_T	C(12)	Tiekėjo terminų lentelės kodas
N08_KODAS_TS_P	C(12)	Pirkėjo terminų lentelės kodas
N08_ADD_DATE	T(8)	Sukūrimo laikas
N08_SUTARTIS	N(1)	Ar būtina pirkėjo sutartis:0-ne,1-taip
N08_KAIN_ABC	N(1)	Ar kontroliuoti pirkėjo sutartčių sąlygas:0-ne,1-taip
N08_DIENOS	N(1)	Rezervas
N08_TIEK_DIEN	N(1)	Ar būtinai reikalinga tiekėjo sutartis:0-ne,1-taip
N08_KRED_LIM	N(1)	Ar kontroliuoti pirkėjo kredito limitą atliekant pardav
N08_PRIEDAI	N(1)	Ar kontroliuoti tiekėjo sutartčių sąlygas:0-ne,1-taip
N08_KODAS_IS	C(12)	Klientui priskirtas padalinio kodas
N08_KODAS_OS_P	C(12)	Klientui priskirtas pardavimų centro kodas
N08_KODAS_OS	C(12)	Klientui priskirtas objekto kodas
N08_KODAS_MS_P	C(12)	Menedžerio pardavėjo kodas
N08_KODAS_MS_T	C(12)	Menedžerio pirkėjo kodas
N08_VAL_POZ	N(1)	Ar galima atsiskaitinėti valiuta:0-ne,1-taip
N08_KODAS_VL_1	C(12)	Atsiskaitymų valiutos kodas 1
N08_KODAS_VL_2	C(12)	Atsiskaitymų valiutos kodas 2
N08_KODAS_VL_3	C(12)	Atsiskaitymų valiutos kodas 3
N08_KODAS_VL_4	C(12)	Atsiskaitymų valiutos kodas 4
N08_KODAS_VL_5	C(12)	Atsiskaitymų valiutos kodas 5
N08_KODAS_VL_6	C(12)	Atsiskaitymų valiutos kodas 6
N08_POZ_DATE	N(1)	Terminuotas0-ne,1-taip
N08_BEG_DATE	T(8)	Pradžios data
N08_END_DATE	T(8)	Pabaigos data
N08_ADDUSR	C(12)	Kas sukūrė
N08_USERIS	C(12)	Kas koregavo
N08_R_DATE	T(8)	Koregavimo laikas
N08_GER_POZ	N(1)	Ar nepatikrintas
N08_KODAS_LS_5	C(12)	Logistikos kodas 5
N08_KODAS_LS_6	C(12)	Logistikos kodas 6
N08_KODAS_LS_7	C(12)	Logistikos kodas 7
N08_KODAS_LS_8	C(12)	Logistikos kodas 8
N08_T_LIM_POZ	N(1)	Tiekėjo kredito limito požymis
N08_T_KRED_LIM	N(12,2)	Tiekėjo kredito limitas
N08_KODAS_VL_LIM	C(12)	Tiekėjo limito valiuta
N08_KAINYNAS	C(1)	Kainynas
N08_AR_REIK_P	N(1)	Ar reikaluti kredito limito
N08_AR_REIK_T	N(1)	Ar reikalauti kredito limito (tiekėjui)
N08_REZERVAS	C(40)	Trumpas įmonės aprašymas
N08_INTRASTAT	N(1)	Intrastat ataskaitos: 0-Ne, 1-Taip
N08_WB_KR	N(1)	Ar sekamas WB įsipareigojimai: 0-ne, 1-Taip
N08_WB_KR_GR	N(1)	Ar griežta WB kredito kontolė: 0-Ne,1-Taip
N08_SUMA_WK_LIMIT	N(12,2)	WB Kredito limito suma
N08_SUMA_WK	N(12,2)	Įsipareigojimų pradinė suma
N08_KODAS_VL_U	C(12)	Užsakymų formavimo valiuta
N08_BUSENA	N(3)	Būsena
N08_TIPAS	N(1)	Tipas: 1-juridinis,2-fizinis
N08_PVM_SKOL_T	N(1)	PVM įtraukti į skolą (Tiekėjas) 0-Ne,1-Taip (default)	nuo v113.0000
N08_PVM_SKOL_P	N(1)	PVM įtraukti į skolą (Pirkėjas) 0-Ne,1-Taip (default)	nuo v113.0000
N08_pastabos	text	Pastabos	nuo v114.0300 (tik nuskaitymui)
N08_SKOL_SUD	N(1)	Automatinis skolų sudengimas 1 - nenaudoti (default), 2 - parinkti dok., 3 - visi dok.	nuo v116.0000
N08_EOIR	C(50)	EOIR kodas	nuo v116.0000
N08_APRASYMAS1	C(150)	Aprašymas1	nuo v116.0000
N08_APRASYMAS2	C(150)	Aprašymas2	nuo v116.0000
N08_APRASYMAS3	C(150)	Aprašymas3	nuo v116.0000
N08_APRASYMAS4	C(150)	Aprašymas4	nuo v116.0000

Parametrai

RGI_N08_UNIK - API pasikartojantys įmonės kodai

Parametras valdantis ar leisti kurti naujus klientus su pasikartojančiais įmonės kodais.

Parametras gali būti valdomas bendrai ar konkrečiam API raktui, nurodant jo prefix'ą.