API v1.0 - 5. Справочники пользователя
5.1. Создание получателя
Параметры запроса
Заголовки
Текст запроса
Доступные поля:
- description: наименование получателя
- phone: телефон получателя (380XXXXXXXXX)
- address: адрес получателя
- town: идентификатор города получателя
- okpo: Код ОКПО для юр. лиц получателей(description необязательно, прийдет в ответе)
Request URL
https://api.sat.ua/study/hs/api/v1.0/catalogs/Counterparty/{format}/save
Содержимое ответа
URL-адрес запроса
Параметры запроса
| format | string | Формат данных для получения ответа (xml, json) | |
|
apiKey |
(дополнительный) |
string |
Ключ пользователя ТК САТ. Для получения ключа нужно пройти регистрацию. Ключ может быть передан как через параметр URL, так и в заголовке HTTP запроса В режиме тестирования без регистрации используйте ключ: devApiKey |
| language | (дополнительный) | string | Код языка для получения ответа (ru, en, uk) |
Текст запроса
Доступные поля:
- description: наименование получателя
- phone: телефон получателя (380XXXXXXXXX)
- address: адрес получателя
- town: идентификатор города получателя
- okpo: Код ОКПО для юр. лиц получателей(description необязательно, прийдет в ответе)
<request>
<item>
<description>Кравцов Олег Игоревич</description>
<phone>380632525252</phone>
<town>255f0170-9320-11da-9860-00024407fbce</town>
</item>
/</request>
<request>
<item>
<phone>+380632525252</phone>
<town>255f0170-9320-11da-9860-00024407fbce</town>
<okpo>1234567890</okpo>
</item>
/</request>
[
{
"description": "Кравцов Олег Игоревич",
"phone": "380632525252",
"town": "255f0170-9320-11da-9860-00024407fbce",
}
]
[
{
"phone": "+380632525252",
"town": "255f0170-9320-11da-9860-00024407fbce",
"okpo": "1234567890"
}
]
Ответ 200
Список добавленных получателей
- ref: идентификатор получателя
- description: наименование получателя
- phone: телефон получателя
- address: адрес получателя
- town: идентификатор города получателя
- counterpartyType: тип получателя
- 1: не имеет договора для безналичных расчетов
- 0: имеет договор для безналичных расчетов
Пример ответа
<response>
<success>true</success>
<data>
<item>
<ref>8f1eeac0-5893-11e5-9ad6-005056b13e62</ref>
<description>Кравцов Олег Игоревич</description>
<phone>+380632525252</phone>
<address/>
<town>255f0170-9320-11da-9860-00024407fbce</town>
<counterpartyType>1</counterpartyType>
</item>
</data>
</response>
[
{
"ref": "8f1eeac0-5893-11e5-9ad6-005056b13e62",
"description": "Кравцов Олег Игоревич",
"phone": "+380632525252",
"address": "",
"town": "255f0170-9320-11da-9860-00024407fbce",
"counterpartyType": "1"
}
]
