Skip to content

Fintoro Public API v1 (1.0.0)

Stabilné API pre integrácie tretích strán napojené na konkrétnu firmu vo Fintoro. Nájdete tu aj read-only lookup endpointy pre číselníky a banky, plus referenčné tabuľky pre rýchle overenie stabilných ID hodnôt.

Download OpenAPI description
Languages
Servers
Mock server
https://docs.fintoro.sk/_mock/openapi
Produkčné Public API.
https://app.fintoro.sk/api/public/v1
Relatívny prefix pre preview prostredie.
https://docs.fintoro.sk/api/public/v1

Lookupy

Read-only lookup endpointy pre integračné dáta. Tieto endpointy vracajú číselníky so stabilnými ID, ktoré môžete bezpečne cachovať na svojej strane. Banky sa priebežne synchronizujú z open banking zdroja a zvyčajne sa len dopĺňajú o nové záznamy; existujúce ID ostávajú zachované kvôli kompatibilite. V praxi odporúčame banky synchronizovať približne raz týždenne.

Operations

Subjekty

Vyhľadanie a overenie údajov o subjekte ešte pred vytvorením klienta.

Operations

Klienti

Správa klientov aktuálnej firmy. Táto sekcia pokrýva zoznam, detail, vytvorenie, úpravu aj zmazanie klienta vrátane fakturačnej adresy, dodacej adresy a klientských predvolených hodnôt použiteľných pri skladaní payloadov nových dokladov.

Operations

Bankové účty

Správa bankových účtov aktuálnej firmy. Táto sekcia pokrýva zoznam, detail, vytvorenie, úpravu aj zmazanie účtu vrátane údajov o banke, primárnom účte a stave open banking napojenia.

Operations

Faktúry

CRUD operácie nad faktúrami aktuálnej firmy.

Operations

Schemas

Schemas

BankAccountCreateInput

Payload pre vytvorenie bankového účtu. Posielate iba business dáta účtu. Polia, ktoré nepošlete a majú backendový default, sa dopočítajú na strane servera.

bankIdinteger or null

Voliteľné ID banky z lookup endpointu bánk. Použite ho, ak chcete účet naviazať na konkrétnu banku z verejného lookupu.

Example: 1
namestring

Názov bankového účtu, pod ktorým ho budete identifikovať vo Fintoro.

Example: "Hlavný účet"
ibanstring

IBAN bankového účtu. Musí byť validný a unikátny v rámci aktuálnej firmy.

Example: "SK3111000000001234567890"
swiftstring

SWIFT alebo BIC kód bankového účtu.

Example: "TATRSKBX"
autoPairingStrategystring

Stratégia automatického párovania platieb pre tento účet. Ak pole nepošlete, použije sa predvolená hodnota by_variable_symbol.

Default "by_variable_symbol"
Enum"none""by_variable_symbol""by_price""by_variable_symbol_and_price""by_all_symbols""by_all_symbols_and_price"
Example: "by_variable_symbol"
isPrimaryboolean

Označuje, či má byť účet vedený ako primárny účet firmy. Aktuálna implementácia novovytvorený účet nastaví ako primárny účet firmy aj pri vynechaní tohto poľa alebo pri odoslaní false, preto toto pole zatiaľ nefunguje ako tvrdý prepínač.

Default true
Example: true
{ "bankId": 1, "name": "Hlavný účet", "iban": "SK3111000000001234567890", "swift": "TATRSKBX", "autoPairingStrategy": "by_variable_symbol", "isPrimary": true }

BankAccountUpdateInput

Payload pre aktualizáciu bankového účtu. Pošlite len polia, ktoré chcete zmeniť. Polia, ktoré vynecháte, zostanú bez zmeny.

bankIdinteger or null

Voliteľné ID banky z lookup endpointu bánk. Pošlite null, ak chcete väzbu na banku odstrániť.

Example: 1
namestring

Nový názov bankového účtu.

Example: "Hlavný účet"
ibanstring

Nový IBAN bankového účtu. Musí zostať validný a unikátny v rámci aktuálnej firmy.

Example: "SK3111000000001234567890"
swiftstring

Nový SWIFT alebo BIC kód bankového účtu.

Example: "TATRSKBX"
autoPairingStrategystring

Nová stratégia automatického párovania platieb pre tento účet. Ak pole vynecháte, zostane zachovaná existujúca hodnota.

Enum"none""by_variable_symbol""by_price""by_variable_symbol_and_price""by_all_symbols""by_all_symbols_and_price"
Example: "by_price"
isPrimaryboolean

Pošlite true, ak chcete účet nastaviť ako primárny účet firmy. Ak pole vynecháte alebo pošlete false, aktuálne priradenie primárneho účtu zostane bez zmeny a účet sa touto operáciou neprepne na neprimárny.

Example: true
{ "bankId": 1, "name": "Hlavný účet", "iban": "SK3111000000001234567890", "swift": "TATRSKBX", "autoPairingStrategy": "by_price", "isPrimary": true }

InvoiceItem

Jedna položka faktúry.

idinteger
Example: 1
namestring
Example: "Konzultácia"
descriptionstring or null
Example: "Mesačný balík konzultácií"
unitPricenumber(float)
Example: 100
unitIdinteger
Example: 1
quantitynumber(float)
Example: 2
vatRatenumber(float)
Example: 20
discountNamestring or null
Example: "Vernostná zľava"
discountTypestring or null
Example: "percentage"
discountValuenumber or null(float)
Example: 10
priceListItemIdinteger or null
Example: 501
totalnumber(float)
Example: 200
totalWithVatnumber(float)
Example: 240
{ "id": 1, "name": "Konzultácia", "description": "Mesačný balík konzultácií", "unitPrice": 100, "unitId": 1, "quantity": 2, "vatRate": 20, "discountName": "Vernostná zľava", "discountType": "percentage", "discountValue": 10, "priceListItemId": 501, "total": 200, "totalWithVat": 240 }