GET päring (Aruanded): erinevus redaktsioonide vahel
Konstantin (arutelu | kaastöö) Resümee puudub |
Konstantin (arutelu | kaastöö) (ResRn aruande tabel lisatud) |
||
307. rida: | 307. rida: | ||
|- | |- | ||
|SimVerf | |SimVerf | ||
|Kaasaarvatud | |Kaasaarvatud simulatsioonid | ||
|integer 0 or 1 | |integer 0 or 1 | ||
|Checkbox | |Checkbox | ||
323. rida: | 323. rida: | ||
|showZeroes | |showZeroes | ||
|Näita nulle tühjade ridade asemel | |Näita nulle tühjade ridade asemel | ||
|integer 0 or 1 | |||
|Checkbox | |||
|} | |||
==== Report "Kasumiaruanne" ==== | |||
Report name = Res''Rn'' | |||
Supported optional parameters | |||
{| class="wikitable" | |||
!Parameter | |||
!Books def. window field | |||
!Format | |||
!Comment | |||
|- | |||
|periodStart | |||
|Periood | |||
|dd.mm.yyyy | |||
|filled by default period if empty | |||
|- | |||
|periodEnd | |||
|Periood | |||
|dd.mm.yyyy | |||
|filled by default period if empty | |||
|- | |||
|Stext | |||
|Eelarveperiood | |||
|string, but contains period in format | |||
dd.mm.yyyy:dd.mm.yyyy | |||
|filled by default period if empty | |||
|- | |||
|ObjStr | |||
|Objekt | |||
|string | |||
|must exist in Books | |||
|- | |||
|ObjType | |||
|Objektitüüp | |||
|string | |||
|must exist in Books | |||
|- | |||
|inclUnspec | |||
|Kaasaarvatud määramata | |||
|integer 0 or 1 | |||
|Checkbox | |||
|- | |||
|CurncyCode | |||
|Valuuta | |||
|string | |||
|must exist in Books | |||
|- | |||
|Language | |||
|Keel | |||
|string | |||
|must exist in Books | |||
|- | |||
|exclObj | |||
|V.a. objekt | |||
|string | |||
|must exist in Books | |||
|- | |||
|AccSpec | |||
|Kontod | |||
|integer | |||
0 = Kõik 1 = Ainult kasutatud 2 = Ainult grupid | |||
3 = Ainult kas. grupid 4 = Ainult saldoga | |||
|Radio buttons | |||
|- | |||
|Notation | |||
|Ümardamine | |||
|integer | |||
0 = Täpne 1 = Tuhandetes 2 = Miljonites | |||
3 = % käibest 4 = Peenrahata | |||
|Radio buttons | |||
|- | |||
|showComparison | |||
|Näita võrdlust | |||
|integer | |||
0 = Väärtustega 1 = % 2 = *not supported* | |||
3 = Ära näita | |||
|Radio buttons | |||
|- | |||
|Comparison | |||
|Võrdlus | |||
|integer | |||
0 = Akumuleeritud 1 = Eelmine aasta 2 = Eelarve | |||
3 = Eelarveparandus 4 = Eelmine tulemus | |||
|Radio buttons | |||
|- | |||
|budgetClass | |||
|" " | |||
|string | |||
|must exist in Books | |||
|- | |||
|basecurncy | |||
|Väärtused | |||
|integer | |||
0 = Baasvaluutas 1 1 = Baasvaluutas 2 | |||
|Radio buttons | |||
|- | |||
|SimVerf | |||
|K.a. simulatsioonid | |||
|integer 0 or 1 | |||
|Checkbox | |||
|- | |||
|listTransNo | |||
|Näita kande numbreid | |||
|integer 0 or 1 | |||
|Checkbox | |||
|- | |||
|noHeader | |||
|Päiseta | |||
|integer 0 or 1 | |integer 0 or 1 | ||
|Checkbox | |Checkbox |
Viimane redaktsioon: 23. august 2018, kell 12:01
GET (for reports)
Request
With authorization
http://username:password@ipAddress:portNumber/WebGETAPI.hal?company=compNumber&report=reportName
Required parameters:
- compNumber is the sequence number of the company in Hansa DB starting from 1
- reportName is the internal Books report name
Optional parameters (default value will be selected by Books if missing):
- (supported optional parameters vary between different reports)
Example:
http://testuser:testpassword@localhost:8989/WebGETAPI.hal?company=1&report=MainRn&periodStart=01.01.2018&periodEnd=31.01.2018
Report "Pearaamat"
Report name = MainRn
Supported optional parameters (please select required and we will remove the rest - Kostya)
Parameter | Books def. window field | Format | Comment |
---|---|---|---|
periodStart | Periood | dd.mm.yyyy | filled by default period if empty |
periodEnd | Periood | dd.mm.yyyy | filled by default period if empty |
account | Konto/objekt 1 | string | * must exist in Books |
tagObject | Objekt | string | must exist in Books |
objType | Objektitüüp | string | must exist in Books |
unspec | Kaasaarvatud määramata | integer 0 or 1 | Checkbox |
withText | Ainult tekstiga | string | |
VATCode | KM-kood | string | must exist in Books |
lang | Keel | string | must exist in Books |
curncy | Valuuta | string | must exist in Books |
reconCode | Võrdl. kood | string | must exist in Books |
exclCode | V.a. koodiga | integer 0 or 1 | |
ref | Viide | string | must exist in Books |
exclObj | V.a. objekt | string | must exist in Books |
usedOnly | Ainult kasutatud kontod | integer 0 or 1 | Checkbox |
showRef | Näita viiteid | integer 0 or 1 | Checkbox |
sorting | Sorteerimine | integer
0 = Kuupäev ja tüüp, 1 = Sisestamise järjek. |
Radio buttons |
withCorr | Koos paran_dustega | integer 0 or 1 | Checkbox |
subTotVAT | KM-koodide vahesummad | integer 0 or 1 | Checkbox |
subTotVATperAcc | KM-k vahes. kontode lõikes | integer 0 or 1 | Checkbox |
listTransNo | Perioodi kanded | integer 0 or 1 | Checkbox |
noTransPrefix | Kanded ilma koodideta | integer 0 or 1 | Checkbox |
showCurncy | Näita valuutasid | integer 0 or 1 | Checkbox |
corrAcc | Korrespondeeruvad kontod | integer 0 or 1 | Checkbox |
B2diffOnly | Näita ainult baasvaluuta 2 vahesid | integer 0 or 1 | Checkbox |
balOnly | Ainult saldod | integer 0 or 1 | Checkbox |
showObj | Näita objekti | integer 0 or 1 | Checkbox |
notRecon | Võrdlemata | integer 0 or 1 | Checkbox |
recon | Võrreldud | integer 0 or 1 | Checkbox |
longLines | Pikad tekstid | integer
0 = Pika reana 1 = Lühendatud ridadena 2 = Lühendatud reana |
Radio buttons |
select | Vali | integer
0 = Näita kõiki kandeid, 1 = Näita dok.nr-ta kandeid, 2 = Näita dok.nr-ga kandeid |
Radio buttons |
loop2 | Konto/objekt (obj.tüüp) | string | must exist in Books |
accountBtn | Kontod | 0 if "account" is used, 1 if "loop2" is used, 2 if "loop3" is used | Radio buttons |
loop3 | Konto/objekt (obj.tüüp) | string | must exist in Books |
inclSim | Kaasaarvatud simulatsioonid | integer
0 = Ilma, 1 = Kõik, 2 = Aastalõpu 1, 3 = "Aastalõpu 1 ja 2 |
Radio buttons |
showZeroes | Näita nulle | integer 0 or 1 | Checkbox |
baseCrncy | Väärtused | integer
0 = Baasvaluutas 1, 1 = "Baasvaluutas 2 |
Radio buttons |
Report "Bilanss"
Report name = BalRn
Supported optional parameters
Parameter | Books def. window field | Format | Comment |
---|---|---|---|
periodStart | Periood | dd.mm.yyyy | filled by default period if empty |
periodEnd | Periood | dd.mm.yyyy | filled by default period if empty |
ObjStr | Objekt | string | must exist in Books |
ObjType | Objektitüüp | string | must exist in Books |
inclUnspec | Kaasa arvatud määramata | integer 0 or 1 | Checkbox |
CurncyCode | Valuuta | string | must exist in Books |
Language | Keel | string | must exist in Books |
header | Päis | string | custom header name for report |
AccSpec | Kontod | integer
0 = Kõik 1 = Ainult _saldoga 2 = Ainult grupid 3 = Ainult kasut. grupid 4 = Ainult kasutatud |
Radio buttons |
Notation | Ümardamine | integer
0 = Täpne 1 = Tuhandetes 2 = Miljonites 3 = *not supported* 4 = Komakohtadeta |
Radio buttons |
compareInPerc | Võrdlus %-des | integer 0 or 1 | Checkbox |
Comparison | Võrdlus | integer
0 = Neto muutus 1 = *not supported* 2 = Eelarve 3 = *not supported* 4 = Eelmine _aasta 5 = Võrdluseta |
Radio buttons |
budgetClass | Klass | string | must exist in Books |
basecurncy | Väärtused | integer
0 = Baasvaluutas 1 1 = Baasvaluutas 2 |
Radio buttons |
SimVerf | Kaasaarvatud simulatsioonid | integer 0 or 1 | Checkbox |
listTransNo | Näita kandenumbreid | integer 0 or 1 | Checkbox |
noHeader | Päiseta | integer 0 or 1 | Checkbox |
showZeroes | Näita nulle tühjade ridade asemel | integer 0 or 1 | Checkbox |
Report "Kasumiaruanne"
Report name = ResRn
Supported optional parameters
Parameter | Books def. window field | Format | Comment |
---|---|---|---|
periodStart | Periood | dd.mm.yyyy | filled by default period if empty |
periodEnd | Periood | dd.mm.yyyy | filled by default period if empty |
Stext | Eelarveperiood | string, but contains period in format
dd.mm.yyyy:dd.mm.yyyy |
filled by default period if empty |
ObjStr | Objekt | string | must exist in Books |
ObjType | Objektitüüp | string | must exist in Books |
inclUnspec | Kaasaarvatud määramata | integer 0 or 1 | Checkbox |
CurncyCode | Valuuta | string | must exist in Books |
Language | Keel | string | must exist in Books |
exclObj | V.a. objekt | string | must exist in Books |
AccSpec | Kontod | integer
0 = Kõik 1 = Ainult kasutatud 2 = Ainult grupid 3 = Ainult kas. grupid 4 = Ainult saldoga |
Radio buttons |
Notation | Ümardamine | integer
0 = Täpne 1 = Tuhandetes 2 = Miljonites 3 = % käibest 4 = Peenrahata |
Radio buttons |
showComparison | Näita võrdlust | integer
0 = Väärtustega 1 = % 2 = *not supported* 3 = Ära näita |
Radio buttons |
Comparison | Võrdlus | integer
0 = Akumuleeritud 1 = Eelmine aasta 2 = Eelarve 3 = Eelarveparandus 4 = Eelmine tulemus |
Radio buttons |
budgetClass | " " | string | must exist in Books |
basecurncy | Väärtused | integer
0 = Baasvaluutas 1 1 = Baasvaluutas 2 |
Radio buttons |
SimVerf | K.a. simulatsioonid | integer 0 or 1 | Checkbox |
listTransNo | Näita kande numbreid | integer 0 or 1 | Checkbox |
noHeader | Päiseta | integer 0 or 1 | Checkbox |
Response body format
*In HTML format*