Elnevezési szótár

Egy dokumentum egy könyvelési tétele. A QUiCK Publikus API-ban ez az assignment: egy összeget köt egy költség- vagy bevételtípushoz, egy ÁFA kategóriához, és haladó könyvelés esetén egy könyvelési számhoz is.

A cégadat-válaszban lévő jelző, ami mutatja, hogy a könyvelési azonosítók használatban vannak-e.

Egy dokumentumhoz csatolt könyvelési megjegyzés. Csak akkor van hatása, ha a haladó könyvelés be van kapcsolva.

A folyamatos szolgáltatás könyvelési (teljesítési) időszakának utolsó napja.

A folyamatos szolgáltatás könyvelési (teljesítési) időszakának első napja, ISO 8601 formátumban.

A dokumentum könyvelési feldolgozási állapota. Ezt a mezőt érdemes a saját rendszerben is tükrözni inkrementális szinkronizáláskor.

A GET /2/company-info/ válaszban lévő jelző, ami mutatja, hogy a cégnél be van-e kapcsolva a haladó könyvelés. Csak ekkor érvényesülnek a tételeken a könyvelési szám és a részletes ÁFA mezők.

A bér- és adótételek összege. Eltér a dokumentumok pénzügyi mezőitől (nettó / ÁFA / bruttó).

Jelzi, hogy a számla jóvá lett-e hagyva. Tömegesen állítható be a /1/expenses/approve/ és /1/expenses/unapprove/ végpontokkal.

A végpont, ami az adóhatósági és auditálási célú XML exportot állítja elő.

A minden híváson kötelező fejléc, Token előtaggal. Egy token pontosan egy céghez tartozik. Hiányzó vagy érvénytelen token esetén a válasz 401; jogosultság hiányában 403.

A partner vagy a pénztár bankszámlaszáma. Dokumentumokon denormalizáltan is megjelenik partner_account_number néven.

A feltöltött dokumentum fájltartalma, Base64 kódolással. Egy hívás legfeljebb 5 elemet fogad el.

Egy tömeges művelet elemenkénti hibaüzenetei. Létrehozás esetén a hibaobjektum id mezője a beküldött tömbön belüli, nulláról induló pozíció -- nem rekordazonosító.

Egy pénztár vagy bankszámla -- az API paid-through-nak hívja. Aktuális egyenlege a pulse összesítőben is megjelenik.

Egy ÁFA kategória iránya: cost -- kiadás (bejövő számla), revenue -- bevétel (kimenő számla).

A cégspecifikus ÁFA kategória azonosítója egy tételen. A név, kód, százalék és ÁFA terület automatikusan kitöltődik a törzsadatból.

Opcionális fejléc, ami explicit módon kiválasztja a célcéget. Ha kihagyod, a cég a tokenből következik -- ez a szokásos eset. Ha az érték nem a token cégével egyezik, a válasz 403.

A saját céged adószáma a cégadat-válaszban. Ne keverd össze a partner tax_number mezőjével.

Egy korábbi számla részleges módosítása -- például hibás mennyiség vagy összeg javítása. A dokumentum típusát az invoice_class jelzi; a helyesbítő számla értéke 4.

Az időpont, amikor a dokumentum bekerült a rendszerbe. Inkrementális szinkronizáláshoz erre a mezőre érdemes szűrni, a date_field=created és a from_date kombinálásával.

Szabad szöveges forrásjelölő, amit a POST /2/expenses/create/ kérésben adhatsz meg. Alapértelmezetten public_api; egyedi címkével azonosíthatod a saját integrációdat.

A dokumentum pénznemének azonosítója (egy egész szám, nem ISO kód). Ha eltér a cég alapértelmezett pénznemétől, egy árfolyam is csatolva van.

Egy pénztár vagy bankszámla aktuális egyenlege, tizedestört stringként. A pulse összesítő adja vissza.

Jelzi, hogy a partner vevőként szerepel-e. Egy partner egyszerre lehet vevő és szállító is.

Kiválasztja, hogy az időszakszűrő melyik dátummezőre vonatkozzon -- például created, fulfilled_at vagy due_at. Inkrementális szinkronizáláshoz nélkülözhetetlen.

A cég alapértelmezett pénzneme. Egy ettől eltérő pénznemű dokumentumon árfolyam is szerepel.

A dokumentumon tárolt partneradatok (partner_name, partner_tax_number, partner_city, partner_zip_code, partner_address, partner_country, partner_account_number). Listázáskor emiatt nincs szükség külön partnerlekérdezésre.

Egy feltöltött fájl (PDF vagy kép), ami egy számlához vagy bevételhez csatolható. Kezelése: GET /1/documents/, csatolás a /1/documents/attach/, leválasztás a /1/documents/detach/ végponttal.

A számlához vagy bevételhez tartozó kép- vagy PDF-melléklet. Meglétét a has_artifact jelzi; a /1/artifacts/expense/ és /1/artifacts/income/ végpontokról olvasható.

A céghez tartozó e-mail cím; az ide küldött fájlok dokumentumként kerülnek be a rendszerbe.

A dokumentum típusa egész szám kódként: 0 -- számla, 1 -- sztornó számla, 2 -- előleg számla, 3 -- végszámla, 4 -- helyesbítő számla.

A dokumentumok típusbesorolása (szerződés, bankkivonat, ...). Törzsadata a /2/document-types/ végpontról olvasható, és a dokumentumlista szűrésére is használható.

Az EU-n belüli kereskedelemhez használt közösségi adószám, országelőtaggal (például HU12345678). A dokumentum ÁFA területét a vat_area mező jelzi: HU, EU vagy 3RD.

Minden hibaválasz ezt az egyetlen szöveges mezőt adja vissza. Nincs hibakód és mezőnkénti hibalista -- a HTTP státuszkód alapján ágazz el a kódodban.

A pénznem eltérése esetén alkalmazott átváltási árfolyam, tizedestört stringként.

A konverzióhoz használt árfolyam dátuma (ISO 8601, ÉÉÉÉ-HH-NN formátumban).

A dokumentum szándékosan ki van zárva a könyvelésből (például téves feltöltés vagy nem elszámolható tétel esetén).

Egy külső szállítótól kapott, könyvelésre váró számla. A QUiCK Publikus API-ban ez az expense erőforrás: a dokumentum feltöltésével jön létre, amit követően a rendszer kinyeri az adatait.

A céghez tartozó e-mail cím: az ide küldött bejövő számlák automatikusan kiadásként jelennek meg. Alternatíva az API-n keresztüli feltöltéshez.

A tételen szereplő költségkategória (költséghely). Katalógusa a /2/expense-types/ végponton kezelhető, és szinkronizálható egy külső ERP-vel.

Jelzi, hogy a tétel már szerepel-e egy könyvelési exportban. A /1/expenses/export/ végponttal állítható be.

Egy külső rendszerből származó azonosító tárolására szolgáló mező -- ezzel köthető össze egy QUiCK rekord a saját rendszered egy rekordjával.

Azok az azonosítók, amelyeket a tömeges művelet nem tudott feldolgozni. A részletes ok az errors tömbben található.

A tömeges művelet során hibára futott elemek száma.

Korlátozza, mely mezőket adja vissza a válasz. Nagy listáknál csökkenti az átvitt adatmennyiséget.

A feltöltött dokumentum fájlneve; kötelező mező a Base64 tartalom mellett.

Az időpont, amikor a dokumentum iktatásra került. Az iktatószámmal együtt a dokumentumkezeléshez tartozik.

A rendszer által kiosztott iktatószám, ami a dokumentumot azonosítja a dokumentumkezelésben.

A dátum, amikor a gazdasági esemény ténylegesen megtörtént, ami meghatározza az ÁFA fizetési kötelezettség keletkezését. Az API-ban ez a fulfilled_at mező; szűrésre is használható a date_field=fulfilled_at értékkel.

Az ÁFÁ-val növelt összeg, a dokumentum pénznemében. Az API tizedestört stringként adja vissza, a nettó és ÁFA összeg mellett.

Jelzi, hogy tartozik-e kép- vagy PDF-melléklet a tételhez. Enélkül a könyvelési feldolgozás jellemzően nem zárható le.

Minden erőforrás egyedi, egész szám azonosítója. Nincs típus-előtag, és a különböző erőforrástípusok azonosítói egymástól függetlenek.

A tömeges műveletek bemenete: az érintett rekordok azonosítói (például jóváhagyás, törlés, export esetén).

A vállalkozás által kiállított kimenő számla. A QUiCK Publikus API-ban ez az income erőforrás, ami a listázó és frissítő végpontokon keresztül érhető el.

Hiányos adatú dokumentumot jelöl -- jellemzően a felismerés nem tudott minden mezőt kitölteni, és emberi kiegészítés szükséges.

Jelzi, hogyan került a dokumentum a rendszerbe: upload -- fájlfeltöltés, public_api -- publikus API, email -- e-mailes beérkeztetés, quick_browser_addon -- böngésző-kiegészítő.

A dokumentumon szereplő számlakiállítási dátum (ISO 8601). Ne keverd össze a teljesítési dátummal és a fizetési határidővel.

A kibocsátó által a dokumentumra nyomtatott számlaszám. Listák szűrésére is használható.

A bér- és adótételek megnevezése. Bértételeknél gyakran egy dátum, ami a könyvelési időszakot jelöli.

A tétel könyvelési számának (főkönyvi számának) azonosítója. A név és a kód automatikusan kitöltődik a törzsadatból. Csak akkor van hatása, ha a haladó könyvelés be van kapcsolva.

Havi bérösszesítő. A GET /1/monthly-salaries/ vagy GET /2/monthly-salaries/ végponttal olvasható.

Az adóbevallásokhoz használt havi adóösszesítő. A GET /1/monthly-taxes/ vagy GET /2/monthly-taxes/ végponttal olvasható.

Egy könyvelői ellenőrzést igénylő tételt jelöl. Csak akkor releváns, ha a haladó könyvelés be van kapcsolva.

Az ÁFA nélküli összeg, a dokumentum pénznemében. Az API tizedestört stringként adja vissza, hogy elkerülje a lebegőpontos kerekítési hibákat.

A következő oldal teljes URL-je, vagy null, ha nincs több elem. A bejárásához a legmegbízhatóbb módszer ennek követése.

Egy mező szerint rendezi a találatokat; a - előtag csökkenő sorrendet jelent (például -created).

A kért oldal sorszáma a lapozott listákban (1-től indul). A QUiCK oldalszám-alapú lapozást használ, nem kurzoralapút.

Az oldalanként visszaadott elemek száma. A nagyobb érték kevesebb kérést, de lassabb választ jelent; általában 50-200 az optimális.

A /2/ végpontok lapozásának opak mutatója, amit a válasz next / previous linkje tartalmaz. Változtatás nélkül kell követni: az értéke nem képezhető és nem fejthető vissza, a belső szerkezetére építeni nem szabad.

A vállalkozás egy vevője vagy szállítója. Egy partner egyszerre lehet mindkettő -- ezt az is_customer és is_vendor mező jelzi. A partnerrekordok adószám alapján (tax_number) egyeztethetők.

A partner törzsrekordjának azonosítója. Dokumentum küldésekor elsőbbséget élvez a beágyazott partneradatokkal szemben.

Egy pénzügyi tranzakció, ami mindig egy pénztárhoz vagy bankszámlához tartozik, és a tranzakcióin keresztül dokumentumokhoz köthető.

A nap, ameddig a számlát ki kell egyenlíteni. Az API-ban ez a due_at mező; a fizetési állapotot külön a paid_status követi (1 -- kifizetetlen, 2 -- kifizetett, 3 -- részletfizetés).

A dokumentum kiegyenlítésének módja: transfer -- átutalás, cash -- készpénz, card -- bankkártya, cod -- utánvét.

A pénztár vagy bankszámla azonosítója, amin keresztül a dokumentum kiegyenlítése történt.

A dokumentum kiegyenlítési állapota egész szám kódként: 1 -- kifizetetlen, 2 -- kifizetett, 3 -- részletfizetés.

Az időszakszűrő záró dátuma, a date_field által kiválasztott dátummezőre alkalmazva.

Az időszakszűrő kezdő dátuma. A date_field dönti el, melyik dátummezőre vonatkozik. Szinkronizáláskor érdemes kis átfedést használni, hogy a határeseti tételek ne maradjanak ki.

A nap, amikorra a kiegyenlítés tervezve van -- a likviditástervezés alapja. Eltérhet a jogilag kötelező fizetési határidőtől.

Az előző oldal teljes URL-je egy lapozott válaszban, vagy null, ha az első oldalon vagy.

Jelzi, hogy a dokumentum feldolgozása befejeződött-e. Listaszűrőként is használható.

A POST /2/expenses/create/ válaszában a feldolgozásra elfogadott számlák azonosítói.

Egy könnyűsúlyú összesítő végpont, ami a cég pénztárainak és bankszámláinak egyenlegét adja vissza. Ideális első hívás a token és a kapcsolat ellenőrzésére.

A lapozott válasz adatait tartalmazó mező, a next / previous mezőkkel együtt alkotva a lapozási borítékot. /1/ végpontokon tömb, és count is tartozik hozzá; /2/ végpontokon szintén tömb, de count nélkül (cursor-lapozás). Egyetlen kivétel a GET /2/expenses/, ahol a results egy objektum: a számlák az expenses kulcs alatt, mellettük a feloldásukhoz szükséges törzsadat-listák.

A tételen szereplő bevételi kategória (költséghely). Katalógusa a /2/revenue-types/ végponton kezelhető.

A bevétel frissítésekor jelzi, hogy át lett-e nézve. Haladó könyvelés bekapcsolása mellett alkalmazandó.

Egy bértétel a cég béralapú könyvelésében. A /1/salaries/create/, /1/salaries/update/ és /1/salaries/delete/ végpontokkal (és a v2 megfelelőikkel) kezelhető.

Szabad szöveges keresés a listákon. A search_fields paraméter szűkíti, mely mezőkben keres.

Külső, a hívó rendszerből származó azonosító, amit a QUiCK eltárol és visszaad a dokumentumon. Kereszthivatkozásra szolgál egy külső ERP-vel vagy más rendszerrel.

Az időpont, amikor egy felhasználó először megnyitotta a dokumentumot. Hasznos az új, még át nem nézett tételek kiszűréséhez.

Csak szöveges címke-azonosítók listája a dokumentumon. Küldéskor a lista felülírja a meglévő halmazt.

Egy korábbi számla teljes érvénytelenítése. A dokumentum típusát az invoice_class mező jelzi; a sztornó számla értéke 1.

Egy tömeges művelet sikeres elemeinek száma. Párja a failure_count; részleges siker esetén mindkettő lehet nullánál nagyobb.

Azok az azonosítók, amelyeket a tömeges művelet sikeresen feldolgozott.

Dokumentumokon és könyvelési tételeken szabadon definiálható címke. A /2/tags/ végponton kezelhető; a listák a with_tag_ids és without_tag_ids paraméterekkel szűrhetők.

Az adóbevallásokhoz használt adókódok törzsadata.

A partner magyar adószáma xxxxxxxx-y-zz formátumban. Ez a partner tax_number mezője; számlákon és bevételeken denormalizáltan partner_tax_number néven is megjelenik.

A szűrésnek megfelelő összes elem száma — nem csak az aktuális oldalon lévőké. Ebből számítható ki az oldalak száma. Csak a /1/ végpontok lapozási borítékában szerepel; a /2/ végpontok cursor-lapozása nem ad összesítést.

Egy dokumentum vagy tétel ÁFA tartalma, tizedestört stringként. A nettó és bruttó összeggel együtt konzisztens hármast alkot.

Egy tételre alkalmazott ÁFA kategória azonosítója. A kategóriák (kód, százalék, ÁFA terület) a /2/accounting/vat-categories/ végpontról olvashatók.

Egy tétel ÁFA tartalmához tartozó könyvelési szám azonosítója. Szintén csak haladó könyvelés esetén érvényesül.

Egy ÁFA kategória százalékos mértéke a törzsadatban. A dokumentumok a kategória azonosítóját tárolják, nem ezt az értéket.

A jelző, ami mutatja, hogy az ÁFA időszak kezelése be van-e kapcsolva a cégnél. Ez határozza meg, hogy a könyvelési időszak mezők értelmezhetők-e.

A tételre alkalmazott ÁFA kulcs. Egy tételen a vat mező tárolja az ÁFA kategória azonosítóját; a kategóriák (kód, százalék, ÁFA terület) a /2/accounting/vat-categories/ végpontról olvashatók.

A dokumentum ÁFA szerinti területi besorolása: HU -- belföld, EU -- Közösségen belüli, 3RD -- harmadik ország.

Jelzi, hogy a partner szállítóként szerepel-e. Kötelező mező a partnerrekordon.