Výpis žádostí o pracovní cesty a zpráv z uskutečněných cest, včetně podrobností, a jejich hromadné schválení nebo zamítnutí. Prostředí, klíč v hlavičce X-Api-Key, stránkování a čtení tabulek popisuje Public API – základy. Výpisy odpovídají stavu API k 6. 8. 2026, schvalování a zamítání stavu API k 24. 9. 2026.
POST /v2/travel/get-travel-requests
Lze zjistit ID žádosti, typ pracovní cesty, stav žádosti, čas a lokace výchozích a cílových míst cesty a odhadované náhrady a náklady cesty.
Je vrácen výpis žádostí o schválení pracovních cest, který podléhá volaným filtrům.
Volané parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
from | Počáteční datum pro filtrování žádostí o schválení pracovních cest. Uveden ve formátu ISO 8601. | 2023-01-13T13:28:35.382Z |
to | Konečné datum pro filtrování žádostí o schválení pracovních cest. Uveden ve formátu ISO 8601. | 2023-11-13T13:28:35.382Z |
lastModifyFrom | Datum pro filtrování žádostí o schválení pracovních cest podle poslední úpravy. Uvedeno ve formátu ISO 8601. | 2023-11-13T13:28:35.382Z |
closed | Indikátor omezení pozdějších úprav žádostí o schválení pracovních cest. Hodnoty: true = žádost bez možnosti úprav (ve stavu closed); false = žádost s možností úprav (ve stavech prepare/approve/approve2). | false |
limit | Maximální počet vrácených řádků. Výchozí hodnota je 100. | 100 |
offsetToken | Klíč pro vícenásobné volání. Uveden jako hodnota parametru nextOffsetToken vraceného do nabytí stavu "complete": true. | T101 |
Vrácené parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
complete | Stav dokončení kompletního výpisu. Hodnoty: true = výpis je kompletní (dokončen); false = výpis není kompletní. | false |
nextOffsetToken | Klíč pro vícenásobné volání. | T101 |
list | Výpis žádostí o schválení pracovních cest. | – |
· travelRequestId | Unikátní identifikátor žádosti o schválení pracovní cesty. | 27fe8798-07e3-11eb-adc1-0242ac120002 |
· travelRequestShortId | Zkrácený identifikátor žádosti o schválení pracovní cesty. | TQ-2 |
· travelRequestName | Název žádosti o schválení pracovní cesty. | Moje cesta do Prahy |
· travelReportId | Unikátní identifikátor zprávy o uskutečněné služební cestě. | 331a0bd0-0f95-11ea-8d71-362b9e155667 |
· travelReportShortId | Zkrácený identifikátor zprávy o uskutečněné služební cestě. | TR-1 |
· 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. Hodnoty: domestic = Tuzemská; foreign = Zahraniční; mixed = Kombinovaná. | domestic |
· travelRequestState | Stav žádosti o schválení pracovní cesty. Hodnoty: prepare = Otevřená; approve = Ke schválení; approve2 = K 2. schválení; closed = Schválená. | prepare |
· journeyStartDate | Počáteční datum služební cesty (Odjezd). | 2023-09-17T13:28:35.382Z |
· journeyEndDate | Konečné datum služební cesty (Příjezd). | 2023-09-17T13:28:35.382Z |
· journeyStartPoint | Místo začátku služební cesty. | Brno, Česko |
· journeyEndPoint | Místo cíle služební cesty. | Praha, Česko |
· mealAllowanceCzk | Stravné. Uvedená v měně CZK (Korunách českých). | 1000.00 |
· pocketMoneyCzk | Odhad dalších nákladů. Uvedená v měně CZK (Korunách českých). | 2500.00 |
· carAllowanceCzk | Náhrada za soukromé vozidlo. Uvedená v měně CZK (Korunách českých). | 3000.00 |
· fuelAllowanceCzk | Náhrada za palivo. Uvedená v měně CZK (Korunách českých). | 4000.00 |
· travelRequestTotal | Předpokládané cestovní náklady. Uvedená v měně CZK (Korunách českých). | 10500.00 |
· journeyNote | Poznámka ke služební cestě. | Přivezu frgál |
· requestCreated | Časové razítko vytvoření žádosti o schválení pracovní cesty. | 2023-09-17T13:28:35.382Z |
· createdBy | Unikátní identifikátor uživatele v systému Fidoo, který vytvořil žádosti o schválení pracovní cesty. | 27fe8798-07e3-11eb-adc1-0242ac120002 |
· 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 peněz na cestu. Uvedená v měně CZK (Korunách českých). | 200.21 |
· depositType | Způsob výplaty peněz na cestu. Hodnoty: cash = Vyplatit v hotovosti; card = Nabít na kartu. | cash |
· depositCurrency | Měna peněz na cestu. Uvedena ve formátu ISO 4217. | CZK |
· lastEditDateTime | Časové razítko poslední úpravy žádosti o schválení pracovní cesty. Uvedeno ve formátu ISO 8601. | 2024-01-12T11:55:48.478Z |
POST /v2/travel/get-travel-request-detail
Lze zjistit informace o cestě, trase a odhadovaných dalších nákladech, které jsou součástí volané žádosti o schválení pracovní cesty.
Je vrácen výpis cest, dílčích míst trasy a odhadovaných dalších nákladů, které budou uskutečněny v rámci jedné žádosti o schválení pracovní cesty.
Volané parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
travelRequestId (povinné) | Unikátní identifikátor žádosti o schválení pracovní cesty v systému Fidoo. | 27fe8798-07e3-11eb-adc1-0242ac120002 |
Vrácené parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
trips | Výpis cest. | – |
· tripId | Unikátní identifikátor cesty v systému Fidoo. | 27fe8798-07e3-11eb-adc1-0242ac120002 |
· startDate | Datum začátku cesty. Uvedeno ve formátu ISO 8601. | 2022-09-17T13:28:35.382Z |
· endDate | Datum konce cesty. Uvedeno ve formátu ISO 8601. | 2022-09-18T19:01:44.382Z |
· startPoint | Výchozí místo cesty. | Praha, Česko |
· endPoint | Konečné místo cesty. | Brno, Česko |
· parts | Výpis dílčích míst cesty. | – |
·· arrival | Datum příjezdu na místo. Uvedeno ve formátu ISO 8601. | 2022-09-18T14:56:12.382Z |
·· departure | Datum odjezdu z místa. Uvedeno ve formátu ISO 8601. | 2022-09-18T15:14:58.382Z |
·· location | Název místa. | Jihlava, Česko |
·· country | Identifikátor země. Uvedeno ve formátu ISO 3166 Alpha-2. | CZ |
travelReportId | Unikátní identifikátor zprávy o uskutečněné služební cestě v systému Fidoo. | 331a0bd0-0f95-11ea-8d71-362b9e155667 |
estimatedTransportCost | Odhad dalších nákladů na dopravu. | – |
· estimatedCost | Částka odhadovaných dalších nákladů na dopravu. | 476 |
· currency | Měna odhadovaných dalších nákladů na dopravu. Uvedena ve formátu ISO 4217. | CZK |
estimatedAccommodationCost | Odhad dalších nákladů na ubytování. | – |
· estimatedCost | Částka odhadovaných dalších nákladů na ubytování. | 2349 |
· currency | Měna odhadovaných dalších nákladů na ubytování. Uvedena ve formátu ISO 4217. | CZK |
estimatedOtherCost | Odhad ostatních dalších nákladů. | – |
· estimatedCost | Částka ostatních odhadovaných dalších nákladů. | 23 |
· currency | Měna ostatních odhadovaných dalších nákladů. Uvedena ve formátu ISO 4217. | CZK |
POST /v2/travel/approve-travel-requests
Public API klíč musí být vystaven na uživatele Fidoo, který je u dané žádosti nastaven jako schvalovatel, případně disponuje klíčovou rolí Účetní: ve stavu approve (Ke schválení) žádost schvaluje její první schvalovatel, ve stavu approve2 (K 2. schválení) její druhý schvalovatel, uživatel s rolí Účetní v obou stavech. Doporučujeme proto klíč vystavit na uživatele s klíčovou rolí Účetní, který pokryje všechny přechody stavů. Klíč musí být typu Ke čtení i k zápisu. Práva rolí se přenášejí na vystavený API klíč.
Umožňuje hromadné schválení žádostí. V případě dvouúrovňového schvalování jsou povolené následující přechody stavů: approve (Ke schválení) → approve2 (K 2. schválení), approve2 (K 2. schválení) → closed (Schválená). V případě jednoúrovňového schvalování je povolený následující přechod stavů: approve (Ke schválení) → closed (Schválená).
Vracena jsou všechna travelOrderId z přijatého bulku. Pakliže dojde k úspěšnému schválení žádosti, je travelOrderId doplněno o parametr state, který potvrdí nový stav, do kterého žádost přešla. V opačném případě je travelOrderId doplněno o parametr errorMessage a parametr state je null. Všechna neschválená travelOrderId jsou současně vypsána v seznamu parametru failedTravelOrderIds. V obou případech je výsledný stav uveden pod parametrem status.
Volané parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
travelRequests (povinné) | Výpis žádostí. | – |
· travelRequestId (povinné) | Unikátní identifikátor žádosti o pracovní cestu v systému Fidoo. Maximální limit je 20 travelRequestId na 1 volání. | 6417d750-2f6a-11e9-b210-d663bd873d93 |
· note | Poznámka ke schválení. Maximální délka: 1 000 znaků. | Schváleno integrací |
Vrácené parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
travelOrders | Výpis žádostí. | – |
· travelOrderId | Unikátní identifikátor žádosti o pracovní cestu v systému Fidoo. | 6417d750-2f6a-11e9-b210-d663bd873d93 |
· errorMessage | Chybová zpráva pro konkrétní travelOrderId. Když bez chyby, pak je vráceno null. | Travel order state not allowed: prepare |
· state | Výsledný stav po akci. Když akce selže, je vráceno null. Hodnoty: prepare = Otevřená; approve = Ke schválení; approve2 = K 2. schválení; closed = Schválená. | approve2 |
metadata | Výpis metadat. | – |
· status | Výsledný stav za celé volání. Hodnoty: SUCCESS = všechny žádosti jsou schváleny; FAILED = žádná ze žádostí není schválena; PARTIAL_SUCCESS = alespoň jedna žádost není schválena, ostatní schváleny. | PARTIAL_SUCCESS |
· errorId | Unikátní identifikátor chybového stavu v systému Fidoo. Když bez chyby, pak je vráceno null. | prod-f1b46317-cc6c-45fc-ae70-5b9f553c92bb |
· timestamp | Časové razítko provedení operace. Uvedeno ve formátu ISO 8601. | 2023-08-24T22:00:00.000Z |
· failedTravelOrderIds | Seznam unikátních identifikátorů odeslaných položek, u kterých akce neproběhla. | 6417d750-2f6a-11e9-b210-d663bd873d93 |
POST /v2/travel/reject-travel-requests
Public API klíč musí být vystaven na uživatele Fidoo, který je u dané žádosti nastaven jako schvalovatel, případně disponuje klíčovou rolí Účetní: ve stavu approve (Ke schválení) žádost schvaluje její první schvalovatel, ve stavu approve2 (K 2. schválení) její druhý schvalovatel, uživatel s rolí Účetní v obou stavech. Doporučujeme proto klíč vystavit na uživatele s klíčovou rolí Účetní, který pokryje všechny přechody stavů. Klíč musí být typu Ke čtení i k zápisu. Práva rolí se přenášejí na vystavený API klíč.
Umožňuje hromadné zamítnutí žádostí. Povolené jsou následující přechody stavů: approve (Ke schválení) → prepare (Otevřená–vrácená), approve2 (K 2. schválení) → prepare (Otevřená–vrácená).
Vracena jsou všechna travelOrderId z přijatého bulku. Pakliže dojde k úspěšnému zamítnutí žádosti, je travelOrderId doplněno o parametr state, který potvrdí nový stav, do kterého žádost přešla. V opačném případě je travelOrderId doplněno o parametr errorMessage a parametr state je null. Všechna nezamítnutá travelOrderId jsou současně vypsána v seznamu parametru failedTravelOrderIds. V obou případech je výsledný stav uveden pod parametrem status.
Volané parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
travelRequests (povinné) | Výpis žádostí. | – |
· travelRequestId (povinné) | Unikátní identifikátor žádosti o pracovní cestu v systému Fidoo. Maximální limit je 20 travelRequestId na 1 volání. | 6417d750-2f6a-11e9-b210-d663bd873d93 |
· note (povinné) | Důvod zamítnutí. Maximální délka: 1 000 znaků. | Chybí doklady |
Vrácené parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
travelOrders | Výpis žádostí. | – |
· travelOrderId | Unikátní identifikátor žádosti o pracovní cestu v systému Fidoo. | 6417d750-2f6a-11e9-b210-d663bd873d93 |
· errorMessage | Chybová zpráva pro konkrétní travelOrderId. Když bez chyby, pak je vráceno null. | Travel order state not allowed: closed |
· state | Výsledný stav po akci. Když akce selže, je vráceno null. Hodnoty: prepare = Otevřená; approve = Ke schválení; approve2 = K 2. schválení; closed = Schválená. | prepare |
metadata | Výpis metadat. | – |
· status | Výsledný stav za celé volání. Hodnoty: SUCCESS = všechny žádosti jsou zamítnuty; FAILED = žádná ze žádostí není zamítnuta; PARTIAL_SUCCESS = alespoň jedna žádost není zamítnuta, ostatní zamítnuty. | PARTIAL_SUCCESS |
· errorId | Unikátní identifikátor chybového stavu v systému Fidoo. Když bez chyby, pak je vráceno null. | prod-f1b46317-cc6c-45fc-ae70-5b9f553c92bb |
· timestamp | Časové razítko provedení operace. Uvedeno ve formátu ISO 8601. | 2023-08-24T22:00:00.000Z |
· failedTravelOrderIds | Seznam unikátních identifikátorů odeslaných položek, u kterých akce neproběhla. | 6417d750-2f6a-11e9-b210-d663bd873d93 |
POST /v2/travel/get-travel-reports
Lze zjistit ID zprávy, typ služební cesty, stav zprávy, čas a lokace výchozích a cílových míst cesty a odhadované náhrady a náklady cesty.
Je vrácen výpis zpráv o uskutečněných služebních cestách, který podléhá volaným filtrům.
Volané parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
from | Počáteční datum pro filtrování zpráv o uskutečněných služebních cestách. Uveden ve formátu ISO 8601. | 2023-01-13T13:28:35.382Z |
to | Konečné datum pro filtrování zpráv o uskutečněných služebních cestách. Uveden ve formátu ISO 8601. | 2023-11-13T13:28:35.382Z |
lastModifyFrom | Datum pro filtrování zpráv o uskutečněných služebních cestách podle poslední úpravy. Uvedeno ve formátu ISO 8601. | 2023-11-13T13:28:35.382Z |
closed | Indikátor omezení pozdějších úprav zpráv o uskutečněných služebních cestách. Hodnoty: true = zpráva bez možnosti úprav (ve stavu personalBill/export/exported); false = zpráva s možností úprav (ve stavech prepare/approve/approve2/accountantApprove). | false |
limit | Maximální počet vrácených řádků. Výchozí hodnota je 100. | 100 |
offsetToken | Klíč pro vícenásobné volání. Uveden jako hodnota parametru nextOffsetToken vraceného do nabytí stavu "complete": true. | T101 |
state | Stav zpráv o uskutečněných služebních cestách. Hodnoty: prepare = Otevřený (Cesťák–zpráva, který je doposud nezpracovaný nebo vrácený zpět uživateli); approve = Ke schválení (Cesťák–zpráva čekající na schválení prvním schvalovatelem); approve2 = K 2. schválení (Cesťák–zpráva čekající na schválení druhým schvalovatelem); accountantApprove = K uzavření (Cesťák–zpráva čekající na uzavření účetní); personalBill = Uzavřený (Cesťák–zpráva otevřeného osobního vyúčtování účetní, Čeká na uzavření celého vyúčtování účetní; export = Vyúčtovaný (Cesťák–zpráva a připravený k prvnímu exportu v Účetní agendě); exported = Exportovaný (Cesťák–zpráva v Účetní agendě). | prepare |
Vrácené parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
complete | Stav dokončení kompletního výpisu. Hodnoty: true = výpis je kompletní (dokončen); false = výpis není kompletní. | false |
nextOffsetToken | Klíč pro vícenásobné volání. | T101 |
list | Výpis zpráv o uskutečněných služebních cestách. | – |
· travelReportId | Unikátní identifikátor zprávy o uskutečněné služební cestě. | 331a0bd0-0f95-11ea-8d71-362b9e155667 |
· travelReportShortId | Zkrácený identifikátor zprávy o uskutečněné služební cestě. | TR-1 |
· travelReportName | Název zprávy o uskutečněné služební cestě. | Moje cesta do Prahy |
· 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. Hodnoty: domestic = Tuzemská; foreign = Zahraniční; mixed = Kombinovaná. | domestic |
· travelReportState | Stav zprávy o uskutečněné služební cestě. Hodnoty: prepare = Otevřený (Cesťák–zpráva, který je doposud nezpracovaný nebo vrácený zpět uživateli); approve = Ke schválení (Cesťák–zpráva čekající na schválení prvním schvalovatelem); approve2 = K 2. schválení (Cesťák–zpráva čekající na schválení druhým schvalovatelem); accountantApprove = K uzavření (Cesťák–zpráva čekající na uzavření účetní); personalBill = Uzavřený (Cesťák–zpráva otevřeného osobního vyúčtování účetní, Čeká na uzavření celého vyúčtování účetní; export = Vyúčtovaný (Cesťák–zpráva a připravený k prvnímu exportu v Účetní agendě); exported = Exportovaný (Cesťák–zpráva v Účetní agendě). | prepare |
· closed | Indikátor omezení pozdějších úprav zprávy o uskutečněné služební cestě. Hodnoty: true = zpráva bez možnosti úprav (ve stavu personalBill/export/exported); false = zpráva s možností úprav (ve stavech prepare/approve/approve2/accountantApprove). | false |
· journeyStartDate | Počáteční datum služební cesty (Odjezd). | 2023-09-17T13:28:35.382Z |
· journeyEndDate | Konečné datum služební cesty (Příjezd). | 2023-09-17T13:28:35.382Z |
· journeyStartPoint | Místo začátku služební cesty. | Brno, Česko |
· journeyEndPoint | Místo cíle služební cesty. | Praha, Česko |
· mealAllowanceCzk | Stravné. Uvedená v měně CZK (Korunách českých). | 1000.00 |
· pocketMoneyCzk | Odhad dalších nákladů. Uvedená v měně CZK (Korunách českých). | 2500.00 |
· carAllowanceCzk | Náhrada za soukromé vozidlo. Uvedená v měně CZK (Korunách českých). | 3000.00 |
· fuelAllowanceCzk | Náhrada za palivo. Uvedená v měně CZK (Korunách českých). | 4000.00 |
· travelRequestTotal | Předpokládané cestovní náklady. Uvedená v měně CZK (Korunách českých). | 10500.00 |
· journeyNote | Poznámka ke služební cestě. | Přivezu frgál |
· reportCreated | Časové razítko vytvoření zprávy o uskutečněné služební cestě. | 2023-09-17T13:28:35.382Z |
· createdBy | Unikátní identifikátor uživatele v systému Fidoo, který vytvořil zprávu o uskutečněné služební cestě. | 27fe8798-07e3-11eb-adc1-0242ac120002 |
· travelRequestId | Unikátní identifikátor žádosti o schválení pracovní cesty. | 27fe8798-07e3-11eb-adc1-0242ac120002 |
· travelRequestShortId | Zkrácený identifikátor žádosti o schválení pracovní cesty. | TQ-2 |
· 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 peněz na cestu. Uvedená v měně CZK (Korunách českých). | 200.21 |
· depositType | Způsob výplaty peněz na cestu. Hodnoty: cash = Vyplatit v hotovosti; card = Nabít na kartu. | cash |
· depositCurrency | Měna peněz na cestu. Uvedena ve formátu ISO 4217. | CZK |
· lastEditDateTime | Časové razítko poslední úpravy zprávy o uskutečněné služební cestě. Uvedeno ve formátu ISO 8601. | 2024-01-12T11:55:48.478Z |
POST /v2/travel/get-travel-report-detail
Lze zjistit informace o cestě a trase, které jsou součástí volané zprávy o uskutečněné služební cestě.
Je vrácen výpis cest a dílčích míst trasy uskutečněných v rámci jedné zprávy o uskutečněné služební cestě.
Volané parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
travelReportId (povinné) | Unikátní identifikátor zprávy o uskutečněné služební cestě v systému Fidoo. | 331a0bd0-0f95-11ea-8d71-362b9e155667 |
Vrácené parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
trips | Výpis cest. | – |
· tripId | Unikátní identifikátor cesty v systému Fidoo. | 27fe8798-07e3-11eb-adc1-0242ac120002 |
· startDate | Datum začátku cesty. Uvedeno ve formátu ISO 8601. | 2022-09-17T13:28:35.382Z |
· endDate | Datum konce cesty. Uvedeno ve formátu ISO 8601. | 2022-09-18T19:01:44.382Z |
· startPoint | Výchozí místo cesty. | Praha, Česko |
· endPoint | Konečné místo cesty. | Brno, Česko |
· parts | Výpis dílčích míst cesty. | – |
·· arrival | Datum příjezdu na místo. Uvedeno ve formátu ISO 8601. | 2022-09-18T14:56:12.382Z |
·· departure | Datum odjezdu z místa. Uvedeno ve formátu ISO 8601. | 2022-09-18T15:14:58.382Z |
·· location | Název místa. | Jihlava, Česko |
·· country | Identifikátor země. Uvedeno ve formátu ISO 3166 Alpha-2. | CZ |
travelRequestId | Unikátní identifikátor žádosti o schválení pracovní cesty v systému Fidoo. | 27fe8798-07e3-11eb-adc1-0242ac120002 |
POST /v2/travel/approve-travel-reports
Public API klíč musí být vystaven na uživatele Fidoo, který je u dané zprávy nastaven jako schvalovatel, případně disponuje klíčovou rolí Účetní: ve stavu approve (Ke schválení) zprávu schvaluje její první schvalovatel, ve stavu approve2 (K 2. schválení) její druhý schvalovatel, uživatel s rolí Účetní v obou stavech; ve stavu accountantApprove (K uzavření) pouze uživatel s rolí Účetní. Doporučujeme proto klíč vystavit na uživatele s klíčovou rolí Účetní, který pokryje všechny přechody stavů. Klíč musí být typu Ke čtení i k zápisu. Práva rolí se přenášejí na vystavený API klíč.
Umožňuje hromadné schválení zpráv. V případě dvouúrovňového schvalování jsou povolené následující přechody stavů: approve (Ke schválení) → approve2 (K 2. schválení), approve2 (K 2. schválení) → accountantApprove (K uzavření), accountantApprove (K uzavření) → personalBill (Uzavřený). V případě jednoúrovňového schvalování jsou povolené následující přechody stavů: approve (Ke schválení) → accountantApprove (K uzavření), accountantApprove (K uzavření) → personalBill (Uzavřený).
Vracena jsou všechna travelOrderId z přijatého bulku. Pakliže dojde k úspěšnému schválení zprávy, je travelOrderId doplněno o parametr state, který potvrdí nový stav, do kterého zpráva přešla. V opačném případě je travelOrderId doplněno o parametr errorMessage a parametr state je null. Všechna neschválená travelOrderId jsou současně vypsána v seznamu parametru failedTravelOrderIds. V obou případech je výsledný stav uveden pod parametrem status.
Volané parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
travelReports (povinné) | Výpis zpráv. | – |
· travelReportId (povinné) | Unikátní identifikátor zprávy o uskutečněné služební cestě v systému Fidoo. Maximální limit je 20 travelReportId na 1 volání. | 6417d750-2f6a-11e9-b210-d663bd873d93 |
· note | Poznámka ke schválení. Maximální délka: 1 000 znaků. | Schváleno integrací |
Vrácené parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
travelOrders | Výpis zpráv. | – |
· travelOrderId | Unikátní identifikátor zprávy o uskutečněné služební cestě v systému Fidoo. | 6417d750-2f6a-11e9-b210-d663bd873d93 |
· errorMessage | Chybová zpráva pro konkrétní travelOrderId. Když bez chyby, pak je vráceno null. | Travel order state not allowed: prepare |
· state | Výsledný stav po akci. Když akce selže, je vráceno null. Hodnoty: prepare = Otevřený (Cesťák–zpráva, který je doposud nezpracovaný nebo vrácený zpět uživateli); approve = Ke schválení (Cesťák–zpráva čekající na schválení prvním schvalovatelem); approve2 = K 2. schválení (Cesťák–zpráva čekající na schválení druhým schvalovatelem); accountantApprove = K uzavření (Cesťák–zpráva čekající na uzavření účetní); personalBill = Uzavřený (Cesťák–zpráva otevřeného osobního vyúčtování účetní, Čeká na uzavření celého vyúčtování účetní; export = Vyúčtovaný (Cesťák–zpráva a připravený k prvnímu exportu v Účetní agendě); exported = Exportovaný (Cesťák–zpráva v Účetní agendě). | accountantApprove |
metadata | Výpis metadat. | – |
· status | Výsledný stav za celé volání. Hodnoty: SUCCESS = všechny zprávy jsou schváleny; FAILED = žádná ze zpráv není schválena; PARTIAL_SUCCESS = alespoň jedna zpráva není schválena, ostatní schváleny. | PARTIAL_SUCCESS |
· errorId | Unikátní identifikátor chybového stavu v systému Fidoo. Když bez chyby, pak je vráceno null. | prod-f1b46317-cc6c-45fc-ae70-5b9f553c92bb |
· timestamp | Časové razítko provedení operace. Uvedeno ve formátu ISO 8601. | 2023-08-24T22:00:00.000Z |
· failedTravelOrderIds | Seznam unikátních identifikátorů odeslaných položek, u kterých akce neproběhla. | 6417d750-2f6a-11e9-b210-d663bd873d93 |
POST /v2/travel/reject-travel-reports
Public API klíč musí být vystaven na uživatele Fidoo, který je u dané zprávy nastaven jako schvalovatel, případně disponuje klíčovou rolí Účetní: ve stavu approve (Ke schválení) zprávu schvaluje její první schvalovatel, ve stavu approve2 (K 2. schválení) její druhý schvalovatel, uživatel s rolí Účetní v obou stavech; ve stavu accountantApprove (K uzavření) pouze uživatel s rolí Účetní. Doporučujeme proto klíč vystavit na uživatele s klíčovou rolí Účetní, který pokryje všechny přechody stavů. Klíč musí být typu Ke čtení i k zápisu. Práva rolí se přenášejí na vystavený API klíč.
Umožňuje hromadné zamítnutí zpráv. V případě dvouúrovňového schvalování jsou povolené následující přechody stavů: approve (Ke schválení) → prepare (Otevřený–vrácený), approve2 (K 2. schválení) → prepare (Otevřený–vrácený), accountantApprove (K uzavření) → prepare (Otevřený–vrácený). V případě jednoúrovňového schvalování jsou povolené následující přechody stavů: approve (Ke schválení) → prepare (Otevřený–vrácený), accountantApprove (K uzavření) → prepare (Otevřený–vrácený).
Vracena jsou všechna travelOrderId z přijatého bulku. Pakliže dojde k úspěšnému zamítnutí zprávy, je travelOrderId doplněno o parametr state, který potvrdí nový stav, do kterého zpráva přešla. V opačném případě je travelOrderId doplněno o parametr errorMessage a parametr state je null. Všechna nezamítnutá travelOrderId jsou současně vypsána v seznamu parametru failedTravelOrderIds. V obou případech je výsledný stav uveden pod parametrem status.
Volané parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
travelReports (povinné) | Výpis zpráv. | – |
· travelReportId (povinné) | Unikátní identifikátor zprávy o uskutečněné služební cestě v systému Fidoo. Maximální limit je 20 travelReportId na 1 volání. | 6417d750-2f6a-11e9-b210-d663bd873d93 |
· note (povinné) | Důvod zamítnutí. Maximální délka: 1 000 znaků. | Chybí doklady |
Vrácené parametry
| Parametr | Popis | Vzor dat |
|---|---|---|
travelOrders | Výpis zpráv. | – |
· travelOrderId | Unikátní identifikátor zprávy o uskutečněné služební cestě v systému Fidoo. | 6417d750-2f6a-11e9-b210-d663bd873d93 |
· errorMessage | Chybová zpráva pro konkrétní travelOrderId. Když bez chyby, pak je vráceno null. | Travel order state not allowed: exported |
· state | Výsledný stav po akci. Když akce selže, je vráceno null. Hodnoty: prepare = Otevřený (Cesťák–zpráva, který je doposud nezpracovaný nebo vrácený zpět uživateli); approve = Ke schválení (Cesťák–zpráva čekající na schválení prvním schvalovatelem); approve2 = K 2. schválení (Cesťák–zpráva čekající na schválení druhým schvalovatelem); accountantApprove = K uzavření (Cesťák–zpráva čekající na uzavření účetní); personalBill = Uzavřený (Cesťák–zpráva otevřeného osobního vyúčtování účetní, Čeká na uzavření celého vyúčtování účetní; export = Vyúčtovaný (Cesťák–zpráva a připravený k prvnímu exportu v Účetní agendě); exported = Exportovaný (Cesťák–zpráva v Účetní agendě). | prepare |
metadata | Výpis metadat. | – |
· status | Výsledný stav za celé volání. Hodnoty: SUCCESS = všechny zprávy jsou zamítnuty; FAILED = žádná ze zpráv není zamítnuta; PARTIAL_SUCCESS = alespoň jedna zpráva není zamítnuta, ostatní zamítnuty. | PARTIAL_SUCCESS |
· errorId | Unikátní identifikátor chybového stavu v systému Fidoo. Když bez chyby, pak je vráceno null. | prod-f1b46317-cc6c-45fc-ae70-5b9f553c92bb |
· timestamp | Časové razítko provedení operace. Uvedeno ve formátu ISO 8601. | 2023-08-24T22:00:00.000Z |
· failedTravelOrderIds | Seznam unikátních identifikátorů odeslaných položek, u kterých akce neproběhla. | 6417d750-2f6a-11e9-b210-d663bd873d93 |
Byl tento článek užitečný?