{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api13.arm20.com/v1/schemas/pos.discount_cards.json","title":"pos.discount_cards","description":"Повертає список дисконтних карток для пошуку клієнта.","type":"object","required":["request","response"],"additionalProperties":false,"properties":{"request":{"oneOf":[{"type":"object","required":["method"],"additionalProperties":false,"properties":{"method":{"const":"pos.discount_cards"},"params":{"type":"object","additionalProperties":false,"properties":{"extra_name":{"type":"string","maxLength":512,"default":"","title":"Назва додаткового поля","example":"","description":"Поле «Назва додаткового поля» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"filter":{"type":"string","enum":["none","code","last_name","first_name","extra"],"default":"none","title":"Фільтр пошуку","example":"none","description":"Варіант «Фільтр пошуку». Використовуйте лише одне зі значень, розшифрованих нижче.","x-api13-group":"Додаткові","x-enumDescriptions":["без фільтра","за номером картки","за прізвищем","за ім’ям","за додатковим полем"],"x-api13-enum-labels":{"none":"без фільтра","code":"за номером картки","last_name":"за прізвищем","first_name":"за ім’ям","extra":"за додатковим полем"}},"limit":{"type":"integer","minimum":1,"maximum":201,"default":201,"title":"Максимальна кількість рядків","example":1,"description":"Максимальна кількість рядків, яку потрібно повернути. Менше значення зменшує відповідь.","x-api13-group":"Додаткові"},"search":{"type":"string","maxLength":512,"default":"","title":"Пошуковий запит","example":"","description":"Поле «Пошуковий запит» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"}}},"id":{"type":["string","integer","null"]}}}]},"response":{"oneOf":[{"type":"object","required":["ok","data","request_id"],"additionalProperties":false,"properties":{"ok":{"const":true},"data":{"type":"object","required":["method","result","id"],"additionalProperties":false,"properties":{"method":{"const":"pos.discount_cards"},"result":{"type":"object","required":["upstream","status","rows"],"additionalProperties":false,"properties":{"upstream":{"type":"object","required":["name","version","resource"],"additionalProperties":false,"properties":{"name":{"const":"UPMAPI"},"version":{"type":"string"},"resource":{"type":"string"}}},"status":{"type":"object","required":["code","operation","value"],"additionalProperties":false,"properties":{"code":{"const":"OK"},"operation":{"type":"string"},"value":{"type":"string"}}},"rows":{"type":"array","items":{"type":"object","required":["code","last_name","first_name","middle_name","discount_percent"],"additionalProperties":false,"properties":{"code":{"type":"string","title":"Номер дисконтної картки","description":"Повернене значення «Номер дисконтної картки» відповідного запису, документа або підсумку ARM20.","example":"1001"},"last_name":{"type":"string","title":"Прізвище","description":"Повернене значення «Прізвище» відповідного запису, документа або підсумку ARM20.","example":"Приклад"},"first_name":{"type":"string","title":"Ім’я","description":"Повернене значення «Ім’я» відповідного запису, документа або підсумку ARM20.","example":"Приклад"},"middle_name":{"type":"string","title":"По батькові","description":"Повернене значення «По батькові» відповідного запису, документа або підсумку ARM20.","example":"Приклад"},"discount_percent":{"type":"string","title":"Discount percent","description":"Точне повернене значення «Discount percent» як десятковий рядок із крапкою.","format":"decimal-string","example":"100.00","x-api13-unit":"percent"}}}}}},"id":{"type":["string","integer","null"]}}},"request_id":{"type":"string"}}}]}},"x-api13-operation":{"description":"Повертає список дисконтних карток для пошуку клієнта.","scope":"pos.read","params":{"extra_name":{"type":"string","max":512,"default":"","title":"Назва додаткового поля","description":"Поле «Назва додаткового поля» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":""},"filter":{"type":"enum","values":["none","code","last_name","first_name","extra"],"default":"none","title":"Фільтр пошуку","description":"Варіант «Фільтр пошуку». Використовуйте лише одне зі значень, розшифрованих нижче.","group":"Додаткові","example":"none","enum_labels":{"none":"без фільтра","code":"за номером картки","last_name":"за прізвищем","first_name":"за ім’ям","extra":"за додатковим полем"}},"limit":{"type":"int","min":1,"max":201,"default":201,"title":"Максимальна кількість рядків","description":"Максимальна кількість рядків, яку потрібно повернути. Менше значення зменшує відповідь.","group":"Додаткові","example":1},"search":{"type":"string","max":512,"default":"","title":"Пошуковий запит","description":"Поле «Пошуковий запит» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":""}},"result":{"mode":"rows","columns":["code","last_name","first_name","middle_name","discount_percent"],"field_specs":{"code":{"title":"Номер дисконтної картки","description":"Повернене значення «Номер дисконтної картки» відповідного запису, документа або підсумку ARM20.","type":"string","example":"1001"},"last_name":{"title":"Прізвище","description":"Повернене значення «Прізвище» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"},"first_name":{"title":"Ім’я","description":"Повернене значення «Ім’я» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"},"middle_name":{"title":"По батькові","description":"Повернене значення «По батькові» відповідного запису, документа або підсумку ARM20.","type":"string","example":"Приклад"},"discount_percent":{"title":"Discount percent","description":"Точне повернене значення «Discount percent» як десятковий рядок із крапкою.","type":"string","format":"decimal-string","unit":"percent","example":"100.00"}}},"mutating":false,"idempotency_required":false,"since":"0.4.0","stability":"stable","deprecated":false,"aliases":["pos","discount cards","Повертає список дисконтних карток для пошуку клієнта.","дисконтна картка","знижка","Windows Каса"],"errors":[{"code":"INVALID_PARAMETER","http":422,"description":"Один із параметрів має неправильний тип, формат або значення.","retry":"Виправити запит; автоматично не повторювати."},{"code":"UPSTREAM_FAILURE","http":502,"description":"Сервер бізнес-операції недоступний або відхилив безпечний контракт.","retry":"Дозволений повтор із backoff."}],"related_methods":["pos.discount_card_add","pos.discount_card_details","pos.discount_extra_names"]}}