Наименование параметра	Тип параметра	Значение	Дополнительно
codes	array[string]	Фильтр по выбранным кодам	Необязательный параметр
search	string	Строка поиска названию документа	Необязательный параметр
offset	integer($int32)	Отступ	Необязательный параметр
count	integer($int32)	Количество	Необязательный параметр

Код	Значение	Дополнительно
200	Success `{ "data": [ { "code": "string", "description": "string" } ], "meta": { "totalCount": 0 } }`	Успешный запрос Возвращаются данные документа, содержащие следующие значения: data - массив документов code - код типа документа description - название документа meta- служебная информация totalCount- общее число документов согласно параметрам запроса
400	BadRequest `{ "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string", "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }`	Неверный запрос
401	Unauthorized	ApiKey отсутствует
403	Forbidden	Доступ запрещен
404	NotFound	Неверный URL
500	InternalServerError	An error has occured

Запрос:

corporate-api/v1/dictionaries/document-types

Ответ:

{
"data": [
{
"code": "21",
"description": "Паспорт гражданина Российской Федерации"
},
{
"code": "12",
"description": "Вид на жительство в Российской Федерации"
},
{
"code": "07",
"description": "Военный билет"
},
{
"code": "10",
"description": "Паспорт иностранного гражданина"
},
{
"code": "15",
"description": "Разрешение на временное проживание в Российской Федерации"
},
{
"code": "19",
"description": "Свидетельство о предоставлении временного убежища на территории Российской Федерации"
},
{
"code": "11",
"description": "Свидетельство о рассмотрении ходатайства о признании лица беженцем на территории Российской Федерации по существу"
},
{
"code": "13",
"description": "Удостоверение беженца"
},
{
"code": "24",
"description": "Удостоверение личности военнослужащего Российской Федерации"
}
],
"meta": {
"totalCount": 9
}
}

Получение справочника B2B полномочий

GET/corporate-api/v1/dictionaries/authorities/b2b

Метод позволяет получить набор полномочий для заполнения параметра code при создании доверенности с relationshipType=B2B.

Наименование параметра	Тип параметра	Значение	Дополнительно
codes	array[string]	Фильтр по выбранным кодам	Необязательный параметр
search	string	Строка поиска по краткому названию	Необязательный параметр
offset	integer($int32)	Отступ	Необязательный параметр
count	integer($int32)	Количество	Необязательный параметр
takeDisabled	boolean	Включать ли в ответ полномочия, которые больше не действуют Принимает значения: true false	Необязательный параметр по умолчанию takeDisabled = false

Код	Значение	Дополнительно
200	Success `{ "data": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "code": "string", "relationshipType": "B2B", "contents": "string", "groupCode": "string", "disabled": true } ], "meta": { "totalCount": 0 } }`	Успешный запрос Возвращаются данные полномочия, содержащие следующие значения: data - массив полномочий id - идентификатор полномочий code - код полномочия (который нужно передать при заполнении параметра code доверенности) relationshipType - формат полномочий contents - наименование полномочий groupCode - код группы полномочий (отсутствует у B2B полномочий) disabled - является ли полномочие недействующим meta - служебная информация totalCount - общее число полномочий согласно параметрам запроса
400	BadRequest `{ "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string", "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }`	Неверный запрос
401	Unauthorized	ApiKey отсутствует
403	Forbidden	Доступ запрещен
404	NotFound	Неверный URL
500	InternalServerError	An error has occured

Запрос:

/corporate-api/v1/dictionaries/authorities/b2b?takeDisabled=false&codes=01,02,03,04

Ответ:

{
"data": [
{
"code": "01",
"relationshipType": "B2B",
"contents": "Подписывать cчета-фактуры/УПД",
"disabled": false,
"id": "005e2afb-6fcc-4c49-bdf0-19e13c4d55eb",
"events": []
},
{
"code": "02",
"relationshipType": "B2B",
"contents": "Подписывать договоры",
"disabled": false,
"id": "028d8e3c-4819-4c13-8118-8eae47c63beb",
"events": []
}
],
"meta": {
"totalCount": 2
}
}

Получение справочника B2G полномочий

GET/corporate-api/v1/dictionaries/authorities/b2g

Метод позволяет получить набор полномочий для заполнения параметра empowermentCodes при создании доверенности с relationshipType=B2G.

Наименование параметра	Тип параметра	Значение	Дополнительно
codes	array[string]	Фильтр по выбранным кодам	Необязательный параметр
search	string	Строка поиска по краткому названию	Необязательный параметр
offset	integer($int32)	Отступ	Необязательный параметр
count	integer($int32)	Количество	Необязательный параметр
takeDisabled	boolean	Включать ли в ответ полномочия, которые больше не действуют Принимает значения: true false	Необязательный параметр по умолчанию takeDisabled = false

Код	Значение	Дополнительно
200	Success `{ "data": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "code": "string", "relationshipType": "B2B", "contents": "string", "groupCode": "string", "disabled": true } ], "meta": { "totalCount": 0 } }`	Успешный запрос data - массив полномочий id - идентификатор полномочий code - код полномочия (который нужно передать при заполнении параметра empowermentCodes доверенности) relationshipType - формат полномочий contents - наименование полномочий groupCode - код группы полномочий (отсутствует у B2G полномочий) disabled - является ли полномочие недействующим meta - служебная информация totalCount- общее число полномочий согласно параметрам запроса
400	BadRequest `{ "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string", "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }`	Неверный запрос
401	Unauthorized	ApiKey отсутствует
403	Forbidden	Доступ запрещен
404	NotFound	Неверный URL
500	InternalServerError	An error has occured

Запрос:

/corporate-api/v1/dictionaries/authorities/b2g?takeDisabled=true&count=2

Ответ:

{
"data": [
{
"code": "01",
"relationshipType": "B2G",
"contents": "Подписывать налоговую декларацию, др. отчетность",
"disabled": true,
"id": "17324427-b8f7-4e42-8f85-a955f5a89e69",
"events": []
},
{
"code": "02",
"relationshipType": "B2G",
"contents": "Представлять налоговую декларацию, др. отчетность",
"disabled": true,
"id": "bb40acc7-855f-40cc-b56d-fd8ba0dbf9a1",
"events": []
}
],
"meta": {
"totalCount": 34
}
}

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

GET/corporate-api/v1/dictionaries/authorities/unified/groups

Метод позволяет получить набор групп полномочий для удобной группировки полномочий при создании доверенности с relationshipType=Unified.

Наименование параметра	Тип параметра	Значение	Дополнительно
search	string	Строка поиска по коду/наименованию группы или по коду/содержанию полномочия	Необязательный параметр
offset	integer($int32)	Отступ	Необязательный параметр
count	integer($int32)	Количество	Необязательный параметр

Код	Значение	Дополнительно
200	Success `{ "data": [ { "code": "string", "name": "string", "relationshipType": "B2B" } ], "meta": { "totalCount": 0 } }`	Успешный запрос data - массив групп полномочий code - код группы полномочия relationshipType - формат полномочий name - наименование группы полномочий meta - служебная информация totalCount - общее число групп полномочий согласно параметрам запроса
400	BadRequest `{ "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string", "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }`	Неверный запрос
401	Unauthorized	ApiKey отсутствует
403	Forbidden	Доступ запрещен
404	NotFound	Неверный URL
500	InternalServerError	An error has occured

Запрос:

/corporate-api/v1/dictionaries/authorities/unified/groups?count=3

Ответ:

{
"data": [
{
"code": "005e2afb-6fcc-4c49-bdf0-19e13c4d55e9",
"name": "Полномочия для ФТС",
"relationshipType": "Unified"
},
{
"code": "1cc1c867-af2a-4100-b9dd-110f9f2e70c8",
"name": "Федеральное казначейство",
"relationshipType": "Unified"
},
{
"code": "21f7f1e7-adb2-45fc-a2e1-f88631d34631",
"name": "ФССП России",
"relationshipType": "Unified"
}
],
"meta": {
"totalCount": 19
}
}

Получение полномочий единого формата по коду группы

GET/corporate-api/v1/dictionaries/authorities/unified/groups/{groupCode}

Метод позволяет получить набор полномочий для заполнения параметра Code и Name при создании доверенности с relationshipType=Unified.

Наименование параметра	Тип параметра	Значение	Дополнительно
groupCode	string	Код группы	Обязательный параметр
search	string	Строка поиска по коду/содержанию полномочия	Необязательный параметр
offset	integer($int32)	Отступ	Необязательный параметр
count	integer($int32)	Количество	Необязательный параметр

Код	Значение	Дополнительно
200	Success `{ "data": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "code": "string", "relationshipType": "B2B", "contents": "string", "groupCode": "string", "disabled": true } ], "meta": { "totalCount": 0 } }`	Успешный запрос data - массив полномочий id - идентификатор полномочий code - код полномочия (который нужно передать при заполнении параметра Code доверенности) relationshipType - формат полномочий contents - наименование полномочий (который нужно передать при заполнении параметра Name доверенности) groupCode - код группы полномочий disabled - является ли полномочие недействующим meta - служебная информация totalCount - общее число полномочий согласно параметрам запроса
400	BadRequest `{ "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string", "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }`	Неверный запрос
401	Unauthorized	ApiKey отсутствует
403	Forbidden	Доступ запрещен
404	NotFound	Неверный URL
500	InternalServerError	An error has occured

Запрос:

/corporate-api/v1/dictionaries/authorities/unified/groups/005e2afb-6fcc-4c49-bdf0-19e13c4d55e9

Ответ:

{
"data": [
{
"code": "FTS_10001",
"relationshipType": "Unified",
"contents": "Подписание таможенных документов, предоставляемых в ФТС России заинтересованными лицами в рамках таможенного декларирования и таможенных операций, связанных с подачей, регистрацией, отзывом и изменением сведений, заявленных в таможенной декларации",
"groupCode": "005e2afb-6fcc-4c49-bdf0-19e13c4d55e9",
"disabled": false,
"id": "049d49a8-b9eb-46ba-9303-19bc31efe934",
"events": []
},
{
"code": "FTS_10002",
"relationshipType": "Unified",
"contents": "Подписание иных электронных документов, предоставляемых заинтересованными лицами в таможенные органы, несвязанных с таможенным декларированием товаров, транспортных средств и выпуском товаров",
"groupCode": "005e2afb-6fcc-4c49-bdf0-19e13c4d55e9",
"disabled": false,
"id": "032a185d-ca3c-435f-b76a-8a13c9c85463",
"events": []
}
],
"meta": {
"totalCount": 2
}
}

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

В настоящее время ограничения к полномочиям указывать не надо, т.к. их не принимает реестр.

GET/corporate-api/v1/dictionaries/authorities/unified/limitations

Метод позволяет получить набор ограничений для заполнения объекта limitations при создании доверенности с relationshipType=Unified.

Наименование параметра	Тип параметра	Значение	Дополнительно
search	string	Строка поиска по коду/наименованию ограничения полномочия	Необязательный параметр
offset	integer($int32)	Отступ	Необязательный параметр
count	integer($int32)	Количество	Необязательный параметр

Код	Значение	Дополнительно
200	Success `{ "data": [ { "code": "string", "name": "string", "description": "string", "hasValuesInDictionary": true, "format": "string", "relationshipType": "B2B" } ], "meta": { "totalCount": 0 } }`	Успешный запрос data - массив ограничений code - код ограничения (который нужно передать при заполнении параметра code доверенности) name - наименование ограничения (который нужно передать при заполнении параметра name доверенности) description - подробное описание ограничения hasValuesInDictionary - имеет ли ограничение значение из справочника Принимает значения: true false format - разрешенный формат значения ограничения (например это может быть текст, либо только числовое значение и тд.) relationshipType - формат полномочий meta - служебная информация totalCount - общее число ограничений согласно параметрам запроса
400	BadRequest `{ "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string", "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }`	Неверный запрос
401	Unauthorized	ApiKey отсутствует
403	Forbidden	Доступ запрещен
404	NotFound	Неверный URL
500	InternalServerError	An error has occured

Запрос:

/corporate-api/v1/dictionaries/authorities/unified/limitations

Ответ:

{
"data": [
{
"code": "LIM_02",
"name": "Вид обязательств",
"description": "Вид обязательства, характеризующий действие, предусмотренное доверенностью",
"hasValuesInDictionary": true,
"format": "text",
"relationshipType": "Unified"
},
{
"code": "LIM_08",
"name": "Контрагент",
"description": "Хозяйствующий субъект, на взаимодействие с которым даны полномочия. Принимает значение в соответствии с ИНН организации",
"hasValuesInDictionary": false,
"format": "char(10)",
"relationshipType": "Unified"
},
{
"code": "LIM_03",
"name": "Лимит по сумме",
"description": "Лимит по сумме",
"hasValuesInDictionary": false,
"format": "integer",
"relationshipType": "Unified"
}
],
"meta": {
"totalCount": 14
}
}

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

В настоящее время ограничения к полномочиям указывать не надо, т.к. их не принимает реестр.

GET/corporate-api/v1/dictionaries/authorities/unified/limitations/{limitationCode}

Метод позволяет получить набор справочных значений для ограничений для заполнения объекта limitations при создании доверенности с relationshipType=Unified.

Наименование параметра	Тип параметра	Значение	Дополнительно
limitationCode	string	Код ограничения полномочия	Обязательный параметр
search	string	Строка поиска по коду/наименованию ограничения полномочия	Необязательный параметр
offset	integer($int32)	Отступ	Необязательный параметр
count	integer($int32)	Количество	Необязательный параметр

Код	Значение	Дополнительно
200	Success `{ "data": [ { "code": "string", "name": "string", "limitationCode": "string" } ], "meta": { "totalCount": 0 } }`	Успешный запрос data - массив значений ограничений code - код значений ограничения (который нужно передать при заполнении параметра valueCode доверенности) name - наименование значения ограничения (который нужно передать при заполнении параметра valueName доверенности) limitationCode - код значения ограничения meta - служебная информация totalCount - общее число значений ограничений согласно параметрам запроса
400	BadRequest `{ "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string", "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }`	Неверный запрос
401	Unauthorized	ApiKey отсутствует
403	Forbidden	Доступ запрещен
404	NotFound	Неверный URL
500	InternalServerError	An error has occured

Запрос:

/corporate-api/v1/dictionaries/authorities/unified/limitations/LIM_02

Ответ:

{
"data": [
{
"code": "LIM_02_01",
"name": "Купля-продажа",
"limitationCode": "LIM_02"
},
{
"code": "LIM_02_02",
"name": "Мена, бартер",
"limitationCode": "LIM_02"
},
{
"code": "LIM_02_03",
"name": "Дарение, пожертвование",
"limitationCode": "LIM_02"
}
],
"meta": {
"totalCount": 32
}
}

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

GET/corporate-api/v1/dictionaries/countries

Метод позволяет получить набор справочных значений стран для заполнения параметра citizenshipCountryCode при создании доверенности с relationshipType=Unified или B2B.

Наименование параметра	Тип параметра	Значение	Дополнительно
codes	array[string]	Фильтр по выбранным кодам	Необязательный параметр
search	string	Строка поиска по краткому названию	Необязательный параметр
offset	integer($int32)	Отступ	Необязательный параметр
count	integer($int32)	Количество	Необязательный параметр

Код	Значение	Дополнительно
200	Success `{ "data": [ { "code": "string", "shortName": "string" } ], "meta": { "totalCount": 0 } }`	Успешный запрос data - массив значений стран code - код страны shortName - наименование страны meta - служебная информация totalCount - общее число стран согласно параметрам запроса
400	BadRequest `{ "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string", "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }`	Неверный запрос
401	Unauthorized	ApiKey отсутствует
403	Forbidden	Доступ запрещен
404	NotFound	Неверный URL
500	InternalServerError	An error has occured

Запрос:

/corporate-api/v1/dictionaries/countries

Ответ:

{
"data": [
{
"code": "643",
"shortName": "РОССИЯ"
},
{
"code": "895",
"shortName": "АБХАЗИЯ"
},
{
"code": "036",
"shortName": "АВСТРАЛИЯ"
}
],
"meta": {
"totalCount": 253
}
}

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

GET/corporate-api/v1/dictionaries/regions

Метод позволяет получить набор справочных регионов для заполнения параметра regionCode при создании доверенности с relationshipType=Unified.

Наименование параметра	Тип параметра	Значение	Дополнительно
search	string	Строка поиска по названию	Необязательный параметр
offset	integer($int32)	Отступ	Необязательный параметр
count	integer($int32)	Количество	Необязательный параметр

Код	Значение	Дополнительно
200	Success `{ "data": [ { "code": "string", "name": "string" } ], "meta": { "totalCount": 0 } }`	Успешный запрос data - массив значений ограничений code - код региона (который нужно передать при заполнении параметра regionCode доверенности) name - наименование региона meta - служебная информация totalCount - общее число стран согласно параметрам запроса
400	BadRequest `{ "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string", "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }`	Неверный запрос
401	Unauthorized	ApiKey отсутствует
403	Forbidden	Доступ запрещен
404	NotFound	Неверный URL
500	InternalServerError	An error has occured

Запрос:

/corporate-api/v1/dictionaries/regions

Ответ:

{
"data": [
{
"code": "01",
"name": "Республика Адыгея (Адыгея)"
},
{
"code": "02",
"name": "Республика Башкортостан"
},
{
"code": "03",
"name": "Республика Бурятия"
}
],
"meta": {
"totalCount": 90
}
}

Получение списка налоговых органов

GET/corporate-api/v1/dictionaries/tax-authorities

Метод позволяет получить набор кодов ИФНС для заполнения параметра submitTaxAuthorityCode или targetTaxAuthorityCodes при создании доверенности с relationshipType=B2G.

Наименование параметра	Тип параметра	Значение	Дополнительно
codes	array[string]	Фильтр по выбранным кодам	Необязательный параметр
search	string	Строка поиска по краткому названию	Необязательный параметр
offset	integer($int32)	Отступ	Необязательный параметр
count	integer($int32)	Количество	Необязательный параметр

Код	Значение	Дополнительно
200	Success `{ "data": [ { "code": "string", "name": "string" } ], "meta": { "totalCount": 0 } }`	Успешный запрос data - массив значений кодов ИФНС code - код ИФНС shortName - наименование ИФНС meta - служебная информация totalCount - общее число ИФНС согласно параметрам запроса
400	BadRequest `{ "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string", "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }`	Неверный запрос
401	Unauthorized	ApiKey отсутствует
403	Forbidden	Доступ запрещен
404	NotFound	Неверный URL
500	InternalServerError	An error has occured

Запрос:

/corporate-api/v1/dictionaries/tax-authorities

Ответ:

{
"data": [
{
"code": "0001",
"name": "ИФНС для Рассылки"
},
{
"code": "0002",
"name": "ИФНС для Рассылки"
},
{
"code": "0003",
"name": "ИФНС для Рассылки"
}
],
"meta": {
"totalCount": 597
}
}

Комментарии для сайта Cackle

Оставить заявку

Напишите нам и мы ответим на ваши вопросы