Skip to content

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.

How to read parameters on this page

  • Endpoints are called as 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.

Invoicing

Detailed export of client invoices, including line items. Parameters are the invoice date range.

ExportEndpointFormatsParameters
Client invoices/InvoicesJSONDateFrom*, DateTo*

Parameters

ParameterTypeRequiredDescription
DateFromdatetimeyesStart of date range by invoice date
DateTodatetimeyesEnd of date range by invoice date

Statistics – Cash register

ExportEndpointFormatsParameters
Basic/Statistics/Invoice/BasicJSON, CSVDateFrom*, DateTo*, IdSupervisor, IdLocation
Extended/Statistics/Invoice/ExtendedJSON, CSVDateFrom*, DateTo*, IdSupervisor, IdLocation
Items/Statistics/Invoice/ItemsJSON, CSVDateFrom*, DateTo*, IdSupervisor, IdLocation
Payment gateway/Statistics/Invoice/PaymentGatewayJSON, CSVDateFrom*, DateTo*, IdSupervisor, IdLocation

Parameters

ParameterTypeRequiredDescription
DateFromdatetimeyesStart of date range by invoice date
DateTodatetimeyesEnd of date range by invoice date
IdSupervisoruuidnoFilter by responsible person on the invoice
IdLocationuuidnoFilter by location

Statistics – Insurance

ExportEndpointFormatsParameters
Documents/Statistics/Insurance/InvoiceJSON, CSVDateFrom*, DateTo*, IdStaff, IdLocation
Basic/Statistics/Insurance/BasicJSON, CSVDateFrom*, DateTo*, IdStaff, IdLocation
Extended/Statistics/Insurance/ExtendedJSON, CSVDateFrom*, DateTo*, IdStaff, IdLocation
Items/Statistics/Insurance/ItemsJSON, CSVDateFrom*, DateTo*, IdStaff, IdLocation
Register/Statistics/Insurance/RegisterJSON, CSVDateFrom*, DateTo*, IdStaff, IdLocation
Batches/Statistics/Insurance/DavkyJSON, CSVDateFrom*, DateTo*, Valid*, IdStaff, IdLocation

Parameters

ParameterTypeRequiredDescription
DateFromdatetimeyesStart of date range by billing date
DateTodatetimeyesEnd of date range by billing date
ValidboolyesFilter for active/deleted
IdStaffuuidnoFilter by staff member
IdLocationuuidnoFilter by location

Statistics – Staff

ExportEndpointFormatsParameters
Item types/Statistics/Staff/ItemsJSON, CSVDateFrom*, DateTo*, IdStaff, IdLocation
Payment types/Statistics/Staff/TypeJSON, CSVDateFrom*, DateTo*, IdLocation

Parameters

ParameterTypeRequiredDescription
DateFromdatetimeyesStart of date range by invoice payment date
DateTodatetimeyesEnd of date range by invoice payment date
IdStaffuuidnoFilter by staff member
IdLocationuuidnoFilter by location

Statistics – Clients

ExportEndpointFormatsParameters
Active/Statistics/Client/ActiveJSON, CSVIdLocation
Credit/Statistics/Client/CreditJSON, CSVDateTo*, IdLocation
Debt/Statistics/Client/DebtJSON, CSVDateFrom*, DateTo*, IdLocation
Insurance/Statistics/Client/InsuranceJSON, CSV(no parameters)
Deleted/Statistics/Client/DeletedJSON, CSVIdStaff, IdLocation
Extended/Statistics/Client/ExtendedJSON, CSVDateFrom*, DateTo*, IdStaff, IdLocation
  • Export Client/Credit accepts only DateTo – returns credit as of that date.
  • Export Client/Debt accepts a date range for debt within a period.
  • Export Client/Extended accepts a date range for record and document creation date.

Parameters

ParameterTypeRequiredDescription
DateFromdatetimeyesStart of date range
DateTodatetimeyesEnd of date range
IdStaffuuidnoFilter by staff member
IdLocationuuidnoFilter by location

Statistics – Calendar

ExportEndpointFormatsParameters
Active/Statistics/Calendar/ActiveJSON, CSVDateFrom*, DateTo*, IdStaff, IdLocation
Deleted/Statistics/Calendar/DeletedJSON, CSVDateFrom*, DateTo*, IdStaff, IdLocation
New/Updated/Statistics/Calendar/NewUpdatedJSON, CSVDateFrom*, DateTo*, IdStaff, IdLocation
Follow-up care/Statistics/Calendar/DispenzarizaceJSON, CSVDateFrom*, DateTo*, IdStaff, IdLocation
Waiting/Statistics/Calendar/WaitingJSON, CSVIdStaff, IdLocation
  • Export Calendar/Active and Calendar/Deleted accept a date range for appointment date.
  • Export Calendar/NewUpdated accepts a date range for last modified date.
  • Export Calendar/Dispenzarizace accepts a date range for follow-up care date.

Parameters

ParameterTypeRequiredDescription
DateFromdatetimeyesStart of date range
DateTodatetimeyesEnd of date range
IdStaffuuidnoFilter by staff member
IdLocationuuidnoFilter by location

Statistics – Forms

ExportEndpointFormatsParameters
Signed forms/Statistics/Forms/SignedJSON, CSVDateFrom*, DateTo*, IdStaff, IdLocation
Expiring/Statistics/Forms/ExpiringJSON, CSVDateFrom*, DateTo*, IdStaff, IdLocation
  • Export Forms/Signed accepts a date range for signature date.
  • Export Forms/Expiring accepts a date range for valid from – to.

Parameters

ParameterTypeRequiredDescription
DateFromdatetimeyesStart of date range
DateTodatetimeyesEnd of date range
IdStaffuuidnoFilter by staff member
IdLocationuuidnoFilter by location

Statistics – Store

ExportEndpointFormatsParameters
Items/Statistics/Store/ItemsJSON, CSVDateFrom*, DateTo*, IdStaff, IdLocation

Parameters

ParameterTypeRequiredDescription
DateFromdatetimeyesStart of date range by operation date
DateTodatetimeyesEnd of date range by operation date
IdStaffuuidnoFilter by staff member
IdLocationuuidnoFilter by location

Statistics – Documentation

ExportEndpointFormatsParameters
Medical records/Statistics/Documentation/MedicalReportJSON, CSVDateFrom*, DateTo*, LastUpdateFrom*, LastUpdateTo*, IdStaff, IdLocation
Created drafts/Statistics/Documentation/DraftJSON, CSVDateFrom*, DateTo*, IdDoctor, IdStaff, IdLocation
Direct payments/Statistics/Documentation/DirectPaymentJSON, CSVDateFrom*, DateTo*, IdStaff, IdLocation
  • Export Documentation/MedicalReport accepts a date range for medical record date and last modified date.
  • Export Documentation/Draft accepts a date range for draft creation date.
  • Export Documentation/DirectPayment accepts a date range for medical record date.

Parameters

ParameterTypeRequiredDescription
DateFromdatetimeyesStart of date range
DateTodatetimeyesEnd of date range
IdStaffuuidnoFilter by staff member
IdDoctoruuidnoFilter by doctor
IdLocationuuidnoFilter by location

Statistics – Notifications

ExportEndpointFormatsParameters
Responses/Statistics/Notifications/AnswersJSON, CSVDateFrom*, DateTo*, IdStaff, IdLocation

Parameters

ParameterTypeRequiredDescription
DateFromdatetimeyesStart of date range by response date
DateTodatetimeyesEnd of date range by response date
IdStaffuuidnoFilter by staff member
IdLocationuuidnoFilter by location

Parameter notes

* Required parameter

  • UUID values for IdLocation are available from the Locations endpoints.
  • UUID values for IdStaff, IdSupervisor and IdDoctor are available from the Staff endpoints.