Specifikace API

Současná verze Fidoo API je umístěna na https://api.fidoo.com/v2/ a obsahuje:

  • sledování karetních transakcí, 
  • přehledy o uživatelích aplikace,
  • přehled o Fidoo kartách,
  • orientace v parametrech a zůstatcích na Fidoo kartách,
  • vytvoření nového uživatele a objednání osobní Fidoo karty, 
  • dobití a odbití osobní a týmové karty.

Generování API klíče

API klíč vygeneruje Hlavní správce v aplikaci Fidoo, API klíč je nutné vložit do hlavičky X-Api-Key v provolávaných dotazech. 

Popis jednotlivých public API volání

Lidé

/v2/user/get-user /v2/user/get-user-by-email
Hodnota Popis
userId Unikátní identifikátor uživatele ve Fidoo
firstName Jméno uživatele
lastName Příjmení uživatele
email Emailová adresa uživatele
phone Telefon uživatele (který slouží pro ověření)
userState Nabývá hodnot PRAVDA /NEPRAVDA. Pravda značí, že je aplikace pro tohoto uživatele aktivní.
employeeNumber Zaměstnanecké číslo uživatele, pokud je vyplněno v profilu uživatele
kycStatus Nabývá hodnot ověřený/neověřený/ uživatel v závislosti na jeho stavu.
language Vybraný jazyk uživatele (pro aplikaci)
position Pole „Pozice“ na detailu uživatele

Karty

/v2/card/get-cards

HodnotaPopis
cardIdUnikátní identifikátor každé karty v systému Fidoo
maskedNumberMaskovaný PAN karty – viditelné je prvních 6 čísel a poslední 4 čísla (jde o čísla vytištěné na přední straně karty)
expirationDatum expirace karty
embossNameZadaný název karty v systému Fidoo
cardStateAktuální stav karty k momentu vzniku exportu. Například Objednaná, aktivní atp.
cardTypeDle typu karty nabývá hodnot Osobní nebo Týmová
userIdUnikátní identifikátory současných uživatelů spojených s kartou – v případě vícero uživatelů jsou odděleny středníkem
connectedUserIdsjména současných uživatelů spojených s kartou – v případě vícero uživatelů jsou odděleni středníkem
accountingBalanceSoučasný účetní zůstatek karty
availableBalanceSoučasný disponibilní zůstatek karty
blockedBalanceSoučet hodnot nezaúčtovaných (blokovaných) transakcí
aliasVolitelný název karty pro snadné hledání v systému
deliveryEstimateOdhad doručení karty

Karetní transakce

/v2/transaction/get-card-transactions

HodnotaPopis
idUnikátní identifikátor transakce v systému Fidoo
cardIdUnikátní identifikátor karty v systému Fidoo
cardEmbossNameNázev konkrétní karty
cardMaskedNumberMaskovaný PAN karty – viditelné je prvních 6 čísel a poslední 4 čísla (jde o čísla vytištěné na přední straně karty)
transactionDateČasové razítko vzniku transakce
settlementDateČasové razítko zaúčtování transakce (pokud bylo již zaúčtováno)
originalAmountČástka platební operace
originalCurrencyMěna transakce
signedAmountČástka která byla zaúčtovaná (pokud již bylo zaúčtováno) – tato hodnota má opačné znaménko než pole částka transakce
serviceFeeObsahuje údaj o výši poplatku v Kč
transactionStatusDle aktuální stavu transakce
transactionTypeObsahuje informaci o povaze platby – např. platba u obchodníka, výběr hotovosti atp.
merchanNameNázev obchodníka
merchantLocationAdresa obchodníka
merchantCountryIdentifikátor země, na jejímž území k transakci došlo.
categoryNamePokud je vyplněno, obsahuje parametr z pole kategorie obchodníka na kartě spárovaného výdaje
expenceIDUnikátní identifikátor připojeného výdaje v systému Fidoo
cardTypeTyp karty

Výdaje

/v2/expense/get-expenses

HodnotaPopis
expenseIDUnikátní ID výdaje v systému Fidoo
shortIdZkrácený unikátní identifikátor výdaje
nameNázev výdaje
cardIdUnikátní ID platební karty v systému Fidoo
travelReportIdV případě přiřazení výdaje k cesťáku obsahuje unikátní identifikátor daného cesťáku
receiptIdsUnikátní Ids připojených účtenek k výdaji (jsou-li připojeny)
amountHodnota výdaje
currencyMěna výdaje
vatAmountVýše DPH
vatRateSazba DPH
accountCodeKód předkontace
accountDebitHodnota MÁ DÁTI
accountCreditHodnota DAL
vatAccountCodeKód DPH dané předkontace
vatAccountDebitHodnota DPH pro MÁ DÁTI
vatAccountCreditHodnota DPH pro DAL
privateAmountHodnota soukromého výdaje
dateTimeDatum vzniku výdaje
taxableDateDatum zdanitelného plnění
classStateStatus schvalování
merchantIdentificationNumberIČ obchodníka
merchantVatIdDIČ obchodníka
merchantNameNázev obchodníka
merchantAddressAdresa obchodníka
costCenterIdsKódy nákladových středisek
projectIdsKódy projektů uvedených ve výdaji
vatBreakDownIdČlenění DPH
ownerUserIdUnikátní ID uživatele v systému Fidoo
lastEditDateTimeČasové razítko poslední úpravy výdaje
typeTyp výdaje (manuální, karetní transakce)
closedTrue/False, určuje, zda je výdaj uzavřený
receiptUrlsURL souborů s účtenkami
originalTaxDocumentNumberPůvodní číslo daňového dokladu
DescriptionPoznámka
StateStav výdaje ve Fidoo (viz Stavy výdajů ve Fidoo)

Stavy výdajů ve Fidoo

 
Systémový stav Stav ve Fidoo Popis stavu
prepare Otevřený Nový výdaj doposud nezpracovaný nebo vrácený zpět uživateli
approve Ke schválení Odeslaný ke schválení
accountantApprove K uzavření Čeká na zpracování ze strany účetního
personalBill Uzavřený Schválený ze strany účetního
Export Vyúčtovaný Osobní vyúčtování s tímto výdajem bylo uzavřeno
exported Exportovaný Exportovaný v účetní agendě

Jednotlivé položky výdaje

Na základě unikátního ID výdaje vrací položky tohoto výdaje a následující hodnoty.

/v2/expense/get-expense-items

HodnotaPopis
expenseIdUnikátní ID výdaje v systému Fidoo
namePoložka – název
amountPoložka – hodnota
vatAmountPoložka – výše DPH
vatRatePoložka – sazba DPH
typePoložka – typ (firemní, soukromá)
accountCodePoložka – kód předkontace
accountCreditPoložka – kód MÁ DÁTI
accountDebitPoložka – kód DAL
costCenterIdsPoložka – nákladové sředisko
projectIdsPoložka – projekty
vatBreakDownIdPoložka – kód členění DPH
vatAccountCodePoložka – kód předkontace DPH
vatAccountDebitPoložka – kód MÁ DÁTI pro DPH
vatAccountCreditPoložka – kód DAL pro DPH

Hotovostní transakce

/v2/cash-transactions/get-cash-transactions

HodnotaPopis
transactionIDID hotovostní transakce (GUID)
shortExpenseIdkrátké ID výdaje (pro zachování vazby na výdaj)
uservlastník peněženky, text struktury „firstName lastName“
walletNamenázev peněženky
createTransactionDatedatum vytvoření transakce
amountOriginalCurrencyčástka transakce v původní měně
currencyměna transakce / výdaje
transactionTypetyp transakce – v úvahu brát pouze hodnoty „expense“, „withdrawal“, „balanceAdjustment“
companyNamenázev obchodníka (dotahuje se z výdaje)
addressadresa obchodníka
categorykategorie obchodníka

Cesťáky – zprávy

/v2/travel/get-travel-reports

HodnotaPopisPříklad dat
travelReportIdSystémové ID zprávy o služební cestě27fe8798-07e3-11eb-adc1-0242ac120002
travelReportShortIdID zprávy o služební cestěTR-1
travelReportNameNázev zprávy o služební cestěMy testing travel order
travellerIdSystémové ID cestovatele27fe8798-07e3-11eb-adc1-0242ac120002
journeyTypeTyp služební cesty„domestic“ / „foreign“
closedUzavřeno„true“ / „false“
journeyStartDateZačátek služební cesty2018-09-17T13:28:35.382Z
journeyEndDateKonec služební cesty2018-09-17T13:28:35.382Z
journeyStartPointMísto začátku služební cestyPrague
journeyEndPointMísto konce služební cestyBrno
mealAllowanceCzkNáhrady za stravné v CZK706.6
pocketMoneyCzkPeníze na cestu v CZK2500
carAllowanceCzkNáhrada za soukrové vozidlo v CZK1354.8
fuelAllowanceCzkNáhrada za palivo v CZK4023
journeyNotePoznámkaNote
reportCreatedČasové razítko vytvoření zprávy o služební cestě2018-09-17T13:28:35.382Z
createdBySystémové ID uživatele, který zprávu vytvořil27fe8798-07e3-11eb-adc1-0242ac120002
travelRequestShortIdID žádosti o služební cestuTQ-2
projectIdSystémové ID projektu0b20bf11-9282-4a98-97e7-85b3d02daa82
costCenterIdSystémové ID nákladového střediskad4a7fbfb-0531-4ff4-81a7-cf0a3315a975
depositRequestedVýše peněz na cestu, o které uživatel žádal v žádosti2000
depositTypeZpůsob výplaty peněz na cestu:
Card – dobití na kartu
Cash – výplata hotovosti
Card / Cash
travelReportStateStav zprávy ve Fidooviz Stavy cesťáků – zpráv ve Fidoo

Stavy cesťáků – zpráv ve Fidoo

Systémový stav Stav ve Fidoo Popis stavu
prepare Otevřená Nová zpráva doposud nezpracovaná nebo vrácená zpět uživateli
approve Ke schválení Odeslaná ke schválení
accountantApprove K uzavření Čeká na zpracování ze strany účetního
personalBill Uzavřená Schválená ze strany účetního
export Vyúčtovaná Osobní vyúčtování s touto zprávou bylo uzavřeno
exported Exportovaná Exportovaná v účetní agendě

Osobní vyúčtování

/v2/personal-billing/get-billings

Pole prvního sheetu – obsahuje souhrnné informace za každé vyúčtování (jeden řádek = jedno vyúčtování)

HodnotaPopis
userIdunikátní ID uživatele
userFirstnamekřestní jméno uživatele
userLastnamepříjmení uživatele
employeeNumberzaměstnanecké číslo
personalBillingShortIdunikátní ID vyúčtování
personalBillingNamenázev vyúčtování
dateFromvyúčtování datum od
dateTovyúčtování datum do
expenseSumCzksuma výdajů k vyúčtování v CZK (součet za všechny měny)
privateExpenseSumCzksuma soukromých výdajů v CZK (součet za všechny měny)
travelAllowanceSumCzksuma náhrad cest v CZK (součet za všechny měny)
cashSettlementSumCzksuma vyrovnání hotovosti v CZK (součet za všechny měny)
giveMoneySumCzkvyplatit uživateli celkem v CZK (součet za všechny měny)
takeMoneySumCzkstrhnout uživateli celkem v CZK (součet za všechny měny)
closingDatedatum uzavření vyúčtování
closedByUserIdunikátní ID uživatele, které vyúčtování uzavřel
closedByUserFirstnamekřestní jméno uživatele, který vyúčtování uzavřel
closedByUserLastnamepříjmení uživatele, který vyúčtování uzavřel

Pole z druhého sheetu – obsahuje vyúčtování rozpadlé po měnách

HodnotaPopis
personalBillingShortIdunikátní ID vyúčtování (1 vyúčtování zde může mít více záznamů)
currencyměna jednotlivého záznamu
privateExpenseSumsuma soukromých výdajů
travelAllowanceSumsuma náhrad cest
exchangeRateCashkurz převodu měny
cashSettlementSumsuma vyrovnání hotovosti
giveMoneySumvyplatit uživateli celkem
takeMoneySumstrhnout uživateli celkem

Fidoo účet

/v2/mvc-transaction/get-transactions
Poskytuje informace k jednotlivým transakcím na Fidoo účtu (dobití a vybití Fidoo účtu, dobití a vybití karet, poplatky, uhrazená fakturace a další).

HodnotaPopisPříklad dat
transactionIdSystémové ID transakce567ac61d-11cc-4596-844f-214721b2a4dc
transactionCreateDateČasové razítko vytvoření transakce2020-10-15T09:38:59Z
transactionType *)Typ transakcecard-creation-fee
transactionOriginalAmountPůvodní částka99
transactionOriginalCurrencyPůvodní měnaCZK
transactionSettledAmountÚčtovaná částka-99
transactionSettlementDateDatum zaúčtování2020-10-15T09:39:03Z
cardIdSystémové ID platební karty (pouze u transakcí souvisejících s kartami)042ca2da-6614-4a10-a575-526fd084f201
cardMaskedNumberMaskované číslo platební karty549546******6231
cardEmbossNameEmbosované jméno na kartěUZIVATELTESTOVACI
transactionInitiatedUserEmailEmail uživatele, který transakci iniciovaltest@fidoo.com
transactionInitiatedUserNameOznačení uživatele, který transakci iniciovalJan Novak
transactionNotePoznámka k transakciLoading money to the account
clientAccountNumberČíslo protiúčtu21312312312/1234
variableSymbolVariabilní symbol123456
specificSymbolSpecifický symbol123456

*) Popis typů transakcí na Fidoo účtu

Transaction typePopis hodnoty
atm-feePoplatek za výběry z bankomatu
balance-adjustmentDoúčtování transakce
card-renewal-feePoplatek za obnovu Fidoo karty
card-creation-feePoplatek za výrobu Fidoo karty
card-loadDobití karty
card-unloadOdbití prostředků z karty na Fidoo účet
fee-balance-adjustmentBonus
insurance-feePoplatek za Direct cestovní pojištění
monthly-service-feePoplatek za vedení Fidoo karty
mvc-loadPřevod na Fidoo účet
mvc-unloadPřevod z Fidoo účtu
online-account-feePoplatek za služby Fidoo
otherOstatní transakce
refundBonus

Nastavení

Nákladová střediska

/v2/settings/get-cost-centers – výpis seznamu nákladových středisek
/v2/settings/add-cost-center – vytvoření nákladového střediska
/v2/settings/delete-cost-center – smazání nákladového střediska (přepnutí do stavu „deleted“)
/v2/settings/update-cost-center – aktualizace dat nákladového střediska

HodnotaPopisVzor dat
idSystémové ID položkyd4a7fbfb-0531-4ff4-81a7-cf0a3315a975
codeKód nákladového střediska ve FidooNS001
nameNázev nákladového střediska ve FidooNázev střediska nový 1
state

Stav nákladového střediska ve Fidoo

active – aktivní a zobrazuje se uživatelům
– inactive – vypnuté, nenabízí se uživatelům
deleted – smazané, nezobrazuje se ve Fidoo

active / inactive / deleted

Projekty

/v2/settings/get-projects – výpis seznamu projektů
/v2/settings/add-project – vytvoření projektu
/v2/settings/delete-project – smazání projektu (přepnutí do stavu „deleted“)
/v2/settings/update-project – aktualizace dat projektu

HodnotaPopisVzor dat
idSystémové ID položky3d161bfd-e46e-4afe-ba35-874e4f912db9
codeKód nákladového střediska ve Fidooprojekt1
nameNázev nákladového střediska ve FidooNázev projektu 1
state

Stav projektu ve Fidoo

active – aktivní a zobrazuje se uživatelům
– inactive – vypnuté, nenabízí se uživatelům
deleted – smazané, nezobrazuje se ve Fidoo

active / inactive / deleted

Členění DPH

/v2/settings/get-vat-breakdowns – výpis seznamu členění DPH
/v2/settings/add-vat-breakdown – smazání členění DPH (přepnutí do stavu „deleted“)
/v2/settings/delete-vat-breakdown – smazání členění DPH (přepnutí do stavu „deleted“)
/v2/settings/update-vat-breakdown – aktualizace dat členění DPH

HodnotaPopisVzor dat
idSystémové ID položky9aea73a4-4403-40f4-9352-33bc2c68df9f
codeKód členění DPH ve FidooPDB2
nameNázev členění DPH ve FidooDPH vstup 10%
state

Stav členění DPH ve Fidoo

active – aktivní a zobrazuje se uživatelům
– inactive – vypnuté, nenabízí se uživatelům
deleted – smazané, nezobrazuje se ve Fidoo

active / inactive / deleted

PSD2 API

K využívání PSD2 API musíte být držiteli certifikátu. O ten můžete požádat u I. Certifikační autority, pokud jste držitelem příslušné licence vydávané Českou národní bankou. Kompletní návod, jak začít využívat naše PSD2 API, najdete na https://psd2.fidoo.com a obsahuje:

  • Informace o platebních účtech (AISP API) – zůstatek Fidoo účtu, historie a detaily dobití a odbití Fidoo účtu

Testovací data

Pokud máte zájem o testovací prostředí, pošlete žádost na info@fidoo.com. Ochotně vám zřídíme testovací prostředí Fidoo, které bude schopno komunikovat s testovacím API z úložiště: https://api-preprod.fidoo.com/v2.

V tomto návodu najdete

Nenašli jste, co jste hledali?

Mohlo by se hodit

Utekl vám začátek Fidoo? Dožeňte to během několika minut s Fidoo akademií.

Už máte mobilní aplikaci Fidoo?

Skoncujte s papírováním ještě dnes

Nechte nám na sebe kontakt a my se vám ozveme nejpozději do 1 pracovního dne.

Chci Cashbot i Fidoo

Nechte nám na sebe kontakt a my se vám ozveme nejpozději do 1 pracovního dne.

Našli jste vše, co jste hledali?

Jestli máte minutku, rádi bychom znali Váš názor na obsah našich webových stránek.

Ale no tak... Řekli jsme přeci bez papírů.

Raději si tuto stránku uložte mezi oblíbené, ať se k ní můžete kdykoli vrátit.

Zdigitalizovat i firemní finance

Nechte nám na sebe kontakt a my se vám ozveme nejpozději do 1 pracovního dne.

Méně stresoo pro účetní

Nechte nám na sebe kontakt a my se vám ozveme nejpozději do 1 pracovního dne.