Andmeladu
ERPLY Books andmeladu saab kasutada API kadu. See võimaldab sünkroniseerida andmed oma andmelattu kahel erineval viisil:
- Aruandegeneraator
- Küsida pearaamatu API kaudu
Antud juhendis kirjeldame, kuidas andmeladu pearaamatu API-ga kasutada. Aruandegeneraatori API-st ligipääsemiseks vaata juhendit siit.
Pearaamatu API üldinfo
Andmelao päring on järgmine:
Näidis URL: https://api.erplybooks.com/api/account_entries/v2
Request Method: GET
Parameetrid:
| accountId | String | Konto id-d. Mitme lisamiseks eralda id-d vertikaalse kriipsuga | |
| customerId | String | Kliendi/Hankija id-d. Mitme lisamiseks eralda id-d vertikaalse kriipsuga | |
| dateFrom | String | yyyy-MM-dd |
| dateTo | String | yyyy-MM-dd |
| projectId | String | Dimensiooni id-d. Mitme lisamiseks eralda id-d vertikaalse kriipsuga | |
| taxRateId | long | Käibemaksu id |
| typeCode | String | Kande tüüp |
| idMoreThan | long | Anna kõik uued kanded alates sellest väärtusest |
| deletedIdMoreThan | long | Anna kõik kustutatud kanded alates sellest väärtusest |
| changedSince | long | Millisekundid alates millest näita muudatusi |
| getProjectGroupMap | boolean | Kui see on true, siis näitab projektigruppe eraldi key-value paaridena |
Struktuur:
| long | id | kanderea id | |
| long | accountId | kanderea konto id | |
| long | transactionEntryId | näitab millises kandes see kande rida on | |
| String | accountNumber | konto number | |
| String | description | kanderea kirjeldus | |
| Date | opDate | kanderea kuupäev | yyyy-MM-dd |
| Decimal | initialBalance | algsaldo | |
| Decimal | debitSum | deebit summa | |
| Decimal | creditSum | kreedit summa | |
| Decimal | closingBalance | lõppsaldo | |
| String | typeCode | kande tüüp | Kui tahad täpsemalt näha, kus nad on defineeritud, siis saab seda eraldi vaadata API dictionary all siin |
| String | code | kande kood | |
| List <Long> | projects | projekt | Kuvab kõikide dimensioonide id-sid. Vaata projects päringut, kui soovid leida vasted: https://api.erplybooks.com/api/projects |
| long | projectId | projekti id | Esimene dimensioon. Kui on mitu, siis seda välja tuleks eirata |
| String | transactionDescription | kande kirjeldus | |
| String | projectName | projekti nimi | |
| String | contactName | kontakti nimi | |
| String | documentNumber | dokumendi number | |
| long | documentId | dokumendi id | |
| long | contactId | kontakti id | |
| long | paymentId | maksmise id | |
| long | taxRateId | km liigi id | |
| List<Key-Value> | projectGroups | projektigrupp | List<Map.Entry<String, String>> – key-value paarid projektigruppidest, kus key=projektigrupp ja value=projekti nimi NB! Seda näidatakse ainult siis, kui on kaasas päringu parameeter: getProjectGroupMap=true |
| long | deletedAccountEntryId | kustutatud kande id | Kustutatud pearaamatu kandeid saab kätte, kui teha eraldi päring eraldi andmebaasi |
Pearaamatu API-t saab kasutada kolme erinevat moodi:
- dateFrom-dateTo: Küsi andmed kuupäevavahemikuga (kõige vähem soovitavam, sest sisaldab juba korra saadetud andmeid)
- changedSince: Küsi andmeid alates viimasest muutmise hetkest (ei sobi ülisuurtele andmemassidele andmebaasi optimeerimise mõttes)
- idMoreThan: Küsi lisatud ja kustutatud andmed alates viimati sünkroniseeritud vahemikust
NB! Andmete sünkroonis hoidmisel tuleb arvestada, et Books’is on võimalik andmeid kustutada, kui see spetsiaalselt kasutajapõhiselt ära ei keelata. Lisaks kande muutmine koos optimeerimispluginatega töötab selliselt, et kande rea muutmisel kustutatakse vana kanne ja lisatakse uus.
idMoreThan ehk anna kõik konkreetsed muudatused
Kuna andmete sünkroonis hoidmiseks on vaja sünkroniseerida uued ja kustutatud, siis tuleb teha kaks päringut:
- Lisa parameeter idMoreThan ja väärtuseks maksimaalne kande id, mis siiani andmelattu sünkroniseeritud ja süsteem tagastab kõik uued tehingud, mis on tehtud peale toda tehingut. Vt struktuurist id
- Lisa parameeter deletedIdMoreThan ja väärtuseks maksimaalne kustutatud kande id, mis siiani andmelattu sünkroniseeritud ja süsteem tagastab kõik uued kustutatud tehingud. Vt struktuurist deletedAccountEntryId
NB! Töötab ainult koos optimeerimispluginatega.
dateFrom-dateTo ehk kuupäevavahemikuga päring
Kõige vähem soovitam lahendus, kus küsitakse andmed pidevalt vahemikus X kuni täna. Üldiselt X hoitakse lukustamiskuupäevana.
changedSince ehk muutmishetkepõhine päring
Määra changedSince=viimanemillisekundkuhumaanisünkroniseeritud. Süsteem tagastab tollest hetkest toimunud muudatused. Seejuures kustutatud kanded on -1ga läbi korrutatud.
NB! Töötab ainult koos optimeerimispluginatega ning süsteem toimib vaid siis kui eraldi kasutajatoega see aktiveerida. Lisainfo support@erplybooks.com.