{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://api13.arm20.com/v1/schemas/pos.debt_pay_cash.json","title":"pos.debt_pay_cash","description":"Погашає заборгованість клієнта грошима.","type":"object","required":["request","response"],"additionalProperties":false,"properties":{"request":{"oneOf":[{"type":"object","required":["method","params"],"additionalProperties":false,"properties":{"method":{"const":"pos.debt_pay_cash"},"params":{"type":"object","additionalProperties":false,"properties":{"akas":{"type":"string","maxLength":512,"minLength":1,"title":"Рахунок оплати","example":"Приклад","description":"Поле «Рахунок оплати» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"amount":{"type":"string","maxLength":512,"title":"Сума","format":"decimal-string","example":"100.00","description":"Точне числове значення «Сума» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.","x-api13-group":"Суми та кількості","x-api13-unit":"currency-of-operation"},"card":{"type":"string","maxLength":512,"minLength":1,"title":"Номер дисконтної картки","example":"990000001","description":"Поле «Номер дисконтної картки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"kasm":{"type":"integer","minimum":-2147483648,"maximum":2147483647,"default":0,"title":"Номер каси","example":1,"description":"Числовий номер каси, налаштований у Windows Касі.","x-api13-group":"Додаткові"},"only_nc":{"type":"string","maxLength":4096,"default":"","title":"Лише вказаний чек","example":"","description":"Поле «Лише вказаний чек» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"payment_name":{"type":"string","maxLength":512,"default":"Оплата долга","title":"Назва способу оплати","example":"Оплата долга","description":"Поле «Назва способу оплати» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","x-api13-group":"Додаткові"},"tdoc":{"type":"string","maxLength":4096,"default":"Приход кассы","title":"Тип документа","example":"Приход кассы","description":"Текстова назва або код виду документа, який зберігається у касовій операції.","x-api13-group":"Додаткові"}},"required":["akas","card"]},"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.debt_pay_cash"},"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","prefixItems":[{"type":"array","prefixItems":[{"type":"string","title":"paid"},{"type":"string","title":"document_number"},{"type":"string","title":"remaining_debt"}],"items":false,"minItems":3,"maxItems":3}],"items":{"type":"array","prefixItems":[{"type":"string","title":"document_number"},{"type":"string","title":"paid"}],"items":false,"minItems":2,"maxItems":2},"minItems":2,"description":"The first row is the operation summary; at least one document-allocation row follows."}}},"id":{"type":["string","integer","null"]}}},"request_id":{"type":"string"}}}]}},"x-api13-operation":{"description":"Погашає заборгованість клієнта грошима.","scope":"pos.write","params":{"akas":{"type":"string","max":512,"required":true,"title":"Рахунок оплати","description":"Поле «Рахунок оплати» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":"Приклад"},"amount":{"type":"string","max":512,"title":"Сума","description":"Точне числове значення «Сума» у JSON-рядку; десятковий роздільник — крапка, символ одиниці не додається.","group":"Суми та кількості","format":"decimal-string","unit":"currency-of-operation","example":"100.00"},"card":{"type":"string","max":512,"required":true,"title":"Номер дисконтної картки","description":"Поле «Номер дисконтної картки» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":"990000001"},"kasm":{"type":"int","min":-2147483648,"max":2147483647,"default":0,"title":"Номер каси","description":"Числовий номер каси, налаштований у Windows Касі.","group":"Додаткові","example":1},"only_nc":{"type":"string","max":4096,"default":"","title":"Лише вказаний чек","description":"Поле «Лише вказаний чек» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":""},"payment_name":{"type":"string","max":512,"default":"Оплата долга","title":"Назва способу оплати","description":"Поле «Назва способу оплати» відповідного документа або довідника ARM20. Передавайте значення так, як воно зберігається у Windows.","group":"Додаткові","example":"Оплата долга"},"tdoc":{"type":"string","max":4096,"default":"Приход кассы","title":"Тип документа","description":"Текстова назва або код виду документа, який зберігається у касовій операції.","group":"Додаткові","example":"Приход кассы"}},"result":{"mode":"variable_rows","contract":"pos_debt_pay_cash","row_shapes":{"summary":["paid","document_number","remaining_debt"],"document":["document_number","paid"]},"constraints":["Перший рядок містить підсумок, після нього є щонайменше один розподіл оплати за документом."],"field_specs":{"paid":{"title":"Paid","description":"Точне повернене значення «Paid» як десятковий рядок із крапкою.","type":"string","format":"decimal-string","unit":"currency-of-operation","example":"100.00"},"document_number":{"title":"Номер документа","description":"Номер документа у базі поточного клієнта.","type":"string","example":"ПН-1001"},"remaining_debt":{"title":"Remaining debt","description":"Точне повернене значення «Remaining debt» як десятковий рядок із крапкою.","type":"string","format":"decimal-string","unit":"currency-of-operation","example":"100.00"}}},"mutating":true,"idempotency_required":true,"since":"0.4.0","stability":"stable","deprecated":false,"aliases":["pos","debt pay cash","Погашає заборгованість клієнта грошима.","Windows Каса"],"errors":[{"code":"INVALID_PARAMETER","http":422,"description":"Один із параметрів має неправильний тип, формат або значення.","retry":"Виправити запит; автоматично не повторювати."},{"code":"UPSTREAM_FAILURE","http":502,"description":"Сервер бізнес-операції недоступний або відхилив безпечний контракт.","retry":"Не створювати новий Idempotency-Key; перевірити журнал і бізнес-об’єкт."},{"code":"IDEMPOTENCY_KEY_REQUIRED","http":422,"description":"Для виконання запису не передано Idempotency-Key.","retry":"Створити ключ для цієї бізнес-операції та повторити."},{"code":"IDEMPOTENCY_RESULT_UNKNOWN","http":409,"description":"Результат попередньої спроби невідомий; gateway не виконав запис повторно.","retry":"Звірити документ, чек або платіж; не створювати новий ключ автоматично."}],"related_methods":["pos.debt_balance","pos.debt_bonus_balance","pos.debt_grid_debts","pos.debt_open_rows"]}}