EDIT_N51

Aprašymas

Sutarčių koregavimas.

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_N51
params :
- oper :
  - I - naujo įrašo sukūrimas (numatytasis)
  - U - dokumento koregavimas
  - D - dokumento ištrynimas
data: perduodami duomenys:
- N51 - atitinkamos lentelės laukai (n51)

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

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

XML request

<body>
    <method>EDIT_N51</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <N51>
            <N51_KODAS_KT>SUT01</N51_KODAS_KT>
            <N51_KODAS_KS>121411842</N51_KODAS_KS>
            <N51_TIPAS>2</N51_TIPAS>
            <N51_OP_DATA>2023-12-31</N51_OP_DATA>
        </N51>    
    </data>
</body>

JSON request

{
    "method": "EDIT_N51",
    "params": {
        "oper": "I"
    },
    "data": {
        "N51": {
            "N51_KODAS_KT": "SUT01",
            "N51_KODAS_KS": "121411842",
            "N51_TIPAS": "2",
            "N51_OP_DATA": "2023-12-31"
        }
    }
}

Response (status 200 OK)

XML response

<RET_DOK>
    <N51>
        <N51_KODAS_KT>SUT01</N51_KODAS_KT>
        <N51_PRIORITETAS>1.000</N51_PRIORITETAS>
        <N51_DOK_NR></N51_DOK_NR>
        <N51_OP_DATA>2023-12-31T00:00:00</N51_OP_DATA>
        <N51_PAV></N51_PAV>
        <N51_KODAS_KS>121411842</N51_KODAS_KS>
        <N51_TIPAS>2</N51_TIPAS>
        <N51_KODAS_MS></N51_KODAS_MS>
        <N51_POZ_SUMA>0</N51_POZ_SUMA>
        <N51_SUMA>0.00</N51_SUMA>
        <N51_PASTABOS></N51_PASTABOS>
        <N51_POZ_DATE>0</N51_POZ_DATE>
        <N51_BEG_DATE>2023-11-21T00:00:00</N51_BEG_DATE>
        <N51_END_DATE>2023-11-21T00:00:00</N51_END_DATE>
        <N51_USERIS>WS</N51_USERIS>
        <N51_ADDUSR>WS</N51_ADDUSR>
        <N51_R_DATE>2023-12-31T23:59:59</N51_R_DATE>
        <N51_VISKAS>0</N51_VISKAS>
        <N51_POZ_KRED>0</N51_POZ_KRED>
        <N51_LIMITAS>0.00</N51_LIMITAS>
        <N51_KODAS_TS></N51_KODAS_TS>
        <N51_KODAS_LS_1></N51_KODAS_LS_1>
        <N51_KODAS_LS_2></N51_KODAS_LS_2>
        <N51_KODAS_LS_3></N51_KODAS_LS_3>
        <N51_KODAS_LS_4></N51_KODAS_LS_4>
        <N51_KODAS_SM></N51_KODAS_SM>
        <N51_KODAS_LS_5></N51_KODAS_LS_5>
        <N51_KODAS_LS_6></N51_KODAS_LS_6>
        <N51_KODAS_LS_7></N51_KODAS_LS_7>
        <N51_KODAS_LS_8></N51_KODAS_LS_8>
        <N51_SUMA_P>0.00</N51_SUMA_P>
        <N51_BUSENA>1</N51_BUSENA>
        <N51_SANAUDOS>0.00</N51_SANAUDOS>
        <N51_KODAS_VL>EUR</N51_KODAS_VL>
    </N51>
</RET_DOK>

JSON response

{
    "N51": {
        "N51_KODAS_KT": "SUT01",
        "N51_PRIORITETAS": 1,
        "N51_DOK_NR": "",
        "N51_OP_DATA": "2023-12-31T00:00:00",
        "N51_PAV": "",
        "N51_KODAS_KS": 121411842,
        "N51_TIPAS": 2,
        "N51_KODAS_MS": "",
        "N51_POZ_SUMA": 0,
        "N51_SUMA": 0,
        "N51_PASTABOS": "",
        "N51_POZ_DATE": 0,
        "N51_BEG_DATE": "2023-11-21T00:00:00",
        "N51_END_DATE": "2023-11-21T00:00:00",
        "N51_USERIS": "WS",
        "N51_ADDUSR": "WS",
        "N51_R_DATE": "2023-12-31T23:59:59",
        "N51_VISKAS": 0,
        "N51_POZ_KRED": 0,
        "N51_LIMITAS": 0,
        "N51_KODAS_TS": "",
        "N51_KODAS_LS_1": "",
        "N51_KODAS_LS_2": "",
        "N51_KODAS_LS_3": "",
        "N51_KODAS_LS_4": "",
        "N51_KODAS_SM": "",
        "N51_KODAS_LS_5": "",
        "N51_KODAS_LS_6": "",
        "N51_KODAS_LS_7": "",
        "N51_KODAS_LS_8": "",
        "N51_SUMA_P": 0,
        "N51_BUSENA": 1,
        "N51_SANAUDOS": 0,
        "N51_KODAS_VL": "EUR"
    }
}

Response (status 400)

Klaida paduodant duomenis / SQL sintaksės klaidos / kitos duomenų klaidos

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id>9357776210.663592f5.1700577430512</id>
    <durationMs>195</durationMs>
    <errorMessage>Nepavyko įvykdyti metodo</errorMessage>
    <document/>
    <errors>
        <error>
            <data>&lt;N51>&lt;N51_KODAS_KS>121411842&lt;/N51_KODAS_KS>&lt;/N51></data>
            <dataErrors>
                <dataError>
                    <tag>N51_KODAS_KT</tag>
                    <code>19013</code>
                    <message>Nenurodytas 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>/v2</path>
</Map>

Koregavimas, trynimas ir perkėlimas

Koregavimas, trynimas ir perkėlimas vyksta pagal atitinkamos lentelės raktą (Primary Key)

Koreguojant informaciją bus koreguojami tik perduodami laukai.

pvz koregavimas:

<body>
    <method>EDIT_N51</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <N51>
            <N51_KODAS_KT>SUT01</N51_KODAS_KT>
            <N51_DOK_NR>DOK001</N51_DOK_NR>
            <N51_PASTABOS>Papildyta sutartis</N51_PASTABOS>
        </N51>    
    </data>
</body>

pvz trynimas:

<body>
    <method>EDIT_N51</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <N51>
            <N51_KODAS_KT>SUT01</N51_KODAS_KT>
        </N51>
    </data>
</body>

PHP pvz

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'ApiKey: uUCz6UY.sKVrjaWRDJAH1c7l4qL2nOnn2K0jARkkkHDdYsss',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
    "method": "EDIT_N51",
    "params": {
        "oper": "I"
    },
    "data": {
        "N51": {
            "N51_KODAS_KT": "SUT01",
            "N51_KODAS_KS": "121411842",
            "N51_TIPAS": "2",
            "N51_OP_DATA": "2023-12-31"
        }
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

N51

Sutarčių lentelė

Laukas	Tipas	Aprašymas	Pastabos naudojant EDIT metodus
N51_KODAS_KT	C(12)	Sutarties kodas	Privalomas , kai oper=U,D
N51_PRIORITETAS	N(14,3)	Sutarties prioritetas
N51_DOK_NR	C(40)	Dokumento numeris
N51_OP_DATA	T(8)	Operacijos data
N51_PAV	C(40)	Pavadinimas
N51_KODAS_KS	C(12)	Klientas	Privalomas, kai oper=I
N51_TIPAS	N(1)	Tipas:1-Pirkimo,2-Pardavimo
N51_KODAS_MS	C(12)	Menedžeris
N51_POZ_SUMA	N(1)	Kontroliuoti sutarties sumą?
N51_SUMA	N(12,2)	Sutarties suma
N51_PASTABOS	M(4)	Pastabos
N51_POZ_DATE	N(1)	Terminuota
N51_BEG_DATE	T(8)	Pradžios data
N51_END_DATE	T(8)	Pabaigos data
N51_USERIS	C(12)	Kas koregavo	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
N51_ADDUSR	C(12)	Kas sukūrė	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
N51_R_DATE	T(8)	Kada koregavo	Neperduodamas. Pildomas automatiškai, Current Datetime
N51_VISKAS	N(1)	Sutartis: 0-aktyvi,1-neaktyvi
N51_POZ_KRED	N(1)	Kontroliuoti kredito limitą?
N51_LIMITAS	N(12,2)	Kredito limitas
N51_KODAS_TS	C(12)	Terminų kodas
N51_KODAS_LS_1	C(12)	Logistikos kodas 1
N51_KODAS_LS_2	C(12)	Logistikos kodas 2
N51_KODAS_LS_3	C(12)	Logistikos kodas 3
N51_KODAS_LS_4	C(12)	Logistikos kodas 7
N51_KODAS_SM	C(12)	Asmuo
N51_KODAS_LS_5	C(12)	Logistikos kodas 5
N51_KODAS_LS_6	C(12)	Logistikos kodas 6
N51_KODAS_LS_7	C(12)	Logistikos kodas 7
N51_KODAS_LS_8	C(12)	Logistikos kodas 8
N51_SUMA_P	N(12,2)	Pradinė suma	nuo v107.0600
N51_BUSENA	N(3)	Būsena	nuo v108.0000
N51_APRASYMAS1	C(60)	Aprašymas 1	nuo v110.0000
N51_APRASYMAS2	C(60)	Aprašymas 2	nuo v110.0000
N51_APRASYMAS3	C(60)	Aprašymas 3	nuo v110.0000
N51_APRASYMAS4	C(60)	Aprašymas 4	nuo v110.0000