CRM deals

Выставить счёт по заказу сделки

Выставляет счёт по заказу сделки (ERP-1615) той же командой «Документооборота», что кнопка карточки заказа, и кладёт его PDF в файлы сделки — в ленте появляется «Прикреплён файл». Срок оплаты due_date не передан — через 5 дней. Повтор с тем же Idempotency-Key отдаёт тот же счёт. Заказа ещё нет — 409 crm.order_missing, отказ документооборота — 422 crm.invoice_refused с причиной. Не удалась печать — счёт всё равно выставлен, поле file пустое. Нужны право изменять сделки, core.trade и docflow.flow на запись; модуль «Документооборот» не подключён — 404 module_disabled.

post/api/v1/crm/deals/{id}/invoice

Request

  • Base URL: https://erp.akeda.ru
  • URL: https://erp.akeda.ru/api/v1/crm/deals/{id}/invoice
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://erp.akeda.ru/oauth2/authorize, token URL https://erp.akeda.ru/oauth2/token, scopes: akeda:delegate)

Headers

Idempotency-Keystring

Ключ одной логической попытки команды. Единственная форма идемпотентности на уровне HTTP; читают его только операции, у которых этот параметр объявлен.

Повтор ТОГО ЖЕ запроса (метод, адрес с параметрами, тело) с тем же ключом не выполняет команду второй раз, а отдаёт первый успешный ответ с заголовком Idempotent-Replay: true. Тот же ключ с другим запросом — отказ 422 idempotency.key_mismatch, а не чужой ответ. Пока первая попытка ещё выполняется, повтор получает 409 idempotency.in_progress и Retry-After: он не ждёт и не выполняется второй раз.

Ключ принадлежит предъявителю в кабинете: человеку, кабинетному API-ключу или установке приложения. Одинаковый ключ у соседа — другая попытка.

Отказ 4xx ключ ОСВОБОЖДАЕТ: запрос отклонён до работы, в кабинете не изменилось ничего, и исправленный запрос с тем же ключом выполняется. Отказ 5xx ключ ЗАПИРАЕТ: записалось или нет — неизвестно, коммит мог случиться, а ответ до вас не доехать. Повтор с тем же ключом получает тот же статус и тот же машинный код, а команда второй раз не выполняется. Чтобы попробовать снова, прочитайте отдельным запросом, появился ли результат, и возьмите НОВЫЙ ключ.

И ответ, и запомненный отказ живут сутки; после этого тот же ключ — новая попытка, и команда выполняется заново. Ответы, несущие секрет (выдача токена, аренда секрета настройки), заголовок не читают: секрет отдаётся ровно один раз. Хранилище недоступно — 503 idempotency.unavailable, команда без защиты не выполняется; этот отказ приходит ДО заявки на ключ и потому ключ не тратит.

Для естественного ключа интеграции годится любая строка вида crm:order:123:create; UUID не обязателен.

Request body

due_datestring date

Оплатить до; пусто — через 5 дней

Response

Счёт выставлен

document_idstring uuid required
numberstring required

Номер счёта

order_idstring uuid required

Changes

No recorded changes to this operation across all 1 revision of this API.