supplier-payments
Оплаты по счетам поставщиков.
Ресурсы
https://selena-online.ru/rest/v1/supplier-payments [POST, PUT, DELETE]
Методы и структуры данных
POST - добавляет новые платежи.
PUT - вносит изменения в платежи.
DELETE - удаляет платежи.
Входные данные передаются в теле http-запроса. Они могут быть представлены в двух форматах: XML или JSON. Передаваемый сервису http-запрос должен содержать заголовок Content-Type, соответствующий формату входных данных: application/xml или application/json.
Допускается пакетная обработка запроса, когда входные данные включают информацию сразу о нескольких платежах. Пакет обрабатывается как транзакция: commit выполняется только при полном отсутствии ошибок во всех документах. Операция POST перед записью не выполняет проверку базы данных на предмет наличия платежей с аналогичными параметрами.
В следующей таблице приведены поля структуры входных данных.
| Поле | Описание | Методы |
|---|---|---|
| BillID | Уникальный ID счёта. | POST, PUT, DELETE |
| PaymentID | Уникальный ID платежа. | PUT, DELETE |
| Date | Дата платежа. | POST, PUT |
| Number | Номер платежа. | POST, PUT |
| PaySum | Сумма платежа в валюте счёта. | POST, PUT |
| CarrySum | Сумма платежа в валюте платежа. В случае, если валюта платежа совпадает с валютой счёта, параметр указывать необязательно. Если не совпадает, параметр необходимо конвертировать по формуле "CarrySum = PaySum * CurrencyRate". | POST, PUT |
| PaymentCurrency | Валюта платежа. По умолчанию - основная валюта системы. | POST, PUT |
| CurrencyRate | Курс валюты платежа. Вычисляется как отношение валюты платежа к валюте счёта. В случае, если валюта платежа совпадает с валютой счёта, параметр указывать необязательно. | POST, PUT |
| Note | Примечание, особые заметки к платежу. Необязательный параметр. | POST, PUT |
Примерный шаблон структуры входных данных в формате JSON:
[
{
"BillID": 1776,
"Date": "2021-01-01",
"Number": "778",
"PaySum": 9000,
"PaymentID": 2069,
},
{
...
}
]
Шаблон структуры входных данных в формате XML:
<?xml version="1.0" encoding="utf-8"?>
<Payments>
<Payment>
<BillID>1776</BillID>
<Date>2021-01-01</Date>
<Number>778</Number>
<PaySum>10760</PaySum>
<PaymentID>2069</PaymentID>
</Payment>
</Payments>
Ответ
Методы PUT и DELETE возвращают статус выполненной операции - успех или неудача.
Метод POST возвращает список уникальных идентификаторов (PaymentID) платежей, добавленных после успешного выполнения запроса. Порядок следования элементов списка соответствует порядку платежей, переданных на вход методу. Ответ в формате JSON:
[ 290311,290312,290313 ]
... и XML:
<Inserted>290311,290312,290313</Inserted>