Alapfogalmak

A QUiCK erőforrás-modellje a magyar könyvelési logikát követi, ugyanakkor fejlesztőbarát: minden objektum egész számú, egyedi id-vel rendelkezik, a listák lapozottak, és a legtöbb erőforrás elérhető a stabil /1/ és a bővített /2/ API-verzióban is.

A cég a legmagasabb szintű egység — egy adószámhoz tartozó könyvelési entitás. Minden más erőforrás ehhez kötődik, és egy API token pontosan egy céghez ad hozzáférést. A cég alapadatai a GET /2/company-info/ hívással kérdezhetők le (id, name, tax_account_number, default_currency_name, advanced_accounting stb.).

A partner egy vevő vagy szállító. Egy partner lehet egyszerre mindkettő; ezt az is_customer és is_vendor mezők jelzik. A partnertörzs tax_number (adószám) alapján deduplikálható.

Elérés: GET /1/partners/ (lapozott lista).

A könyvelés két központi erőforrása a költség (expense, bejövő bizonylat) és a bevétel (income, kimenő bizonylat). Mindkettő egy partnerhez, egy pénznemhez és egy vagy több könyvelési hozzárendeléshez kapcsolódik.

• Költség létrehozása bizonylat feltöltésével történik: POST /2/expenses/create/ a fájlt Base64-ként a content mezőben várja. A rendszer a bizonylatból dolgozza fel az adatokat.
• Listázás és részletek: GET /1/expenses/, GET /2/expenses/, GET /2/expenses/{expenseId}/.
• Bevételek hasonló modellt követnek (GET /1/incomes/), a könyvelési hozzárendelések a POST /2/incomes/{incomeId}/update/ végponttal frissíthetők.

A bizonylat típusát az invoice_class mező jelzi:

Költségeken és bevételeken visszatérő mezők: partner (+ denormalizált partner_name, partner_tax_number stb.), invoice_number, currency, net_amount / vat_amount / gross_amount (decimális, string formátumban), issued_at / fulfilled_at / due_at dátumok, paid_status (fizetettség) és accounting_status (könyvelési állapot).

A hozzárendelés egy költség vagy bevétel könyvelési bontássora — ez felel meg a klasszikus „tételnek". Egy hozzárendelés köti az összeget könyvelési kategóriákhoz: expense_type / revenue_type, net_amount / vat_amount / gross_amount, vat (ÁFA-kategória) és — bekapcsolt advanced_accounting esetén — ledger_number_id (főkönyvi szám).

A bizonylat a feltöltött fájl (PDF, kép), amely egy költséghez vagy bevételhez tartozik. Kezelése: GET /1/documents/, feltöltés és összekapcsolás a /1/documents/attach/, /1/documents/detach/ és /1/documents/files/ végpontokkal, illetve a v2 /2/documents/* műveletekkel.

A pénzmozgás (payment) egy fizetési tranzakció, amely egy pénztárhoz vagy bankszámlához (account) kötődik. A pénztárak aktuális egyenlege a GET /1/pulse/ összesítőben is megjelenik (accounts[].current_balance).

A /2/ API a könyvelési kategóriák karbantartását is lehetővé teszi:

• Azonosítók: minden erőforrás egész számú id-t kap (pl. 4821). Nincs típus-előtag.
• Lapozás: a listavégpontok count / next / previous / results szerkezetben válaszolnak; a page és page_size query paraméterekkel lapozol.
• Formátum: a legtöbb végpont ?format=json (alapértelmezett) mellett ?format=html böngészőbarát nézetet is ad.