Export types overview
This overview lists all available export types, their endpoints, supported output formats, and parameters.
The full asynchronous workflow is described in the exports section.
Availability
Exports are available only for Business and Enterprise plans.
How to read parameters
- Endpoint calls use
POST /api/{version}/ExportRequest/{type}. - All parameters listed in the tables below (for example
DateFrom,DateTo,IdStaff) are sent in the request body (application/json). - Only generic export options belong to query string:
format,password,email,callback. - Date and time values in export files without
Utcin the field name are XDENT local time. Fields withUtcin the name are true UTC.
General exports
Test export
POST /api/v1/ExportRequest/Test
Test export intended for testing export integration.
- This export supports
CSVformat only.
Parameters
This endpoint has no request-body parameters.
You can use generic export options in query string:
| Parameter | Type | Required | Description |
|---|---|---|---|
format | string | no | Export output format (CSV) |
password | string | no | Password for the generated ZIP file |
email | string | no | Email for notification after export completion |
callback | string | no | Callback URL called after export completion |
Response
| Column | Value |
|---|---|
Export Type | Always TEST |
Generated At UTC | Current UTC time at export generation (ISO O format) |
Job ID | Export identifier |
Invoicing
POST /api/v1/ExportRequest/Invoices
Detailed export of client invoices, including line items.
This export is based on an older implementation and will be replaced by a newer version in the future.
- This export is available only in
JSONformat.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
DateFrom | datetime | yes | Start of the data range by invoice issue or modification date |
DateTo | datetime | yes | End of the data range by invoice issue or modification date |
Response
Response is an InvoiceExportInfo object.
| Field | Type | Description |
|---|---|---|
dateCreated | datetime | Export creation date |
companies | InvoiceExportCompanyInfo[] | Companies included in the export |
InvoiceExportCompanyInfo
| Field | Type | Description |
|---|---|---|
idCRM | string | External company identifier |
companyName | string | Company name |
clients | InvoiceExportClientInfo[] | Clients with records in the export |
InvoiceExportClientInfo
| Field | Type | Description |
|---|---|---|
idClient | uuid | Client identifier |
fullName | string | Client full name |
phone | string | Client phone |
email | string | Client email |
city | string | Client city |
street | string | Client street |
post | string | Client ZIP/postal code |
staffName | string | Responsible staff name |
clientId | int | Numeric client ID |
staffId | int | Numeric staff ID |
reports | InvoiceExportMedicalReportInfo[] | Client medical records |
invoices | InvoiceExportInvoiceInfo[] | Client documents |
InvoiceExportMedicalReportInfo
| Field | Type | Description |
|---|---|---|
IdMedicalReport | uuid | Medical record identifier |
date | datetime | Medical record date |
insuranceItems | InvoiceExportInsuranceItemInfo[] | Insurance items in the medical record |
InvoiceExportInsuranceItemInfo
| Field | Type | Description |
|---|---|---|
code | string | Item code |
insurancePrice | number | Insurance price |
laboratoryPrice | number | Laboratory price |
patientPrice | number | Client price |
InvoiceExportInvoiceInfo
| Field | Type | Description |
|---|---|---|
idInvoice | uuid | Document identifier |
idSupervisor | uuid | Identifier of the responsible person on the document |
dateIssue | datetime | Issue date |
dateDue | datetime | Due date |
dateTax | datetime | Taxable supply date |
dateLastChange | datetime | Last change date |
invoiceNumber | long | Document number |
accountNumber | string | Account number |
bankCode | string | Bank code |
billingName | string | Billing first name |
billingSurname | string | Billing last name |
billingStreet | string | Billing street |
billingCity | string | Billing city |
billingPost | string | Billing ZIP/postal code |
billingRegNumber | string | Company registration number |
billingVatNumber | string | VAT ID |
billingType | string | Payment type |
officeName | string | Office/company name |
officeStreet | string | Office street |
officeCity | string | Office city |
officePost | string | Office ZIP/postal code |
officeCountry | string | Office country |
officeEmail | string | Office email |
officePhone | string | Office phone |
officeWeb | string | Office web |
currency | string | Currency of the account. priceTotal, priceDiscount, priceService, priceMaterial, priceDebt and payments are in this currency |
currencyTotal | string | Currency in which the document is issued. Empty for documents in the account currency |
currencyRate | number | Exchange rate: units of currency per 1 unit of currencyTotal |
deposit | number | Legacy deposit, 0 on new documents. Not included in priceDebt |
discount | number | Discount |
eetLock | int | Flag indicating the document is locked after being sent to EET |
iban | string | IBAN |
swift | string | SWIFT |
type | string | Document type |
invoiceVat | bool | Whether the document is issued with VAT |
note | string | Note |
paid | bool | Whether the document is paid |
priceDiscount | number | Discount amount |
priceLaboratory | number | Laboratory price |
priceMaterial | number | Material price |
priceService | number | Service price |
priceTotal | number | Total price |
priceCredit | number | Amount covered by client credit, in the document currency (currencyTotal) |
priceDebt | number | Debt amount in currency |
providerName | string | Responsible person first name |
providerSurname | string | Responsible person last name |
providerDegree | string | Title before name |
providerDegreeAfter | string | Title after name |
regNumber | string | Registration number of the location that issued the document |
vatNumber | string | VAT ID of the location that issued the document |
variableSymbol | string | Payment gateway order number, if one is recorded for the document |
writtenBy | string | Issued by |
providerId | int | Numeric ID of the responsible person |
items | InvoiceExportDetailInfo[] | Document line items |
payments | InvoiceExportPaymentInfo[] | Document payments |
InvoiceExportDetailInfo
| Field | Type | Description |
|---|---|---|
idInvoiceDetail | uuid | Document item identifier |
idParent | uuid | Parent item identifier |
id | int | Item sequence number |
parentId | int | Parent item sequence number |
code | string | Item code |
codeType | string | Code type |
description | string | Description |
duration | int | Procedure duration |
materialType | string | Material type |
name | string | Item name |
note | string | Note |
position | int | Position in document |
priceLaboratory | number | Laboratory price |
pricePerMinute | number | Price per minute |
quantity | number | Quantity |
unitPrice | number | Unit price including VAT. In currency, for items from a price list kept in a foreign currency, in currencyTotal |
vatRate | string | Item VAT rate in percent |
InvoiceExportPaymentInfo
| Field | Type | Description |
|---|---|---|
idSupervisor | uuid | Responsible person identifier |
pricePayment | number | Paid amount in currency |
datePayment | datetime | Payment date |
note | string | Payment note |
billingType | string | Payment type |
currency | string | Document currency |
providerId | int | Numeric ID of the responsible person |
providerFirstname | string | Responsible person first name |
providerLastname | string | Responsible person last name |
type
| Value | Meaning |
|---|---|
INVOICE_TYPE_BILL | Invoice |
INVOICE_TYPE_INVOICE | Receipt |
INVOICE_TYPE_SPECIFICATION | Price quote |
INVOICE_TYPE_EXPENDITURE | Expense document |
INVOICE_TYPE_CREDIT | Credit top-up |
billingType
The same values are used for both the invoice and the payment. On the invoice, the value may be empty if no payment type is set.
| Value | Meaning |
|---|---|
INVOICE_PAYMENT_TYPE_CASH | Cash |
INVOICE_PAYMENT_TYPE_CARD | Payment card |
INVOICE_PAYMENT_TYPE_TRANSFER | Bank transfer |
INVOICE_PAYMENT_TYPE_COUPON | Coupon |
INVOICE_PAYMENT_TYPE_OTHER | Other |
Calendar
POST /api/v1/ExportRequest/Calendar
Detailed calendar export for capacity overview, office hours, notes, and appointments/reservations in the selected period.
This export is available only in
JSONformat.This export accepts a maximum range of 31 days.
Values in
IdStaffmust correspond to staff members with a calendar. If the request contains a user that is not a calendar staff member, the export fails with a validation error.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
DateFrom | datetime | yes | Start of data range |
DateTo | datetime | yes | End of data range |
IdStaff | uuid[] | yes | List of staff identifiers |
Response
Response is a CalendarExtendedExportStaffDto[] array.
CalendarExtendedExportStaffDto
| Field | Type | Description |
|---|---|---|
IdStaff | uuid | Staff identifier |
StaffName | string | Staff name |
Days | CalendarExtendedExportDayDto[] | Days in the requested period |
CalendarExtendedExportDayDto
| Field | Type | Description |
|---|---|---|
Date | datetime | Day date |
Appointments | CalendarExtendedExportAppointmentDto[] | Appointments/reservations |
Notes | CalendarExtendedExportNoteDto[] | Notes |
OpenHours | CalendarExtendedExportOpenHourDto[] | Office hours |
IsHoliday | bool | Holiday flag |
CalendarExtendedExportAppointmentDto
| Field | Type | Description |
|---|---|---|
IdAppointment | uuid | Appointment identifier |
StartDate | datetime | Appointment start |
EndDate | datetime | Appointment end |
Subject | string | Subject |
Description | string | Description |
IdClient | uuid | Client identifier |
IdService | uuid | Service identifier |
EntryType | string | Entry type |
OccurrenceType | string | Occurrence type |
Status | string | Appointment status |
OnlineBooked | bool | Appointment created online |
Confirmed | bool | Appointment confirmation |
NoShow | bool | Client did not arrive |
NewClient | bool | New client |
CalendarExtendedExportNoteDto
| Field | Type | Description |
|---|---|---|
IdNote | uuid | Note identifier |
Subject | string | Subject |
Description | string | Description |
OccurrenceType | string | Occurrence type |
CalendarExtendedExportOpenHourDto
| Field | Type | Description |
|---|---|---|
IdOpenHour | uuid | Office hour identifier |
StartDate | datetime | Start |
EndDate | datetime | End |
Subject | string | Subject |
Description | string | Description |
OccurrenceType | string | Occurrence type |
Active | bool | Active office hour |
ActiveOverride | bool | Overridden by exception |
EntryType
| Value | Meaning |
|---|---|
CLIENT_APPOINTMENT | Client appointment (record has IdClient) |
STAFF_RESERVATION | Staff reservation (record has no IdClient) |
OccurrenceType
| Value | Meaning |
|---|---|
ONE_OFF | One-time record |
RECURRING | Recurring record |
EDITED_EXCEPTION | Edited exception of a recurring record |
DELETED_EXCEPTION | Deleted exception of a recurring record |
Status
| Value | Meaning |
|---|---|
ORDERED | Ordered |
CONFIRMED | Confirmed |
WAITING | Waiting |
TAKING_CARE | In treatment |
TAKEN_CARE | Treated |
FINISHED | Finished |
NOT_ARRIVED | Did not arrive |
Statistics exports
In statistics exports:
- listed exports support both
CSVandJSONformats, CSVformat is 1:1 equivalent to table exports in XDENT statistics,- the response documented below describes the JSON version of the export.
Cash register
Basic
POST /api/v1/ExportRequest/Statistics/Invoice/Basic
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
DateFrom | datetime | yes | Start of range by invoice issue date |
DateTo | datetime | yes | End of range by invoice issue date |
IdSupervisor | uuid | no | Filter by responsible person |
IdLocation | uuid | no | Filter by location |
Response
Response is a StatsInvoiceItemsBasicExportDto[] array.
StatsInvoiceItemsBasicExportDto
| Field | Type | Description |
|---|---|---|
InvoiceCode | InvoiceCodeDto | Invoice item |
Supervisor | SupervisorDto | Responsible person |
Laboratory | LaboratoryDto | Laboratory (if available) |
SupervisorDto
| Field | Type | Description |
|---|---|---|
IdSupervisor | uuid | Responsible person identifier |
Name | string | Responsible person name |
LaboratoryDto
| Field | Type | Description |
|---|---|---|
IdLaboratory | uuid | Laboratory identifier |
Name | string | Laboratory name |
InvoiceCodeDto
| Field | Type | Description |
|---|---|---|
IdInvoiceCode | uuid | Invoice code identifier |
Code | string | Item code |
Name | string | Item name |
Description | string | Item description |
Quantity | number | Quantity |
Price | number | Price |
PriceNoVat | number | Price without VAT |
PriceLaboratory | number | Laboratory price |
Type | ItemTypeDto | Item type |
Vat | VatDto | VAT |
ItemTypeDto
| Field | Type | Description |
|---|---|---|
IdCodeType | uuid | Code type identifier |
CodeType | string | Type code |
IdMaterialCode | uuid | Material type identifier |
MaterialCodeType | string | Material type |
CodeGroupType | string | Group code |
CodeGroupTypeTitle | string | Group title |
VatDto
| Field | Type | Description |
|---|---|---|
IdVatRate | uuid | VAT rate identifier |
RateCode | string | Rate code |
Rate | int | VAT rate value |
Extended
POST /api/v1/ExportRequest/Statistics/Invoice/Extended
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
DateFrom | datetime | yes | Start of range by invoice issue date |
DateTo | datetime | yes | End of range by invoice issue date |
IdSupervisor | uuid | no | Filter by responsible person |
IdLocation | uuid | no | Filter by location |
Response
Response is a StatsInvoiceItemsExtendedExportDto[] array.
StatsInvoiceItemsExtendedExportDto
| Field | Type | Description |
|---|---|---|
Client | ClientDto | Client |
Invoice | InvoiceDto | Document |
InvoiceCode | InvoiceCodeDto | Invoice item |
Supervisor | SupervisorDto | Responsible person |
Laboratory | LaboratoryDto | Laboratory |
Location | LocationDto | Location |
CustomTags | CustomTagEntry[] | Client custom tags |
ClientDto
| Field | Type | Description |
|---|---|---|
IdClient | uuid | Client identifier |
ClientName | string | Client name |
PersonalId | string | Personal ID |
InvoiceDto
| Field | Type | Description |
|---|---|---|
InvoiceNumber | long | Document number |
DateIssue | datetime | Issue date |
IsPaid | bool | Paid flag |
IsFullyPaid | bool | Document is fully paid |
SupervisorDto
| Field | Type | Description |
|---|---|---|
IdSupervisor | uuid | Responsible person identifier |
Name | string | Responsible person name |
LocationDto
| Field | Type | Description |
|---|---|---|
IdLocation | uuid | Location identifier |
Name | string | Location name |
CustomTagEntry
| Field | Type | Description |
|---|---|---|
customTagName | string | Custom tag name |
color | string | Tag color |
InvoiceCodeDto
| Field | Type | Description |
|---|---|---|
IdInvoiceCode | uuid | Invoice code identifier |
Code | string | Item code |
Name | string | Item name |
Description | string | Item description |
Quantity | number | Quantity |
Price | number | Price |
PriceNoVat | number | Price without VAT |
PriceLaboratory | number | Laboratory price |
Duration | int | Procedure duration |
LocalizationCode | string | Localization code |
Note | string | Note |
Type | ItemTypeDto | Item type |
Vat | VatDto | VAT |
VatDto
| Field | Type | Description |
|---|---|---|
IdVatRate | uuid | VAT rate identifier |
RateCode | string | Rate code |
Rate | int | VAT rate value |
ItemTypeDto
| Field | Type | Description |
|---|---|---|
IdCodeType | uuid | Code type identifier |
CodeType | string | Code type |
IdMaterialCode | uuid | Material type identifier |
MaterialCodeType | string | Material type |
CodeGroupType | string | Group code |
CodeGroupTypeTitle | string | Group title |
LaboratoryDto
| Field | Type | Description |
|---|---|---|
IdLaboratory | uuid | Laboratory identifier |
Name | string | Laboratory name |
Items
POST /api/v1/ExportRequest/Statistics/Invoice/Items
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
DateFrom | datetime | yes | Start of range by invoice issue date |
DateTo | datetime | yes | End of range by invoice issue date |
IdSupervisor | uuid | no | Filter by responsible person |
IdLocation | uuid | no | Filter by location |
Response
Response is a StatsInvoiceItemsExportDto[] array.
StatsInvoiceItemsExportDto
| Field | Type | Description |
|---|---|---|
Item | ItemDto | Invoice item |
Location | LocationDto | Location |
Type | TypeDto | Item type |
Quantity | number | Quantity |
Price | number | Price |
PriceNoVat | number | Price without VAT |
VRate | int | VAT rate |
ItemDto
| Field | Type | Description |
|---|---|---|
Code | string | Item code |
Name | string | Item name |
Description | string | Item description |
LocationDto
| Field | Type | Description |
|---|---|---|
IdLocation | uuid | Location identifier |
Name | string | Location name |
TypeDto
| Field | Type | Description |
|---|---|---|
IdCodeType | uuid | Code type identifier |
TypeCode | string | Type code |
IdMaterialType | uuid | Material type identifier |
MaterialTypeCode | string | Material type |
GroupCode | string | Group code |
GroupTitle | string | Group title |
Payment gateway
POST /api/v1/ExportRequest/Statistics/Invoice/PaymentGateway
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
DateFrom | datetime | yes | Start of range by invoice issue date |
DateTo | datetime | yes | End of range by invoice issue date |
IdSupervisor | uuid | no | Filter by responsible person |
IdLocation | uuid | no | Filter by location |
Response
Response is a StatsInvoicePaymentGatewayExportDto[] array.
StatsInvoicePaymentGatewayExportDto
| Field | Type | Description |
|---|---|---|
IdPaymentGatewayRequest | uuid | Payment gateway request identifier |
Location | LocationDto | Location |
Client | ClientDto | Client |
Invoice | InvoiceDto | Document |
Supervisor | SupervisorDto | Responsible person |
Appointment | AppointmentDto | Appointment |
Service | ServiceDto | Service |
Price | number | Price |
DateIssue | datetime | Issue date |
LocationDto
| Field | Type | Description |
|---|---|---|
IdLocation | uuid | Location identifier |
Name | string | Location name |
ClientDto
| Field | Type | Description |
|---|---|---|
IdClient | uuid | Client identifier |
Name | string | Client name |
InvoiceDto
| Field | Type | Description |
|---|---|---|
IdInvoice | uuid | Document identifier |
InvoiceNumber | long | Document number |
OrderNumber | long | Payment gateway order number |
SupervisorDto
| Field | Type | Description |
|---|---|---|
IdSupervisor | uuid | Responsible person identifier |
Name | string | Responsible person name |
AppointmentDto
| Field | Type | Description |
|---|---|---|
IdAppointment | uuid | Appointment identifier |
IdStaff | uuid | Staff identifier on appointment |
StartDate | datetime | Appointment start |
EndDate | datetime | Appointment end |
AppointmentDateDisplay | string | Text representation of the appointment date (if available) |
ServiceDto
| Field | Type | Description |
|---|---|---|
IdService | uuid | Service identifier |
Caption | string | Service name |
Insurance
Documents
POST /api/v1/ExportRequest/Statistics/Insurance/Invoice
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
DateFrom | datetime | yes | Start of range by billing date |
DateTo | datetime | yes | End of range by billing date |
IdStaff | uuid | no | Filter by staff member |
IdLocation | uuid | no | Filter by location |
Response
Response is a StatsInsuranceInvoiceExportDto[] array.
StatsInsuranceInvoiceExportDto
| Field | Type | Description |
|---|---|---|
Report | ReportDto | Reporting information |
Client | ClientDto | Client |
Staff | StaffDto | Staff |
Pricing | PricingDto | Prices |
ReportDto
| Field | Type | Description |
|---|---|---|
IdReport | uuid | Record identifier |
Date | datetime | Record date |
IdBatch | uuid | Batch identifier |
BatchNumber | long | Batch number |
DocumentNumber | long | Document number |
CreatedAt | datetime | Creation date |
Insurance | InsuranceDto | Insurance company |
Sent | bool | Sent flag |
InsuranceDto
| Field | Type | Description |
|---|---|---|
IdInsurance | uuid | Insurance company identifier |
Name | string | Insurance company name |
IdInsuranceType | uuid | Insurance type identifier |
TypeName | string | Insurance type name |
PricingDto
| Field | Type | Description |
|---|---|---|
InsuranceTotal | number | Total for insurance company |
ClientTotal | number | Total for client |
LaboratoryPrice | number | Laboratory price |
Profit | number | Result (insurance + client − laboratory) |
ClientDto
| Field | Type | Description |
|---|---|---|
IdClient | uuid | Client identifier |
Name | string | Client name |
PersonalId | string | Personal ID |
StaffDto
| Field | Type | Description |
|---|---|---|
IdStaff | uuid | Staff identifier |
Name | string | Staff name |
Basic
POST /api/v1/ExportRequest/Statistics/Insurance/Basic
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
DateFrom | datetime | yes | Start of range by billing date |
DateTo | datetime | yes | End of range by billing date |
IdStaff | uuid | no | Filter by staff member |
IdLocation | uuid | no | Filter by location |
Response
Response is a StatsInsuranceBasicExportDto[] array.
StatsInsuranceBasicExportDto
| Field | Type | Description |
|---|---|---|
Staff | StaffDto | Staff |
Item | ItemDto | Item |
Insurance | InsuranceDto | Insurance company |
Prices | PricesDto | Prices |
StaffDto
| Field | Type | Description |
|---|---|---|
IdStaff | uuid | Staff identifier |
Name | string | Staff name |
ItemDto
| Field | Type | Description |
|---|---|---|
Code | string | Item code |
Name | string | Item name |
Type | string | Item type code |
TypeName | string | Localized item type title (if available) |
Amount | number | Quantity |
InsuranceDto
| Field | Type | Description |
|---|---|---|
IdInsurance | uuid | Insurance company identifier |
Name | string | Insurance company name |
PricesDto
| Field | Type | Description |
|---|---|---|
InsurancePrice | number | Insurance price |
ClientPrice | number | Client price |
LaboratoryPrice | number | Laboratory price |
Extended
POST /api/v1/ExportRequest/Statistics/Insurance/Extended
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
DateFrom | datetime | yes | Start of range by billing date |
DateTo | datetime | yes | End of range by billing date |
IdStaff | uuid | no | Filter by staff member |
IdLocation | uuid | no | Filter by location |
Response
Response is a StatsInsuranceExtendedExportDto[] array.
StatsInsuranceExtendedExportDto
| Field | Type | Description |
|---|---|---|
Staff | StaffDto | Staff |
Client | ClientDto | Client |
Item | ItemDto | Item |
Insurance | InsuranceDto | Insurance company |
Laboratory | LaboratoryDto | Laboratory |
Report | ReportDto | Record data |
Prices | PricesDto | Prices |
CustomTags | CustomTagEntry[] | Client custom tags |
StaffDto
| Field | Type | Description |
|---|---|---|
IdStaff | uuid | Staff identifier |
Name | string | Staff name |
ClientDto
| Field | Type | Description |
|---|---|---|
IdClient | uuid | Client identifier |
Name | string | Client name |
PersonalId | string | Personal ID |
Address | AddressDto | Client address |
AddressDto
| Field | Type | Description |
|---|---|---|
City | string | City |
Street | string | Street |
Post | string | ZIP/postal code |
ItemDto
| Field | Type | Description |
|---|---|---|
Code | string | Item code |
Name | string | Item name |
CodeType | string | Item type code |
Amount | number | Quantity |
Localization | int | Tooth localization |
InsuranceDto
| Field | Type | Description |
|---|---|---|
IdInsurance | uuid | Insurance company identifier |
Name | string | Insurance company name |
InsuranceType | InsuranceTypeDto | Insurance type (if available) |
InsuranceTypeDto
| Field | Type | Description |
|---|---|---|
IdInsuranceType | uuid | Insurance type identifier |
ClientInsuranceType | string | Insurance type name |
LaboratoryDto
| Field | Type | Description |
|---|---|---|
IdLaboratory | uuid | Laboratory identifier |
Name | string | Laboratory name |
ReportDto
| Field | Type | Description |
|---|---|---|
ReportDate | datetime | Record date |
Diagnose | string | Diagnosis |
PaymentType | string | Insurance payment type (if available) |
PricesDto
| Field | Type | Description |
|---|---|---|
InsurancePrice | number | Insurance price |
ClientPrice | number | Client price |
LaboratoryPrice | number | Laboratory price |
CustomTagEntry
| Field | Type | Description |
|---|---|---|
customTagName | string | Custom tag name |
color | string | Tag color |
Items
POST /api/v1/ExportRequest/Statistics/Insurance/Items
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
DateFrom | datetime | yes | Start of range by billing date |
DateTo | datetime | yes | End of range by billing date |
IdStaff | uuid | no | Filter by staff member |
IdLocation | uuid | no | Filter by location |
Response
Response is a StatsInsuranceItemsExportDto[] array.
StatsInsuranceItemsExportDto
| Field | Type | Description |
|---|---|---|
Code | string | Item code |
Name | string | Item name |
Amount | number | Quantity |
Type | ItemTypeDto | Item type |
Prices | PricesDto | Prices |
Location | LocationDto | Location |
ItemTypeDto
| Field | Type | Description |
|---|---|---|
CodeType | string | Item type code |
CodeTypeTitle | string | Localized item type title |
PricesDto
| Field | Type | Description |
|---|---|---|
InsurancePrice | number | Insurance price |
ClientPrice | number | Client price |
LaboratoryPrice | number | Laboratory price |
LocationDto
| Field | Type | Description |
|---|---|---|
IdLocation | uuid | Location identifier |
Name | string | Location name |
Register
POST /api/v1/ExportRequest/Statistics/Insurance/Register
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
DateFrom | datetime | yes | Start of range by registration date |
DateTo | datetime | yes | End of range by registration date |
IdStaff | uuid | no | Filter by staff member |
IdLocation | uuid | no | Filter by location |
Response
Response is a StatsInsuranceRegisterExportDto[] array.
StatsInsuranceRegisterExportDto
| Field | Type | Description |
|---|---|---|
RegistrationDate | datetime | Registration date |
Client | ClientDto | Client |
Insurance | InsuranceDto | Insurance company |
Staff | StaffDto | Insurance staff member |
Batch | BatchDto | Batch |
ClientDto
| Field | Type | Description |
|---|---|---|
IdClient | uuid | Client identifier |
Name | string | Client name |
PersonalId | string | Personal ID |
InsuranceDto
| Field | Type | Description |
|---|---|---|
Id | uuid | Insurance company identifier |
Name | string | Insurance company name |
Type | TypeDto | Insurance type |
TypeDto
| Field | Type | Description |
|---|---|---|
Id | uuid | Insurance type identifier |
Name | string | Insurance type name |
StaffDto
| Field | Type | Description |
|---|---|---|
Id | uuid | Staff identifier |
Name | string | Staff name |
Icp | string | ICP |
BatchDto
| Field | Type | Description |
|---|---|---|
CreatedAt | datetime | Batch creation date |
Number | long | Batch number |
Batches
POST /api/v1/ExportRequest/Statistics/Insurance/Davky
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
DateFrom | datetime | yes | Start of range by batch period |
DateTo | datetime | yes | End of range by batch period |
Valid | bool | yes | Filter valid / invalid records |
IdStaff | uuid | no | Filter by staff member |
IdLocation | uuid | no | Filter by location |
Response
Response is a StatsInsuranceDavkyExportDto[] array.
StatsInsuranceDavkyExportDto
| Field | Type | Description |
|---|---|---|
Invoice | InvoiceDto | Batch/document |
Insurance | InsuranceDto | Insurance company |
Staff | StaffDto | Staff |
Location | LocationDto | Location |
InvoiceDto
| Field | Type | Description |
|---|---|---|
IdInsuranceInvoice | uuid | Insurance batch identifier |
PeriodStart | datetime | Period start |
PeriodEnd | datetime | Period end |
VCIS | long | VCIS number |
DCIS | long | DCIS number |
AHCID | long | AHCID value |
ZHCID | long | ZHCID value |
HCID | long | HCID value |
InvoiceType | string | Batch type |
Care | string | Care type |
TotalPrice | number | Total price |
TotalPoint | number | Total points |
Description | string | Description |
CreatedDate | datetime | Creation date |
InsuranceDto
| Field | Type | Description |
|---|---|---|
IdInsuranceCompany | uuid | Insurance company identifier |
Code | string | Insurance code |
IdInsuranceType | uuid | Insurance type identifier |
InsuranceTypeName | string | Insurance type name |
StaffDto
| Field | Type | Description |
|---|---|---|
IdStaff | uuid | Staff identifier |
FullName | string | Staff name |
LocationDto
| Field | Type | Description |
|---|---|---|
IdLocation | uuid | Location identifier |
Name | string | Location name |
Staff
Item types
POST /api/v1/ExportRequest/Statistics/Staff/Items
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
DateFrom | datetime | yes | Start of range by payment date |
DateTo | datetime | yes | End of range by payment date |
IdStaff | uuid | no | Filter by staff member |
IdLocation | uuid | no | Filter by location |
Response
Response is a StatsStaffItemsExportDto[] array.
StatsStaffItemsExportDto
| Field | Type | Description |
|---|---|---|
IdStaff | uuid | Staff identifier |
StaffFullName | string | Staff name |
IdLocation | uuid | Location identifier |
LocationName | string | Location name |
Invoice | InvoiceDto | Direct payments summary |
Insurance | InsuranceDto | Insurance summary |
Laboratory | LaboratoryDto | Laboratory summary |
MaterialPayment | number | Consumable material |
ClientCount | int | Client count |
ReportCount | int | Record count |
Credit | CreditDto | Credit movements |
Profit | number | Result |
InvoiceDto
| Field | Type | Description |
|---|---|---|
Total | number | Total direct payments |
SellPayment | number | Sales |
DirectPayment | number | Direct payments |
ServicePayment | number | Service payments |
ClientPayment | number | Client payments |
OtherPayment | number | Other payments |
DiscountPrice | number | Discounts |
ExpenditurePayment | number | Expenses |
OtherInvoiceNums | string | Related document numbers |
InsuranceDto
| Field | Type | Description |
|---|---|---|
Total | number | Insurance total |
MaterialPrice | number | Material for insurance |
ServicePrice | number | Services for insurance |
LaboratoryDto
| Field | Type | Description |
|---|---|---|
Total | number | Laboratory total |
InsuranceLaboratoryPrice | number | Laboratory price from insurance |
InvoiceLaboratoryPrice | number | Laboratory price from cash register |
CreditDto
| Field | Type | Description |
|---|---|---|
Deposit | number | Credit deposits |
Withdraw | number | Credit withdrawals |
Payment type
POST /api/v1/ExportRequest/Statistics/Staff/Type
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
DateFrom | datetime | yes | Start of range by payment date |
DateTo | datetime | yes | End of range by payment date |
IdLocation | uuid | no | Filter by location |
Response
Response is a StatsStaffTypeExportDto[] array.
StatsStaffTypeExportDto
| Field | Type | Description |
|---|---|---|
IdStaff | uuid | Staff identifier |
StaffFullName | string | Staff name |
IdLocation | uuid | Location identifier |
LocationName | string | Location name |
Payment | PaymentDto | Payment breakdown by type |
PaymentDto
| Field | Type | Description |
|---|---|---|
Total | number | Total payments |
Cash | number | Cash |
Card | number | Card |
Transfer | number | Transfer |
Coupon | number | Voucher |
Other | number | Other |
Credit | number | Credit payment |
Clients
Active
POST /api/v1/ExportRequest/Statistics/Client/Active
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
IdLocation | uuid | no | Filter by location |
Response
Response is a StatsClientActiveExportDto[] array.
StatsClientActiveExportDto
| Field | Type | Description |
|---|---|---|
Staff | StaffDto | Staff |
ClientCount | int | Active client count |
StaffDto
| Field | Type | Description |
|---|---|---|
Id | uuid | Staff identifier |
Name | string | Staff name |
Credit
POST /api/v1/ExportRequest/Statistics/Client/Credit
- This export accepts only
DateToand returns the credit balance as of that date.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
DateTo | datetime | yes | Credit state as of this date |
IdLocation | uuid | no | Filter by location |
Response
Response is a StatsClientCreditExportDto[] array.
StatsClientCreditExportDto
| Field | Type | Description |
|---|---|---|
Location | LocationDto | Location |
Staff | StaffDto | Staff |
Client | ClientDto | Client |
Credit | number | Credit amount |
CurrencyCode | string | Currency code |
InvoiceNumbers | string[] | Document numbers |
LocationDto
| Field | Type | Description |
|---|---|---|
Name | string | Location name |
StaffDto
| Field | Type | Description |
|---|---|---|
Name | string | Staff name |
ClientDto
| Field | Type | Description |
|---|---|---|
Name | string | Client name |
Phone | string | Client phone |
Email | string | Client email |
Address | string | Client address |
Pid | string | Personal ID |
Tags | CustomTagEntry[] | Client custom tags |
CustomTagEntry
| Field | Type | Description |
|---|---|---|
customTagName | string | Custom tag name |
color | string | Tag color |
Debt
POST /api/v1/ExportRequest/Statistics/Client/Debt
- This export accepts a date range for debt within the selected period.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
DateFrom | datetime | yes | Start of debt period |
DateTo | datetime | yes | End of debt period |
IdLocation | uuid | no | Filter by location |
Response
Response is a StatsClientDebtExportDto[] array.
StatsClientDebtExportDto
| Field | Type | Description |
|---|---|---|
Staff | StaffDto | Staff |
Client | ClientDto | Client |
Debt | number | Debt amount |
InvoiceNumbers | string[] | Document numbers |
StaffDto
| Field | Type | Description |
|---|---|---|
Name | string | Staff name |
ClientDto
| Field | Type | Description |
|---|---|---|
Name | string | Client name |
Phone | string | Client phone |
Email | string | Client email |
Address | string | Client address |
Pid | string | Personal ID |
Tags | CustomTagEntry[] | Client custom tags |
CustomTagEntry
| Field | Type | Description |
|---|---|---|
customTagName | string | Custom tag name |
color | string | Tag color |
Insurance
POST /api/v1/ExportRequest/Statistics/Client/Insurance
Parameters
This endpoint has no request body parameters.
Response
Response is a StatsClientInsuranceExportDto[] array.
StatsClientInsuranceExportDto
| Field | Type | Description |
|---|---|---|
Insurance | string | Insurance code and name |
ClientCount | int | Client count |
Deleted
POST /api/v1/ExportRequest/Statistics/Client/Deleted
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
IdLocation | uuid | no | Filter by location |
IdStaff | uuid | no | Filter by staff member |
Response
Response is a StatsClientDeletedExportDto[] array.
StatsClientDeletedExportDto
| Field | Type | Description |
|---|---|---|
Client | ClientDto | Client |
Deletion | DeletionDto | Deletion information |
ClientDto
| Field | Type | Description |
|---|---|---|
Id | uuid | Client identifier |
FullName | string | Client full name |
PersonalId | string | Personal ID |
Contact | ContactDto | Contact details |
Address | AddressDto | Client address |
ContactDto
| Field | Type | Description |
|---|---|---|
Phone | string | Client phone |
Email | string | Client email |
AddressDto
| Field | Type | Description |
|---|---|---|
Street | string | Street |
City | string | City |
Post | string | ZIP/postal code |
DeletionDto
| Field | Type | Description |
|---|---|---|
ReasonId | uuid | Deletion reason identifier |
ReasonTitle | string | Deletion reason name |
DeletedAt | datetime | Deletion date |
Extended
POST /api/v1/ExportRequest/Statistics/Client/Extended
- This export accepts a date range by creation date of records and documents.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
DateFrom | datetime | yes | Start of range |
DateTo | datetime | yes | End of range |
IdLocation | uuid | no | Filter by location |
IdStaff | uuid | no | Filter by staff member |
Response
Response is a StatsClientExtendedExportDto[] array.
StatsClientExtendedExportDto
| Field | Type | Description |
|---|---|---|
Client | ClientDto | Client |
MedicalReport | MedicalReportDto | Medical record data |
Invoice | InvoiceDto | Cash register data |
ClientDto
| Field | Type | Description |
|---|---|---|
IdClient | uuid | Client identifier |
Name | string | Client name |
MedicalReportDto
| Field | Type | Description |
|---|---|---|
DirectPayments | number | Direct payments in documentation |
AdditionalPayment | number | Additional payments in documentation |
Laboratory | number | Laboratory part in documentation |
Insurance | number | Insurance part in documentation |
RecordCount | int | Medical record count |
InvoiceDto
| Field | Type | Description |
|---|---|---|
DirectPayments | number | Direct payments in cash register |
AdditionalPayment | number | Additional payments in cash register |
Laboratory | number | Laboratory part in cash register |
Discount | number | Discounts |
Credit | number | Credit |
InvoiceCount | int | Document count |
Calendar
Active
POST /api/v1/ExportRequest/Statistics/Calendar/Active
- This export accepts a date range by appointment date.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
DateFrom | datetime | yes | Start of range by appointment date |
DateTo | datetime | yes | End of range by appointment date |
IdLocation | uuid | no | Filter by location |
IdStaff | uuid | no | Filter by staff member |
Response
Response is a StatsCalendarActiveExportDto[] array.
StatsCalendarActiveExportDto
| Field | Type | Description |
|---|---|---|
Appointment | AppointmentDto | Appointment |
Staff | StaffDto | Staff |
Client | ClientDto | Client |
Booking | BookingDto | Booking information |
Meta | MetaDto | Metadata |
AppointmentDto
| Field | Type | Description |
|---|---|---|
StartDate | datetime | Appointment start |
Service | string | Service name |
Status | int | Appointment status |
StatusName | string | Status name (if available) |
Duration | int | Appointment duration in minutes |
StaffDto
| Field | Type | Description |
|---|---|---|
IdStaff | uuid | Staff identifier |
FullName | string | Staff name |
ClientDto
| Field | Type | Description |
|---|---|---|
IdClient | uuid | Client identifier |
FullName | string | Client name |
Phone | string | Client phone |
Email | string | Client email |
Description | string | Client/appointment note |
BookingDto
| Field | Type | Description |
|---|---|---|
OnlineBooked | bool | Booked online |
FindUs | string | Source describing how the client found the office |
MetaDto
| Field | Type | Description |
|---|---|---|
CreatedDate | datetime | Creation date |
LastUpdateDate | datetime | Last update date |
CustomTags | CustomTagEntry[] | Client custom tags |
CustomTagEntry
| Field | Type | Description |
|---|---|---|
customTagName | string | Custom tag name |
color | string | Tag color |
Deleted
POST /api/v1/ExportRequest/Statistics/Calendar/Deleted
- This export accepts a date range by appointment date.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
DateFrom | datetime | yes | Start of range by appointment date |
DateTo | datetime | yes | End of range by appointment date |
IdLocation | uuid | no | Filter by location |
IdStaff | uuid | no | Filter by staff member |
Response
Response is a StatsCalendarDeletedExportDto[] array.
StatsCalendarDeletedExportDto
| Field | Type | Description |
|---|---|---|
Appointment | AppointmentDto | Appointment |
Staff | StaffDto | Staff |
Client | ClientDto | Client |
Cancellation | CancellationDto | Cancellation information |
AppointmentDto
| Field | Type | Description |
|---|---|---|
StartDate | datetime | Appointment start |
Service | string | Service name |
Duration | int | Appointment duration in minutes |
Description | string | Appointment description |
CreatedDate | datetime | Creation date |
LastUpdateDate | datetime | Last update date |
StaffDto
| Field | Type | Description |
|---|---|---|
IdStaff | uuid | Staff identifier |
FullName | string | Staff name |
ClientDto
| Field | Type | Description |
|---|---|---|
IdClient | uuid | Client identifier |
FullName | string | Client name |
Phone | string | Client phone |
Email | string | Client email |
CustomTags | CustomTagEntry[] | Client custom tags |
CustomTagEntry
| Field | Type | Description |
|---|---|---|
customTagName | string | Custom tag name |
color | string | Tag color |
CancellationDto
| Field | Type | Description |
|---|---|---|
DateCancel | datetime | Cancellation date |
CancelReason | string | Cancellation reason |
IdStaffCancel | uuid | Identifier of user who canceled |
StaffFullNameCancel | string | Name of user who canceled |
New/Updated
POST /api/v1/ExportRequest/Statistics/Calendar/NewUpdated
- This export accepts a date range by last update date.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
DateFrom | datetime | yes | Start of range by last update date |
DateTo | datetime | yes | End of range by last update date |
IdLocation | uuid | no | Filter by location |
IdStaff | uuid | no | Filter by staff member |
Response
Response is a StatsCalendarNewUpdatedExportDto[] array.
StatsCalendarNewUpdatedExportDto
| Field | Type | Description |
|---|---|---|
Appointment | AppointmentDto | Appointment including create/update information |
AppointmentDto
| Field | Type | Description |
|---|---|---|
StartDate | datetime | Appointment start |
EndDate | datetime | Appointment end |
Service | string | Service name |
Status | int | Appointment status |
StatusName | string | Status name (if available) |
Duration | int | Appointment duration in minutes |
IsNew | bool | Newly created appointment |
EventType | int | Record type |
OnlineBooked | bool | Booked online |
CreatedDate | datetime | Creation date |
LastUpdateDate | datetime | Last update date |
Staff | StaffDto | Appointment staff |
Client | ClientDto | Client |
Creator | CreatorDto | User who created the record |
StaffDto
| Field | Type | Description |
|---|---|---|
IdStaff | uuid | Staff identifier |
FullName | string | Staff name |
ClientDto
| Field | Type | Description |
|---|---|---|
IdClient | uuid | Client identifier |
FullName | string | Client name |
Phone | string | Client phone |
Email | string | Client email |
Description | string | Client/appointment note |
CustomTags | CustomTagEntry[] | Client custom tags |
CreatorDto
| Field | Type | Description |
|---|---|---|
IdStaff | uuid | Identifier of user who created/updated the record |
FullName | string | Name of user who created/updated the record |
CustomTagEntry
| Field | Type | Description |
|---|---|---|
customTagName | string | Custom tag name |
color | string | Tag color |
Follow-up care
POST /api/v1/ExportRequest/Statistics/Calendar/Dispenzarizace
- This export accepts a date range by follow-up care date.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
DateFrom | datetime | yes | Start of range by follow-up care date |
DateTo | datetime | yes | End of range by follow-up care date |
IdLocation | uuid | no | Filter by location |
IdStaff | uuid | no | Filter by staff member |
Response
Response is a StatsCalendarDispenzarizaceExportDto[] array.
StatsCalendarDispenzarizaceExportDto
| Field | Type | Description |
|---|---|---|
Visit | VisitDto | Visit information |
Client | ClientDto | Client |
Staff | StaffDto | Staff |
Location | LocationDto | Location |
VisitDto
| Field | Type | Description |
|---|---|---|
DateVisit | datetime | Visit date |
ServiceCaption | string | Service name |
ServiceDescription | string | Service description |
ServiceCreatedOn | datetime | Service creation date |
Booked | bool | Indicates the visit is booked |
ClientDto
| Field | Type | Description |
|---|---|---|
IdClient | uuid | Client identifier |
FullName | string | Client name |
Phone | string | Client phone |
StaffDto
| Field | Type | Description |
|---|---|---|
IdStaff | uuid | Staff identifier |
FullName | string | Staff name |
LocationDto
| Field | Type | Description |
|---|---|---|
IdLocation | uuid | Location identifier |
Name | string | Location name |
Waiting
POST /api/v1/ExportRequest/Statistics/Calendar/Waiting
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
IdLocation | uuid | no | Filter by location |
IdStaff | uuid | no | Filter by staff member |
Response
Response is a StatsCalendarWaitingExportDto[] array.
StatsCalendarWaitingExportDto
| Field | Type | Description |
|---|---|---|
Client | ClientDto | Client |
Service | ServiceDto | Service |
Staff | StaffDto | Staff |
Location | LocationDto | Location |
Note | string | Note |
DateAdded | datetime | Date added |
ClientDto
| Field | Type | Description |
|---|---|---|
IdClient | uuid | Client identifier |
FullName | string | Client name |
Phone | string | Client phone |
ServiceDto
| Field | Type | Description |
|---|---|---|
IdService | uuid | Service identifier |
Caption | string | Service name |
StaffDto
| Field | Type | Description |
|---|---|---|
IdStaff | uuid | Staff identifier |
FullName | string | Staff name |
LocationDto
| Field | Type | Description |
|---|---|---|
IdLocation | uuid | Location identifier |
Name | string | Location name |
Forms
Signed
POST /api/v1/ExportRequest/Statistics/Forms/Signed
- This export accepts a date range by signature date.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
DateFrom | datetime | yes | Start of range by signature date |
DateTo | datetime | yes | End of range by signature date |
IdLocation | uuid | no | Filter by location |
IdStaff | uuid | no | Filter by staff member |
Response
Response is a StatsFormSignedExportDto[] array.
StatsFormSignedExportDto
| Field | Type | Description |
|---|---|---|
Client | ClientDto | Client |
Staff | StaffDto | Staff |
Form | FormDto | Form |
ClientDto
| Field | Type | Description |
|---|---|---|
IdClient | uuid | Client identifier |
Fullname | string | Client name |
StaffDto
| Field | Type | Description |
|---|---|---|
IdStaff | uuid | Staff identifier |
Fullname | string | Staff name |
FormDto
| Field | Type | Description |
|---|---|---|
IdFormRequest | uuid | Form identifier |
Name | string | Form name |
StatusCode | string | Form status code |
StatusText | string | Form status text |
DateSigned | datetime | Signature date |
ValidUntil | datetime | Expiration date |
Expiring
POST /api/v1/ExportRequest/Statistics/Forms/Expiring
- This export accepts a date range for validity period.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
DateFrom | datetime | yes | Start of validity range |
DateTo | datetime | yes | End of validity range |
IdLocation | uuid | no | Filter by location |
IdStaff | uuid | no | Filter by staff member |
Response
Response is a StatsFormExpiringExportDto[] array.
StatsFormExpiringExportDto
| Field | Type | Description |
|---|---|---|
Client | ClientDto | Client |
Staff | StaffDto | Staff |
Form | FormDto | Form |
ClientDto
| Field | Type | Description |
|---|---|---|
IdClient | uuid | Client identifier |
Fullname | string | Client name |
StaffDto
| Field | Type | Description |
|---|---|---|
IdStaff | uuid | Staff identifier |
Fullname | string | Staff name |
FormDto
| Field | Type | Description |
|---|---|---|
IdFormRequest | uuid | Form identifier |
Name | string | Form name |
ValidUntil | datetime | Expiration date |
DateSigned | datetime | Signature date |
Store
Items
POST /api/v1/ExportRequest/Statistics/Store/Items
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
DateFrom | datetime | yes | Start of range by operation date |
DateTo | datetime | yes | End of range by operation date |
IdLocation | uuid | no | Filter by location |
IdStaff | uuid | no | Filter by staff member |
Response
Response is a StatsStoreItemsExportDto[] array.
StatsStoreItemsExportDto
| Field | Type | Description |
|---|---|---|
OperationDate | datetime | Operation date |
DocumentNumber | string | Document number |
Staff | StaffDto | Staff |
Store | StoreDto | Store |
Partner | PartnerDto | Operation partner |
Operation | OperationDto | Operation type and code |
Material | MaterialDto | Material |
StaffDto
| Field | Type | Description |
|---|---|---|
IdStaff | uuid | Staff identifier |
Name | string | Staff name |
StoreDto
| Field | Type | Description |
|---|---|---|
IdStore | uuid | Store identifier |
Name | string | Store name |
PartnerDto
| Field | Type | Description |
|---|---|---|
Id | uuid | Partner identifier |
Name | string | Partner name |
OperationDto
| Field | Type | Description |
|---|---|---|
Type | string | Store operation type |
Code | string | Store operation code |
MaterialDto
| Field | Type | Description |
|---|---|---|
Code | string | Material code |
Name | string | Material name |
Lot | string | Lot |
Expiration | datetime | Expiration date |
Quantity | number | Quantity |
Price | number | Price |
Documentation
Medical records
POST /api/v1/ExportRequest/Statistics/Documentation/MedicalReport
- This export accepts date ranges by medical record date and by last update date.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
DateFrom | datetime | yes | Start of range by record date |
DateTo | datetime | yes | End of range by record date |
LastUpdateFrom | datetime | yes | Start of range by last update date |
LastUpdateTo | datetime | yes | End of range by last update date |
IdLocation | uuid | no | Filter by location |
IdStaff | uuid | no | Filter by staff member |
Response
Response is a StatsDocumentationMedicalReportExportDto[] array.
StatsDocumentationMedicalReportExportDto
| Field | Type | Description |
|---|---|---|
MedicalReport | MedicalReportDto | Medical record |
Staff | StaffDto | Staff |
Location | LocationDto | Location |
Client | ClientDto | Client |
MedicalReportDto
| Field | Type | Description |
|---|---|---|
IdMedicalReport | uuid | Medical record identifier |
Created | datetime | Creation date |
LastUpdate | datetime | Last update date |
IsDigitalSign | bool | Digital signature flag |
StaffDto
| Field | Type | Description |
|---|---|---|
IdStaff | uuid | Staff identifier |
StaffFullName | string | Staff name |
LocationDto
| Field | Type | Description |
|---|---|---|
IdLocation | uuid | Location identifier |
LocationName | string | Location name |
ClientDto
| Field | Type | Description |
|---|---|---|
IdClient | uuid | Client identifier |
ClientFullName | string | Client name |
PersonalId | string | Personal ID |
Phone | string | Client phone |
Created drafts
POST /api/v1/ExportRequest/Statistics/Documentation/Draft
- This export accepts a date range by draft creation date.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
DateFrom | datetime | yes | Start of range by draft creation date |
DateTo | datetime | yes | End of range by draft creation date |
IdDoctor | uuid | no | Filter by doctor |
IdStaff | uuid | no | Filter by staff member |
IdLocation | uuid | no | Filter by location |
Response
Response is a StatsDocumentationDraftExportDto[] array.
StatsDocumentationDraftExportDto
| Field | Type | Description |
|---|---|---|
IdMedicalReport | uuid | Record identifier |
Created | datetime | Creation date |
IsInsurance | bool | Draft intended for insurance reporting |
AuthorizeStaff | AuthorizeStaffDto | Approver |
DraftStaff | DraftStaffDto | Draft author |
InsuranceStaff | InsuranceStaffDto | Reporting person |
Location | LocationDto | Location |
Client | ClientDto | Client |
AuthorizeStaffDto
| Field | Type | Description |
|---|---|---|
Id | uuid | Approver identifier |
FullName | string | Approver name |
DraftStaffDto
| Field | Type | Description |
|---|---|---|
Id | uuid | Draft author identifier |
FullName | string | Draft author name |
InsuranceStaffDto
| Field | Type | Description |
|---|---|---|
Id | uuid | Reporting person identifier |
FullName | string | Reporting person name |
LocationDto
| Field | Type | Description |
|---|---|---|
Id | uuid | Location identifier |
Name | string | Location name |
ClientDto
| Field | Type | Description |
|---|---|---|
Id | uuid | Client identifier |
FullName | string | Client name |
PersonalId | string | Personal ID |
Direct payments
POST /api/v1/ExportRequest/Statistics/Documentation/DirectPayment
- This export accepts a date range by medical record date.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
DateFrom | datetime | yes | Start of range by record date |
DateTo | datetime | yes | End of range by record date |
IdLocation | uuid | no | Filter by location |
IdStaff | uuid | no | Filter by staff member |
Response
Response is a StatsDocumentationDirectPaymentExportDto[] array.
StatsDocumentationDirectPaymentExportDto
| Field | Type | Description |
|---|---|---|
IdMedicalReport | uuid | Record identifier |
Created | datetime | Creation date |
Supervisor | SupervisorDto | Responsible person |
Location | LocationDto | Location |
Client | ClientDto | Client |
Item | InvoiceItemDto | Invoice item |
SupervisorDto
| Field | Type | Description |
|---|---|---|
Id | uuid | Responsible person identifier |
Name | string | Responsible person name |
LocationDto
| Field | Type | Description |
|---|---|---|
Id | uuid | Location identifier |
Name | string | Location name |
ClientDto
| Field | Type | Description |
|---|---|---|
Id | uuid | Client identifier |
Name | string | Client name |
InvoiceItemDto
| Field | Type | Description |
|---|---|---|
IdInvoiceCode | uuid | Item code identifier |
Code | string | Item code |
Duration | int | Procedure duration |
Quantity | number | Quantity |
Price | number | Price |
Notifications
Answers
POST /api/v1/ExportRequest/Statistics/Notifications/Answers
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
DateFrom | datetime | yes | Start of range by answer date |
DateTo | datetime | yes | End of range by answer date |
IdLocation | uuid | no | Filter by location |
IdStaff | uuid | no | Filter by staff member |
Response
Response is a StatsNotificationsAnswersExportDto[] array.
StatsNotificationsAnswersExportDto
| Field | Type | Description |
|---|---|---|
Answer | AnswerDto | Notification answer |
Client | ClientDto | Client |
Appointment | AppointmentDto | Appointment |
Staff | StaffDto | Staff |
Location | LocationDto | Location |
AnswerDto
| Field | Type | Description |
|---|---|---|
IdAnswer | uuid | Answer identifier |
DateReceived | datetime | Answer received date |
ContentAnswer | string | Answer content |
ContentOriginal | string | Original message content |
ArcStatus | int | Answer evaluation: 0 = appointment confirmation, 1 = cancellation, 2 = unrecognized answer. null if automatic appointment confirmation is not active. |
Confirmed | bool | The answer is marked as read in XDENT (automatically for a positive answer, otherwise manually by a user). |
ClientDto
| Field | Type | Description |
|---|---|---|
IdClient | uuid | Client identifier |
Fullname | string | Client name |
Phone | string | Client phone |
AppointmentDto
| Field | Type | Description |
|---|---|---|
IdAppointment | uuid | Appointment identifier |
StartDate | datetime | Appointment start |
EndDate | datetime | Appointment end |
IdService | uuid | Service identifier |
Service | string | Service name |
AppointmentDateDisplay | string | Text representation of the appointment date (if available) |
StaffDto
| Field | Type | Description |
|---|---|---|
IdStaff | uuid | Staff identifier |
Fullname | string | Staff name |
LocationDto
| Field | Type | Description |
|---|---|---|
IdLocation | uuid | Location identifier |
Name | string | Location name |