метод REST scope: sale

sale.payment.add

Добавить оплату

Кто может выполнять: администратор

Описание

Метод sale.payment.add добавляет новую оплату.

Параметры

fields object обязательный

Значения полей (подробное описание приведено ниже) для создания оплаты в виде структуры:

fields: {
    orderId: "значение",
    paySystemId: "значение",
    paid: "значение",
    datePaid: "значение",
    empPaidId: "значение",
    psStatus: "значение",
    psStatusCode: "значение",
    psStatusDescription: "значение",
    psStatusMessage: "значение",
    psSum: "значение",
    psCurrency: "значение",
    psResponseDate: "значение",
    payVoucherNum: "значение",
    payVoucherDate: "значение",
    datePayBefore: "значение",
    dateBill: "значение",
    xmlId: "значение",
    sum: "значение",
    companyId: "значение",
    payReturnNum: "значение",
    priceCod: "значение",
    payReturnDate: "значение",
    empReturnId: "значение",
    payReturnComment: "значение",
    responsibleId: "значение",
    empResponsibleId: "значение",
    isReturn: "значение",
    comments: "значение",
    updated1c: "значение",
    id1c: "значение",
    version1c: "значение",
    externalPayment: "значение",
    psInvoiceId: "значение",
    marked: "значение",
    reasonMarked: "значение",
    empMarkedId: "значение",
}

Параметр fields

orderId sale_order.id обязательный

Идентификатор заказа

paySystemId sale_paysystem.id обязательный

Идентификатор платежной системы

paid string необязательный

Оплата оплачена:

  • Y — да
  • N — нет

По умолчанию устанавливается N

datePaid datetime необязательный

Дата оплаты

empPaidId user.id необязательный

Идентификатор пользователя, который оплатил оплату

psStatus string необязательный

Флаг статуса платежной системы — успешно ли оплачена оплата. Варианты:

  • Y — да
  • N — нет

По умолчанию устанавливается null

psStatusCode string необязательный

Код статуса платёжной системы

psStatusDescription string необязательный

Описание результата работы платежной системы

psStatusMessage string необязательный

Сообщение от платежной системы

psSum double необязательный

Сумма платежной системы

psCurrency string необязательный

Валюта платежной системы

psResponseDate datetime необязательный

Дата ответа платежной системы

payVoucherNum string необязательный

Номер платежного документа

payVoucherDate datetime необязательный

Дата платежного документа

datePayBefore datetime необязательный

Устаревший.
Дата, по которой необходимо оплатить счет

dateBill datetime необязательный

Дата выставления счета

xmlId string необязательный

Внешний идентификатор

sum double необязательный

Сумма оплаты

companyId integer необязательный

Идентификатор компании, которая будет принимать оплату

В настоящий момент не используется

payReturnNum string необязательный

Номер документа возврата

priceCod double необязательный

Актуально только для коробочной версии
Стоимость оплаты при доставке. Используется для наложенного платежа

payReturnDate date необязательный

Дата документа возврата

empReturnId user.id необязательный

Идентификатор пользователя, который выполнял возврат

payReturnComment string необязательный

Комментарий к возврату

responsibleId user.id необязательный

Идентификатор пользователя, ответственного за оплату

empResponsibleId user.id необязательный

Идентификатор пользователя, назначившего ответственного

isReturn string необязательный

Выполнялся ли возврат:

  • Y — да
  • N — нет

По умолчанию устанавливается N

comments string необязательный

Комментарии к оплате

updated1c string необязательный

Оплата обновлена через 1С:

  • Y — да
  • N — нет

По умолчанию устанавливается N

id1c string необязательный

Идентификатор в 1С

version1c string необязательный

Версия документа оплаты от 1С

externalPayment string необязательный

Актуально только для коробочной версии
Внешняя оплата или нет. Используется для импорта из 1С через XML

  • Y — да
  • F — да, загружена вместе с заказом
  • N — нет

По умолчанию устанавливается N

psInvoiceId string необязательный

Идентификатор оплаты в платежной системе

marked string необязательный

Флаг маркировки. Признак того, является ли оплата отмеченной как проблемная:

  • Y — да
  • N — нет

По умолчанию устанавливается N

reasonMarked string необязательный

Причина маркировки

empMarkedId user.id необязательный

Идентификатор пользователя, промаркировавшего оплату

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"orderId":200,"paySystemId":1,"paid":"Y","datePaid":"2024-04-10T10:00:00","empPaidId":1,"psStatus":"Y","psStatusCode":"","psStatusDescription":"","psStatusMessage":"","psSum":100,"psCurrency":"RUB","psResponseDate":"2024-04-10T10:00:00","payVoucherNum":"","payVoucherDate":"2024-04-10T10:00:00","datePayBefore":"2024-04-10T10:00:00","dateBill":"2024-04-10T10:00:00","xmlId":"","sum":100,"companyId":1,"payReturnNum":"","priceCod":100,"payReturnDate":"2024-04-10T10:00:00","empReturnId":1,"payReturnComment":"","responsibleId":1,"empResponsibleId":1,"isReturn":"N","comments":"","updated1c":"N","id1c":"","version1c":"","externalPayment":"N","psInvoiceId":1,"marked":"N","reasonMarked":"","empMarkedId":1}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.payment.add

Ответ

HTTP-статус: 200

{
    "result": {
        "payment": {
            "accountNumber": "356\/1",
            "comments": "",
            "companyId": 1,
            "currency": "RUB",
            "dateBill": "2024-04-10T09:00:00+03:00",
            "dateMarked": "2024-04-16T16:32:49+03:00",
            "datePaid": "2024-04-10T09:00:00+03:00",
            "datePayBefore": "2024-04-10T09:00:00+03:00",
            "dateResponsibleId": "2024-04-16T16:32:49+03:00",
            "empMarkedId": 1,
            "empPaidId": 1,
            "empResponsibleId": 1,
            "empReturnId": 1,
            "externalPayment": "N",
            "id": 144,
            "id1c": "",
            "isReturn": "N",
            "marked": "N",
            "orderId": 200,
            "paid": "Y",
            "payReturnComment": "",
            "payReturnDate": "2024-04-10T09:00:00+03:00",
            "payReturnNum": "",
            "paySystemId": 1,
            "paySystemIsCash": "N",
            "paySystemName": "Банковский перевод (Компании)",
            "paySystemXmlId": "",
            "payVoucherDate": "2024-04-10T09:00:00+03:00",
            "payVoucherNum": "",
            "priceCod": "100",
            "psCurrency": "RUB",
            "psInvoiceId": 1,
            "psResponseDate": "2024-04-10T09:00:00+03:00",
            "psStatus": "Y",
            "psStatusCode": "",
            "psStatusDescription": "",
            "psStatusMessage": "",
            "psSum": 100,
            "reasonMarked": "",
            "responsibleId": 1,
            "sum": 100,
            "updated1c": "N",
            "version1c": "",
            "xmlId": ""
        }
    },
    "time": {
        "start": 1713277968.822151,
        "finish": 1713277972.577136,
        "duration": 3.7549850940704346,
        "processing": 3.3574018478393555,
        "date_start": "2024-04-16T17:32:48+03:00",
        "date_finish": "2024-04-16T17:32:52+03:00"
    }
}

Возвращаемые данные

result object

Корневой элемент ответа

payment sale_order_payment

Объект с информацией о добавленной оплате

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error":200040300020,
    "error_description":"Access Denied"
}
Код Описание Значение
200040300020 Недостаточно прав для добавления оплаты
100 Не указан или пустой параметр fields
0 Не переданы обязательные поля
0 Другие ошибки (например, фатальные ошибки)

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.