Дата последнего обновления:
Данный метод используется для создания сведений о контрагентах.
Код ответа | Описание |
201 Created | Статистика создана |
401 Unauthorized | Доступ запрещен, невалидный токен |
422 Unprocessable Content | Некорректный запрос |
Пример запроса:
curl -X ‘POST’ \
‘https://api.ord-a.ru/api/v2/organizations’ \
-H ‘accept: application/json’ \
-H ‘Authorization: Bearer TOKEN’ \
-H ‘Content-Type: application/json’ \
-H ‘X-CSRF-TOKEN: ‘ \
-d ‘{
“name”: “Третье имя”,
“type”: “ul”,
“is_ors”: true,
“is_rr”: false,
“is_rd”: false,
“inn”: “7613946079”,
“rs_url”: “https://my-dev.ord-a.ru”,
“platforms”: [
326404, 326390
],
“owned_platforms”: [
326404
],
“disable_platform_sync”: false,
“external_id”: “123”,
“legal_address”: “123456, г. Москва, ул. Арбат, д. 1, офис 10”
Успешный ответ:
{
“data”: {
“id”: 14168,
“name”: “Третье имя”,
“is_partner”: false,
“membership_id”: 1,
“type”: “ul”,
“is_ors”: true,
“is_rr”: false,
“is_rd”: false,
“inn”: “7613946079”,
“mobile_phone”: null,
“epay_number”: null,
“reg_number”: null,
“alternative_inn”: null,
“oksm_number”: null,
“kpp”: null,
“rs_url”: “https://my-dev.ord-a.ru”,
“is_agent”: false,
“platforms”: [
326404,
326390
],
“owned_platforms”: [
326404
],
“created_at”: “2024-02-26T10:40:48+03:00”,
“deleted_at”: null,
“external_id”: “123”,
“legal_address”: “123456, г. Москва, ул. Арбат, д. 1, офис 10”
}
}
Была ли эта глава полезной?
Параметры запроса
Параметр | Тип | Обязательность | Описание |
page | число | нет | Номер страницы |
limit | число | нет | Количество записей на странице |
sort | строка | нет | Используется при get запросе. Сортировка по столбцу. Допустимые значения: id, -id, name, -name, created_at, -created_at, inn, -inn, alternative_inn, -alternative_inn, oksm_number, -oksm_number |
Данный метод вернет сведения о всех заведенных контрагентах.
Код ответа | Описание |
200 ОК | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
Пример запроса:
curl -X ‘GET’ \
‘https://api.ord-a.ru/api/v2/organizations’ \
-H ‘accept: application/json’ \
-H ‘Authorization: Bearer TOKEN’ \
-H ‘X-CSRF-TOKEN: ‘
Пример успешного ответа:
{
“data”: [
{
“id”: 14166,
“name”: “Первое имя”,
“is_partner”: false,
“membership_id”: 1,
“has_cid_contracts”: false,
“type”: “ul”,
“is_ors”: true,
“is_rr”: false,
“is_rd”: false,
“inn”: “7613946079”,
“mobile_phone”: null,
“epay_number”: null,
“reg_number”: null,
“alternative_inn”: null,
“oksm_number”: null,
“kpp”: null,
“rs_url”: “https://my-dev.ord-a.ru”,
“is_agent”: false,
“platforms”: [
326009
],
“owned_platforms”: [
326009
],
“created_at”: “2024-02-19T13:33:31+03:00”,
“deleted_at”: null,
“external_id”: null,
“legal_address”: “123456, г. Москва, ул. Арбат, д. 1, офис 10”
},
{
“id”: 14165,
“name”: “Имя второе”,
“is_partner”: false,
“membership_id”: 1,
“has_cid_contracts”: false,
“type”: “fl”,
“is_ors”: true,
“is_rr”: false,
“is_rd”: false,
“inn”: “277332520750”,
“mobile_phone”: null,
“epay_number”: null,
“reg_number”: null,
“alternative_inn”: null,
“oksm_number”: null,
“kpp”: null,
“rs_url”: “https://my-dev.ord-a.ru”,
“is_agent”: false,
“platforms”: [
326008
],
“owned_platforms”: [],
“created_at”: “2024-02-19T10:41:40+03:00”,
“deleted_at”: null,
“external_id”: null,
“legal_address”: null
}
],
“links”: {
“first”: “http://api.ord-a.ru/api/v2/organizations?page=1”,
“last”: “http://aapi.ord-a.ru/api/v2/organizations?page=16”,
“prev”: null,
“next”: “http://api.ord-a.ru/api/v2/organizations?page=2”
},
“meta”: {
“current_page”: 1,
“from”: 1,
“last_page”: 1,
“links”: [
{
“url”: null,
“label”: “« Вперед”,
“active”: false
},
{
“url”: “http://api.ord-a.ru/api/v2/organizations?page=1”,
“label”: “1”,
“active”: true
},
{
“url”: “http://api.ord-a.ru/api/v2/organizations?page=2”,
“label”: “2”,
“active”: false
},
],
“path”: “http://api.ord-a.ru/api/v2/organizations”,
“per_page”: 2,
“to”: 1,
“total”: 2
}
}
Была ли эта глава полезной?
Документация доступна только в виде файла по ссылке ниже.
Тип/свойство | Описание | |
Organizations | ||
legal_address | Добавлено новое поле “legal_address”- «Адрес регистрации / места жительства» для всех типов контрагентов. Тип – строка. Является необязательным. Максимальная длина: 500 символов. Минимальная длина: 10 символов. – Если тип контрагента ФЛ (fl), ИП (ip) или ЮЛ (ul), то в поле допускается использовать прописные и строчные буквы русского алфавита, арабские цифры, а также следующие символы: “-” – дефис; “.” – точка; “,” – запятая; ” ” – пробел; “’” – апостроф (не более одного между словами. При этом в начале и в конце символа не должно быть); “(” – открывающая круглая скобка; “)” – закрывающая круглая скобка; “N”, “№” – знак номера; “/” – косая черта; “I”, “V”, “X”, “L”, “C”, “D”, “M” – Символы римских чисел. Адрес не должен состоять только из одних символов: пробел, дефис, точка, апостроф, запятая, скобок, знака номера, а также символов римских чисел. В начале и в конце не должно быть пробелов. – Если тип контрагента иностранное физическое (ffl) или иностранное юридическое лицо (ful), то в поле допускается использовать прописные и строчные буквы русского или латинского алфавитов, арабские цифры, а также следующие символы: “-” – дефис; “.” – точка; “,” – запятая; ” ” – пробел; “’” – апостроф (не более одного между словами. При этом в начале и в конце символа не должно быть); “(” – открывающая круглая скобка; “)” – закрывающая круглая скобка; “N”, “№”, “#” – знак номера; “/” – косая черта; “I”, “V”, “X”, “L”, “C”, “D”, “M” – Символы римских чисел. Адрес не должен состоять только из одних символов: пробел, дефис, точка, апостроф, запятая, скобок, знака номера, а также символов римских чисел. В начале и в конце не должно быть пробелов. Пример ожидаемого формата адреса: “115230, Московская область, г. Одинцово, ш. Ленинградское, д.76, стр.1, 34” | |
Была ли эта глава полезной?