GET päring (Aruanded): erinevus redaktsioonide vahel

Allikas: Excellent || Opendoc
Mine navigeerimisribale Mine otsikasti
Resümee puudub
(MainRn report added with its parameters)
10. rida: 10. rida:
*reportName is the internal Books report name
*reportName is the internal Books report name
Optional parameters (default value will be selected by Books if missing):
Optional parameters (default value will be selected by Books if missing):
*periodStart in format dd.mm.yyyy
* (supported optional parameters vary between different reports)
*periodEnd in format dd.mm.yyyy
''Example'':<syntaxhighlight>
''Example'':<syntaxhighlight>
http://testuser:testpassword@localhost:8989/WebGETAPI.hal?company=1&report=MainRn
http://testuser:testpassword@localhost:8989/WebGETAPI.hal?company=1&report=MainRn&periodStart=01.01.2018&periodEnd=31.01.2018
</syntaxhighlight>
</syntaxhighlight>
====Report "Kannete arv perioodis"====
 
==== Report "Pearaamat" ====
Report name = ''MainRn''
 
Supported optional parameters
{| class="wikitable"
!Parameter
!Books def. window field
!Format
!Comment
|-
|periodStart
|Periood
|dd.mm.yyyy
|
|-
|periodEnd
|Periood
|dd.mm.yyyy
|
|-
|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
|}
 
====<s>Report "Kannete arv perioodis"</s> (seda ei ole)====
Report name = ''TransNumberRn''
Report name = ''TransNumberRn''


Redaktsioon: 8. august 2018, kell 08:21

Hausing - Pealeht

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

Parameter Books def. window field Format Comment
periodStart Periood dd.mm.yyyy
periodEnd Periood dd.mm.yyyy
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 "Kannete arv perioodis" (seda ei ole)

Report name = TransNumberRn

Available parameters:

  • compNumber -  the sequence number of the company in Hansa DB starting from 1
  • periodStart – Perioodi algus (format dd.mm.yyyy)
  • periodEnd- Perioodi lõpp format (dd.mm.yyyy)
  • allComp
    • Value “0” or not presented returns only company specified in parameter compNumber.
    • Value “1” returns all companies
  • byEmpl
    • Value “0” or not presented returns numbers for all employees.
    • Value “1” returns numbers by employee.
  • byTRDate
    • Value “0” or not presented returns numbers based on date of registration.
    • Value “1” returns numbers by Transaction date.
    • If invoice is inserted on 15.04.2018 and invoice date is 28.02.2018, then “0” tracks it in april, “1” in february.

Sample query for UKU:

https://api:api@s001.excellent.ee:6443/WebGETAPI.hal?company=1&report=TransNumberRn&periodStart=01.03.2018&periodEnd=31.03.2018&allComp=1&byEmpl=0

Response body format

*In HTML format*

Pärit leheküljelt "https://kaust.excellent.ee/opendoc/index.php?title=GET_päring_(Aruanded)&oldid=341"