EDIT_I53_FULL

Aprašymas

Naujo mokėjimo dokumento sukūrimas (kartu su detaliomis eilutėmis)

Specifikacija

Informacija apie autorizaciją, bendruosius parametrus ir klaidų kodus: Rivile API v2 naudojimo pagrindai

Body
  • method : EDIT_I53_FULL
  • params :
    • errorAction - klaidos parametras nurodantis koks veiksmas bus atliekamas įvykus klaidai papildomos informacijos formavimo metu, kai yra sukuriama mokėjimo operacija (I53) ir gaunama klaida vykdant veiksmus su dokumentų sudengimo eilutėmis (K62). Parametras gali turėti tris reikšmes: EXIT, CONTINUE, ROLLBACK (default reikšmė). Reikšmė turi būti paduodama dydžiosiomis raidėmis!
    • user - vartotojo vardas (naudojamas dokumentų skaitliukams, parametrams ir kt.), veikia tik rakto prefix'ui įjungus parametrą RGI_USR_EDIT
  • data: perduodami duomenys:
    • I53 - Kliento pagrindinė informacija (I53)
    • K62 - Kliento papildoma informacija (K62)

errorAction reikšmė turi būti paduodama didžiosiomis raidėmis!

errorAction reikšmių aprašymai:

Reikšmė Aprašymas
ROLLBACK (default reikšmė) Įvykus klaidai tolimesnės procedūros nebus vykdamos, bus ištrinamas dokumentas (I53) ir grąžinama klaida. Klaidos statusas 400
EXIT Įvykus klaidai tolimesnės procedūros nebus vykdamos, bus grąžinamas sukurtas dokumentas (I53) ir klaidų sąrašas. Klaidos statusas 207
CONTINUE Įvykus klaidai procedūros bus vykdamos iki pabaigos, o klaidos dedamos į sąrašą. Grąžinamas sukurtas dokumentas (I53) ir klaidų sąrašas pabaigoje. Klaidos statusas 207

pvz application/xml:

<body>
    <method>EDIT_I53_FULL</method>
    <data>
        <I53>
            <I53_OP_RUSIS>1</I53_OP_RUSIS>
            <I53_DOK_TIPAS>2</I53_DOK_TIPAS>
            <I53_DOK_NR>RIV07</I53_DOK_NR>
            <I53_KODAS_KS>1234567</I53_KODAS_KS>
            <I53_SUMA>100</I53_SUMA>
            <i53_KODAS_SS>7</i53_KODAS_SS>
            <K62>
                <K62_PAV>CREATE1</K62_PAV>
                <K62_KODAS_KS_2>1234567</K62_KODAS_KS_2>
                <K62_DOK_NR_2>CREATE1</K62_DOK_NR_2>
                <K62_KODAS_VL>USD</K62_KODAS_VL>
                <K62_SUMA_VL>500</K62_SUMA_VL>
            </K62>
            <K62>
                <K62_PAV>CREATE2</K62_PAV>
                <K62_KODAS_KS_2>1234567</K62_KODAS_KS_2>
                <K62_DOK_NR_2>CREATE2</K62_DOK_NR_2>
                <K62_KODAS_VL>CAD</K62_KODAS_VL>
                <K62_SUMA_VL>500</K62_SUMA_VL>
            </K62>
        </I53>
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_I53_FULL",
    "data": {
        "I53": {
            "I53_OP_RUSIS": "1",
            "I53_DOK_TIPAS": "2",
            "I53_DOK_NR": "RIV07",
            "I53_KODAS_KS": "1234567",
            "I53_SUMA": "100",
            "i53_KODAS_SS": "7",
            "K62": [
                {
                    "K62_PAV": "CREATE1",
                    "K62_KODAS_KS_2": "1234567",
                    "K62_DOK_NR_2": "CREATE1",
                    "K62_KODAS_VL": "USD",
                    "K62_SUMA_VL": "500"
                },
                {
                    "K62_PAV": "CREATE2",
                    "K62_KODAS_KS_2": "1234567",
                    "K62_DOK_NR_2": "CREATE2",
                    "K62_KODAS_VL": "CAD",
                    "K62_SUMA_VL": "500"
                }
            ]
        }
    }
}
Response (status 200 OK)

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

pvz:

<RET_DOK>
    <I53>
        <I53_KODAS_OI>000R00000367</I53_KODAS_OI>
        <I53_OP_RUSIS>1</I53_OP_RUSIS>
        <I53_PAV>                                                           </I53_PAV>
        <I53_DOK_NR>RIV07               </I53_DOK_NR>
        <I53_DATA>2025-11-06T00:00:00</I53_DATA>
        <I53_KODAS_KS>1234567   </I53_KODAS_KS>
        <I53_KODAS_SS>7           </I53_KODAS_SS>
        <I53_KODAS_VL>EUR         </I53_KODAS_VL>
        <I53_SUMA>100.00</I53_SUMA>
        <I53_MOKETOJAS>1</I53_MOKETOJAS>
        <I53_KODAS_SS_S>           </I53_KODAS_SS_S>
        <I53_PASTABOS> </I53_PASTABOS>
        <I53_KODAS_WS>           </I53_KODAS_WS>
        <I53_KODAS_CH>           </I53_KODAS_CH>
        <I53_SUMA2>0.00</I53_SUMA2>
        <I53_PERKELTA>1</I53_PERKELTA>
        <I53_USERIS>1234567     </I53_USERIS>
        <I53_R_DATE>2025-11-06T16:25:32</I53_R_DATE>
        <I53_ADDUSR>1234567     </I53_ADDUSR>
        <I53_ADD_DATE>2025-11-06T16:25:32</I53_ADD_DATE>
        <I53_DOK_NR_MOK>                   </I53_DOK_NR_MOK>
        <I53_KODAS_IS>           </I53_KODAS_IS>
        <I53_KODAS_OS>           </I53_KODAS_OS>
        <I53_KODAS_OS_C>           </I53_KODAS_OS_C>
        <I53_KODAS_MS>           </I53_KODAS_MS>
        <I53_S_KODAS>                                            </I53_S_KODAS>
        <I53_ID>                                       </I53_ID>
        <I53_DOK_TIPAS>2</I53_DOK_TIPAS>
        <I53_SUMA_VL>100.00</I53_SUMA_VL>
        <I53_KURSAS>1.000000000000000</I53_KURSAS>
        <I53_KODAS_KT>           </I53_KODAS_KT>
        <I53_KODAS_K0>           </I53_KODAS_K0>
        <I53_BUSENA>1</I53_BUSENA>
        <I53_KODAS_SM>           </I53_KODAS_SM>
        <I53_SUMA_AP>0.00</I53_SUMA_AP>
        <K62_SO>
            <K62>
                <K62_KODAS_SO>000R00000037</K62_KODAS_SO>
                <K62_PAV>CREATE1</K62_PAV>
                <K62_MODUL>OI</K62_MODUL>
                <K62_KODAS_OP>000R00000367</K62_KODAS_OP>
                <K62_KODAS_KS_1>1234567   </K62_KODAS_KS_1>
                <K62_DOK_NR_1>RIV07               </K62_DOK_NR_1>
                <K62_KODAS_KS_2>1234567   </K62_KODAS_KS_2>
                <K62_DOK_NR_2>CREATE1             </K62_DOK_NR_2>
                <K62_KODAS_VL>USD         </K62_KODAS_VL>
                <K62_SUMA>429.33</K62_SUMA>
                <K62_SUMA_VL>500.00</K62_SUMA_VL>
                <K62_KURSAS>0.858663918942126</K62_KURSAS>
                <K62_PRIORITETAS>1.000</K62_PRIORITETAS>
                <K62_PERKELTA>1</K62_PERKELTA>
                <K62_POZ_DEL>0</K62_POZ_DEL>
                <K62_ADDUSR>1234567     </K62_ADDUSR>
                <K62_ADD_DATE>2025-11-06T16:25:32</K62_ADD_DATE>
                <K62_USERIS>1234567     </K62_USERIS>
                <K62_R_DATE>2025-11-06T16:25:32</K62_R_DATE>
            </K62>
            ...
        </K62_SO>
    </I53>
</RET_DOK>
Response (status 207)

207 statusas gaunamas, kai procedūros yra vykdamos perduodant parametrą errorAction su reikšme EXIT arba CONTINUE ir gaunama klaida kažkurioje iš procedūrų, pvz.:

<RET_DOK>
    <i53>
        <I53_KODAS_OI>000R00000368</I53_KODAS_OI>
        <I53_OP_RUSIS>1</I53_OP_RUSIS>
        <I53_PAV>                                                           </I53_PAV>
        <I53_DOK_NR>RIV07               </I53_DOK_NR>
        <I53_DATA>2025-11-06T00:00:00</I53_DATA>
        ...
        <k62_so>
            <K62>
                <K62_KODAS_SO>000R00000039</K62_KODAS_SO>
                <K62_PAV>CREATE1</K62_PAV>
                <K62_MODUL>OI</K62_MODUL>
                ...
            </K62>
        </k62_so>
    </i53>
    <errors>
        <error>
            <data>...</data>
            <dataErrors>
                <dataError>
                    <tag>KODAS_VL</tag>
                    <code>2046</code>
                    <message>Nerastas valiutos kodas</message>
                </dataError>
            </dataErrors>
        </error>
    </errors>
</RET_DOK>
Response (status 400)

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

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id>9357776210.1c62e1bb.1723638333091</id>
    <durationMs>1141</durationMs>
    <errorMessage>Nepavyko įvykdyti metodo</errorMessage>
    <document/>
    <errors>
        <error>
            <data>...</data>
            <dataErrors>
                <dataError>
                    <tag>KODAS_VL</tag>
                    <code>2046</code>
                    <message>Nerastas valiutos kodas</message>
                </dataError>
            </dataErrors>
        </error>
    </errors>
</RET_DOK>

PHP pvz

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'ApiKey: 1234567.7654321',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
$response = curl_exec($ch);
curl_close($ch);

Lentelės

I53

Nuoroda į lentelės aprašymą: I53

K62

Nuoroda į lentelės aprašymą: K62