EDIT_I03

Aprašymas

Didžiosios knygos operacijos detalios eilutės 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_I03
params :
- oper :
  - I - naujo įrašo sukūrimas (numatytasis)
  - U - įrašo koregavimas
  - D - įrašo ištrynimas
- user : vartotojo vardas (naudojamas dokumentų skaitliukams, parametrams ir kt.), veikia tik rakto prefix'ui įjungus parametrą RGI_USR_EDIT
data: perduodami duomenys:
- I03 - atitinkamos lentelės laukai (i03)

Pirmi 7 ApiKey simboliai (pvz USERABC.JQKPGGd7Pkjxj38ObsgdfEvvfEfvF1oL7h7UMOLo -> 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_I03</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <I03>
            <I03_KODAS_ZS>DK1</I03_KODAS_ZS>
            <I03_KODAS_DH>010000000001</I03_KODAS_DH>
            <I03_KODAS_SSD>272</I03_KODAS_SSD>
            <I03_KODAS_SSC>273</I03_KODAS_SSC>
        </I03>
    </data>
</body>

JSON request

{
    "method": "EDIT_I03",
    "params": {
        "oper": "I"
    },
    "data": {
        "I03": {
            "I03_KODAS_ZS": "DK1",
            "I03_KODAS_DH": "010000000001",
            "I03_KODAS_SSD": "272",
            "I03_KODAS_SSC": "273"
        }
    }
}

Response (status 200 OK)

XML response

<RET_DOK>
    <I03>
        <I03_KODAS_ZS>DK1</I03_KODAS_ZS>
        <I03_KODAS_DH>010000000001</I03_KODAS_DH>
        <I03_EIL_NR>1</I03_EIL_NR>
        <I03_KODAS_SSD>272</I03_KODAS_SSD>
        <I03_KODAS_SSC>273</I03_KODAS_SSC>
        <I03_VAL_SUMD>0.00</I03_VAL_SUMD>
        <I03_VAL_SUMC>0.00</I03_VAL_SUMC>
        <I03_SUMA>0.00</I03_SUMA>
        <I03_KODAS_IS>01</I03_KODAS_IS>
        <I03_KODAS_OS></I03_KODAS_OS>
        <I03_KODAS_OS_S></I03_KODAS_OS_S>
        <I03_SERIJA></I03_SERIJA>
        <I03_ADDUSR>WS</I03_ADDUSR>
        <I03_USERIS>WS</I03_USERIS>
        <I03_R_DATE>2024-01-01T00:00:01</I03_R_DATE>
    </I03>
</RET_DOK>

JSON response

{
    "I03": {
        "I03_KODAS_ZS": "DK1",
        "I03_KODAS_DH": "010000000001",
        "I03_EIL_NR": 1,
        "I03_KODAS_SSD": 272,
        "I03_KODAS_SSC": 272,
        "I03_VAL_SUMD": 0,
        "I03_VAL_SUMC": 0,
        "I03_SUMA": 0,
        "I03_KODAS_IS": "01",
        "I03_KODAS_OS": "",
        "I03_KODAS_OS_S": "",
        "I03_SERIJA": "",
        "I03_ADDUSR": "WS",
        "I03_USERIS": "WS",
        "I03_R_DATE": "2024-01-01T00:00:01"
    }
}

Response (status 400)

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

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id/>
    <durationMs>1</durationMs>
    <errorMessage>Nepavyko įvykdyti metodo</errorMessage>
    <document/>
    <errors>
        <error>
            <data></data>
            <dataErrors>
                <dataError>
                    <tag>I03_KODAS_DH</tag>
                    <code>25001</code>
                    <message>Toks operacijos kodas nerastas</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>2024-01-01T00:00:01.001+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_I03</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <I03>
            <I03_KODAS_ZS>DK1</I03_KODAS_ZS>
            <I03_KODAS_DH>010000000001</I03_KODAS_DH>
            <I03_EIL_NR>1</I03_EIL_NR>
            <I03_KODAS_SSC>275</I03_KODAS_SSC>
        </I03>
    </data>
</body>

pvz trynimas:

<body>
    <method>EDIT_I03</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <I03>
            <I03_KODAS_ZS>DK1</I03_KODAS_ZS>
            <I03_KODAS_DH>010000000001</I03_KODAS_DH>
            <I03_EIL_NR>1</I03_EIL_NR>
        </I03>
    </data>
</body>

PHP pvz

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'ApiKey: uUCz7UY.sKVrjaWRDJAH1c7l4qL222nn2K0jARkkkHDdYTss',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{
    "method": "EDIT_I03",
    "params": {
        "oper": "I"
    },
    "data": {
        "I03": {
            "I03_KODAS_ZS": "DK1",
            "I03_KODAS_DH": "010000000001",
            "I03_KODAS_SSD": "272",
            "I03_KODAS_SSC": "273"
        }
    }
}');
$response = curl_exec($ch);
curl_close($ch);

Lentelės

I03

Didžiosios knygos detali informacija

Laukas	Tipas	Aprašymas	Pastabos naudojant EDIT metodus
I03_KODAS_ZS	C(12)	DK žurnalo kodas	Privalomas
I03_KODAS_DH	C(12)	DK operacijos numeris žurnale	Privalomas
I03_EIL_NR	N(6)	Eilutės numeris operacioje	Privalomas , kai oper=U,D
I03_KODAS_SSD	C(12)	Debeto sąskaita	Privalomas, kai oper=I
I03_KODAS_SSC	C(12)	Kredito sąskaita	Privalomas, kai oper=I
I03_VAL_SUMD	N(18,2)	Debeto suma valiuta
I03_VAL_SUMC	N(18,2)	Kredito suma valiuta
I03_SUMA	N(12,2)	Suma
I03_KODAS_IS	C(12)	Padalinys
I03_KODAS_OS	C(12)	Objektas/Rinkinio ID
I03_KODAS_OS_S	C(12)	Centras
I03_SERIJA	C(12)	Serija
I03_ADDUSR	C(12)	Kas sukūrė	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
I03_USERIS	C(12)	Kas koregavo	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
I03_R_DATE	T(8)	Kada koregavo	Neperduodamas. Pildomas automatiškai, Current Datetime
I03_DIM01	C(12)	Dimensija-1
I03_DIM02	C(12)	Dimensija-2
I03_DIM03	C(12)	Dimensija-3
I03_DIM04	C(12)	Dimensija-4
I03_DIM05	C(12)	Dimensija-5
I03_DIM06	C(12)	Dimensija-6
I03_DIM07	C(12)	Dimensija-7
I03_DIM08	C(12)	Dimensija-8
I03_DIM09	C(12)	Dimensija-9
I03_DIM10	C(12)	Dimensija-10
I03_DIM11	C(12)	Dimensija-11
I03_DIM12	C(12)	Dimensija-12
I03_DIM13	C(12)	Dimensija-13
I03_DIM14	C(12)	Dimensija-14
I03_DIM15	C(12)	Dimensija-15