Контрагенты (Organizations) Archives

Получение сведений о контрагентах

GET https://api.ord-a.ru/api/v2/organizations

Данный метод вернет сведения о всех заведенных контрагентах.

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

Параметр	Тип	Обязательность	Описание
page	число	нет	Номер страницы
limit	число	нет	Количество записей на странице
sort	строка	нет	Используется при get запросе. Сортировка по столбцу. Допустимые значения: id, -id, name, -name, created_at, -created_at, inn, -inn, alternative_inn, -alternative_inn, oksm_number, -oksm_number

Ответы

Код ответа	Описание
200 OK	Статус успешного запроса
401 Unauthorized	Доступ запрещен, невалидный токен

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

Content type application/json

curl -X 'GET' \

'https://api.ord-a.ru/api/v2/organizations' \

-H 'accept: application/json' \

-H 'Authorization: Bearer TOKEN' \

-H 'X-CSRF-TOKEN: '

curl -X 'GET' \
'https://api.ord-a.ru/api/v2/organizations' \
-H 'accept: application/json' \
-H 'Authorization: Bearer TOKEN' \
-H 'X-CSRF-TOKEN: '

Скопировать

Пример успешного ответа:

Content type application/json

{

"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_inf": null,

"oksm_number": null,

"kpp": null,

"rs_url": "https://my-dev.ord-a.ru",

"is_agent": false,

"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_inf": null,

"oksm_number": null,

"kpp": null,

"rs_url": "https://my-dev.ord-a.ru",

"is_agent": false,

"platforms": [

326008

],

"owned_platforms": [

1

],

"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://api.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

}

{
	"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_inf": null,
			"oksm_number": null,
			"kpp": null,
			"rs_url": "https://my-dev.ord-a.ru",
			"is_agent": false,
			"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_inf": null,
			"oksm_number": null,
			"kpp": null,
			"rs_url": "https://my-dev.ord-a.ru",
			"is_agent": false,
			"platforms": [
				326008
			],
			"owned_platforms": [
				1
			],
			"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://api.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
	}
}

Скопировать

Была ли эта глава полезной?

Получение сведений определенного контрагента

GET https://api.ord-a.ru/api/v2/organizations/id

Данный метод вернет сведения определенного контрагента.

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

Параметр	Тип	Обязательность	Описание
id	число	да	идентификатор контрагента

Ответы

Код ответа	Описание
200 OK	Статус успешного запроса
401 Unauthorized	Доступ запрещен, невалидный токен
404 Not found	Идентификатор контрагента не найден

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

Content type application/json

curl -X 'GET' \

'https://api.ord-a.ru/api/v2/organizations/704' \

-H 'accept: application/json' \

-H 'Authorization: Bearer TOKEN' \

-H 'X-CSRF-TOKEN: '

curl -X 'GET' \
'https://api.ord-a.ru/api/v2/organizations/704' \
-H 'accept: application/json' \
-H 'Authorization: Bearer TOKEN' \
-H 'X-CSRF-TOKEN: '

Скопировать

Пример успешного ответа:

Content type application/json

{

"data": {

"id": 704,

"name": "ООО "ОРД-А"",

"is_partner": false,

"membership_id": 1,

"erir_entity": {

"id": 1906,

"status": "Зарегистрирован",

"status_label": "registered",

"last_item": {

"id": 4244,

"status": "Зарегистрирован",

"status_label": "registered",

"errors": [

],

"message": null,

"created_at": "2024-06-19T10:03:34+03:00",

"pending_at": "2024-06-19T10:08:34+03:00",

"status_changed_at": "2024-06-20T04:13:04+03:00"

},

"registered_at": "2024-06-20 04:13:04",

"created_at": "2024-06-19T10:03:32+03:00"

},

"has_cid_contracts": false,

"dependent_relationships": [

{

"name": "contract",

"id": 311

},

{

"name": "self_promotion_creatives",

"id": 284

}

],

"type": "ul",

"is_ors": false,

"is_rr": true,

"is_rd": false,

"inn": "9715420338",

"mobile_phone": null,

"epay_number": null,

"reg_number": null,

"alternative_inn": null,

"oksm_number": null,

"kpp": null,

"rs_url": null,

"is_agent": false,

"platforms": [

200,

201

],

"owned_platforms": [

200,

201

],

"created_at": "2024-06-19T10:03:32+03:00",

"deleted_at": null,

"external_id": null,

"legal_address": "127018, г. Москва, вн.тер.г. муниципальный округ Марьина роща, Стрелецкая ул., д. 6, эт./помещ. полуподвал/II, ком. 15"

}

{
	"data": {
		"id": 704,
		"name": "ООО \"ОРД-А\"",
		"is_partner": false,
		"membership_id": 1,
		"erir_entity": {
			"id": 1906,
			"status": "Зарегистрирован",
			"status_label": "registered",
			"last_item": {
				"id": 4244,
				"status": "Зарегистрирован",
				"status_label": "registered",
				"errors": [],
				"message": null,
				"created_at": "2024-06-19T10:03:34+03:00",
				"pending_at": "2024-06-19T10:08:34+03:00",
				"status_changed_at": "2024-06-20T04:13:04+03:00"
			},
			"registered_at": "2024-06-20 04:13:04",
			"created_at": "2024-06-19T10:03:32+03:00"
		},
		"has_cid_contracts": false,
		"dependent_relationships": [
			{
				"name": "contract",
				"id": 311
			},
			{
				"name": "self_promotion_creatives",
				"id": 284
			}
		],
		"type": "ul",
		"is_ors": false,
		"is_rr": true,
		"is_rd": false,
		"inn": "9715420338",
		"mobile_phone": null,
		"epay_number": null,
		"reg_number": null,
		"alternative_inn": null,
		"oksm_number": null,
		"kpp": null,
		"rs_url": null,
		"is_agent": false,
		"platforms": [
			200,
			201
		],
		"owned_platforms": [
			200,
			201
		],
		"created_at": "2024-06-19T10:03:32+03:00",
		"deleted_at": null,
		"external_id": null,
		"legal_address": "127018, г. Москва, вн.тер.г. муниципальный округ Марьина роща, Стрелецкая ул., д. 6, эт./помещ. полуподвал/II,
ком. 15"
	}
}

Скопировать

Была ли эта глава полезной?

Создание контрагента

POST https://api.ord-a.ru/api/v2/organizations

Данный метод используется для создания сведений о контрагентах.

Ответы

Код ответа	Описание
201 Created	Статистика создана
401 Unauthorized	Доступ запрещен, невалидный токен
422 Unprocessable Content	Некорректный запрос

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

Content type application/json

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

],

"external_id": "123",

"legal_address": "123456, г. Москва, ул. Арбат, д. 1, офис 10"

}

'

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
	],
	"external_id": "123",
	"legal_address": "123456, г. Москва, ул. Арбат, д. 1, офис 10"
}'

Скопировать

Пример успешного ответа:

Content type application/json

{

"data": {

"id": 14168,

"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

],

"created_at": "2024-02-26T10:40:48+03:00",

"external_id": "123",

"legal_address": "123456, г. Москва, ул. Арбат, д. 1, офис 10"

}

{
	"data": {
		"id": 14168,
		"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
		],
		"created_at": "2024-02-26T10:40:48+03:00",
		"external_id": "123",
		"legal_address": "123456, г. Москва, ул. Арбат, д. 1, офис 10"
	}
}

Скопировать

Была ли эта глава полезной?

Обновление контрагента

PUT https://api.ord-a.ru/api/v2/organizations/id

Данный метод используется для обновления сведений о контрагентах.

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

Параметр	Тип	Обязательность	Описание
id	число	да	идентификатор контрагента

Ответы

Код ответа	Описание
200 OK	Статус успешного запроса
401 Unauthorized	Доступ запрещен, невалидный токен
404 Not found	Идентификатор контрагента не найден
422 Unprocessable Content	Некорректный запрос

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

Content type application/json

curl -X 'PUT' \

'https://api.ord-a.ru/api/v2/organizations/704' \

-H 'accept: application/json' \

-H 'Authorization: Bearer TOKEN' \

-H 'Content-Type: application/json' \

-H 'X-CSRF-TOKEN: ' \

-d '

{

"type": "ul",

"name": "OOO "ОРД-А"",

"legal_address": "123456, г. Москва, ул. Арбат, д. 1, офис 10",

"is_ors": true,

"is_rr": true,

"is_agent": true,

"is_rd": true,

"inn": 9715420338,

"rs_url": "https://my-dev.ord-a.ru",

"platforms": [

"7734"

],

"owned_platforms": [

"7734"

]

}

'

curl -X 'PUT' \
'https://api.ord-a.ru/api/v2/organizations/704' \
-H 'accept: application/json' \
-H 'Authorization: Bearer TOKEN' \
-H 'Content-Type: application/json' \
-H 'X-CSRF-TOKEN: ' \
-d '{
	"type": "ul",
	"name": "OOO \"ОРД-А\"",
	"legal_address": "123456, г. Москва, ул. Арбат, д. 1, офис 10",
	"is_ors": true,
	"is_rr": true,
	"is_agent": true,
	"is_rd": true,
	"inn": 9715420338,
	"rs_url": "https://my-dev.ord-a.ru",
	"platforms": [
		"7734"
	],
	"owned_platforms": [
		"7734"
	]
}'

Скопировать

Пример успешного ответа:

Content type application/json

{

"data": {

"id": 704,

"name": "OOO "ОРД-А"",

"is_partner": false,

"membership_id": 1,

"type": "ul",

"is_ors": true,

"is_rr": true,

"is_rd": true,

"inn": "9715420338",

"rs_url": "https://my-dev.ord-a.ru",

"is_agent": true,

"platforms": [

7734

],

"owned_platforms": [

7734

],

"created_at": "2024-06-19T10:03:32+03:00",

"legal_address": "123456, г. Москва, ул. Арбат, д. 1, офис 10"

}

{
	"data": {
		"id": 704,
		"name": "OOO \"ОРД-А\"",
		"is_partner": false,
		"membership_id": 1,
		"type": "ul",
		"is_ors": true,
		"is_rr": true,
		"is_rd": true,
		"inn": "9715420338",
		"rs_url": "https://my-dev.ord-a.ru",
		"is_agent": true,
		"platforms": [
			7734
		],
		"owned_platforms": [
			7734
		],
		"created_at": "2024-06-19T10:03:32+03:00",
		"legal_address": "123456, г. Москва, ул. Арбат, д. 1, офис 10"
	}
}

Скопировать

Была ли эта глава полезной?

Удаление контрагента

DELETE https://api.ord-a.ru/api/v2/organizations/id

Данный метод используется для удаления сведений о контрагенте.

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

Параметр	Тип	Обязательность	Описание
id	число	да	Идентификатор контрагента

Ответы

Код ответа	Описание
204 No Content	Статус успешного запроса
401 Unauthorized	Доступ запрещен, невалидный токен
400 Bad Request	У объекта есть зависящие сущности, мешающие удалению
404 Not found	Идентификатор контрагента не найден

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

Content type application/json

curl -X 'DELETE' \

'https://api.ord-a.ru/api/v2/organizations/901' \

-H 'accept: application/json' \

-H 'Authorization: Bearer TOKEN' \

-H 'Content-Type: application/json' \

-H 'X-CSRF-TOKEN: '

curl -X 'DELETE' \
'https://api.ord-a.ru/api/v2/organizations/901' \
-H 'accept: application/json' \
-H 'Authorization: Bearer TOKEN' \
-H 'Content-Type: application/json' \
-H 'X-CSRF-TOKEN: '

Скопировать

Была ли эта глава полезной?

Восстановление контрагента

GET https://api.ord-a.ru/api/v2/organizations/id/restore

Данный метод используется для восстановления сведений о контрагенте.

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

Параметр	Тип	Обязательность	Описание
id	число	да	Идентификатор контрагента

Ответы

Код ответа	Описание
200 OK	Статус успешного запроса
401 Unauthorized	Доступ запрещен, невалидный токен
404 Not found	Идентификатор контрагента найден

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

Content type application/json

curl -X 'GET' \

'https://api.ord-a.ru/api/v2/organizations/901/restore' \

-H 'accept: application/json' \

-H 'Authorization: Bearer TOKEN' \

-H 'Content-Type: application/json' \

-H 'X-CSRF-TOKEN: '

curl -X 'GET' \
'https://api.ord-a.ru/api/v2/organizations/901/restore' \
-H 'accept: application/json' \
-H 'Authorization: Bearer TOKEN' \
-H 'Content-Type: application/json' \
-H 'X-CSRF-TOKEN: '

Скопировать

Пример успешного ответа:

Content type application/json

{

"data": {

"id": 901,

"name": "четвертое имя",

"is_partner": false,

"membership_id": 1,

"type": "ful",

"is_ors": false,

"is_rr": true,

"is_rd": false,

"inn": null,

"mobile_phone": null,

"epay_number": "11",

"reg_number": "32423-232-424",

"alternative_inn": "32423232424",

"oksm_number": "232",

"rs_url": null,

"kpp": null,

"is_agent": false,

"created_at": "2024-06-28T12:59:32+03:00",

"deleted_at": null,

"external_id": null,

"legal_address": "123456, г. Москва, ул. Арбат, д. 1, офис 10"

}

{
	"data": {
		"id": 901,
		"name": "четвертое имя",
		"is_partner": false,
		"membership_id": 1,
		"type": "ful",
		"is_ors": false,
		"is_rr": true,
		"is_rd": false,
		"inn": null,
		"mobile_phone": null,
		"epay_number": "11",
		"reg_number": "32423-232-424",
		"alternative_inn": "32423232424",
		"oksm_number": "232",
		"rs_url": null,
		"kpp": null,
		"is_agent": false,
		"created_at": "2024-06-28T12:59:32+03:00",
		"deleted_at": null,
		"external_id": null,
		"legal_address": "123456, г. Москва, ул. Арбат, д. 1, офис 10"
	}
}

Скопировать

Была ли эта глава полезной?

Массовое добавление, обновление данных о контрагентах

POST https://api.ord-a.ru/api/v2/organizations/upsert

Данный метод используется для массового добавления, обновления данных о контрагентах.

Массовое добавление, обновление данных о контрагентах

Максимально количество объектов, которое может быть передано в одном запросе: 1000

Ответы

Код ответа	Описание
200 OK	Статус успешного запроса
401 Unauthorized	Доступ запрещен, невалидный токен
422 Unprocessable Content	Некорректный запрос

Пример запроса на обновление:

Content type application/json

curl -X 'POST' \

'https://api.ord-a.ru/api/v2/organizations/upsert' \

-H 'accept: application/json' \

-H 'Authorization: Bearer TOKEN' \

-H 'Content-Type: application/json' \

-H 'X-CSRF-TOKEN: ' \

-d '

{

"organizations": [

{

"id": 14168,

"name": "Имменнное имя",

"type": "ul",

"is_ors": true,

"is_rr": false,

"is_rd": false,

"inn": "7613946079",

"rs_url": "https://local.ru",

"platforms": [

326404

],

"owned_platforms": [

326404

],

"external_id": "123",

"legal_address": null

},

{

"id": 14167,

"name": "Тест",

"type": "ul",

"is_ors": false,

"is_rr": true,

"is_rd": false,

"inn": "7613946079",

"rs_url": "https://my-dev.ord-a.ru",

"platforms": [

326390

],

"external_id": "43",

"legal_address": "123456, г. Москва, ул. Арбат, д. 1, офис 10"

}

]

}

'

curl -X 'POST' \
'https://api.ord-a.ru/api/v2/organizations/upsert' \
-H 'accept: application/json' \
-H 'Authorization: Bearer TOKEN' \
-H 'Content-Type: application/json' \
-H 'X-CSRF-TOKEN: ' \
-d '{
	"organizations": [
		{
			"id": 14168,
			"name": "Имменнное имя",
			"type": "ul",
			"is_ors": true,
			"is_rr": false,
			"is_rd": false,
			"inn": "7613946079",
			"rs_url": "https://local.ru",
			"platforms": [
				326404
			],
			"owned_platforms": [
				326404
			],
			"external_id": "123",
			"legal_address": null
		},
		{
			"id": 14167,
			"name": "Тест",
			"type": "ul",
			"is_ors": false,
			"is_rr": true,
			"is_rd": false,
			"inn": "7613946079",
			"rs_url": "https://my-dev.ord-a.ru",
			"platforms": [
				326390
			],
			"external_id": "43",
			"legal_address": "123456, г. Москва, ул. Арбат, д. 1, офис 10"
		}
	]
}'

Скопировать

Пример успешного ответа:

Content type application/json

{

"data": [

{

"id": 14168,

"external_id": "43"

},

{

"id": 14167,

"external_id": "43"

}

]

}

{
	"data": [
		{
			"id": 14168,
			"external_id": "43"
		},
		{
			"id": 14167,
			"external_id": "43"
		}
	]
}

Скопировать

Была ли эта глава полезной?