Přehled typů exportů
Tento přehled uvádí všechny dostupné typy exportů, jejich endpointy, podporované formáty výstupu a parametry.
Celý asynchronní workflow je popsán v sekci exporty.
Dostupnost
Exporty jsou dostupné pouze pro tarify Business a Enterprise.
Jak číst parametry
- Volání endpointů probíhá jako
POST /api/{verze}/ExportRequest/{typ}. - Všechny parametry uvedené v tabulkách níže (např.
DateFrom,DateTo,IdStaff) se posílají v request body (application/json). - Do query stringu patří pouze obecné volby exportu:
format,password,email,callback. - Datumové a časové hodnoty v exportních souborech bez
Utcv názvu jsou lokální čas XDENT. Pole sUtcv názvu jsou skutečné UTC.
Obecné exporty
Testovací export
POST /api/v1/ExportRequest/Test
Testovací export určený k otestování integrace exportů.
- Tento export podporuje pouze formát
CSV.
Parametry
Endpoint nemá parametry v těle požadavku.
Do query stringu lze použít obecné volby exportu:
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
format | string | ne | Výstupní formát exportu (CSV) |
password | string | ne | Heslo pro vygenerovaný ZIP soubor |
email | string | ne | E-mail pro notifikaci po dokončení exportu |
callback | string | ne | Callback URL volané po dokončení exportu |
Odpověď
| Sloupec | Hodnota |
|---|---|
Export Type | Vždy TEST |
Generated At UTC | Aktuální UTC čas při generování exportu (ISO formát O) |
Job ID | Identifikátor exportu |
Fakturace
POST /api/v1/ExportRequest/Invoices
Detailní export faktur klientů, včetně položek.
Tento export vychází ze starší implementace a v budoucnu bude nahrazen novější verzí.
- Tento export je dostupný pouze ve formátu
JSON.
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
DateFrom | datetime | ano | Začátek datového rozsahu podle data vystavení nebo úpravy faktury |
DateTo | datetime | ano | Konec datového rozsahu podle data vystavení nebo úpravy faktury |
Odpověď
Odpověď je objekt InvoiceExportInfo.
| Pole | Typ | Popis |
|---|---|---|
dateCreated | datetime | Datum vytvoření exportu |
companies | InvoiceExportCompanyInfo[] | Společnosti zahrnuté do exportu |
InvoiceExportCompanyInfo
| Pole | Typ | Popis |
|---|---|---|
idCRM | string | Externí identifikátor společnosti |
companyName | string | Název společnosti |
clients | InvoiceExportClientInfo[] | Klienti se záznamy v exportu |
InvoiceExportClientInfo
| Pole | Typ | Popis |
|---|---|---|
idClient | uuid | Identifikátor klienta |
fullName | string | Celé jméno klienta |
phone | string | Telefon klienta |
email | string | E-mail klienta |
city | string | Město klienta |
street | string | Ulice klienta |
post | string | PSČ klienta |
staffName | string | Jméno odpovědného zaměstnance |
clientId | int | Číselné ID klienta |
staffId | int | Číselné ID zaměstnance |
reports | InvoiceExportMedicalReportInfo[] | Zdravotní záznamy klienta |
invoices | InvoiceExportInvoiceInfo[] | Doklady klienta |
InvoiceExportMedicalReportInfo
| Pole | Typ | Popis |
|---|---|---|
IdMedicalReport | uuid | Identifikátor zdravotního záznamu |
date | datetime | Datum zdravotního záznamu |
insuranceItems | InvoiceExportInsuranceItemInfo[] | Pojišťovnové položky ve zdravotním záznamu |
InvoiceExportInsuranceItemInfo
| Pole | Typ | Popis |
|---|---|---|
code | string | Kód položky |
insurancePrice | number | Cena pro pojišťovnu |
laboratoryPrice | number | Laboratorní cena |
patientPrice | number | Cena pro klienta |
InvoiceExportInvoiceInfo
| Pole | Typ | Popis |
|---|---|---|
idInvoice | uuid | Identifikátor dokladu |
idSupervisor | uuid | Identifikátor odpovědné osoby na dokladu |
dateIssue | datetime | Datum vystavení |
dateDue | datetime | Datum splatnosti |
dateTax | datetime | Datum zdanitelného plnění |
dateLastChange | datetime | Datum poslední změny |
invoiceNumber | long | Číslo dokladu |
accountNumber | string | Číslo účtu |
bankCode | string | Kód banky |
billingName | string | Jméno na faktuře |
billingSurname | string | Příjmení na faktuře |
billingStreet | string | Ulice fakturační adresy |
billingCity | string | Město fakturační adresy |
billingPost | string | PSČ fakturační adresy |
billingRegNumber | string | IČ |
billingVatNumber | string | DIČ |
billingType | string | Typ úhrady |
officeName | string | Název ordinace/společnosti |
officeStreet | string | Ulice ordinace |
officeCity | string | Město ordinace |
officePost | string | PSČ ordinace |
officeCountry | string | Země ordinace |
officeEmail | string | E-mail ordinace |
officePhone | string | Telefon ordinace |
officeWeb | string | Web ordinace |
currency | string | Domácí měna účtu. V této měně jsou priceTotal, priceDiscount, priceService, priceMaterial, priceDebt a úhrady |
currencyTotal | string | Měna, ve které je doklad vystaven. Prázdné u dokladu v domácí měně |
currencyRate | number | Kurz: počet jednotek měny currency za 1 jednotku měny currencyTotal |
deposit | number | Historická záloha, u nových dokladů 0. Do priceDebt se nezapočítává |
discount | number | Sleva |
eetLock | int | Příznak uzamčení dokladu po odeslání do EET |
iban | string | IBAN |
swift | string | SWIFT |
type | string | Typ dokladu |
invoiceVat | bool | Zda je doklad vystavený s DPH |
note | string | Poznámka |
paid | bool | Je doklad uhrazen |
priceDiscount | number | Výše slevy |
priceLaboratory | number | Laboratorní cena |
priceMaterial | number | Cena materiálu |
priceService | number | Cena služeb |
priceTotal | number | Celková cena |
priceCredit | number | Částka krytá kreditem klienta, v měně dokladu (currencyTotal) |
priceDebt | number | Dlužná částka v měně currency |
providerName | string | Jméno odpovědné osoby |
providerSurname | string | Příjmení odpovědné osoby |
providerDegree | string | Titul před jménem |
providerDegreeAfter | string | Titul za jménem |
regNumber | string | IČ pobočky, která doklad vystavila |
vatNumber | string | DIČ pobočky, která doklad vystavila |
variableSymbol | string | Číslo objednávky platební brány, pokud je k dokladu evidováno |
writtenBy | string | Vystavil |
providerId | int | Číselné ID odpovědné osoby |
items | InvoiceExportDetailInfo[] | Položky dokladu |
payments | InvoiceExportPaymentInfo[] | Úhrady dokladu |
InvoiceExportDetailInfo
| Pole | Typ | Popis |
|---|---|---|
idInvoiceDetail | uuid | Identifikátor položky dokladu |
idParent | uuid | Identifikátor nadřazené položky |
id | int | Pořadové číslo položky |
parentId | int | Pořadové číslo nadřazené položky |
code | string | Kód položky |
codeType | string | Typ kódu |
description | string | Popis |
duration | int | Délka výkonu |
materialType | string | Typ materiálu |
name | string | Název položky |
note | string | Poznámka |
position | int | Pořadí na dokladu |
priceLaboratory | number | Laboratorní cena |
pricePerMinute | number | Cena za minutu |
quantity | number | Množství |
unitPrice | number | Jednotková cena s DPH. V měně currency, u položek z ceníku vedeného v cizí měně v měně currencyTotal |
vatRate | string | Procentní sazba DPH u položky |
InvoiceExportPaymentInfo
| Pole | Typ | Popis |
|---|---|---|
idSupervisor | uuid | Identifikátor odpovědné osoby |
pricePayment | number | Uhrazená částka v měně currency |
datePayment | datetime | Datum úhrady |
note | string | Poznámka k úhradě |
billingType | string | Typ úhrady |
currency | string | Měna dokladu |
providerId | int | Číselné ID odpovědné osoby |
providerFirstname | string | Jméno odpovědné osoby |
providerLastname | string | Příjmení odpovědné osoby |
type
| Hodnota | Význam |
|---|---|
INVOICE_TYPE_BILL | Faktura |
INVOICE_TYPE_INVOICE | Příjmový doklad |
INVOICE_TYPE_SPECIFICATION | Cenový návrh |
INVOICE_TYPE_EXPENDITURE | Výdajový doklad |
INVOICE_TYPE_CREDIT | Dobití kreditu |
billingType
Stejné hodnoty se používají u faktury i u úhrady. U faktury může být hodnota prázdná, pokud typ úhrady není nastaven.
| Hodnota | Význam |
|---|---|
INVOICE_PAYMENT_TYPE_CASH | Hotovost |
INVOICE_PAYMENT_TYPE_CARD | Platební karta |
INVOICE_PAYMENT_TYPE_TRANSFER | Převodem |
INVOICE_PAYMENT_TYPE_COUPON | Kupón |
INVOICE_PAYMENT_TYPE_OTHER | Jiný |
Kalendář
POST /api/v1/ExportRequest/Calendar
Detailní export kalendáře pro přehled kapacit, ordinačních hodin, poznámek a objednávek/rezervací ve zvoleném období.
- Tento export je dostupný pouze ve formátu
JSON. - Tento export přijímá maximální interval 31 dní.
- Hodnoty v
IdStaffmusí odpovídat zaměstnancům s kalendářem. Pokud požadavek obsahuje uživatele, který není zaměstnancem s kalendářem, export skončí validační chybou.
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
DateFrom | datetime | ano | Začátek datového rozsahu |
DateTo | datetime | ano | Konec datového rozsahu |
IdStaff | uuid[] | ano | Seznam identifikátorů zaměstnanců |
Odpověď
Odpověď je pole CalendarExtendedExportStaffDto[].
CalendarExtendedExportStaffDto
| Pole | Typ | Popis |
|---|---|---|
IdStaff | uuid | Identifikátor zaměstnance |
StaffName | string | Jméno zaměstnance |
Days | CalendarExtendedExportDayDto[] | Dny v požadovaném období |
CalendarExtendedExportDayDto
| Pole | Typ | Popis |
|---|---|---|
Date | datetime | Datum dne |
Appointments | CalendarExtendedExportAppointmentDto[] | Objednávky/rezervace |
Notes | CalendarExtendedExportNoteDto[] | Poznámky |
OpenHours | CalendarExtendedExportOpenHourDto[] | Ordinační hodiny |
IsHoliday | bool | Indikace svátku |
CalendarExtendedExportAppointmentDto
| Pole | Typ | Popis |
|---|---|---|
IdAppointment | uuid | Identifikátor objednávky |
StartDate | datetime | Začátek objednávky |
EndDate | datetime | Konec objednávky |
Subject | string | Předmět |
Description | string | Popis |
IdClient | uuid | Identifikátor klienta |
IdService | uuid | Identifikátor služby |
EntryType | string | Typ záznamu |
OccurrenceType | string | Typ výskytu |
Status | string | Stav objednávky |
OnlineBooked | bool | Objednávka vytvořená online |
Confirmed | bool | Potvrzení objednávky |
NoShow | bool | Klient nedorazil |
NewClient | bool | Nový klient |
CalendarExtendedExportNoteDto
| Pole | Typ | Popis |
|---|---|---|
IdNote | uuid | Identifikátor poznámky |
Subject | string | Předmět |
Description | string | Popis |
OccurrenceType | string | Typ výskytu |
CalendarExtendedExportOpenHourDto
| Pole | Typ | Popis |
|---|---|---|
IdOpenHour | uuid | Identifikátor ordinační hodiny |
StartDate | datetime | Začátek |
EndDate | datetime | Konec |
Subject | string | Předmět |
Description | string | Popis |
OccurrenceType | string | Typ výskytu |
Active | bool | Aktivní ordinační hodina |
ActiveOverride | bool | Přepsání výjimkou |
EntryType
| Hodnota | Význam |
|---|---|
CLIENT_APPOINTMENT | Objednávka klienta (záznam má vyplněné IdClient) |
STAFF_RESERVATION | Rezervace zaměstnance (záznam nemá IdClient) |
OccurrenceType
| Hodnota | Význam |
|---|---|
ONE_OFF | Jednorázový záznam |
RECURRING | Opakovaný záznam |
EDITED_EXCEPTION | Upravená výjimka opakovaného záznamu |
DELETED_EXCEPTION | Smazaná výjimka opakovaného záznamu |
Status
| Hodnota | Význam |
|---|---|
ORDERED | Objednáno |
CONFIRMED | Potvrzeno |
WAITING | Čekající |
TAKING_CARE | Ošetřován |
TAKEN_CARE | Ošetřen |
FINISHED | Dokončen |
NOT_ARRIVED | Nedostavil se |
Statistické exporty
Ve statistických exportech platí:
- níže uvedené exporty podporují formáty
CSViJSON, - formát
CSVje 1:1 shodný s exportem tabulek dané statistiky v XDENT, - níže popsaná odpověď dokumentuje JSON verzi exportu.
Pokladna
Základní
POST /api/v1/ExportRequest/Statistics/Invoice/Basic
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
DateFrom | datetime | ano | Začátek rozsahu podle data vystavení faktury |
DateTo | datetime | ano | Konec rozsahu podle data vystavení faktury |
IdSupervisor | uuid | ne | Filtr podle odpovědné osoby |
IdLocation | uuid | ne | Filtr podle pobočky |
Odpověď
Odpověď je pole StatsInvoiceItemsBasicExportDto[].
StatsInvoiceItemsBasicExportDto
| Pole | Typ | Popis |
|---|---|---|
InvoiceCode | InvoiceCodeDto | Fakturační položka |
Supervisor | SupervisorDto | Odpovědná osoba |
Laboratory | LaboratoryDto | Laboratoř (pokud je dostupná) |
SupervisorDto
| Pole | Typ | Popis |
|---|---|---|
IdSupervisor | uuid | Identifikátor odpovědné osoby |
Name | string | Jméno odpovědné osoby |
LaboratoryDto
| Pole | Typ | Popis |
|---|---|---|
IdLaboratory | uuid | Identifikátor laboratoře |
Name | string | Název laboratoře |
InvoiceCodeDto
| Pole | Typ | Popis |
|---|---|---|
IdInvoiceCode | uuid | Identifikátor kódu položky |
Code | string | Kód položky |
Name | string | Název položky |
Description | string | Popis položky |
Quantity | number | Množství |
Price | number | Cena |
PriceNoVat | number | Cena bez DPH |
PriceLaboratory | number | Laboratorní cena |
Type | ItemTypeDto | Typ položky |
Vat | VatDto | DPH |
ItemTypeDto
| Pole | Typ | Popis |
|---|---|---|
IdCodeType | uuid | Identifikátor typu kódu |
CodeType | string | Kód typu |
IdMaterialCode | uuid | Identifikátor typu materiálu |
MaterialCodeType | string | Typ materiálu |
CodeGroupType | string | Kód skupiny |
CodeGroupTypeTitle | string | Název skupiny |
VatDto
| Pole | Typ | Popis |
|---|---|---|
IdVatRate | uuid | Identifikátor sazby DPH |
RateCode | string | Kód sazby |
Rate | int | Hodnota sazby DPH |
Rozšířená
POST /api/v1/ExportRequest/Statistics/Invoice/Extended
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
DateFrom | datetime | ano | Začátek rozsahu podle data vystavení faktury |
DateTo | datetime | ano | Konec rozsahu podle data vystavení faktury |
IdSupervisor | uuid | ne | Filtr podle odpovědné osoby |
IdLocation | uuid | ne | Filtr podle pobočky |
Odpověď
Odpověď je pole StatsInvoiceItemsExtendedExportDto[].
StatsInvoiceItemsExtendedExportDto
| Pole | Typ | Popis |
|---|---|---|
Client | ClientDto | Klient |
Invoice | InvoiceDto | Doklad |
InvoiceCode | InvoiceCodeDto | Fakturační položka |
Supervisor | SupervisorDto | Odpovědná osoba |
Laboratory | LaboratoryDto | Laboratoř |
Location | LocationDto | Pobočka |
CustomTags | CustomTagEntry[] | Vlastní štítky klienta |
ClientDto
| Pole | Typ | Popis |
|---|---|---|
IdClient | uuid | Identifikátor klienta |
ClientName | string | Jméno klienta |
PersonalId | string | Rodné číslo / osobní identifikátor |
InvoiceDto
| Pole | Typ | Popis |
|---|---|---|
InvoiceNumber | long | Číslo dokladu |
DateIssue | datetime | Datum vystavení |
IsPaid | bool | Příznak uhrazení |
IsFullyPaid | bool | Doklad je plně uhrazen |
SupervisorDto
| Pole | Typ | Popis |
|---|---|---|
IdSupervisor | uuid | Identifikátor odpovědné osoby |
Name | string | Jméno odpovědné osoby |
LocationDto
| Pole | Typ | Popis |
|---|---|---|
IdLocation | uuid | Identifikátor pobočky |
Name | string | Název pobočky |
CustomTagEntry
| Pole | Typ | Popis |
|---|---|---|
customTagName | string | Název vlastního štítku |
color | string | Barva štítku |
InvoiceCodeDto
| Pole | Typ | Popis |
|---|---|---|
IdInvoiceCode | uuid | Identifikátor kódu položky |
Code | string | Kód položky |
Name | string | Název položky |
Description | string | Popis položky |
Quantity | number | Množství |
Price | number | Cena |
PriceNoVat | number | Cena bez DPH |
PriceLaboratory | number | Laboratorní cena |
Duration | int | Délka výkonu |
LocalizationCode | string | Kód lokalizace |
Note | string | Poznámka |
Type | ItemTypeDto | Typ položky |
Vat | VatDto | DPH |
VatDto
| Pole | Typ | Popis |
|---|---|---|
IdVatRate | uuid | Identifikátor sazby DPH |
RateCode | string | Kód sazby |
Rate | int | Hodnota sazby DPH |
ItemTypeDto
| Pole | Typ | Popis |
|---|---|---|
IdCodeType | uuid | Identifikátor typu kódu |
CodeType | string | Typ kódu |
IdMaterialCode | uuid | Identifikátor typu materiálu |
MaterialCodeType | string | Typ materiálu |
CodeGroupType | string | Kód skupiny |
CodeGroupTypeTitle | string | Název skupiny |
LaboratoryDto
| Pole | Typ | Popis |
|---|---|---|
IdLaboratory | uuid | Identifikátor laboratoře |
Name | string | Název laboratoře |
Položky
POST /api/v1/ExportRequest/Statistics/Invoice/Items
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
DateFrom | datetime | ano | Začátek rozsahu podle data vystavení faktury |
DateTo | datetime | ano | Konec rozsahu podle data vystavení faktury |
IdSupervisor | uuid | ne | Filtr podle odpovědné osoby |
IdLocation | uuid | ne | Filtr podle pobočky |
Odpověď
Odpověď je pole StatsInvoiceItemsExportDto[].
StatsInvoiceItemsExportDto
| Pole | Typ | Popis |
|---|---|---|
Item | ItemDto | Fakturační položka |
Location | LocationDto | Pobočka |
Type | TypeDto | Typ položky |
Quantity | number | Množství |
Price | number | Cena |
PriceNoVat | number | Cena bez DPH |
VRate | int | Sazba DPH |
ItemDto
| Pole | Typ | Popis |
|---|---|---|
Code | string | Kód položky |
Name | string | Název položky |
Description | string | Popis položky |
LocationDto
| Pole | Typ | Popis |
|---|---|---|
IdLocation | uuid | Identifikátor pobočky |
Name | string | Název pobočky |
TypeDto
| Pole | Typ | Popis |
|---|---|---|
IdCodeType | uuid | Identifikátor typu kódu |
TypeCode | string | Typ kódu |
IdMaterialType | uuid | Identifikátor typu materiálu |
MaterialTypeCode | string | Typ materiálu |
GroupCode | string | Kód skupiny |
GroupTitle | string | Název skupiny |
Platební brána
POST /api/v1/ExportRequest/Statistics/Invoice/PaymentGateway
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
DateFrom | datetime | ano | Začátek rozsahu podle data vystavení faktury |
DateTo | datetime | ano | Konec rozsahu podle data vystavení faktury |
IdSupervisor | uuid | ne | Filtr podle odpovědné osoby |
IdLocation | uuid | ne | Filtr podle pobočky |
Odpověď
Odpověď je pole StatsInvoicePaymentGatewayExportDto[].
StatsInvoicePaymentGatewayExportDto
| Pole | Typ | Popis |
|---|---|---|
IdPaymentGatewayRequest | uuid | Identifikátor požadavku platební brány |
Location | LocationDto | Pobočka |
Client | ClientDto | Klient |
Invoice | InvoiceDto | Doklad |
Supervisor | SupervisorDto | Odpovědná osoba |
Appointment | AppointmentDto | Objednávka |
Service | ServiceDto | Služba |
Price | number | Cena |
DateIssue | datetime | Datum vystavení |
LocationDto
| Pole | Typ | Popis |
|---|---|---|
IdLocation | uuid | Identifikátor pobočky |
Name | string | Název pobočky |
ClientDto
| Pole | Typ | Popis |
|---|---|---|
IdClient | uuid | Identifikátor klienta |
Name | string | Jméno klienta |
InvoiceDto
| Pole | Typ | Popis |
|---|---|---|
IdInvoice | uuid | Identifikátor dokladu |
InvoiceNumber | long | Číslo dokladu |
OrderNumber | long | Číslo objednávky platební brány |
SupervisorDto
| Pole | Typ | Popis |
|---|---|---|
IdSupervisor | uuid | Identifikátor odpovědné osoby |
Name | string | Jméno odpovědné osoby |
AppointmentDto
| Pole | Typ | Popis |
|---|---|---|
IdAppointment | uuid | Identifikátor objednávky |
IdStaff | uuid | Identifikátor zaměstnance u objednávky |
StartDate | datetime | Začátek objednávky |
EndDate | datetime | Konec objednávky |
AppointmentDateDisplay | string | Textová reprezentace termínu (pokud je dostupná) |
ServiceDto
| Pole | Typ | Popis |
|---|---|---|
IdService | uuid | Identifikátor služby |
Caption | string | Název služby |
Pojišťovna
Doklady
POST /api/v1/ExportRequest/Statistics/Insurance/Invoice
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
DateFrom | datetime | ano | Začátek rozsahu podle data fakturace |
DateTo | datetime | ano | Konec rozsahu podle data fakturace |
IdStaff | uuid | ne | Filtr podle zaměstnance |
IdLocation | uuid | ne | Filtr podle pobočky |
Odpověď
Odpověď je pole StatsInsuranceInvoiceExportDto[].
StatsInsuranceInvoiceExportDto
| Pole | Typ | Popis |
|---|---|---|
Report | ReportDto | Informace o vykázání |
Client | ClientDto | Klient |
Staff | StaffDto | Zaměstnanec |
Pricing | PricingDto | Ceny |
ReportDto
| Pole | Typ | Popis |
|---|---|---|
IdReport | uuid | Identifikátor záznamu |
Date | datetime | Datum záznamu |
IdBatch | uuid | Identifikátor dávky |
BatchNumber | long | Číslo dávky |
DocumentNumber | long | Číslo dokladu |
CreatedAt | datetime | Datum vytvoření |
Insurance | InsuranceDto | Pojišťovna |
Sent | bool | Příznak odeslání |
InsuranceDto
| Pole | Typ | Popis |
|---|---|---|
IdInsurance | uuid | Identifikátor pojišťovny |
Name | string | Název pojišťovny |
IdInsuranceType | uuid | Identifikátor typu pojištění |
TypeName | string | Název typu pojištění |
PricingDto
| Pole | Typ | Popis |
|---|---|---|
InsuranceTotal | number | Celkem pro pojišťovnu |
ClientTotal | number | Celkem pro klienta |
LaboratoryPrice | number | Laboratorní cena |
Profit | number | Výsledek (pojišťovna + klient − laboratoř) |
ClientDto
| Pole | Typ | Popis |
|---|---|---|
IdClient | uuid | Identifikátor klienta |
Name | string | Jméno klienta |
PersonalId | string | Rodné číslo / osobní identifikátor |
StaffDto
| Pole | Typ | Popis |
|---|---|---|
IdStaff | uuid | Identifikátor zaměstnance |
Name | string | Jméno zaměstnance |
Základní
POST /api/v1/ExportRequest/Statistics/Insurance/Basic
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
DateFrom | datetime | ano | Začátek rozsahu podle data fakturace |
DateTo | datetime | ano | Konec rozsahu podle data fakturace |
IdStaff | uuid | ne | Filtr podle zaměstnance |
IdLocation | uuid | ne | Filtr podle pobočky |
Odpověď
Odpověď je pole StatsInsuranceBasicExportDto[].
StatsInsuranceBasicExportDto
| Pole | Typ | Popis |
|---|---|---|
Staff | StaffDto | Zaměstnanec |
Item | ItemDto | Položka |
Insurance | InsuranceDto | Pojišťovna |
Prices | PricesDto | Ceny |
StaffDto
| Pole | Typ | Popis |
|---|---|---|
IdStaff | uuid | Identifikátor zaměstnance |
Name | string | Jméno zaměstnance |
ItemDto
| Pole | Typ | Popis |
|---|---|---|
Code | string | Kód položky |
Name | string | Název položky |
Type | string | Kód typu položky |
TypeName | string | Lokalizovaný název typu položky (pokud je dostupný) |
Amount | number | Množství |
InsuranceDto
| Pole | Typ | Popis |
|---|---|---|
IdInsurance | uuid | Identifikátor pojišťovny |
Name | string | Název pojišťovny |
PricesDto
| Pole | Typ | Popis |
|---|---|---|
InsurancePrice | number | Cena pro pojišťovnu |
ClientPrice | number | Cena pro klienta |
LaboratoryPrice | number | Laboratorní cena |
Rozšířená
POST /api/v1/ExportRequest/Statistics/Insurance/Extended
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
DateFrom | datetime | ano | Začátek rozsahu podle data fakturace |
DateTo | datetime | ano | Konec rozsahu podle data fakturace |
IdStaff | uuid | ne | Filtr podle zaměstnance |
IdLocation | uuid | ne | Filtr podle pobočky |
Odpověď
Odpověď je pole StatsInsuranceExtendedExportDto[].
StatsInsuranceExtendedExportDto
| Pole | Typ | Popis |
|---|---|---|
Staff | StaffDto | Zaměstnanec |
Client | ClientDto | Klient |
Item | ItemDto | Položka |
Insurance | InsuranceDto | Pojišťovna |
Laboratory | LaboratoryDto | Laboratoř |
Report | ReportDto | Data záznamu |
Prices | PricesDto | Ceny |
CustomTags | CustomTagEntry[] | Vlastní štítky klienta |
StaffDto
| Pole | Typ | Popis |
|---|---|---|
IdStaff | uuid | Identifikátor zaměstnance |
Name | string | Jméno zaměstnance |
ClientDto
| Pole | Typ | Popis |
|---|---|---|
IdClient | uuid | Identifikátor klienta |
Name | string | Jméno klienta |
PersonalId | string | Rodné číslo / osobní identifikátor |
Address | AddressDto | Adresa klienta |
AddressDto
| Pole | Typ | Popis |
|---|---|---|
City | string | Město |
Street | string | Ulice |
Post | string | PSČ |
ItemDto
| Pole | Typ | Popis |
|---|---|---|
Code | string | Kód položky |
Name | string | Název položky |
CodeType | string | Kód typu položky |
Amount | number | Množství |
Localization | int | Lokalizace zubu |
InsuranceDto
| Pole | Typ | Popis |
|---|---|---|
IdInsurance | uuid | Identifikátor pojišťovny |
Name | string | Název pojišťovny |
InsuranceType | InsuranceTypeDto | Typ pojištění (pokud je dostupný) |
InsuranceTypeDto
| Pole | Typ | Popis |
|---|---|---|
IdInsuranceType | uuid | Identifikátor typu pojištění |
ClientInsuranceType | string | Název typu pojištění |
LaboratoryDto
| Pole | Typ | Popis |
|---|---|---|
IdLaboratory | uuid | Identifikátor laboratoře |
Name | string | Název laboratoře |
ReportDto
| Pole | Typ | Popis |
|---|---|---|
ReportDate | datetime | Datum záznamu |
Diagnose | string | Diagnóza |
PaymentType | string | Typ úhrady pojišťovny (pokud je dostupný) |
PricesDto
| Pole | Typ | Popis |
|---|---|---|
InsurancePrice | number | Cena pro pojišťovnu |
ClientPrice | number | Cena pro klienta |
LaboratoryPrice | number | Laboratorní cena |
CustomTagEntry
| Pole | Typ | Popis |
|---|---|---|
customTagName | string | Název vlastního štítku |
color | string | Barva štítku |
Položky
POST /api/v1/ExportRequest/Statistics/Insurance/Items
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
DateFrom | datetime | ano | Začátek rozsahu podle data fakturace |
DateTo | datetime | ano | Konec rozsahu podle data fakturace |
IdStaff | uuid | ne | Filtr podle zaměstnance |
IdLocation | uuid | ne | Filtr podle pobočky |
Odpověď
Odpověď je pole StatsInsuranceItemsExportDto[].
StatsInsuranceItemsExportDto
| Pole | Typ | Popis |
|---|---|---|
Code | string | Kód položky |
Name | string | Název položky |
Amount | number | Množství |
Type | ItemTypeDto | Typ položky |
Prices | PricesDto | Ceny |
Location | LocationDto | Pobočka |
ItemTypeDto
| Pole | Typ | Popis |
|---|---|---|
CodeType | string | Kód typu položky |
CodeTypeTitle | string | Lokalizovaný název typu položky |
PricesDto
| Pole | Typ | Popis |
|---|---|---|
InsurancePrice | number | Cena pro pojišťovnu |
ClientPrice | number | Cena pro klienta |
LaboratoryPrice | number | Laboratorní cena |
LocationDto
| Pole | Typ | Popis |
|---|---|---|
IdLocation | uuid | Identifikátor pobočky |
Name | string | Název pobočky |
Registrace
POST /api/v1/ExportRequest/Statistics/Insurance/Register
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
DateFrom | datetime | ano | Začátek rozsahu podle data registrace |
DateTo | datetime | ano | Konec rozsahu podle data registrace |
IdStaff | uuid | ne | Filtr podle zaměstnance |
IdLocation | uuid | ne | Filtr podle pobočky |
Odpověď
Odpověď je pole StatsInsuranceRegisterExportDto[].
StatsInsuranceRegisterExportDto
| Pole | Typ | Popis |
|---|---|---|
RegistrationDate | datetime | Datum registrace |
Client | ClientDto | Klient |
Insurance | InsuranceDto | Pojišťovna |
Staff | StaffDto | Zaměstnanec |
Batch | BatchDto | Dávka |
ClientDto
| Pole | Typ | Popis |
|---|---|---|
IdClient | uuid | Identifikátor klienta |
Name | string | Jméno klienta |
PersonalId | string | Rodné číslo / osobní identifikátor |
InsuranceDto
| Pole | Typ | Popis |
|---|---|---|
Id | uuid | Identifikátor pojišťovny |
Name | string | Název pojišťovny |
Type | TypeDto | Typ pojištění |
TypeDto
| Pole | Typ | Popis |
|---|---|---|
Id | uuid | Identifikátor typu pojištění |
Name | string | Název typu pojištění |
StaffDto
| Pole | Typ | Popis |
|---|---|---|
Id | uuid | Identifikátor zaměstnance |
Name | string | Jméno zaměstnance |
Icp | string | IČP |
BatchDto
| Pole | Typ | Popis |
|---|---|---|
CreatedAt | datetime | Datum vytvoření dávky |
Number | long | Číslo dávky |
Dávky
POST /api/v1/ExportRequest/Statistics/Insurance/Davky
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
DateFrom | datetime | ano | Začátek rozsahu podle období dávky |
DateTo | datetime | ano | Konec rozsahu podle období dávky |
Valid | bool | ano | Filtr platných / neplatných záznamů |
IdStaff | uuid | ne | Filtr podle zaměstnance |
IdLocation | uuid | ne | Filtr podle pobočky |
Odpověď
Odpověď je pole StatsInsuranceDavkyExportDto[].
StatsInsuranceDavkyExportDto
| Pole | Typ | Popis |
|---|---|---|
Invoice | InvoiceDto | Dávka/doklad |
Insurance | InsuranceDto | Pojišťovna |
Staff | StaffDto | Zaměstnanec |
Location | LocationDto | Pobočka |
InvoiceDto
| Pole | Typ | Popis |
|---|---|---|
IdInsuranceInvoice | uuid | Identifikátor dávky pojišťovny |
PeriodStart | datetime | Začátek období |
PeriodEnd | datetime | Konec období |
VCIS | long | Číslo VČIS |
DCIS | long | Číslo DČIS |
AHCID | long | Hodnota AHCID |
ZHCID | long | Hodnota ZHCID |
HCID | long | Hodnota HCID |
InvoiceType | string | Typ dávky |
Care | string | Typ péče |
TotalPrice | number | Celková cena |
TotalPoint | number | Celkové body |
Description | string | Popis |
CreatedDate | datetime | Datum vytvoření |
InsuranceDto
| Pole | Typ | Popis |
|---|---|---|
IdInsuranceCompany | uuid | Identifikátor pojišťovny |
Code | string | Kód pojišťovny |
IdInsuranceType | uuid | Identifikátor typu pojištění |
InsuranceTypeName | string | Název typu pojištění |
StaffDto
| Pole | Typ | Popis |
|---|---|---|
IdStaff | uuid | Identifikátor zaměstnance |
FullName | string | Jméno zaměstnance |
LocationDto
| Pole | Typ | Popis |
|---|---|---|
IdLocation | uuid | Identifikátor pobočky |
Name | string | Název pobočky |
Zaměstnanci
Typ položek
POST /api/v1/ExportRequest/Statistics/Staff/Items
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
DateFrom | datetime | ano | Začátek rozsahu podle data úhrady |
DateTo | datetime | ano | Konec rozsahu podle data úhrady |
IdStaff | uuid | ne | Filtr podle zaměstnance |
IdLocation | uuid | ne | Filtr podle pobočky |
Odpověď
Odpověď je pole StatsStaffItemsExportDto[].
StatsStaffItemsExportDto
| Pole | Typ | Popis |
|---|---|---|
IdStaff | uuid | Identifikátor zaměstnance |
StaffFullName | string | Jméno zaměstnance |
IdLocation | uuid | Identifikátor pobočky |
LocationName | string | Název pobočky |
Invoice | InvoiceDto | Souhrn přímých plateb |
Insurance | InsuranceDto | Souhrn pojišťovny |
Laboratory | LaboratoryDto | Souhrn laboratoře |
MaterialPayment | number | Spotřební materiál |
ClientCount | int | Počet klientů |
ReportCount | int | Počet záznamů |
Credit | CreditDto | Pohyby kreditu |
Profit | number | Výsledek |
InvoiceDto
| Pole | Typ | Popis |
|---|---|---|
Total | number | Celkem přímé platby |
SellPayment | number | Prodej |
DirectPayment | number | Přímé platby |
ServicePayment | number | Úhrady služeb |
ClientPayment | number | Úhrady klientů |
OtherPayment | number | Ostatní úhrady |
DiscountPrice | number | Slevy |
ExpenditurePayment | number | Výdaje |
OtherInvoiceNums | string | Související čísla dokladů |
InsuranceDto
| Pole | Typ | Popis |
|---|---|---|
Total | number | Celkem pojišťovna |
MaterialPrice | number | Materiál pro pojišťovnu |
ServicePrice | number | Výkony pro pojišťovnu |
LaboratoryDto
| Pole | Typ | Popis |
|---|---|---|
Total | number | Celkem laboratoř |
InsuranceLaboratoryPrice | number | Laboratorní cena z pojišťovny |
InvoiceLaboratoryPrice | number | Laboratorní cena z pokladny |
CreditDto
| Pole | Typ | Popis |
|---|---|---|
Deposit | number | Vklady kreditu |
Withdraw | number | Čerpání kreditu |
Typ úhrady
POST /api/v1/ExportRequest/Statistics/Staff/Type
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
DateFrom | datetime | ano | Začátek rozsahu podle data úhrady |
DateTo | datetime | ano | Konec rozsahu podle data úhrady |
IdLocation | uuid | ne | Filtr podle pobočky |
Odpověď
Odpověď je pole StatsStaffTypeExportDto[].
StatsStaffTypeExportDto
| Pole | Typ | Popis |
|---|---|---|
IdStaff | uuid | Identifikátor zaměstnance |
StaffFullName | string | Jméno zaměstnance |
IdLocation | uuid | Identifikátor pobočky |
LocationName | string | Název pobočky |
Payment | PaymentDto | Rozpad plateb podle typu |
PaymentDto
| Pole | Typ | Popis |
|---|---|---|
Total | number | Celkem úhrady |
Cash | number | Hotovost |
Card | number | Karta |
Transfer | number | Převod |
Coupon | number | Poukaz |
Other | number | Ostatní |
Credit | number | Platba kreditem |
Klienti
Aktivní
POST /api/v1/ExportRequest/Statistics/Client/Active
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
IdLocation | uuid | ne | Filtr podle pobočky |
Odpověď
Odpověď je pole StatsClientActiveExportDto[].
StatsClientActiveExportDto
| Pole | Typ | Popis |
|---|---|---|
Staff | StaffDto | Zaměstnanec |
ClientCount | int | Počet aktivních klientů |
StaffDto
| Pole | Typ | Popis |
|---|---|---|
Id | uuid | Identifikátor zaměstnance |
Name | string | Jméno zaměstnance |
Kredit
POST /api/v1/ExportRequest/Statistics/Client/Credit
- Tento export přijímá pouze
DateTo- vrací kredit k danému datu.
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
DateTo | datetime | ano | Stav kreditu k danému datu |
IdLocation | uuid | ne | Filtr podle pobočky |
Odpověď
Odpověď je pole StatsClientCreditExportDto[].
StatsClientCreditExportDto
| Pole | Typ | Popis |
|---|---|---|
Location | LocationDto | Pobočka |
Staff | StaffDto | Zaměstnanec |
Client | ClientDto | Klient |
Credit | number | Výše kreditu |
CurrencyCode | string | Kód měny |
InvoiceNumbers | string[] | Čísla dokladů |
LocationDto
| Pole | Typ | Popis |
|---|---|---|
Name | string | Název pobočky |
StaffDto
| Pole | Typ | Popis |
|---|---|---|
Name | string | Jméno zaměstnance |
ClientDto
| Pole | Typ | Popis |
|---|---|---|
Name | string | Jméno klienta |
Phone | string | Telefon klienta |
Email | string | E-mail klienta |
Address | string | Adresa klienta |
Pid | string | Rodné číslo / osobní identifikátor |
Tags | CustomTagEntry[] | Vlastní štítky klienta |
CustomTagEntry
| Pole | Typ | Popis |
|---|---|---|
customTagName | string | Název vlastního štítku |
color | string | Barva štítku |
Dluh
POST /api/v1/ExportRequest/Statistics/Client/Debt
- Tento export přijímá datové rozmezí
dluh v období.
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
DateFrom | datetime | ano | Začátek období dluhu |
DateTo | datetime | ano | Konec období dluhu |
IdLocation | uuid | ne | Filtr podle pobočky |
Odpověď
Odpověď je pole StatsClientDebtExportDto[].
StatsClientDebtExportDto
| Pole | Typ | Popis |
|---|---|---|
Staff | StaffDto | Zaměstnanec |
Client | ClientDto | Klient |
Debt | number | Výše dluhu |
InvoiceNumbers | string[] | Čísla dokladů |
StaffDto
| Pole | Typ | Popis |
|---|---|---|
Name | string | Jméno zaměstnance |
ClientDto
| Pole | Typ | Popis |
|---|---|---|
Name | string | Jméno klienta |
Phone | string | Telefon klienta |
Email | string | E-mail klienta |
Address | string | Adresa klienta |
Pid | string | Rodné číslo / osobní identifikátor |
Tags | CustomTagEntry[] | Vlastní štítky klienta |
CustomTagEntry
| Pole | Typ | Popis |
|---|---|---|
customTagName | string | Název vlastního štítku |
color | string | Barva štítku |
Pojišťovna
POST /api/v1/ExportRequest/Statistics/Client/Insurance
Parametry
Endpoint nemá parametry v těle požadavku.
Odpověď
Odpověď je pole StatsClientInsuranceExportDto[].
StatsClientInsuranceExportDto
| Pole | Typ | Popis |
|---|---|---|
Insurance | string | Kód a název pojišťovny |
ClientCount | int | Počet klientů |
Odstranění
POST /api/v1/ExportRequest/Statistics/Client/Deleted
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
IdLocation | uuid | ne | Filtr podle pobočky |
IdStaff | uuid | ne | Filtr podle zaměstnance |
Odpověď
Odpověď je pole StatsClientDeletedExportDto[].
StatsClientDeletedExportDto
| Pole | Typ | Popis |
|---|---|---|
Client | ClientDto | Klient |
Deletion | DeletionDto | Informace o odstranění |
ClientDto
| Pole | Typ | Popis |
|---|---|---|
Id | uuid | Identifikátor klienta |
FullName | string | Celé jméno klienta |
PersonalId | string | Rodné číslo / osobní identifikátor |
Contact | ContactDto | Kontaktní údaje |
Address | AddressDto | Adresa klienta |
ContactDto
| Pole | Typ | Popis |
|---|---|---|
Phone | string | Telefon klienta |
Email | string | E-mail klienta |
AddressDto
| Pole | Typ | Popis |
|---|---|---|
Street | string | Ulice |
City | string | Město |
Post | string | PSČ |
DeletionDto
| Pole | Typ | Popis |
|---|---|---|
ReasonId | uuid | Identifikátor důvodu odstranění |
ReasonTitle | string | Název důvodu odstranění |
DeletedAt | datetime | Datum odstranění |
Rozšířená
POST /api/v1/ExportRequest/Statistics/Client/Extended
- Tento export přijímá datové rozmezí
datum vytvoření záznamů a dokladů.
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
DateFrom | datetime | ano | Začátek rozsahu |
DateTo | datetime | ano | Konec rozsahu |
IdLocation | uuid | ne | Filtr podle pobočky |
IdStaff | uuid | ne | Filtr podle zaměstnance |
Odpověď
Odpověď je pole StatsClientExtendedExportDto[].
StatsClientExtendedExportDto
| Pole | Typ | Popis |
|---|---|---|
Client | ClientDto | Klient |
MedicalReport | MedicalReportDto | Data ze zdravotních záznamů |
Invoice | InvoiceDto | Data z pokladny |
ClientDto
| Pole | Typ | Popis |
|---|---|---|
IdClient | uuid | Identifikátor klienta |
Name | string | Jméno klienta |
MedicalReportDto
| Pole | Typ | Popis |
|---|---|---|
DirectPayments | number | Přímé platby v dokumentaci |
AdditionalPayment | number | Doplatky v dokumentaci |
Laboratory | number | Laboratorní část v dokumentaci |
Insurance | number | Pojišťovna v dokumentaci |
RecordCount | int | Počet zdravotních záznamů |
InvoiceDto
| Pole | Typ | Popis |
|---|---|---|
DirectPayments | number | Přímé platby v pokladně |
AdditionalPayment | number | Doplatky v pokladně |
Laboratory | number | Laboratorní část v pokladně |
Discount | number | Slevy |
Credit | number | Kredit |
InvoiceCount | int | Počet dokladů |
Kalendář
Aktivní
POST /api/v1/ExportRequest/Statistics/Calendar/Active
- Tento export přijímá datové rozmezí
datum objednávky.
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
DateFrom | datetime | ano | Začátek rozsahu podle data objednávky |
DateTo | datetime | ano | Konec rozsahu podle data objednávky |
IdLocation | uuid | ne | Filtr podle pobočky |
IdStaff | uuid | ne | Filtr podle zaměstnance |
Odpověď
Odpověď je pole StatsCalendarActiveExportDto[].
StatsCalendarActiveExportDto
| Pole | Typ | Popis |
|---|---|---|
Appointment | AppointmentDto | Objednávka |
Staff | StaffDto | Zaměstnanec |
Client | ClientDto | Klient |
Booking | BookingDto | Informace o objednání |
Meta | MetaDto | Metadata |
AppointmentDto
| Pole | Typ | Popis |
|---|---|---|
StartDate | datetime | Začátek objednávky |
Service | string | Název služby |
Status | int | Stav objednávky |
StatusName | string | Název stavu (pokud je dostupný) |
Duration | int | Délka objednávky v minutách |
StaffDto
| Pole | Typ | Popis |
|---|---|---|
IdStaff | uuid | Identifikátor zaměstnance |
FullName | string | Jméno zaměstnance |
ClientDto
| Pole | Typ | Popis |
|---|---|---|
IdClient | uuid | Identifikátor klienta |
FullName | string | Jméno klienta |
Phone | string | Telefon klienta |
Email | string | E-mail klienta |
Description | string | Poznámka ke klientovi/objednávce |
BookingDto
| Pole | Typ | Popis |
|---|---|---|
OnlineBooked | bool | Objednáno online |
FindUs | string | Zdroj, jak se klient dozvěděl o ordinaci |
MetaDto
| Pole | Typ | Popis |
|---|---|---|
CreatedDate | datetime | Datum vytvoření |
LastUpdateDate | datetime | Datum poslední úpravy |
CustomTags | CustomTagEntry[] | Vlastní štítky klienta |
CustomTagEntry
| Pole | Typ | Popis |
|---|---|---|
customTagName | string | Název vlastního štítku |
color | string | Barva štítku |
Odstraněno
POST /api/v1/ExportRequest/Statistics/Calendar/Deleted
- Tento export přijímá datové rozmezí
datum objednávky.
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
DateFrom | datetime | ano | Začátek rozsahu podle data objednávky |
DateTo | datetime | ano | Konec rozsahu podle data objednávky |
IdLocation | uuid | ne | Filtr podle pobočky |
IdStaff | uuid | ne | Filtr podle zaměstnance |
Odpověď
Odpověď je pole StatsCalendarDeletedExportDto[].
StatsCalendarDeletedExportDto
| Pole | Typ | Popis |
|---|---|---|
Appointment | AppointmentDto | Objednávka |
Staff | StaffDto | Zaměstnanec |
Client | ClientDto | Klient |
Cancellation | CancellationDto | Informace o zrušení |
AppointmentDto
| Pole | Typ | Popis |
|---|---|---|
StartDate | datetime | Začátek objednávky |
Service | string | Název služby |
Duration | int | Délka objednávky v minutách |
Description | string | Popis objednávky |
CreatedDate | datetime | Datum vytvoření |
LastUpdateDate | datetime | Datum poslední úpravy |
StaffDto
| Pole | Typ | Popis |
|---|---|---|
IdStaff | uuid | Identifikátor zaměstnance |
FullName | string | Jméno zaměstnance |
ClientDto
| Pole | Typ | Popis |
|---|---|---|
IdClient | uuid | Identifikátor klienta |
FullName | string | Jméno klienta |
Phone | string | Telefon klienta |
Email | string | E-mail klienta |
CustomTags | CustomTagEntry[] | Vlastní štítky klienta |
CustomTagEntry
| Pole | Typ | Popis |
|---|---|---|
customTagName | string | Název vlastního štítku |
color | string | Barva štítku |
CancellationDto
| Pole | Typ | Popis |
|---|---|---|
DateCancel | datetime | Datum zrušení |
CancelReason | string | Důvod zrušení |
IdStaffCancel | uuid | Identifikátor uživatele, který zrušil |
StaffFullNameCancel | string | Jméno uživatele, který zrušil |
Nové/Upravené
POST /api/v1/ExportRequest/Statistics/Calendar/NewUpdated
- Tento export přijímá datové rozmezí
datum poslední úpravy.
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
DateFrom | datetime | ano | Začátek rozsahu podle data poslední úpravy |
DateTo | datetime | ano | Konec rozsahu podle data poslední úpravy |
IdLocation | uuid | ne | Filtr podle pobočky |
IdStaff | uuid | ne | Filtr podle zaměstnance |
Odpověď
Odpověď je pole StatsCalendarNewUpdatedExportDto[].
StatsCalendarNewUpdatedExportDto
| Pole | Typ | Popis |
|---|---|---|
Appointment | AppointmentDto | Objednávka včetně vytvoření/úpravy |
AppointmentDto
| Pole | Typ | Popis |
|---|---|---|
StartDate | datetime | Začátek objednávky |
EndDate | datetime | Konec objednávky |
Service | string | Název služby |
Status | int | Stav objednávky |
StatusName | string | Název stavu (pokud je dostupný) |
Duration | int | Délka objednávky v minutách |
IsNew | bool | Nově vytvořená objednávka |
EventType | int | Typ záznamu |
OnlineBooked | bool | Objednáno online |
CreatedDate | datetime | Datum vytvoření |
LastUpdateDate | datetime | Datum poslední úpravy |
Staff | StaffDto | Zaměstnanec objednávky |
Client | ClientDto | Klient |
Creator | CreatorDto | Uživatel, který záznam vytvořil |
StaffDto
| Pole | Typ | Popis |
|---|---|---|
IdStaff | uuid | Identifikátor zaměstnance |
FullName | string | Jméno zaměstnance |
ClientDto
| Pole | Typ | Popis |
|---|---|---|
IdClient | uuid | Identifikátor klienta |
FullName | string | Jméno klienta |
Phone | string | Telefon klienta |
Email | string | E-mail klienta |
Description | string | Poznámka ke klientovi/objednávce |
CustomTags | CustomTagEntry[] | Vlastní štítky klienta |
CreatorDto
| Pole | Typ | Popis |
|---|---|---|
IdStaff | uuid | Identifikátor uživatele, který záznam vytvořil/upravil |
FullName | string | Jméno uživatele, který záznam vytvořil/upravil |
CustomTagEntry
| Pole | Typ | Popis |
|---|---|---|
customTagName | string | Název vlastního štítku |
color | string | Barva štítku |
Dispenzarizace
POST /api/v1/ExportRequest/Statistics/Calendar/Dispenzarizace
- Tento export přijímá datové rozmezí
datum dispenzarizace.
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
DateFrom | datetime | ano | Začátek rozsahu podle data dispenzarizace |
DateTo | datetime | ano | Konec rozsahu podle data dispenzarizace |
IdLocation | uuid | ne | Filtr podle pobočky |
IdStaff | uuid | ne | Filtr podle zaměstnance |
Odpověď
Odpověď je pole StatsCalendarDispenzarizaceExportDto[].
StatsCalendarDispenzarizaceExportDto
| Pole | Typ | Popis |
|---|---|---|
Visit | VisitDto | Informace o návštěvě |
Client | ClientDto | Klient |
Staff | StaffDto | Zaměstnanec |
Location | LocationDto | Pobočka |
VisitDto
| Pole | Typ | Popis |
|---|---|---|
DateVisit | datetime | Datum návštěvy |
ServiceCaption | string | Název služby |
ServiceDescription | string | Popis služby |
ServiceCreatedOn | datetime | Datum založení služby |
Booked | bool | Indikace, že je návštěva objednaná |
ClientDto
| Pole | Typ | Popis |
|---|---|---|
IdClient | uuid | Identifikátor klienta |
FullName | string | Jméno klienta |
Phone | string | Telefon klienta |
StaffDto
| Pole | Typ | Popis |
|---|---|---|
IdStaff | uuid | Identifikátor zaměstnance |
FullName | string | Jméno zaměstnance |
LocationDto
| Pole | Typ | Popis |
|---|---|---|
IdLocation | uuid | Identifikátor pobočky |
Name | string | Název pobočky |
Čekající
POST /api/v1/ExportRequest/Statistics/Calendar/Waiting
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
IdLocation | uuid | ne | Filtr podle pobočky |
IdStaff | uuid | ne | Filtr podle zaměstnance |
Odpověď
Odpověď je pole StatsCalendarWaitingExportDto[].
StatsCalendarWaitingExportDto
| Pole | Typ | Popis |
|---|---|---|
Client | ClientDto | Klient |
Service | ServiceDto | Služba |
Staff | StaffDto | Zaměstnanec |
Location | LocationDto | Pobočka |
Note | string | Poznámka |
DateAdded | datetime | Datum zařazení |
ClientDto
| Pole | Typ | Popis |
|---|---|---|
IdClient | uuid | Identifikátor klienta |
FullName | string | Jméno klienta |
Phone | string | Telefon klienta |
ServiceDto
| Pole | Typ | Popis |
|---|---|---|
IdService | uuid | Identifikátor služby |
Caption | string | Název služby |
StaffDto
| Pole | Typ | Popis |
|---|---|---|
IdStaff | uuid | Identifikátor zaměstnance |
FullName | string | Jméno zaměstnance |
LocationDto
| Pole | Typ | Popis |
|---|---|---|
IdLocation | uuid | Identifikátor pobočky |
Name | string | Název pobočky |
Formuláře
Podepsané
POST /api/v1/ExportRequest/Statistics/Forms/Signed
- Tento export přijímá datové rozmezí
datum podpisu.
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
DateFrom | datetime | ano | Začátek rozsahu podle data podpisu |
DateTo | datetime | ano | Konec rozsahu podle data podpisu |
IdLocation | uuid | ne | Filtr podle pobočky |
IdStaff | uuid | ne | Filtr podle zaměstnance |
Odpověď
Odpověď je pole StatsFormSignedExportDto[].
StatsFormSignedExportDto
| Pole | Typ | Popis |
|---|---|---|
Client | ClientDto | Klient |
Staff | StaffDto | Zaměstnanec |
Form | FormDto | Formulář |
ClientDto
| Pole | Typ | Popis |
|---|---|---|
IdClient | uuid | Identifikátor klienta |
Fullname | string | Jméno klienta |
StaffDto
| Pole | Typ | Popis |
|---|---|---|
IdStaff | uuid | Identifikátor zaměstnance |
Fullname | string | Jméno zaměstnance |
FormDto
| Pole | Typ | Popis |
|---|---|---|
IdFormRequest | uuid | Identifikátor formuláře |
Name | string | Název formuláře |
StatusCode | string | Kód stavu formuláře |
StatusText | string | Text stavu formuláře |
DateSigned | datetime | Datum podpisu |
ValidUntil | datetime | Datum expirace |
Expirace
POST /api/v1/ExportRequest/Statistics/Forms/Expiring
- Tento export přijímá datové rozmezí
platný od - do.
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
DateFrom | datetime | ano | Začátek rozsahu platnosti |
DateTo | datetime | ano | Konec rozsahu platnosti |
IdLocation | uuid | ne | Filtr podle pobočky |
IdStaff | uuid | ne | Filtr podle zaměstnance |
Odpověď
Odpověď je pole StatsFormExpiringExportDto[].
StatsFormExpiringExportDto
| Pole | Typ | Popis |
|---|---|---|
Client | ClientDto | Klient |
Staff | StaffDto | Zaměstnanec |
Form | FormDto | Formulář |
ClientDto
| Pole | Typ | Popis |
|---|---|---|
IdClient | uuid | Identifikátor klienta |
Fullname | string | Jméno klienta |
StaffDto
| Pole | Typ | Popis |
|---|---|---|
IdStaff | uuid | Identifikátor zaměstnance |
Fullname | string | Jméno zaměstnance |
FormDto
| Pole | Typ | Popis |
|---|---|---|
IdFormRequest | uuid | Identifikátor formuláře |
Name | string | Název formuláře |
ValidUntil | datetime | Datum expirace |
DateSigned | datetime | Datum podpisu |
Sklad
Položky
POST /api/v1/ExportRequest/Statistics/Store/Items
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
DateFrom | datetime | ano | Začátek rozsahu podle data operace |
DateTo | datetime | ano | Konec rozsahu podle data operace |
IdLocation | uuid | ne | Filtr podle pobočky |
IdStaff | uuid | ne | Filtr podle zaměstnance |
Odpověď
Odpověď je pole StatsStoreItemsExportDto[].
StatsStoreItemsExportDto
| Pole | Typ | Popis |
|---|---|---|
OperationDate | datetime | Datum operace |
DocumentNumber | string | Číslo dokladu |
Staff | StaffDto | Zaměstnanec |
Store | StoreDto | Sklad |
Partner | PartnerDto | Partner operace |
Operation | OperationDto | Typ a kód operace |
Material | MaterialDto | Materiál |
StaffDto
| Pole | Typ | Popis |
|---|---|---|
IdStaff | uuid | Identifikátor zaměstnance |
Name | string | Jméno zaměstnance |
StoreDto
| Pole | Typ | Popis |
|---|---|---|
IdStore | uuid | Identifikátor skladu |
Name | string | Název skladu |
PartnerDto
| Pole | Typ | Popis |
|---|---|---|
Id | uuid | Identifikátor partnera |
Name | string | Název partnera |
OperationDto
| Pole | Typ | Popis |
|---|---|---|
Type | string | Typ skladové operace |
Code | string | Kód skladové operace |
MaterialDto
| Pole | Typ | Popis |
|---|---|---|
Code | string | Kód materiálu |
Name | string | Název materiálu |
Lot | string | Šarže |
Expiration | datetime | Datum expirace |
Quantity | number | Množství |
Price | number | Cena |
Dokumentace
Lékařské záznamy
POST /api/v1/ExportRequest/Statistics/Documentation/MedicalReport
- Tento export přijímá datové rozmezí
datum lékařského záznamuadatum poslední úpravy.
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
DateFrom | datetime | ano | Začátek rozsahu podle data záznamu |
DateTo | datetime | ano | Konec rozsahu podle data záznamu |
LastUpdateFrom | datetime | ano | Začátek rozsahu podle data poslední úpravy |
LastUpdateTo | datetime | ano | Konec rozsahu podle data poslední úpravy |
IdLocation | uuid | ne | Filtr podle pobočky |
IdStaff | uuid | ne | Filtr podle zaměstnance |
Odpověď
Odpověď je pole StatsDocumentationMedicalReportExportDto[].
StatsDocumentationMedicalReportExportDto
| Pole | Typ | Popis |
|---|---|---|
MedicalReport | MedicalReportDto | Zdravotní záznam |
Staff | StaffDto | Zaměstnanec |
Location | LocationDto | Pobočka |
Client | ClientDto | Klient |
MedicalReportDto
| Pole | Typ | Popis |
|---|---|---|
IdMedicalReport | uuid | Identifikátor zdravotního záznamu |
Created | datetime | Datum vytvoření |
LastUpdate | datetime | Datum poslední úpravy |
IsDigitalSign | bool | Indikace digitálního podpisu |
StaffDto
| Pole | Typ | Popis |
|---|---|---|
IdStaff | uuid | Identifikátor zaměstnance |
StaffFullName | string | Jméno zaměstnance |
LocationDto
| Pole | Typ | Popis |
|---|---|---|
IdLocation | uuid | Identifikátor pobočky |
LocationName | string | Název pobočky |
ClientDto
| Pole | Typ | Popis |
|---|---|---|
IdClient | uuid | Identifikátor klienta |
ClientFullName | string | Jméno klienta |
PersonalId | string | Rodné číslo / osobní identifikátor |
Phone | string | Telefon klienta |
Vytvořené koncepty
POST /api/v1/ExportRequest/Statistics/Documentation/Draft
- Tento export přijímá datové rozmezí
datum vytvoření konceptu.
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
DateFrom | datetime | ano | Začátek rozsahu podle data vytvoření konceptu |
DateTo | datetime | ano | Konec rozsahu podle data vytvoření konceptu |
IdDoctor | uuid | ne | Filtr podle lékaře |
IdStaff | uuid | ne | Filtr podle zaměstnance |
IdLocation | uuid | ne | Filtr podle pobočky |
Odpověď
Odpověď je pole StatsDocumentationDraftExportDto[].
StatsDocumentationDraftExportDto
| Pole | Typ | Popis |
|---|---|---|
IdMedicalReport | uuid | Identifikátor záznamu |
Created | datetime | Datum vytvoření |
IsInsurance | bool | Koncept určený k vykázání na pojišťovnu |
AuthorizeStaff | AuthorizeStaffDto | Schvalující osoba |
DraftStaff | DraftStaffDto | Autor konceptu |
InsuranceStaff | InsuranceStaffDto | Vykazující osoba |
Location | LocationDto | Pobočka |
Client | ClientDto | Klient |
AuthorizeStaffDto
| Pole | Typ | Popis |
|---|---|---|
Id | uuid | Identifikátor schvalující osoby |
FullName | string | Jméno schvalující osoby |
DraftStaffDto
| Pole | Typ | Popis |
|---|---|---|
Id | uuid | Identifikátor autora konceptu |
FullName | string | Jméno autora konceptu |
InsuranceStaffDto
| Pole | Typ | Popis |
|---|---|---|
Id | uuid | Identifikátor vykazující osoby |
FullName | string | Jméno vykazující osoby |
LocationDto
| Pole | Typ | Popis |
|---|---|---|
Id | uuid | Identifikátor pobočky |
Name | string | Název pobočky |
ClientDto
| Pole | Typ | Popis |
|---|---|---|
Id | uuid | Identifikátor klienta |
FullName | string | Jméno klienta |
PersonalId | string | Rodné číslo / osobní identifikátor |
Přímé platby
POST /api/v1/ExportRequest/Statistics/Documentation/DirectPayment
- Tento export přijímá datové rozmezí
datum lékařského záznamu.
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
DateFrom | datetime | ano | Začátek rozsahu podle data záznamu |
DateTo | datetime | ano | Konec rozsahu podle data záznamu |
IdLocation | uuid | ne | Filtr podle pobočky |
IdStaff | uuid | ne | Filtr podle zaměstnance |
Odpověď
Odpověď je pole StatsDocumentationDirectPaymentExportDto[].
StatsDocumentationDirectPaymentExportDto
| Pole | Typ | Popis |
|---|---|---|
IdMedicalReport | uuid | Identifikátor záznamu |
Created | datetime | Datum vytvoření |
Supervisor | SupervisorDto | Odpovědná osoba |
Location | LocationDto | Pobočka |
Client | ClientDto | Klient |
Item | InvoiceItemDto | Fakturační položka |
SupervisorDto
| Pole | Typ | Popis |
|---|---|---|
Id | uuid | Identifikátor odpovědné osoby |
Name | string | Jméno odpovědné osoby |
LocationDto
| Pole | Typ | Popis |
|---|---|---|
Id | uuid | Identifikátor pobočky |
Name | string | Název pobočky |
ClientDto
| Pole | Typ | Popis |
|---|---|---|
Id | uuid | Identifikátor klienta |
Name | string | Jméno klienta |
InvoiceItemDto
| Pole | Typ | Popis |
|---|---|---|
IdInvoiceCode | uuid | Identifikátor kódu položky |
Code | string | Kód položky |
Duration | int | Délka výkonu |
Quantity | number | Množství |
Price | number | Cena |
Notifikace
Odpovědi
POST /api/v1/ExportRequest/Statistics/Notifications/Answers
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
DateFrom | datetime | ano | Začátek rozsahu podle data odpovědi |
DateTo | datetime | ano | Konec rozsahu podle data odpovědi |
IdLocation | uuid | ne | Filtr podle pobočky |
IdStaff | uuid | ne | Filtr podle zaměstnance |
Odpověď
Odpověď je pole StatsNotificationsAnswersExportDto[].
StatsNotificationsAnswersExportDto
| Pole | Typ | Popis |
|---|---|---|
Answer | AnswerDto | Odpověď na notifikaci |
Client | ClientDto | Klient |
Appointment | AppointmentDto | Objednávka |
Staff | StaffDto | Zaměstnanec |
Location | LocationDto | Pobočka |
AnswerDto
| Pole | Typ | Popis |
|---|---|---|
IdAnswer | uuid | Identifikátor odpovědi |
DateReceived | datetime | Datum přijetí odpovědi |
ContentAnswer | string | Obsah odpovědi |
ContentOriginal | string | Původní obsah zprávy |
ArcStatus | int | Vyhodnocení odpovědi: 0 = potvrzení termínu, 1 = zrušení, 2 = nerozpoznaná odpověď. null, pokud není aktivní automatické potvrzování objednávek. |
Confirmed | bool | Odpověď je v XDENT označena jako přečtená (automaticky u kladné odpovědi, jinak ručně uživatelem). |
ClientDto
| Pole | Typ | Popis |
|---|---|---|
IdClient | uuid | Identifikátor klienta |
Fullname | string | Jméno klienta |
Phone | string | Telefon klienta |
AppointmentDto
| Pole | Typ | Popis |
|---|---|---|
IdAppointment | uuid | Identifikátor objednávky |
StartDate | datetime | Začátek objednávky |
EndDate | datetime | Konec objednávky |
IdService | uuid | Identifikátor služby |
Service | string | Název služby |
AppointmentDateDisplay | string | Textová reprezentace termínu (pokud je dostupná) |
StaffDto
| Pole | Typ | Popis |
|---|---|---|
IdStaff | uuid | Identifikátor zaměstnance |
Fullname | string | Jméno zaměstnance |
LocationDto
| Pole | Typ | Popis |
|---|---|---|
IdLocation | uuid | Identifikátor pobočky |
Name | string | Název pobočky |
Poznámky k parametrům
- UUID hodnoty pro
IdLocationzískáte z endpointů Pobočky. - UUID hodnoty pro
IdStaff,IdSupervisoraIdDoctorzískáte z endpointů Zaměstnanci.