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
/v2/user/get-user-by-employee-number
| Hodnota | Popis | Příklad dat | Poznámka |
|---|---|---|---|
| firstName | Jméno uživatele | Jan | – |
| lastName | Příjmení uživatele | Novak | – |
| E-mailová adresa uživatele | jan.novak@example.com | – | |
| phone | Telefon uživatele | +420605562478 | Slouží k ověření |
| employeeNumber | Zaměstnanecké číslo uživatele | AX12545 | Určuje si klient, vyplněno v profilu uživatele |
| userState | Stav uživatele | active / deleted / new | Nabývá jedné hodnoty ze tří obměn. Platný v momentu exportu. |
| kycStatus | Vás stav z pozice zákazníka | unknown / ok / failed / refused | Nabývá jedné hodnoty ze čtyř obměn. Platný v momentu exportu. |
| language | Jazyk aplikace uživatele | cs / en | – |
| userId | Unikátní identifikátor uživatele v systému Fidoo | 30dcca40-9858-4139-9230-bb86d97cf64e | – |
| position | Pozice uživatele ve své společnosti | Účetní | – |
| usesApplication | Má/nemá přístup do aplikace | true / false | True (pravda) odpovídá uživateli, který má přístup do aplikace. |
| deactivated | Uživatel je/není deaktivovaný | true / false | True (pravda) odpovídá deaktivovanému uživateli, false (nepravda) aktivnímu. |
/v2/user/get-users
| Hodnota | Popis | Příklad dat | Poznámka |
|---|---|---|---|
| userId | Unikátní identifikátor uživatele v systému Fidoo | 30dcca40-9858-4139-9230-bb86d97cf64e | – |
| firstName | Jméno uživatele | Jan | – |
| lastName | Příjmení uživatele | Novak | – |
| E-mailová adresa uživatele | jan.novak@example.com | – | |
| phone | Telefon uživatele | +420605562478 | Slouží k ověření |
| companyId | Unikátní identifikátor společnosti v systému Fidoo | r6417d750-2f6a-11e9-b210-d663bd873d93 | – |
| employeeNumber | Zaměstnanecké číslo uživatele | AX12545 | Určuje si klient, vyplněno v profilu uživatele |
| position | Pozice uživatele ve své společnosti | Účetní | Určuje si klient, vyplněno v profilu uživatele |
| userState | Stav uživatele | active / deleted / new | Nabývá jedné hodnoty ze tří obměn. Platný v momentu exportu. |
| deactivated | Je uživatel deaktivovaný? | true / false | True (pravda) odpovídá deaktivovanému uživateli, false (nepravda) aktivnímu. |
| lastModified | Datum poslední úpravy uživatele | 2022-09-17T13:28:35.382Z | – |
| usesApplication | Má/nemá přístup do aplikace | true / false | True (pravda) odpovídá uživateli, který má přístup do aplikace. |
| language | Jazyk aplikace uživatele | cs / en | – |
Karty
/v2/card/get-cards| Hodnota | Popis | Příklad dat | Poznámka |
|---|---|---|---|
| cardId | Unikátní identifikátor karty v systému Fidoo | b16d2df4-5c28-4b90-9a8a-a88c3258fa53 | – |
| cardState | Stav karty | first-ordered / active / hard-blocked / soft-blocked / expired | Nabývá jedné hodnoty z pěti obměn. Platný v momentu exportu. |
| cardType | Typ karty | personal / shared | Nabývá hodnoty buď personal (osobní), nebo shared (týmová). |
| maskedNumber | Maskovaný PAN karty | 549546******3575 | Zobrazuje se prvních 6 čísel a poslední 4 čísla. Jedná se o číslo vyražené na přední straně karty. |
| embossName | Držitel karty v systému Fidoo | Jan Novak | Jedná se o jméno vyražené na přední straně karty. |
| alias | Volitelný název karty pro snadné hledání v systému | Honzova karta | – |
| expiration | Datum expirace karty | 2024-01-31 | – |
| availableBalance | Disponibilní zůstatek karty | 0 | Platný v momentu exportu. |
| accountingBalance | Účetní zůstatek karty | 0 | Platný v momentu exportu. |
| blockedBalance | Součet všech nezaúčtovaných (blokovaných) transakcí | 0 | Platný v momentu exportu. |
| deliveryEstimate | Předpokládané datum doručení karty | 2022-01-31 | – |
| userId | Unikátní identifikátor uživatele v systému Fidoo | 30dcca40-9858-4139-9230-bb86d97cf64e | – |
| connectedUserIds | Unikátní identifikátory uživatelů v systému Fidoo spojených s kartou | 30dcca40-9858-4139-9230-bb86d97cf64e | Pokud se jedná o týmovou kartu, pak je k ní přiřazeno více uživatelů, jejichž IDs jsou odděleny středníkem. |
/v2/card/load-card
/v2/card/unload-card
| Hodnota | Popis | Příklad dat | Poznámka |
|---|---|---|---|
| cardId | Unikátní identifikátor karty v systému Fidoo | b16d2df4-5c28-4b90-9a8a-a88c3258fa53 | Nabíjená/vybíjená karta |
| amount | Částka | 1000 | Nabíjená/vybíjená částka v CZK |
| message | Volitelná zpráva | Peníze na nákup materiálu | Vztahující se k nabití/vybití karty, o maximální délce 50 znaků |
Karetní transakce
/v2/transaction/get-card-transactions
| Hodnota | Popis | Příklad dat | Poznámka |
|---|---|---|---|
| id | Unikátní identifikátor v systému Fidoo | 07dcca40-9858-4139-9230-bb86d97cf64e | – |
| cardId | Unikátní identifikátor karty v systému Fidoo | b16d2df4-5c28-4b90-9a8a-a88c3258fa53 | – |
| expenseId | Unikátní identifikátor výdaje v systému Fidoo | r6417d750-2f6a-11e9-b210-d663bd873d93 | – |
| cardEmbossName | Jméno uživatele či název vyražený na kartě | KAMIL BLAZEK | – |
| cardMaskedNumber | Maskovaný PAN karty | 549546******3575 | Zobrazuje se prvních 6 čísel a poslední 4 čísla. Jedná se o číslo vyražené na přední straně karty. |
| transactionDate | Časové razítko vzniku transakce | 2022-09-17T13:28:35.382+02:00 | – |
| settlementDate | Časové razítko zaúčtování transakce (pokud bylo již zaúčtováno) | 2022-09-18T13:28:35.382+02:00 | – |
| originalAmount | Částka v původní měně | 450 | – |
| originalCurrency | Měna transakce | EUR | – |
| signedAmount | Zaúčtovaná částka v CZK (pokud již bylo zaúčtováno) | -11745,14 | Tato hodnota má opačné znaménko než pole originalAmount. |
| serviceFee | Výše servisního poplatku | 0 | Obvykle za použití bankomatu (ATM). |
| transactionStatus | Stav transakce | accounted | Platný v momentu exportu. |
| transactionType | Typ transakce | [viz poznámka] | Např. load |
| merchantName | Název obchodníka | CESKE DRAHY, A.S. | – |
| merchantLocation | Adresa (město) obchodníka | PRAHA 1 | – |
| merchantCountry | Identifikátor země, na jejímž území k transakci došlo | CZ | – |
| categoryName | Kategorie obchodníka | travel | Zobrazuje se, pokud je vyplněn. |
| cardType | Typ karty | personal / shared | Nabývá buď hodnoty personal (osobní), nebo shared (týmová). |
| mcc | Merchant Category Code (Mezinárodní kód kategorie obchodníka) | 4722 | Složen ze 4 číslic. |
| transactionLocalDateTime | Časové razítko transakce v místním čase | 2022-06-20T12:17:24 | Může nabývat i hodnoty null, pokud není hodnota známa. |
Výdaje
/v2/expense/get-expenses| Hodnota | Popis | Příklad dat | Poznámka | |
|---|---|---|---|---|
| expenseId | – | Unikátní identifikátor výdaje v systému Fidoo | r6417d750-2f6a-11e9-b210-d663bd873d93 | – |
| ownerUserId | – | Unikátní identifikátor uživatele v systému Fidoo, který vytvořil výdaj | 30dcca40-9858-4139-9230-bb86d97cf64e | – |
| dateTime | – | Časové razítko vzniku výdaje | 2022-09-17T13:28:35.382Z | – |
| lastEditDateTime | – | Časové razítko poslední úpravy výdaje | 2022-09-17T13:28:35.382Z | – |
| name | – | Název | Nazev | Zadaný název výdaje, např. Oběd s klientem |
| classState | – | Stav výdajů | open / sent / approved / other | Nabývá jedné hodnoty ze čtyř obměn. Platný v momentu exportu. |
| type | – | Typ | [viz poznámka] | Typ výdaje nabývá buď hodnoty manual (ručně zadané), nebo card-transaction (karetní transakce). |
| amount | – | Částka | 1000 | Celková částka výdaje, uvedena v původní měně |
| amountCzk | – | Částka v CZK | 1000 | Celková částka výdaje v českých korunách |
| currency | – | Měna transakce | EUR | Uvedena ve formátu ISO 4217 |
| shortId | – | Zkrácený identifikátor výdaje | EX-10 | – |
| receiptIds | – | Unikátní identifikátory připojených účtenek k výdaji v systému Fidoo (pokud jsou připojeny) | 07dcca40-9858-4139-9230-bb86d97cf64e | – |
| companyExpense | – | Částka firemního výdaje | 420 | Hodnota amount (Částka transakce) snížena o privateAmount (Částka soukromého výdaje) |
| privateAmount | – | Součet všech soukromých výdajů | 30 | – |
| cardId | – | Unikátní identifikátor karty v systému Fidoo | b16d2df4-5c28-4b90-9a8a-a88c3258fa53 | Pokud je výdaj typu card-transaction (karetní transakce). |
| travelReportId | – | Unikátní identifikátor zprávy o služební cestě (cesťáku) v systému Fidoo | 331a0bd0-0f95-11ea-8d71-362b9e155667 | – |
| vatAmount | – | Výše DPH | 34.81 | – |
| vatRate | – | Sazba DPH | 0.21 | Uvedena v rozmezí 0-1 |
| taxBase | – | Částka bez DPH (základ) | 950 | – |
| accountCode | – | Kód předkontace | PHM | – |
| accountCredit | – | Hodnota DAL | 450 | – |
| accountDebit | – | Hodnota MÁ DÁTI | 320 | – |
| vatAccountCode | – | Kód DPH dané předkontace | DPH21 | – |
| vatAccountCredit | – | Hodnota DPH pro DAL | 20 | – |
| vatAccountDebit | – | Hodnota DPH pro MÁ DÁTI | 10 | – |
| costCenterIds | – | Unikátní identifikátory nákladových středisek v systému Fidoo připojených k výdaji | a787d2f0-f261-4618-b7d1-7c9ad71c73e6 | – |
| projectIds | – | Unikátní identifikátory projektů v systému Fidoo připojených k výdaji | a787d2f0-f261-4618-b7d1-7c9ad71c73e6 | – |
| vatBreakDownId | – | Unikátní identifikátor členění DPH v systému Fidoo | a787d2f0-f261-4618-b7d1-7c9ad71c73e6 | – |
| taxableDate | – | Datum zdanitelného plnění | 2022-09-17 | Uveden ve formátu ISO 8601 |
| merchantIdentificationNumber | – | IČ obchodníka | 4566544 | – |
| merchantVatId | – | DIČ obchodníka | CZ4566544 | – |
| merchantName | – | Název obchodníka | CESKE DRAHY, A.S. | – |
| merchantCategory | – | Kategorie obchodníka | Travel | – |
| merchantAddress | – | Adresa obchodníka | Jecna 1 | – |
| cardTransactionId | – | Unikátní identifikátor karetní transakce v systému Fidoo | 7fec49fb-7e1d-4d2a-9ddb-d5377040cb45 | – |
| exchangeRate | – | Měnový kurz | 23.4244 | – |
| description | – | Popis či poznámka | Upřesňující informace | – |
| state | – | Stav v systému Fidoo | [viz poznámka] | Stav výdaje nabývá jedné hodnoty z 11 obměn, viz níže Stavy výdajů ve Fidoo |
| closed | – | Je již uzavřeno? | true / false | True (pravda) odpovídá uzavřenému výdaji, který se již později nezmění. |
| receiptUrls | – | Veřejný URL odkaz pro stažení souboru s účtenkami | https://api.fidoo.com/doc/download/FcSddkfkEEdffSSwervvf | Pokud je účtenka připojena. |
| originalTaxDocumentNumber | – | Původní číslo daňového dokladu | FV202103 | – |
| pairingKey | – | Párovací klíč | 205-23062021 1086000537810 | – |
| accountingCategory | – | Účetní kategorie | – | – |
| – | id | Unikátní identifikátor v systému Fidoo | 0aa54c71-aca4-43ba-8107-89daaf4e8fa2/td> | – |
| – | accountAssignment | Předkontace | – | Rozpadá se podle níže uvedené tabulky “Předkontace”. |
| – | code | Kód | GLO23 | – |
| – | name | Název | Nápoje | – |
| – | state | Stav v systému Fidoo | active / inactive / deleted | Stav nabývá jedné hodnoty ze tří obměn; active (zobrazuje se uživatelům), inactive (nenabízí se uživatelům), nebo deleted (smazán z Fidoo). |
Stavy výdajů v systému Fidoo
| Systémový stav | Stav v aplikaci Fidoo | Popis stavu |
|---|---|---|
| prepare | Otevřený | Nový výdaj doposud nezpracovaný nebo vrácený zpět uživateli |
| approve | Ke schválení | Čeká se na schválení prvním schvalovatelem |
| approve2 | K 2. schválení | Čeká se na schválení druhým schvalovatelem |
| accountantApprove | K uzavření | Čeká se na chválení účetní |
| personalBill | Uzavřený | Uzavřené osobní vyúčtování |
| export | Vyúčtovaný | Vyúčtovaný a připravený pro nový export v účetní agendě |
| exported | Exportovaný | Exportovaný v účetní agendě |
Jednotlivé položky výdaje
/v2/expense/get-expense-items| Hodnota | Popis | Příklad dat | Poznámka | |
|---|---|---|---|---|
| expenseItemId | – | Unikátní identifikátor položky výdaje v systému Fidoo | 9716297e-9279-4fff-918f-b257eb520c7c | – |
| expenseId | – | Unikátní identifikátor výdaje v systému Fidoo | r6417d750-2f6a-11e9-b210-d663bd873d93 | – |
| name | – | Název | Nazev | Zadaný název položky výdaje, např. Nafta |
| amount | – | Částka | 1000 | Částka položky |
| taxBase | – | Částka bez DPH (základ) | 950 | Částka položky bez DPH (základ) |
| vatAmount | – | Výše DPH | 34.81 | Výše DPH položky |
| vatRate | – | Sazba DPH | 0.21 | Sazba DPH pro položku, uvedena v rozmezí 0-1 |
| type | – | Typ | [viz poznámka] | Typ výdaje nabývá buď hodnoty private (soukromá), nebo corporate (firemní). |
| accountCode | – | Kód předkontace | PHM | – |
| accountCredit | – | Hodnota DAL | 450 | – |
| accountDebit | – | Hodnota MÁ DÁTI | 320 | – |
| vatAccountCode | – | Kód DPH dané předkontace | DPH21 | – |
| vatAccountCredit | – | Hodnota DPH pro DAL | 20 | – |
| vatAccountDebit | – | Hodnota DPH pro MÁ DÁTI | 10 | – |
| costCenterIds | – | Unikátní identifikátory nákladových středisek v systému Fidoo připojených k výdaji | a787d2f0-f261-4618-b7d1-7c9ad71c73e6 | – |
| projectIds | – | Unikátní identifikátory projektů v systému Fidoo připojených k výdaji | a787d2f0-f261-4618-b7d1-7c9ad71c73e6 | – |
| vatBreakDownId | – | Unikátní identifikátor členění DPH v systému Fidoo | a787d2f0-f261-4618-b7d1-7c9ad71c73e6 | – |
| accountingCategory | – | Účetní kategorie | – | – |
| – | id | Unikátní identifikátor v systému Fidoo | 0aa54c71-aca4-43ba-8107-89daaf4e8fa2/td> | – |
| – | accountAssignment | Předkontace | – | Rozpadá se podle níže uvedené tabulky “Předkontace”. |
| – | code | Kód | GLO23 | – |
| – | name | Název | Nápoje | – |
| – | state | Stav v systému Fidoo | active / inactive / deleted | Stav nabývá jedné hodnoty ze tří obměn; active (zobrazuje se uživatelům), inactive (nenabízí se uživatelům), nebo deleted (smazán z Fidoo). |
Hotovostní transakce
/v2/cash-transactions/get-cash-transactions| Hodnota | Popis | Příklad dat | Poznámka |
|---|---|---|---|
| transactionID | Unikátní identifikátor hotovostní transakce v systému Fidoo | 30dcca40-9858-4139-9230-bb86d97cf64e | – |
| shortExpenseId | Zkrácený identifikátor výdaje | EX-10 | – |
| user | Unikátní identifikátor uživatele v systému Fidoo, který vlastní danou peněženku | 30dcca40-9858-4139-9230-bb86d97cf64e | – |
| walletName | Název peněženky | Pepova penezenka | – |
| createTransactionDate | Časové razítko vytvoření transakce | 2022-09-17T13:28:35.382+02:00 | – |
| amountOriginalCurrency | Částka v původní měně | 100 | – |
| currency | Měna transakce | EUR | – |
| transactionType | Typ transakce | [viz poznámka] | Stav výdaje nabývá jedné hodnoty ze 7 obměn, viz Typy hotovostních transakcí |
| companyName | Název obchodníka | McDonald’s | – |
| address | Adresa obchodníka | Ulice 1, Praha, CZ | – |
| category | Kategorie obchodníka | [viz poznámka] | Stav výdaje nabývá jedné hodnoty ze 23 obměn, viz níže Kategorie obchodníků |
| receiptUrls | Veřejný URL odkaz pro stažení souboru s účtenkami | https://api.fidoo.com/doc/download/FcSddkfkEEdffSSwervvf | Pokud je účtenka připojena. |
Typy hotovostních transakcí
| Systémový stav | Stav v aplikaci Fidoo |
|---|---|
| expense | Hotovostní výdaj |
| balanceAdjustment | Vyrovnání hotovosti |
| private_expense | Soukromý výdaj |
| withdrawal | Výběr z bankomatu |
| deposit | Vklad v hotovosti |
| receiveCash | Nabití peněženky |
| returnCash | Vybití peněženky |
Cesťáky – zprávy
/v2/travel/get-travel-reports /v2/travel/get-travel-requests| Hodnota | Popis | Příklad dat | Poznámka |
|---|---|---|---|
| travelRequestId | Unikátní identifikátor žádosti o služební cestu v systému Fidoo | 27fe8798-07e3-11eb-adc1-0242ac120002 | Platí pouze pro API volání “/v2/travel/get-travel-requests”. |
| travelRequestShortId | Zkrácený identifikátor žádosti o služební cestu | TQ-2 | Platí pouze pro API volání “/v2/travel/get-travel-requests”. |
| travelRequestName | Název žádosti o služební cestu (cesťáku) | Moje cesta do Brna | Platí pouze pro API volání “/v2/travel/get-travel-requests”. |
| travelReportId | Unikátní identifikátor zprávy o služební cestě (cesťáku) v systému Fidoo | 331a0bd0-0f95-11ea-8d71-362b9e155667 | – |
| travelReportShortId | Zkrácený identifikátor zprávy o služební cestě (cesťáku) | TR-1 | – |
| travelReportName | Název zprávy o služební cestě (cesťáku) | Moje cesta do Brna | – |
| travellerId | Unikátní identifikátor uživatele na služební cestě v systému Fidoo | 27fe8798-07e3-11eb-adc1-0242ac120002 | – |
| journeyType | Typ služební cesty | domestic / foreign / mixed | Nabývá jedné hodnoty ze tří obměn. |
| travelReportState | Stav zprávy o služební cestě (cesťáku) v systému Fidoo | [viz poznámka] | Stav cesťáku nabývá jedné z hodnot, viz níže Stavy cesťáků – zpráv v systému Fidoo. |
| closed | Je již uzavřeno? | true / false | True (pravda) odpovídá uzavřené zprávě o služební cestě (cesťáku), která se již později nezmění. |
| journeyStartDate | Začátek služební cesty | 2018-09-17T13:28:35.382Z | – |
| journeyEndDate | Konec služební cesty | 2018-09-17T13:28:35.382Z | – |
| journeyStartPoint | Místo začátku služební cesty | Prague | – |
| journeyEndPoint | Místo konce služební cesty | Brno | – |
| mealAllowanceCzk | Náhrady za stravné v CZK | 1000 | – |
| pocketMoneyCzk | Peníze na cestu v CZK | 2500 | – |
| carAllowanceCzk | Náhrada za soukromé vozidlo v CZK | 3000 | – |
| fuelAllowanceCzk | Náhrada za palivo v CZK | 4000 | – |
| travelReportTotal | Celkové náhrady v CZK | 10500 | – |
| journeyNote | Poznámka ke služební cestě | Privezu frgal | – |
| reportCreated | Časové razítko vytvoření zprávy o služební cestě (cesťáku) | 2022-09-17T13:28:35.382Z | – |
| createdBy | Unikátní identifikátor uživatele v systému Fidoo, který vytvořil zprávu o služební cestě (cesťáku) | 27fe8798-07e3-11eb-adc1-0242ac120002 | – |
| travelRequestId | Unikátní identifikátor žádosti o služební cestu v systému Fidoo | 27fe8798-07e3-11eb-adc1-0242ac120002 | Platí pouze pro API volání “/v2/travel/get-travel-reports”. |
| travelRequestShortId | Zkrácený identifikátor žádosti o služební cestu | TQ-2 | Platí pouze pro API volání “/v2/travel/get-travel-reports”. |
| projectId | Unikátní identifikátor projektu v systému Fidoo | 0b20bf11-9282-4a98-97e7-85b3d02daa82 | – |
| costCenterId | Unikátní identifikátor nákladového střediska v systému Fidoo | d4a7fbfb-0531-4ff4-81a7-cf0a3315a975 | – |
| depositRequested | Uživatelem požadovaná částka na služební cestu | 2000 | – |
| depositType | Způsob výplaty peněz žadateli na služební cestu | cash / card / null | Nabývá buď hodnoty cash (výplata v hotovosti), nebo card (dobití karty). Hodnota může být i null. |
| depositCurrency | Měna peněz na služební cestu | CZK | – |
| lastEditDateTime | Časové razítko poslední úpravy výdaje | 2022-09-17T13:28:35.382Z | Uveden ve formátu ISO 8601 |
Stavy cesťáků – zpráv v systému Fidoo
| Systémový stav | Stav v aplikaci Fidoo | Popis stavu |
|---|---|---|
| prepare | Otevřená | Nová zpráva o cestě doposud nezpracovaná nebo vrácená zpět uživateli |
| approve | Ke schválení | Čeká se na schválení prvním schvalovatelem |
| approve2 | K 2.schválení | Čeká se na schválení druhým schvalovatelem |
| accountantApprove | K uzavření | Čeká se na chválení účetní |
| personalBill | Uzavřená | Uzavřené osobní vyúčtování |
| export | Vyúčtovaná | Vyúčtovaná a připravená pro nový export v účetní agendě |
| exported | Exportovaná | Exportovaná v účetní agendě |
| … | … | … |
Cesťáky – detail
/v2/travel/get-travel-detail| Hodnota | Popis | Příklad dat | Poznámka |
|---|---|---|---|
| tripId | Unikátní identifikátor cesty v systému Fidoo | 27fe8798-07e3-11eb-adc1-0242ac120002 | – |
| startDate | Datum začátku cesty | 2022-09-17T13:28:35.382Z | – |
| endDate | Datum konce cesty | 2022-09-18T13:28:35.382Z | – |
| startPoint | Výchozí místo cesty | Prague | – |
| endPoint | Konečné místo cesty | Brno | – |
Osobní vyúčtování
/v2/personal-billing/get-billings| Hodnota | Popis | Příklad dat | Poznámka |
|---|---|---|---|
| personalBillingShortId | Zkrácený identifikátor osobního vyúčtování v systému Fidoo | PB-459 | – |
| personalBillingName | Název osobního vyúčtování | Od 1.4.2022 | – |
| dateFrom | Počáteční datum vystaveného osobního vyúčtování | 2022-04-01 | – |
| dateTo | Závěrečný datum vystaveného osobního vyúčtování | 2023-01-06 | – |
| state | Stav v systému Fidoo | [viz poznámka] | Nabývá buď hodnoty opened (otevřené), nebo closed (zavřené). |
| expenseSumCzk | Součet všech výdajů více měn k vyúčtování v CZK | 500 | – |
| privateExpenseSumCzk | Součet všech soukromých výdajů více měn k vyúčtování v CZK | 50 | – |
| travelAllowanceSumCzk | Součet všech cestovních náhrad více měn k vyúčtování v CZK | 100 | – |
| cashSettlementSumCzk | Součet všech vyrovnání hotovosti více měn k vyúčtování v CZK | 50 | – |
| giveMoneySumCzk | Celkové částka více měn k vyplacení uživateli v CZK | 200 | – |
| takeMoneySumCzk | Celkové částka více měn ke stržení uživateli v CZK | 300 | – |
| closingDate | Datum uzavření vyúčtování | 2027-07-06 | – |
| Hodnota | Popis | Příklad dat | Poznámka |
|---|---|---|---|
| userId | Unikátní identifikátor uživatele v systému Fidoo | 30dcca40-9858-4139-9230-bb86d97cf64e | Pokud následuje po closedByUser, pak jde o uživatele, který uzavřel vyúčtování. |
| firstName | Jméno uživatele | Jan | Pokud následuje po closedByUser, pak jde o jméno uživatele, který uzavřel vyúčtování. |
| lastName | Příjmení uživatele | Novak | Pokud následuje po closedByUser, pak jde o příjmení uživatele, který uzavřel vyúčtování. |
| employeeNumber | Zaměstnanecké číslo uživatele | AX12545 | Určuje si klient, vyplněno v profilu uživatele. Pokud následuje po closedByUser, pak jde o zam. číslo uživatele, který uzavřel vyúčtování. |
| deactivated | Je uživatel deaktivovaný? | true / false | Pokud následuje po closedByUser, pak true (pravda) odpovídá deaktivovanému uživateli, který uzavřel vyúčtování. |
| Hodnota | Popis | Příklad dat | Poznámka |
|---|---|---|---|
| personalBillingShortId | Zkrácený identifikátor osobního vyúčtování v systému Fidoo | PB-459 | – |
| currency | Měna transakce | EUR | – |
| privateExpenseSum | Součet všech soukromých výdajů k vyúčtování shrnutý podle měn | 200 | – |
| travelAllowanceSum | Součet všech cestovních náhrad k vyúčtování podle měn | 100 | – |
| giveMoneySum | Celkové částka k vyplacení uživateli podle měn | 50 | – |
| takeMoneySum | Celkové částka ke stržení uživateli podle měn | 20 | – |
| exchangeRateCash | Měnový kurz | 23.4244 | – |
| cashSettlementSum | Součet všech vyrovnání hotovosti k vyúčtování podle měn | 10 | – |
Fidoo účet
/v2/mvc-transaction/get-transactions| Hodnota | Popis | Příklad dat | Poznámka |
|---|---|---|---|
| transactionID | Unikátní identifikátor hotovostní transakce v systému Fidoo | 30dcca40-9858-4139-9230-bb86d97cf64e | – |
| transactionCreateDate | Časové razítko vytvoření transakce | 2022-10-15T09:38:59Z | – |
| transactionType | Typ transakce | [viz poznámka] | Stav výdaje nabývá např. hodnoty “card-load”. |
| transactionOriginalAmount | Původní částka transakce | 1000 | – |
| transactionOriginalCurrency | Původní měna transakce | CZK | Nabývá buď hodnoty opened (otevřené), nebo closed (zavřené). |
| transactionSettledAmount | Zaúčtovaná částka transakce (pokud již bylo zaúčtováno) | -1000 | Tato hodnota má opačné znaménko než pole transactionOriginalAmount. |
| transactionSettlementDate | Datum zaúčtování transakce (pokud již bylo zaúčtováno) | 2022-10-15T09:39:032Z | – |
| cardId | Unikátní identifikátor karty v systému Fidoo | b16d2df4-5c28-4b90-9a8a-a88c3258fa53 | Pokud se jednalo o kartetní transakci. |
| cardMaskedNumber | Maskovaný PAN karty | 549546******3575 | Pokud se jednalo o karetní transakci. |
| cardEmbossName | Jméno uživatele či název vyražený na kartě | KAMIL BLAZEK | Pokud se jednalo o karetní transakci. |
| transactionInitiatedUserEmail | E-mail uživatele, který transakci inicioval | jan.novak@fidoo.com | Pro transakce typu (transactionType) card-load a card-unload. |
| transactionInitiatedUserName | Jméno a příjmení uživatele, který transakci inicioval | Jan Novak | Pro transakce typu (transactionType) card-load a card-unload. |
| transactionNote | Poznámka k transakci | Nahrani penez na ucet | – |
| clientAccountNumber | Číslo protiúčtu, ze kterého byl stav Fidoo účet navýšen nebo snížen. | 21312312312/1234 | Pro transakce typu (transactionType) mvc-load a mvc-unload. |
| variableSymbol | Variabilní symbol transakce | 123456 | Pro transakce typu (transactionType) mvc-load a mvc-unload. |
| specificSymbol | Specifický symbol transakce | 123456 | Pro transakce typu (transactionType) mvc-load a mvc-unload. |
NASTAVENÍ
Nákladová střediska
| Hodnota | Popis | Příklad dat | Poznámka |
|---|---|---|---|
| code | Zkrácený identifikátor v systému Fidoo | NS001 | Zkrácený identifikátor nákladového střediska v systému Fidoo |
| id | Unikátní identifikátor v systému Fidoo | 07dcca40-9858-4139-9230-bb86d97cf64e | Unikátní identifikátor nákladového střediska v systému Fidoo |
| name | Název | Nazev | Název nákladového střediska |
| state | Stav v systému Fidoo | [viz poznámka] | Stav výdaje nabývá jedné hodnoty ze tří obměn; active (zobrazuje se uživatelům), inactive (nenabízí se uživatelům), nebo deleted (smazán z Fidoo). |
Projekty
/v2/settings/get-projects| Hodnota | Popis | Příklad dat | Poznámka |
|---|---|---|---|
| code | Zkrácený identifikátor v systému Fidoo | NS001 | Zkrácený identifikátor projektu v systému Fidoo |
| id | Unikátní identifikátor v systému Fidoo | 07dcca40-9858-4139-9230-bb86d97cf64e | Unikátní identifikátor projektu v systému Fidoo |
| name | Název | Nazev | Název projektu |
| state | Stav v systému Fidoo | [viz poznámka] | Stav výdaje nabývá jedné hodnoty ze tří obměn; active (zobrazuje se uživatelům), inactive (nenabízí se uživatelům), nebo deleted (smazán z Fidoo). |
Předkontace
/v2/settings/get-account-assignments
| Hodnota | Popis | Příklad dat | Poznámka |
|---|---|---|---|
| id | Unikátní identifikátor v systému Fidoo | 07dcca40-9858-4139-9230-bb86d97cf64e | Unikátní identifikátor předkontace v systému Fidoo |
| code | Zkrácený identifikátor v systému Fidoo | NS001 | Zkrácený identifikátor předkontace v systému Fidoo |
| name | Název | Nazev | Název předkontace |
| description | Popis či poznámka | Upřesňující informace | – |
| debit | Účet MÁ DÁTI | 518001 | – |
| credit | Účet DAL | 321000 | – |
| type | Typ | [viz poznámka] | Typ předkontace nabývá buď hodnoty normal (předkontace), nebo vat (DPH). |
| state | Stav v systému Fidoo | [viz poznámka] | Stav nabývá jedné hodnoty ze tří obměn; active (zobrazuje se uživatelům), inactive (nenabízí se uživatelům), nebo deleted (smazán z Fidoo). |
Vozidla
/v2/settings/get-vehicles| Hodnota | Popis | Příklad dat | Poznámka |
|---|---|---|---|
| vehicleid | Unikátní identifikátor vozidla v systému Fidoo | 11ca5afd-deaf-4578-97d5-5c82bffc0e99 | – |
| ownerid | Unikátní identifikátor uživatele v systému Fidoo, kterému patří vozidlo | 0f7a31d9-c2a8-43f8-99db-a3affe0f6163 | – |
| brand | Značka vozidla | Škoda | – |
| model | Model vozidla | Fabia | – |
| registrationNumber | Registrační značka (RZ) | 5A2 4512 | – |
| vin | VIN (Vehicle Identification Number) kód vozidla | TMBGDM9A1KP042788 | – |
| type | Typ | [viz poznámka] | Typ vozidla nabývá jedné hodnoty ze tří obměn; car (osobní automobil), motorcycle (jednostopé motorové vozidlo), nebo truck (nákladní automobil). |
| ownership | Vlastnictví vozidla | private / company | Vozidlo může být ve vlastnictví buď private (soukromém), nebo company (firemním). |
| usage | Využití vozidla | individual / pool | Vozidlo může být využíváno buď individual (konkrétním uživatelem), nebo pool (sdílené mezi více uživateli). |
| engineVolume | Zdvihový objem motoru vozidla [cm3] | 1198 | – |
| fuelConsumption | Kombinovaná spotřeba paliva [l/100km] | 4.6 | – |
| fuelType | Druh paliva vozidla | natural95 / super98 / diesel / electric / other | Druh paliva vozidla nabývá jedné hodnoty z pěti obměn. |
| state | Stav v systému Fidoo | [viz poznámka] | Stav vozidla nabývá buď hodnoty active (zobrazuje se uživatelům), nebo inactive (nenabízí se uživatelům). |
| price | Pořizovací cena vozidla v CZK | 730000 | Platí pouze pro firemní vozidla. |
| isLowEmission | Nízkoemisní vozidlo | true / false | True (pravda) odpovídá nízkoemisnímu vozidlu. Platí pouze pro firemní vozidla. |
Členění DPH
/v2/settings/get-vat-breakdowns| Hodnota | Popis | Příklad dat | Poznámka |
|---|---|---|---|
| id | Unikátní identifikátor v systému Fidoo | 07dcca40-9858-4139-9230-bb86d97cf64e | Unikátní identifikátor členění DPH v systému Fidoo |
| code | Zkrácený identifikátor v systému Fidoo | NS001 | Zkrácený identifikátor členení DPH v systému Fidoo |
| name | Název | Nazev | Název členění DPH, např. DPH21 |
| state | Stav v systému Fidoo | [viz poznámka] | Stav členění DPH nabývá jedné hodnoty ze tří obměn; active (zobrazuje se uživatelům), inactive (nenabízí se uživatelům), nebo deleted (smazán z Fidoo). |
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.