Zakázky a výjezdy

Order

Informace o zakázce

idstring(GUID)

externalIdstring

createdstring(DateTime)

Datum vytvoření

modifiedstring(DateTime)

Datum poslední úpravy

codestring

Číslo zakázky

namestring

Název zakázky

requestedDatestring(DateTime)

Požadované datum (vyplňuje zákazník, pokud mu přijde žádost o doplnění informací)

estimatedDurationinteger

Odhadovaná doba trvání v minutách

customerIdstring(GUID)

ID zákazníka (Customer)

customerNamestring

Název zákazníka (Customer)

addressIdstring(GUID)

ID Adresy zakázky (CustomerAddress)

addressCustomerAddress

Adresa zakázky (CustomerAddress)

contactPersonIdstring(GUID)

ID Kontaktní osoby (ContactPerson)

contactPersonContactPerson

Kontaktní osoba (ContactPerson)

categoryIdstring(GUID)

ID Kategorie zakázky (OrderCategory)

categoryNamestring

Název kategorie zakázky (OrderCategory)

ownerIdstring(GUID)

ID vlastníka (User). Vlastník je automaticky dispečer, který zakázku založil. V případě založení zakázky systémem (např. přes API, nebo automaticky pro pravidelný servis) je vlastníkem zakázky administrátor firmy.

ownerNamestring

Celé jméno vlastníka (User). Vlastník je automaticky dispečer, který zakázku založil. V případě založení zakázky systémem (např. přes API, nebo automaticky pro pravidelný servis) je vlastníkem zakázky administrátor firmy.

priorityOrderPriority

Priorita zakázky (OrderPriority)

stateOrderState

Stav zakázky (OrderState)

customStateIdstring(GUID)

ID Vlastního stavu zakázky (OrderCustomState)

customStateNamestring

Název Vlastního stavu zakázky (OrderCustomState)

waitingForCustomerInfoboolean

Čeká na zákazníka. Může nastat např. v případě pravidelného servisu nebo po manuální k “požádání zákazníka o doplnění”.

hasInterventionsboolean

Zakázka s aktivním výjezdem je zakázka, která má alespoň jeden výjezd ve stavu Naplánovaný, Probíhající, Čeká na podpis nebo Čeká na schválení.

completedAtstring(DateTime)

Datum dokončení zakázky

cancelledAtstring(DateTime)

Datum zrušení zakázky

cancelReasonstring

Důvod zrušení zakázky

cancelledByIdstring(GUID)

ID uživatele (dispečera), který zrušil zakázku (User)

cancelledByNamestring

Celé jméno uživatele (dispečera), který zrušil zakázku (User)

problemDescriptionFromCustomerstring

Popis požadavku od zákazníka

internalNotestring

Interní poznámka

interventionsInterventionInOrder[]

Všechny výjezdy (InterventionInOrder) k dané zakázce

Upozornění

V budoucích verzích API se množství informací o výjezdu v zakázce sníží. V plánu bude nový endpoint pro získání detailu výjezdu pro konkrétní zakázku.

totalPricedecimal

Součet ceny cestovného, práce a materiálu.
Pouze u zakázek s alespoň jedním dokončeným výjezdem.

travelPricedecimal

Celková cena za cestu.
Pouze u zakázek s alespoň jedním dokončeným výjezdem.

travelDistanceinteger

Celkový počet vykázaných kilometrů.
Pouze u zakázek s alespoň jedním dokončeným výjezdem.

workPricedecimal

Celková cena vykázané práce.
Pouze u zakázek s alespoň jedním dokončeným výjezdem.

workHoursdecimal

Celkový počet hodin vykázané práce.
Pouze u zakázek s alespoň jedním dokončeným výjezdem.

materialPricedecimal

Celková cena vykázaného materiálu.
Pouze u zakázek s alespoň jedním dokončeným výjezdem.

materialCountdecimal

Celkový počet jednotek vykázaného materiálu.
Pouze u zakázek s alespoň jedním dokončeným výjezdem.

OrderDetail

Detailní informace o zakázce

idstring(GUID)

externalIdstring

createdstring(DateTime)

Datum vytvoření

modifiedstring(DateTime)

Datum poslední úpravy

codestring

Číslo zakázky

namestring

Název zakázky

requestedDatestring(DateTime)

Požadované datum (vyplňuje zákazník, pokud mu přijde žádost o doplnění informací)

estimatedDurationinteger

Odhadovaná doba trvání v minutách

customerIdstring(GUID)

ID zákazníka (Customer)

customerNamestring

Název zákazníka (Customer)

invoiceCustomerIdstring(GUID)

ID Objednatele (Customer)

addressIdstring(GUID)

ID Adresy zakázky (CustomerAddress)

addressCustomerAddress

Adresa zakázky (CustomerAddress)

contactPersonIdstring(GUID)

ID Kontaktní osoby (ContactPerson)

contactPersonContactPerson

Kontaktní osoba (ContactPerson)

categoryIdstring(GUID)

ID Kategorie zakázky (OrderCategory)

categoryNamestring

Název kategorie zakázky (OrderCategory)

ownerIdstring(GUID)

ID vlastníka (User). Vlastník je automaticky dispečer, který zakázku založil. V případě založení zakázky systémem (např. přes API, nebo automaticky pro pravidelný servis) je vlastníkem zakázky administrátor firmy.

ownerNamestring

Celé jméno vlastníka (User). Vlastník je automaticky dispečer, který zakázku založil. V případě založení zakázky systémem (např. přes API, nebo automaticky pro pravidelný servis) je vlastníkem zakázky administrátor firmy.

priorityOrderPriority

Priorita zakázky (OrderPriority)

stateOrderState

Stav zakázky (OrderState)

customStateIdstring(GUID)

ID Vlastního stavu zakázky (OrderCustomState)

customStateNamestring

Název Vlastního stavu zakázky (OrderCustomState)

waitingForCustomerInfoboolean

Čeká na zákazníka. Může nastat např. v případě pravidelného servisu nebo po manuální k “požádání zákazníka o doplnění”.

hasInterventionsboolean

Zakázka s aktivním výjezdem je zakázka, která má alespoň jeden výjezd ve stavu Naplánovaný, Probíhající, Čeká na podpis nebo Čeká na schválení.

completedAtstring(DateTime)

Datum dokončení zakázky

cancelledAtstring(DateTime)

Datum zrušení zakázky

cancelReasonstring

Důvod zrušení zakázky

cancelledByIdstring(GUID)

ID uživatele (dispečera), který zrušil zakázku (User)

cancelledByNamestring

Celé jméno uživatele (dispečera), který zrušil zakázku (User)

problemDescriptionFromCustomerstring

Popis požadavku od zákazníka

internalNotestring

Interní poznámka

customDatastring(JSON)

Dodatečná data k zakázce ve formátu JSON

interventionsInterventionInOrder[]

Všechny výjezdy (InterventionInOrder) k dané zakázce

Upozornění

V budoucích verzích API se množství informací o výjezdu v zakázce sníží. V plánu bude nový endpoint pro získání detailu výjezdu pro konkrétní zakázku.

serviceObjectsServiceObjectInOrder[]

Zařízení (ServiceObjectInOrder), která jsou součástí zakázky. Všechny zařízení navázané na formuláře musí být v tomto seznamu. (ServiceObjectInOrder)

attachmentsAttachment[]

Přílohy pro zakázku (Attachment)

travelCostsTravelCostItem[]

Položky cestovného ze všech formulářů z dokončených výjezdů v rámci zakázky (TravelCostItem)

workTableWorkTableItem[]

Položky výkazů práce ze všech formulářů z dokončených výjezdů v rámci zakázky (WorkTableItem)

usedMaterialUsedMaterialItem[]

Položky materiálu ze všech formulářů z dokončených výjezdů v rámci zakázky (UsedMaterialItem)

totalPricedecimal

Součet ceny cestovného, práce a materiálu.
Pouze u zakázek s alespoň jedním dokončeným výjezdem.

travelPricedecimal

Celková cena za cestu.
Pouze u zakázek s alespoň jedním dokončeným výjezdem.

travelDistanceinteger

Celkový počet vykázaných kilometrů.
Pouze u zakázek s alespoň jedním dokončeným výjezdem.

workPricedecimal

Celková cena vykázané práce.
Pouze u zakázek s alespoň jedním dokončeným výjezdem.

workHoursdecimal

Celkový počet hodin vykázané práce.
Pouze u zakázek s alespoň jedním dokončeným výjezdem.

materialPricedecimal

Celková cena vykázaného materiálu.
Pouze u zakázek s alespoň jedním dokončeným výjezdem.

materialCountdecimal

Celkový počet jednotek vykázaného materiálu.
Pouze u zakázek s alespoň jedním dokončeným výjezdem.

OrderRequest

Informace o požadavku

idstring(GUID)

externalIdstring

createdstring(DateTime)

Datum vytvoření

modifiedstring(DateTime)

Datum poslední úpravy

customerKindCustomerKind

Druh zákazníka (CustomerKind)

customerNamestring

Název zákazníka - v případě zákazníka typu Household jde o jméno a příjmení, v případě typu Company by mělo jít o název firmy

identificationNumberstring

IČ zákazníka

firstNamestring

Křestní jméno zákazníka

lastNamestring

Příjmení zákazníka

phonePhoneNumber

Telefonní číslo (PhoneNumber)

emailstring(Email)

Emailová adresa

oneLineAddressstring

Adresa ve formátu ulice a ČP, město, PSČ

serviceObjectNamestring

Název zařízení

serviceObjectIdentificationNumberstring

Výrobní číslo zařízení

descriptionstring

Popis požadavku

creationSourceOrderRequestCreationSource

Způsob založení požadavku (OrderRequestCreationSource)

categoryIdstring(GUID)

ID Kategorie požadavku (OrderRequestCategory)

categoryNamestring

Název kategorie požadavku (OrderRequestCategory)

requestedDatestring(DateTime)

Požadované datum

stateOrderRequestState

Stav požadavku (OrderRequestState)

customStateIdstring(GUID)

ID Vlastního stavu požadavku (OrderRequestCustomState)

customStateNamestring

Název Vlastního stavu požadavku (OrderRequestCustomState)

priorityOrderRequestPriority

Priorita požadavku (OrderRequestPriority)

internalNotestring

Interní poznámka

ownerIdstring(GUID)

ID vlastníka (User). V případě založení přes externí formulář a přes veřejné API je vlastník ve výchozím stavu nenastaven. V případě založení v aplikaci je vlastníkem uživatel, který požadavek založil.

OrderRequestDetail

Detailní informace o požadavku

idstring(GUID)

externalIdstring

createdstring(DateTime)

Datum vytvoření

modifiedstring(DateTime)

Datum poslední úpravy

customerKindCustomerKind

Druh zákazníka (CustomerKind)

customerNamestring

Název zákazníka - v případě zákazníka typu Household jde o jméno a příjmení, v případě typu Company by mělo jít o název firmy

identificationNumberstring

IČ zákazníka

firstNamestring

Křestní jméno zákazníka

lastNamestring

Příjmení zákazníka

phonePhoneNumber

Telefonní číslo (PhoneNumber)

emailstring(Email)

Emailová adresa

streetstring

Ulice a ČP

citystring

Město

postalCodestring

PSČ

countrystring

coordinatesGeoCoordinate

Zeměpisné souřdnice (GeoCoordinate)

attachmentsAttachment[]

Přílohy pro požadavek (Attachment)

ordersOrderInOrderRequest[]

Zakázky, na které je požadavek navázán (OrderInOrderRequest)

serviceObjectNamestring

Název zařízení

serviceObjectIdentificationNumberstring

Výrobní číslo zařízení

descriptionstring

Popis požadavku

creationSourceOrderRequestCreationSource

Způsob založení požadavku (OrderRequestCreationSource)

categoryIdstring(GUID)

ID Kategorie požadavku (OrderRequestCategory)

categoryNamestring

Název kategorie požadavku (OrderRequestCategory)

requestedDatestring(DateTime)

Požadované datum

stateOrderRequestState

Stav požadavku (OrderRequestState)

customStateIdstring(GUID)

ID Vlastního stavu požadavku (OrderRequestCustomState)

customStateNamestring

Název Vlastního stavu požadavku (OrderRequestCustomState)

priorityOrderRequestPriority

Priorita požadavku (OrderRequestPriority)

internalNotestring

Interní poznámka

ownerIdstring(GUID)

ID vlastníka (User). V případě založení přes externí formulář a přes veřejné API je vlastník ve výchozím stavu nenastaven. V případě založení v aplikaci je vlastníkem uživatel, který požadavek založil.

Intervention

Informace o výjezdu. Tento typ je výstupem ze Seznamu výjezdů.

idstring(GUID)

externalIdstring

createdstring(DateTime)

Datum vytvoření

modifiedstring(DateTime)

Datum poslední úpravy

orderIdstring(GUID)

ID zakázky, do které výjezd patří (Order)

categoryIdstring(GUID)

ID Kategorie výjezdu (InterventionCategory)

categoryNamestring

Název kategorie výjezdu (InterventionCategory)

stateInterventionState

Stav výjezdu (InterventionState)

customStateIdstring(GUID)

ID Vlastního stavu výjezdu (InterventionCustomState)

customStateNamestring

Název Vlastního stavu výjezdu (InterventionCustomState)

priorityInterventionPriority

Priorita výjezdu (InterventionPriority)

ownerIdstring(GUID)

ID vlastníka (User). Vlastník je automaticky uživatel, který výjezd naplánoval.

ownerNamestring

Celé jméno vlastníka (User). Vlastník je automaticky uživatel, který výjezd naplánoval.

daystring(Date)

Datum výjezdu

primaryAssigneeIdstring(GUID)

ID hlavního technika (User)

assignationsInterventionAssignation[]

Všichni technici, přiřazení k výjezdu včetně přesného časového rozpětí (InterventionAssignation)

startedAtstring(DateTime)

Datum a čas zahájení výjezdu technikem

endedAtstring(DateTime)

Datum a čas ukončení výjezdu technikem

totalPricedecimal

Součet ceny cestovného, práce a materiálu.

travelPricedecimal

Celková cena za cestu.

travelDistanceinteger

Celkový počet vykázaných kilometrů.

workPricedecimal

Celková cena vykázané práce.

workHoursdecimal

Celkový počet hodin vykázané práce.

materialPricedecimal

Celková cena vykázaného materiálu.

materialCostPricedecimal

Celková nákupní cena vykázaného materiálu.

materialCountdecimal

Celkový počet jednotek vykázaného materiálu.

InterventionInOrder

Informace o výjezdu v zakázce

idstring(GUID)

externalIdstring

createdstring(DateTime)

Datum vytvoření

modifiedstring(DateTime)

Datum poslední úpravy

categoryIdstring(GUID)

ID Kategorie výjezdu (InterventionCategory)

categoryNamestring

Název kategorie výjezdu (InterventionCategory)

stateInterventionState

Stav výjezdu (InterventionState)

customStateIdstring(GUID)

ID Vlastního stavu výjezdu (InterventionCustomState)

customStateNamestring

Název Vlastního stavu výjezdu (InterventionCustomState)

priorityInterventionPriority

Priorita výjezdu (InterventionPriority)

ownerIdstring(GUID)

ID vlastníka (User). Vlastník je automaticky uživatel, který výjezd naplánoval.

ownerNamestring

Celé jméno vlastníka (User). Vlastník je automaticky uživatel, který výjezd naplánoval.

daystring(Date)

Datum výjezdu

primaryAssigneeIdstring(GUID)

ID hlavního technika (User)

primaryAssigneeNamestring

Celé jméno hlavního technika (User)

assignationsInterventionAssignation[]

Všichni technici, přiřazení k výjezdu včetně přesného časového rozpětí (InterventionAssignation)

sendReminderOneDayBeforeboolean

Zákazníkovi se odešle připomínka den před výjezdem

departureStartedAtstring(DateTime)

Datum a čas zahájení cesty technikem

startedAtstring(DateTime)

Datum a čas zahájení výjezdu technikem

endedAtstring(DateTime)

Datum a čas ukončení výjezdu technikem

cancelledAtstring(DateTime)

Datum a čas zrušení výjezdu

totalPricedecimal

Součet ceny cestovného, práce a materiálu.

travelPricedecimal

Celková cena za cestu.

travelDistanceinteger

Celkový počet vykázaných kilometrů.

workPricedecimal

Celková cena vykázané práce.

workHoursdecimal

Celkový počet hodin vykázané práce.

materialPricedecimal

Celková cena vykázaného materiálu.

materialCostPricedecimal

Celková nákupní cena vykázaného materiálu.

materialCountdecimal

Celkový počet jednotek vykázaného materiálu.

InterventionDetail

Detailní informace o výjezdu v zakázce

idstring(GUID)

externalIdstring

createdstring(DateTime)

Datum vytvoření

modifiedstring(DateTime)

Datum poslední úpravy

categoryIdstring(GUID)

ID Kategorie výjezdu (InterventionCategory)

categoryNamestring

Název kategorie výjezdu (InterventionCategory)

stateInterventionState

Stav výjezdu (InterventionState)

customStateIdstring(GUID)

ID Vlastního stavu výjezdu (InterventionCustomState)

customStateNamestring

Název Vlastního stavu výjezdu (InterventionCustomState)

ownerIdstring(GUID)

ID vlastníka (User). Vlastník je automaticky uživatel, který výjezd naplánoval.

ownerNamestring

Celé jméno vlastníka (User). Vlastník je automaticky uživatel, který výjezd naplánoval.

daystring(Date)

Datum výjezdu

primaryAssigneeIdstring(GUID)

ID hlavního technika (User)

orderIdstring(GUID)

ID zakázky, do které výjezd patří (Order)

priorityInterventionPriority

Priorita výjezdu (InterventionPriority)

assignationsInterventionAssignation[]

Všichni technici, přiřazení k výjezdu včetně přesného časového rozpětí (InterventionAssignation)

customFormsOrderCustomFormInIntervention[]

Formuláře navázané na výjezd (OrderCustomFormInIntervention)

internalNotestring

Interní poznámka k výjezdu

sendReminderOneDayBeforeboolean

Zákazníkovi se odešle připomínka den před výjezdem

startedAtstring(DateTime)

Datum a čas zahájení výjezdu technikem

endedAtstring(DateTime)

Datum a čas ukončení výjezdu technikem

signaturesConfirmedAtstring(DateTime)

Datum a čas podepsání dokumentů zákazníkem

confirmedAtstring(DateTime)

Datum a čas schválení výjezdu dispečerem

confirmedByIdstring(GUID)

ID uživatele, který výjezd schválil (User)

cancelledAtstring(DateTime)

Datum a čas zrušení výjezdu

cancelledByIdstring(GUID)

ID uživatele, který výjezd zrušil (User)

cancelReasonstring

Důvod zrušení výjezdu

startedLocationGeoCoordinate

Zeměpisná poloha, ve které technik zahájil výjezd (GeoCoordinate)

endLocationGeoCoordinate

Zeměpisná poloha, ve které technik ukončil výjezd (GeoCoordinate)

signaturesConfirmedLocationGeoCoordinate

Zeměpisná poloha, ve které zákazník podepsal dokumenty (GeoCoordinate)

totalPricedecimal

Součet ceny cestovného, práce a materiálu.

travelPricedecimal

Celková cena za cestu.

travelDistanceinteger

Celkový počet vykázaných kilometrů.

workPricedecimal

Celková cena vykázané práce.

workHoursdecimal

Celkový počet hodin vykázané práce.

materialPricedecimal

Celková cena vykázaného materiálu.

materialCostPricedecimal

Celková nákupní cena vykázaného materiálu.

materialCountdecimal

Celkový počet jednotek vykázaného materiálu.

InterventionAssignation

userIdstring(GUID)

ID technika (User)

plannedStartstring(DateTime)

Datum a čas začátku alokace technika na výjezdu

plannedEndstring(DateTime)

Datum a čas konce alokace technika na výjezdu

OrderCustomFormInIntervention

idstring(GUID)

createdstring(DateTime)

Datum vytvoření

modifiedstring(DateTime)

Datum poslední úpravy

codeNumberinterger

Číslo formuláře v zakázce. První formulář v zakázce má číslo 1.

customFormTemplateNamestring

Název (šablony) formuláře

customFormTemplateIdstring(GUID)

ID šablony formuláře

priceListIdstring(GUID)

ID ceníku. Pokud jsou použity základní ceny, je hodnota null/undefined.

priceListNamestring

Název ceníku. Pokud jsou použity základní ceny, je hodnota null/undefined.

needsServiceObjectboolean

Formulář musí být navázaný na (alespoň jedno) zařízení

multipleServiceObjectsboolean

Formulář může být navázán na více než jedno zařízení

serviceObjectIdsstring(GUID)[]

ID všech navázaných zařízení

isProccessedboolean

Formulář byl zpracován (tzn. byly aplikované skladové pohyby, byly synchronizovány data do ostatních entit, apod.)

isSubmittedboolean

Formulář byl vyplněn (obsahuje všechny povinná data)

sendsReportsboolean

Dokumenty tohoto formuláře se odesílají e-mailem zákazníkovi

isRevisionboolean

Formulář posouva datum příštího pravidelného servisu

vatOptionIdstring(GUID)

ID sazby daně

vatOptionNamestring

Název sazby daně

vatRatedecimal

Daňová sazba v procentech jako hodnota 0-100 (např. 15 = 15%)

paymentTypeIdstring(GUID)

ID druhu platby

paymentTypeNamestring

Název druhu platby

CustomFormReportDocument

Dokument vygenerovaný z formuláře. Dokumenty se generují po dokončení výjezdu.

idstring(GUID)

createdstring(DateTime)

Datum vygenerování dokumentu

namestring

Název dokumentu (dle šablony formuláře)

languagestring

Jazyk dokumentu

publicUrlstring(URL)

Odkaz ke stažení dokumentu

isPrivateboolean

Dokument je interní a neodesílá se zákazníkovi

serviceObjectNamesstring[]

Názvy zařízení, ke kterým dokument patří. Vyplněno pouze u dokumentů, které se generují pro každé zařízení zvlášť (ServiceObject)

WorkTableItem

Položka výkazu práce vykázaná ve formuláři

idstring(GUID)

createdstring(DateTime)

Datum vytvoření

modifiedstring(DateTime)

Datum poslední úpravy

orderCustomFormIdstring(GUID)

ID Formuláře

interventionIdstring(GUID)

ID Výjezdu

assigneeIdstring(GUID)

ID technika (User)

descriptionstring

Popis položky výkazu práce

amountdecimal

Počet jednotek (hodin)

pricedecimal

Prodejní cena za jednotku (bez DPH)

UsedMaterialItem

Položka materiálu vykázaná ve formuláři. Může mít vazbu na definici materiálu, nebo se může jednat o ruční položku.

idstring(GUID)

createdstring(DateTime)

Datum vytvoření

modifiedstring(DateTime)

Datum poslední úpravy

orderCustomFormIdstring(GUID)

ID Formuláře

interventionIdstring(GUID)

ID Výjezdu

namestring

Název materiálu

identificationNumberstring

Kód materiálu

descriptionstring

Popis materiálu

supplierCodestring

Kód dodavatele materiálu

pricedecimal

Prodejní cena materiálu (bez DPH)

materialIdstring(GUID)

ID Materiálu

materialExternalIdstring

Externí ID Materiálu

storeIdstring(GUID)

ID Skladu, ze kterého byl materiál vykázán

storeExternalIdstring

Externí ID Skladu, ze kterého byl materiál vykázán

Poznámka

V případě, že byla položka vytvořena jako ruční položka, není materialId, materialExternalId, storeId a storeExternalId dostupné

TravelCostItem

Položka cestovného vykázaná ve formuláři

idstring(GUID)

createdstring(DateTime)

Datum vytvoření

modifiedstring(DateTime)

Datum poslední úpravy

orderCustomFormIdstring(GUID)

ID Formuláře

interventionIdstring(GUID)

ID Výjezdu

descriptionstring

Popis položky cestovného

distanceinteger

Vykázaná vzdálenost v kilometrech