Тема
Звіт каса
Отримання токену доступу
Інструкція з отримання токену - https://medakadem.freshdesk.com/uk/support/solutions/articles/77000530947-отримання-token
Використання токену - https://medakadem.freshdesk.com/uk/support/solutions/articles/77000530917-token
Для використання API потрібні скоупи: "gambit:erp:salepack". Якщо немає потрібних scope, то повертатиметься помилка - Code 403 Forbidden
Потрібно встановити пареметри по даті початку та кінця (діапазон дати початку та кінця не повинен перевищувати 365 днів dateEnd - DateStart <= 365).
Якщо інтервал буде більше року, то повертатиметься помилка - Code 422 Unprocessable Content
Також потрібно вказати ідентифікатор філіалу для пошуку (встановлення ідентифікатора філіалу не є обв'язковим), наприклад:
HTTP methods: GET
/api/erp/v1/reports/cashDesk?dateStart=2024-06-23&dateEnd=2024-06-24&clinicId={clinicId}
Responses:
При успішному виконані запиту повернеться - Code 200 Success
Example Value:
[
{
"BookingId": 0,
"DiscoveryId": 0,
"LaboratoryId": 0,
"DateCr": "2025-05-22T12:12:45.744Z",
"DoctorsLFM": "string",
"PackName": "string",
"Count": 0,
"PatientID": 0,
"PatientLFM": "string",
"PaymentTypeId": 1,
"TypeReff": 0,
"ContractorCoordinatorId": 0,
"ContractorId": 0,
"Code": "string",
"CreatedById": 0,
"GroupPackageId": 0,
"ParentGroupPackageId": 0,
"PackageTagId": 0,
"PackageId": 0,
"ParentPackageId": 0,
"ParentPackageCode": "string",
"ParentPackageName": "string",
"Number": "string",
"PriceName": "string",
"PackageTypeId": 0,
"CashDesk": 0,
"Note": "string",
"FiskalPrinterContractorName": "string",
"ReceiptFiscalNumber": "string",
"ExecutorId": 0,
"FiscalStatus": 0,
"ClinicId": 0,
"Debt": 0,
"SalepackId": 0,
"PriceUndiscountCash": 0,
"PriceDiscountCash": 0,
"PriceDiscountWithoutCash": 0,
"PriceUndiscountWithoutCash": 0,
"CashbackUsed": 0,
"PromotionNote": "string",
"PromotionId": 0,
"Del": true,
"TotalIncomingMoney": 0,
"CostWithDiscount": 0,
"Cash": 0,
"Terminal": 0,
"Discount": 0,
"Cost": 0,
"IsRepayment": true
}
]| Параметр | Тип | Опис |
| BookingId | integer($int32) | ідентифікатор чеку |
| DiscoveryId | integer($int32) nullable: true | ідентифікатор обстежуючого лікаря |
| LaboratoryId | integer($int32) nullable: true | ідентифікатор лабораторії |
| DateCr | string($date-time) | дата створення |
| DoctorsLFM | string nullable: true | ПІБ направляючого лікаря |
| PackName | string nullable: true | назва послуги |
| Count | integer($int32) | кількість |
| PatientID | integer($int32) | ідентифікатор пацієнта |
| PatientLFM | string nullable: true | ПІБ пацієнта |
| PaymentTypeId | integer($int32) | тип оплати (може бути готівка - 2 і безготівка - 1) |
| TypeReff | integer($int32) | тип звернення (1 - самозвернення, 2 - направляючий лікар, 3 - страхова, 4 - оранізація, 5 - замовлення) |
| ContractorCoordinatorId | integer($int32) nullable: true | ідентифікатор координатора страхової компанії |
| ContractorId | integer($int32) nullable: true | ідентифікатор страхової компанії або організації |
| Code | string nullable: true | код послуги |
| CreatedById | integer($int32) nullable: true | ідентифікатор того, хто створив |
| GroupPackageId | integer($int32) nullable: true | ідентифікатор груп послуг |
| ParentGroupPackageId | integer($int32) nullable: true | ідентифікатор батьківської групи послуг |
| PackageTagId | integer($int32) nullable: true | ідентифікатор тегу |
| PackageId | integer($int32) nullable: true | ідентифікатор послуги |
| ParentPackageId | integer($int32) nullable: true | ідентифікатор пакету (якщо надана послуга не є частиною пакета ParentPackageId = PackageId) |
| Number | string nullable: true | номер страхового полісу (якщо є) |
| PriceName | string nullable: true | назва прайсу |
| PackageTypeId | integer($int32) | тип послуги (1 - обстеження, 2 - аналіз) |
| CashDesk | integer($int32) | каса |
| Note | string nullable: true | опис |
| FiskalPrinterContractorName | string nullable: true | ім'я контрагента за яким відбувся фіскальний продаж |
| ReceiptFiscalNumber | string nullable: true | фіскальний код чеку (прро) |
| ExecutorId | integer($int32) nullable: true | ідентифікатор виконавця |
| FiscalStatus | integer($int32) | статус фіскалізації (1 - продаж, 2 - проведення, 0 - не був проданий) |
| ClinicId | integer($int32) nullable: true | ідентифікатор філіалу |
| Debt | number($double) | борг |
| SalepackId | integer($int32) readOnly: true | ідентифікатор наданої послуги (ідентифікатор сутності, яка описує оформлену послугу пацієнта, позиції в чеку) |
| PriceUndiscountCash | number($double) | без знижки готівка |
| PriceDiscountCash | number($double) | зі знижкою готівка |
| PriceDiscountWithoutCash | number($double) | без знижки безготівка |
| PriceUndiscountWithoutCash | number($double) | зі знижкожкою безготівка |
| CashbackUsed | number($double) | сума використаного кешбеку на обрану послугу |
| PromotionNote | string nullable: true | коментар до акції |
| PromotionId | integer($int32) nullable: true | ідентифікатор акції |
| Del | boolean readOnly: true | видалений |
| TotalIncomingMoney | number($double) | сума погашеного боргу (якщо був) |
| CostWithDiscount | number($double) readOnly: true | ціна зі знижкою |
| Cash | number($double) readOnly: true | готівка |
| Terminal | number($double) readOnly: true | карта |
| Discount | number($double) readOnly: true | знижка |
| Cost | number($double) readOnly: true | ціна |
| IsRepayment | boolean | була передплата |