Руководство по API ОРД

Документ содержит описание детализации запросов по API и Swagger ORD-API.

Выберите раздел в навигации слева, чтобы просмотреть конкретный раздел документа.

Общая информация по API#

API Endpoints

Стенд	Endpoint	Authentication
Sandbox	https://sandbox.ord-lab.ru/api/v3, https://sandbox.ord-lab.ru/api/v4	Bearer (token)
Prod	https://api.ord-lab.ru/api/v3, https://api.ord-lab.ru/api/v4	Bearer (token)

Протокол

Для реализации API используется протокол HTTP REST.

Типы данных определяются в соответствии со спецификацией OpenAPI 3.

Используются следующие методы HTTP REST:

Метод	Описание
GET	Получение данных по существующему объекту. Получение данных по статусу существующего объекта.
POST	Создание нового объекта. Принудительная синхронизация существующего объекта.
PUT	Обновление информации по существующему объекту.
HEAD	Эквивалентен запросу GET, но без передачи самих данных. Может быть использован для запроса статуса объекта.
DELETE	Удаление объекта.

При успешном завершении статусная информация передается в кастомных заголовках HTTP.

Запросы PUT и POST могут выполняться частично асинхронно (т.е. после возврата управления из запроса).

При этом:

Регистрация объекта в ОРД выполняется всегда синхронно
Загрузка медиафайлов в хранилище ОРД может выполняться синхронно или асинхронно
Регистрация сущности в ЕРИР происходит после загрузки медиафайлов и может также выполняться синхронно или асинхронно

Запросы могут возвращать следующие статусные коды HTTP:

Код ответа	Описание
200 OK	Возвращается в ответ на успешные запросы GET и полностью выполненные (включая регистрацию в ЕРИР) запросы PUT
201 Created	Возвращается в ответ на выполненные запросы POST и PUT
202 Accepted	Возвращается в ответ на выполненные запросы POST и PUT, если ответ от ЕРИР не получен
400 Bad Request	Ошибка в JSON либо в параметрах запроса (включая название метода)
401 Unauthorized	Ошибка аутентификации
403 Forbidden	Отказано в доступе к объекту, например, объект принадлежит другому клиенту. Данная ошибка может также возвращаться, если зависимый объект (например, контрагент по договору при создании последнего) не найден или не принадлежит запрашивающей стороне
404 Not Found	Запрашиваемый объект не найден
429 Too Many Requests	Cервис ОРД перегружен - необходимо повторно выполнить запрос позже
500 Internal Server Error	Внутренняя ошибка сервиса. Просьба обратиться в ТП сервиса
501 Not Implemented	Внутренняя ошибка сервиса. Просьба обратиться в ТП сервиса
503 Service Unavailable	Данный статусный код может возвращаться при временной недоступности сервиса, например, при технологических работах

Аутентификация

Поддерживается один метод аутентификации:

Bearer (JWT) - для среды PROD

В случае ошибки аутентификации возвращается ответ с кодом 401 Unauthorized

Заголовки ответов (Custom HTTP Response Headers)

Данные заголовки могут присутствовать в ответах каждого из запросов API:

Версия	Атрибут	Тип	Описание
all	responseHeaders
all	Ord-State	string	Статус объекта в ОРД и в ЕРИР. Варианты:
all	Ord-Erir-Registered-At	timestamp	Дата и время последней успешной регистрации объекта в ЕРИР, если таковая имела место
all	Ord-Erir-Error	string	Текст сообщения об ошибке от ЕРИР, полученный при последнем обновлении данных по объекту в ЕРИР. Отсутствует, если последнее обновление было успешным.

Тип статуса	Значение статуса
PENDING	Объект зарегистрирован в ОРД, но пока не зарегистрирован в ЕРИР (в процессе регистрации)
ACCEPTED	Объект зарегистрирован в ОРД, передан в ЕРИР, проходит отложенные проверки данных
MEDIA LOADING	Идет загрузка медиаданных креатива
APPROVED	Объект зарегистрирован в ОРД и в ЕРИР
DECLINED	Объект зарегистрирован в ОРД, но отклонен ЕРИР
DELETING	Объект в процессе удаления

Объект STATUS

Данный объект возвращается в ответ на запросы POST и PUT со статусом 200, 201, 202.

Часть полей объекта дублирует соответствующие Заголовки ответов.

Атрибут	Тип	Описание
id	string(uuid)	Идентификатор, под которым объект зарегистрирован в ОРД
erirRegisteredAt	timestamp	См. заголовок Ord-Erir-Registered-At
erirError	string	Cм. заголовок Ord-Erir-Error
state	string	См. заголовок Ord-State
mediaError	string	См. заголовок Ord-Media-Error
marker	string	Маркер креативаТолько для объектов типа Creative, имеющих state = APPROVED
syncError	string	Сообщение об ошибке процесса синхронизации с ЕРИР, возникшей в ходе исполнения данного запроса. Если присутствует, обычно совпадает с erirError

Объект ERROR

Данный объект возвращается в ответ на запросы, имеющие статусные коды 4xx и, в ряде случаев, 5xx.

Атрибут	Тип	Описание
requestId	string(uuid); required	Уникальный идентификатор запроса
status	int; required	HTTP код ответа
code	string; required	Код ошибки
title	string; required	Краткое описание ошибки. Одинаковое для одного и того же значения code
detail	string	Детальное описание ошибки

Объект Pagination - постраничный вывод

Данный объект возвращается в составе ответа на списочные запросы.

Атрибут	Тип	Описание
limit	int	Сколько элементов на странице
page	int	Номер страницы
total	int	Общее количество элементов

Детальная информация по вызовам API#

Организации

Субъекты рекламного рынка: рекламодатели, агентства, ОРС (операторы рекламных систем), РР (рекламораспространители). Российские и иностранные юридические и физические лица.

Версия	Атрибут	Тип	Описание
All	id	string(uuid)	Идентификатор организации, выданный ОРД
All	type	string; required	Тип организации
All	isOrs	boolean; required	Является ОРС
All	isRr	boolean; required	Является РР
All	inn	string	ИНН. Обязательно для российских субъектов: физических лиц, юридических лиц, индивидуальных предпринимателей.
All	platforms	Organization Platform[]	Площадки организации. Обязательно для организаций, являющихся РР и/или ОРС
All	kpp	string	КПП. Можно передавать только для российских юридических лиц.
All	name	string	ОПФ и полное наименование организации.
All	mobilePhone	string	Абонентский номер мобильного телефона. Обязательно для иностранных физических лиц.
All	epayNumber	string	Номер электронного средства платежа. Обязательно для иностранных физических лиц.
All	regNumber	string	Регистрационный номер, либо его аналог. Обязательно для иностранных организаций.
All	alternativeInn	string	Номер налогоплательщика либо его аналог в стране регистрации для иностранных физических и юридических лиц. Обязательно для иностранных организаций.
All	oksmNumber	string	Код страны регисрации юридического лица в соответствии с ОКСМ.
All	rsUrl	string	Сведения об ИС и (или) программе для ЭВМ, которые предназначены и используются ОРС для организации распространения в сети "Интернет" рекламы.

Значение	Описание
ffl	Иностранное физическое лицо
ful	Иностранное юридическое лицо
ip	Индивидуальный предприниматель
fl	Физическое лицо
ul	Юридическое лицо

Версия	Атрибут	Тип	Описание
All	platformId	string(uuid)	Идентификатор площадки ОРД
All	externalId	string; required	Пользовательский идентификатор площадки.
All	isOwned	boolean; required	Площадка принадлежит контрагенту
All	type	string; required	Тип площадки
All	name	string; required	Название сайта (блога), или приложения, или иные способы адресации
All	url	string	URL площадки или приложения в сторе

Значение	Описание
is*	Информационная система
apps	Приложение
site	Сайт

* Значение Информационная система нельзя использовать при создании/редактировании, но оно может приходить в ответах

для объектов которые были заведены до введения этого ограничения.

ExternailID для Platform

Поле ExternalId необходимо для идентфикации платформы пользователем в случае одновременной регистрации нескольких площадок.

Если в рамках одного запроса POST/organizations был направлен объект с множественными вложенными площадками, в ответном объекте порядок площадок может отличаться от порядка, в котором они были переданы в запросе. При необходимости, externalId может быть использован для адресации на стороне клиента. Однако следует помнить, что для первичной адрессации использовать externalId нельзя и, например, при регистрации Invoice использовать можно только platformId, генерируемы на стороне ОРД.

POST /organizations - Регистрация Организации в ОРД

Атрибут	Тип	Описание
requestBody
В теле запроса передается объект Organization без id
short	bool	По умолчанию false - отдавать созданный объект целиком, true - отдавать статус объекта

HTTP Status	Response Body
2xx	Объект Organization (short = false)
2xx	Объект Status (short = true)
4xx	Объект Error

Примеры:

Запрос:

POST /organizations

{
  "type": "ul",
  "isOrs": false,
  "isRr": false,
  "inn": "77012345678",
  "kpp": "999999999",
  "name": "ООО \"Некий рекламодатель\"",
  "platforms": [
    {
      "externalId": "myPlatform",
      "isOwned": "false",
      "type": "site",
      "name": "Моя Площадка",
      "url": "http://myplatform.org"
    }
  ]
}

Ответ:

// short=false
202 Accepted

{
 "id": "bee899e8-17f7-11ed-861d-0242ac120002",
 "state": "ACCEPTED",
 "erirRegisteredAt": "2022-09-12T13:20:50.052"
}

PUT /ORGANIAZTIONS/{ID} - Обновление информации об организации в ОРД от SberAds

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

Атрибут	Тип	Описание
id	string(uuid)	Идентификатор Организации, полученный в ответе от ОРД при регистрации
requestBody
В теле запроса передается объект Organization
short	bool	По умолчанию false - отдавать созданный объект целиком, true - отдавать статус объекта

Ответ:

HTTP Status	Response Body
2xx	Объект Status (short=true)
4xx	Объект Error
2xx	Объект Organization (short = false)

GET /organizations/{id} - Получение информации о зарегистрированной в ОРД Организации

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

Атрибут	Тип	Описание
id	string(uuid)	Идентификатор, под которым организация зарегистрирована в ОРД

Ответ:

HTTP Status	Response Body
200	Объект Organization
4xx	Объект Error

POST / organizations / search - Получение списка зарегистрированных в ОРД организации

OrganizationFilter object - Фильтр по организациям

Атрибут	Тип	Описание
id	string(uuid)	Список идентификаторов организаций выданных ОРД
alternativeInn	string	Альтернативный ИНН
created	timestamp	Дата создания в формате YYYY-MM-DD
epayNumber	string	Номер электронного платежа
erirRegDate	timestamp	Дата регистрации в формате YYYY-MM-DD
inn	string	ИНН
kpp	string	КПП
isOrs	bool	Организация является оператором рекламной системы
isRr	bool	Организация является рекламораспространителем
mobilePhone	string	Номер телефона
name	string	Название организации
oksmNumber	string	Код страны регистрации юрлица в соответствии с ОКСМ
regNumber	string	Регистрационный номер
page	number (int)	Номер страницы для постраничной навигации
limit	number (int)	Ограничение на количество элементов- максимальное 100
type	string	Тип организации
status	string	Статус
sorting	string	Сортировка

Значения sorting

По умолчанию сортировка устанавливается по возрастающей (asc), обратную сортировку можно получить добавив после названия поля desc через разделитель:

Пример: ["name:desc"]

Значения

Значение	Описание
status	Cтатус
type	Тип организации
name	Название организации
oksmnumber	Код страны регистрации юрлица в соответствии с ОКСМ
erirregdate	Дата ренистрации
isrr	Организация является рекламораспространителем
isors	Организация является оператором рекламной системы
created	Дата создания

OrganizationSearchResponse object - Объект

Атрибут	Тип	Описание
data	OrganizationItem	Агрегат организации и статуса
meta	Pagination	Объект постраничного вывода

OrganizationItem object - Агрегат организации и статуса

Атрибут	Тип	Описание
organization	Organization	Объект организации
entity	Status	Статус сущности

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

Атрибут	Тип
requestBody	–
В теле запроса передается объект OrganizationFilter	–

Ответ:

HTTP Status	Response Body
200	Объект OrganizationSearchResponse
4xx	Объект Error

HEAD /organizations/{id} - Получение статуса Организации в ОРД

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

Атрибут	Тип	Описание
id	string(uuid)	Идентификатор, под которым организация зарегистрирована в ОРД

Ответ:

HTTP Status	Response Body
200	–
4xx	–

GET /organizations/{id}/status - Получение информации о статусе зарегистрированной в ОРД Организации

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

Атрибут	Тип	Описание
id	string(uuid)	Идентификатор, под которым организация зарегистрирована в ОРД

Ответ:

HTTP Status	Response Body
200	Объект Status
4xx	Объект Error

POST /organizations/{id}/sync - Возобновление неоконченной регистрации или обновления данных Организации

Если после первой попытки регистрации (или обновления) сущности в ЕРИР, ее статус остался в значении Pending (то есть возникла не-перманентная ошибка), она отправляется в очередь для повторной отправки. Интервалы в очереди составляют один час и более.

Если пользователь не имеет возможности ждать повторной автоматической попытки, можно провести ее вручную, использовав метод sync.

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

Атрибут	Тип	Описание
id	string(uuid)	Идентификатор, под которым организация зарегистрирована в ОРД

Ответ:

HTTP Status	Response Body
200	Объект Status
4xx	Объект Error

Platform object - Площадка

Атрибут	Тип	Описание
organizationId	string(uuid)	Идентификатор организации
platformId	string(uuid)	Идентификатор площадки ОРД
externalId	string, required	Пользовательский идентификатор площадки
isOwned	boolean	Площадка принадлежит контрагенту
type	string, required	Тип площадки
name	string, required	Название сайта (блога), или приложения, или иные способы адресации
url	string	URL площадки или приложения в сторе

Значения type

Значение	Описание
apps	Приложение
site	Сайт
*is	Информационная система

*Значение Информационная система нельзя использовать при создании/редактировании, но оно может приходить в ответах для объектов которые были заведены до введения этого ограничения.

ExternalId для Platform

Поле ExternalId необходимо для идентификации площадки пользователем в случае одновременной регистрации нескольких площадок.

PlatformItem object - Агрегат площадки и сущности

Атрибут	Тип	Описание
platform	platform	Объект площадки
entity	Status	Статус сущности

POST /platforms - Регистрация Площадки в ОРД

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

Атрибут	Описание
requestBody	–
В теле запроса передается объект Platform без id	–

Ответ:

HTTP Status	Response Body
2хх	Объект Platform
4хх	Объект Error

Примеры:

POST /platforms
{"externalId": "myPlatform",
"isOwned": false,
"name": "Моя Площадка",
"organizationId": "000025be-a797-48cd-86d4-9da826f24522"
"type": "site",
"url": "http://myplatform.org",}

202 Accepted
{"organizationId": "000025be-a797-48cd-86d4-9da826f24522"
"platformId": "3e14cea8-f80a-4105-b5c8-ec8bb916443d",
"externalId": "myPlatform",
"type": "site",
"isOwned": false,
"name": "Моя Площадка",
"url": "http://myplatform.org",}

PUT /platforms/{id} - Обновление информации об Площадке в ОРД

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

Атрибут	Тип	Описание
id	string(uuid)	Идентификатор Площадки, полученный в ответе от ОРД при регистрации
requestBody	–	–
В теле запроса передается объект Platform	–	–

Ответ:

HTTP Status	Response Body
2хх	Объект Platform
4хх	Объект Error

GET /platforms/{id} - Получение информации о зарегистрированной в ОРД Площадки

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

Атрибут	Тип	Описание
id	string(uuid)	Идентификатор, под которым площадка зарегистрирована в ОРД

Ответ:

HTTP Status	Response Body
200	Объект Platform
4хх	Объект Error

HEAD /platforms/{id} - Получение статуса Площадки в ОРД

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

Атрибут	Тип	Описание
id	string(uuid)	Идентификатор, под которым Площадка зарегистрирована в ОРД

Ответ:

HTTP Status	Response Body
200	–
4хх	–

POST /platforms/search - Получение списка зарегистрированных в ОРД площадок

PlatformFilter object - Фильтр по организациям

Атрибут	Тип	Описание
organizationId	string(uuid)	Идентификатор организации выданный ОРД
platformId	string(uuid)	Идентификатор площадки выданный ОРД
type	string	Тип площадки
name	string	Название площадки
externalId	string	Внешний идентификатор
url	bool	Адрес площадки
createDate	string	Дата создания
status	string	Статус
limit	number (int)	Ограничение на количество элементов максимальное 100
page	number (int)	Номер страницы для постраничной навигации
sorting	string	Сортировка

Значения sorting

Пример: ["name:desc"]

Значения:

Значение	Описание
organizationId	Идентификатор организации выданный ОРД
organizationName	Название организации
platformid	Идентификатор площадки выданный ОРД
status	Статус
name	Название площадки
url	Адрес площадки
type	Тип площадки
isowner	Владелец площадки
externalid	Внешний идентификатор
registred	Дата регистрации
created	Дата создания

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

Атрибут	Описание
requestBody	–
В теле запроса передается объект PlatformFilter	–

PlatformSearchResponse object

Атрибут	Тип	Описание
data	PlatformItem[]	Агрегат площадки и статуса
meta	Pagination	Объект постраничного вывода

Ответ:

HTTP Status	Response Body
200	Объект PlatformSearchResponse
4хх	Объект Error

Договоры

Договоры между субъектами рекламного рынка. В привязке к договору креативы регистрируются в ОРД и ЕРИР.

Contract object - Договор

Версия	Атрибут	Тип	Описание
All	id	string(uuid)	Идентификатор договора, выданный ОРД
All	type	string; required	Тип договора. Возможные значения:
All	clientId	string(uuid); required	Идентификатор контрагента-заказчика в ОРД
All	contractorId	string(uuid); required	Идентификатор контрагент-исполнителя в ОРД
All	isRegReport	boolean; required	На контрагенте-исполнителе лежит обязанность регистрировать креативы и передавать информацию в ОРД
All	actionType	string	Тип договора
All	subjectType	string; required	Тип договора
All	number	string	Номер договора
All	date	date; required	Дата заключения договора или принятия оферты
All	amount	number (double)	Сумма договора
All	contractId	string(uuid)	Идентификатор основного договора договора для доп. соглашений. null - если это основной договор
All	cid	string(uuid)	Идентификатор изначального договора
All	agentActingForPublisher	boolean	Признак направления денежного потока в сторону принципала
All	endDate	date	Дата окончания срока действия договора

Значения type

Значение	Описание
intermediary-contract	Посреднический договор
contract	Договор оказания услуг
additional-agreement	Дополнительное соглашение

Значения actionType

Значение	Описание
other	Иное
distribution	Действия в целях распространения рекламы
conclude	Заключение договоров
commercial	Коммерческое представительство

Значения subjectType

Значение	Описание
representation	Представительство
other	Иное
org-distribution	Договор на организацию распространения рекламы
mediation	Посредничество
distribution	Договор на распространение рекламы

POST /contracts - Регистрация Договора в ОРД

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

Атрибут	Тип	Описание
requestBody
В теле запроса передается объект Contract без id
short	bool	по умолчанию false - отдавать созданный объект целиком, true - отдавать статус объекта

Ответ:

HTTP Status	Response Body
4xx	Объект Error
2xx	Объект Contract (short = false)
2xx	Объект Status (short = true)

Примеры:

Запрос:

POST /contracts
{ "type": "contract",
"clientId": "bee899e8-17f7-11ed-861d-0242ac120002",
"contractorId": "bee89dd0-17f7-11ed-861d-0242ac120002",
"isRegReport": true,
"actionType": "distribution",
"subjectType": "org-distribution",
"number": "123/22-02",
"date": "2022-05-23",
"isVat": true }

Ответ:

202 Accepted
{ "id": "7f5ee34c-4d21-423c-97c0-176e8f1585c3",
"state": "ACCEPTED",
"erirRegisteredAt": "2022-09-12T13:25:50.052" }

PUT /contracts/{id} - Обновление информации о Договоре в ОРД

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

Атрибут	Тип	Описание
id	string(uuid)	Идентификатор Договора, полученный в ответе от ОРД при регистрации
requestBody
Объект Contract
short	bool	по умолчанию false - отдавать созданный объект целиком, true - отдавать статус объекта

Ответ:

HTTP Status	Response Body
2xx	Объект Error short = true)
4xx	Объект Error
2xx	Объект Contract (short = false)

GET /contracts/{id} - Получение информации о зарегистрированном в ОРД Договоре

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

Атрибут	Тип	Описание
id	string(uuid)	Идентификатор Договора, полученный в ответе от ОРД при регистрации

Ответ:

HTTP Status	Response Body
200	Объект Contract
4xx	Объект Error

HEAD /contracts/{id} - Получение статуса зарегистрированного в ОРД Договора

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

Атрибут	Тип	Описание
id	string(uuid)	Идентификатор, под которым договор зарегистрирован в ОРД

Ответ:

HTTP Status	Response Body
200	–
4xx	–

GET /contracts/{id}/status - Получение информации о статусе зарегистрированного в ОРД Договора

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

Атрибут	Тип	Описание
id	string(uuid)	Идентификатор, под которым договор зарегистрирован в ОРД

Ответ:

HTTP Status	Response Body
200	Объект Status
4xx	Объект Error

POST /contracts/{id}/sync - Возобновление неоконченной регистрации или обновления данных Договора

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

Атрибут	Тип	Описание
id	string(uuid)	Идентификатор, под которым договор зарегистрирован в ОРД

Ответ:

HTTP Status	Response Body
200	Объект Status
4xx	Объект Error

Cid object - объект содержащий идентификатор изначального договора

Версия	Атрибут	Тип	Описание
All	cid	string(uuid)	Идентификатор изначального договора

POST /contracts/cid - Создать идентификатор изначального договора

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

Атрибут	Тип	Описание
id	string(uuid)	Идентификатор, под которым договор зарегистрирован в ОРД

Ответ:

HTTP Status	Response Body
201	Объект Cid
4xx	Объект Error

GET /contracts/cid/{id} - Получить идентификатор изначального договора

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

Атрибут	Тип	Описание
id	string(uuid)	Идентификатор, под которым договор зарегистрирован в ОРД

Ответ:

HTTP Status	Response Body
201	Объект Cid
4xx	Объект Error

Креативы

Маркировка креативов

Перед началом открутки креатив должен быть обязательно зарегистрирован в ЕРИР через ОРД. Маркер для креатива выдает ОРД.

Маркер возвращается в поле marker в объектах Creative и Status ТОЛЬКО для креативов, зарегистрированных в ЕРИР.

При изменении медиаданых креатива требуется получение нового маркера через ОРД.

Подробнее см. Маркировка рекламных материалов

Адресация креативов

При адресации креативов в запросах GET и PUT допускается:

использовать маркер вместо id в request-uri
использовать поле marker вместо поля id (но не вместе c полем id)

Creative object - Креатив

Версия	Атрибут	Тип	Описание
All	id	string(uuid)	Уникальный идентификатор креатива
All	selfPromotionOrganizationId	string(uuid)	ID организации, для которой данный креатив является саморекламой. Обязана быть Null, если contractid не Null
All	marker	string	Маркер креатива (для креатива, зарегистрированного в ЕРИР)
All	contractId	string(uuid)	Идентификатор зарегистрированного в ОРД договора (или доп. соглашения), в рамках которого производится размещение креатива
All	description	string	Общее описание объекта рекламирования, обязательно при указании кода ккту 30.15.1
All	form	string; required	Форма распространения рекламы.
All	url	string[]	Целевые ссылки креатива
All	targetAudience	CreativeTargetAudience	Параметры целевой аудитории рекламы
All	creativeData	CreativeData[]	Медиаданные (asset'ы) креатива
All	cid	string(uuid)	Идентификатор изначального договора, обязан быть null, если selfPromotionOrganizationId не null или contractId не null
All	isSocial	boolean, required	Признак социальной рекламы
All	ktu	string, required	Код справочника ККТУ
All	isSocialQuota	boolean; required	Признак социальной рекламы по квоте
All	erirIdType	string	Тип маркера/ Не может быть изменен PUT-запросом

Значения form

Значение	Описание
text-block	Текстовый блок
text-video-block	Текстовый блок с видео
text-audio-block	Текстовый блок с аудио
text-audio-video-block	Текстовый блок с аудио и видео
text-graphic-block	Текстово-графический блок
text-graphic-video-block	Текстово-графический блок с видео
text-graphic-audio-block	Текстово-графический блок с аудио
text-graphic-audio-video-block	Текстово-графический блок с аудио и видео
banner	Баннер
banner-html5	HTML5-баннер
video	Видеоролик
audio-rec	Аудиозапись
live-video	Видеотрансляция в прямом эфире
live-audio	Аудиотрансляция в прямом эфире
*other	Иное

Значение Иное нельзя использовать при создании/редактировании, но оно может приходить в ответах для объектов которые были заведены до введения этого ограничения.

Значения erirIdType

Значение	Описание
LONG	Длинный маркер (56 симв.)
MED	Средний маркер (11+ символов)
SHORT	Короткий маркер (6-9 символов)
PREMIUM	Маркер со словом внутри

CreativeTargetAudience object - Параметры целевой аудитории рекламы

Атрибут	Тип	Описание
age	string	Возраст целевой аудитории, Пример: ["20:25" , "30:35"]
geo	string	Регионы целевой аудитории, Пример: ["50" , "16"]
sex	string	Пол целевой аудитории, Пример: ["male"] / ["female"]

CreativeData object - Медиаданные креатива

Версия	Атрибут	Тип	Описание
All	textData	string	Содержимое текстовых медиаданных Обязателен либо textData, либо mediaUrl
All	externalId	string	Клиентский идентификатор creativeData для случаев, в которых может быть необходимо идентифицировать creativeData для редактирования.
All	mediaUrlFileType	string	Тип медиаданных
All	mediaUrl	string	Ссылка на медиафайл (для медиаданных Изображение, Видео и т.п.) Обязателен либо textData, либо mediaUrl

Значения mediaUrlFileType

Значение	Описание
image	Изображение
video	Видео или gif с несколькими кадрами (анимация)
audio	Аудио
zip	Архив в формате zip
other	Прочее

POST /creatives - Регистрация Креатива в ОРД

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

Атрибут	Тип	Описание
В теле запроса передается объект Creative
requestBody
short	bool	по умолчанию false - отдавать созданный объект целиком, true - отдавать статус объекта

Ответ:

HTTP Status	Response Body
2xx	Объект Error (short = true)
4xx	Объект Error
2xx	Объект Creative (short = false)

Запрос:

POST /creatives
{ "contractId": ["df56689e-17f8-11ed-861d-0242ac120002"],
"creativeData": [{"externalID": "123",
"textData": "текст"}],
"description": "Баннер РК 123123",
"erirIdType": "MED",
"form": "text-block",
"isSocial": false,
"isSocialQuota": false,
"selfPromotionOrganizationId": null,
"ktu": ["30.15.1"],
"targetAudience": {"age": ["20:25"],
"geo" ["16", "50"],
"sex": ["male"]},
"url": ["https://advertiser.ru/landing"] }

Ответ:

//short=true
202 Accepted
{ "id": "cfc1b665-796e-4716-a376-1ca14c0c4730",
"state": "APPROVED",
"erirRegisteredAt": "2022-09-12T13:20:50.052",
"marker": "2Ranyn7YfuE",}

PUT /creatives/{id} - Обновление информации о Креативе в ОРД

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

Атрибут	Тип	Описание
id	string	ID креатива или маркер, полученный в ответе от ОРД при регистрации
requestBody
В теле запроса передается объект Creative
short	bool	по умолчанию false - отдавать созданный объект целиком, true - отдавать статус объекта

Ответ:

HTTP Status	Response Body
2xx	Объект Status (short = true)
4xx	Объект Error
2xx	Объект Creative (short = false)

GET /creatives/{id} - Получение информации о зарегистрированном в ОРД Креативе

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

Атрибут	Тип	Описание
id	string	Id или маркер Креатива, полученный при регистрации в ОРД

Ответ:

HTTP Status	Response Body
200	Объект Creative
4xx	Объект Error

HEAD /creatives/{id} - Получение статуса зарегистрированного в ОРД Креатива

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

Атрибут	Тип	Описание
id	string	Id или маркер Креатива, полученный при регистрации в ОРД

Ответ:

HTTP Status	Response Body
200
4xx

GET /creatives/{id}/status - Получение информации о статусе зарегистрированного в ОРД Креатива

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

Атрибут	Тип	Описание
id	string	Id или маркер Креатива, полученный при регистрации в ОРД

Ответ:

HTTP Status	Response Body
200	Объект Status
4xx	Объект Error

POST /creatives/{id}/sync - Возобновление неоконченной регистрации или обновления данных Креатива или загрузки медиаданных

То же самое относится к медиаданным: в случае получения не-перманентной ошибке при попытке их загрузить, они после определённой паузы будут отправлены на повторную загрузку. И если пользователь хочет повторить попытку загрузки немедленно, он может вызвать метод sync.

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

Атрибут	Тип	Описание
id	string(uuid)	Id или маркер Креатива, полученный при регистрации в ОРД

Ответ:

HTTP Status	Response Body
200	Объект Status
4хх	Объект Error

Акты и статистика выполнения РК

В течение месяца, следующего за отчетным, необходимо предоставить Акты и статистику по РК, выполнявшихся в отчетном месяце.

Разделение Актов и Статистики креативов

Логика работы с актами и статистикой

После обновления API предполагается три сценария работы:

Если ваша работа предполагает формирование актов раз в месяц, также как и статистики, то рекомендуется передавать статистику вместе с актом /invoices/with-statistic.
Если ваша работа предполагает формирование актов реже, чем раз в месяц (например, квартальный акт) то используется следующий алгоритм:
В течение 30 дней с момента окончания месяца направлять статистику по каждому креативу по каждой площадке в течение всего периода через /creative-statistics
По составлении акта в конце периода зарегистрировать его через /invoces
После подтверждения регистрации акта в ЕРИР (получения статуса APPROVED) зарегистрировать связку акта со статистикой, указав каждый креатив по каждому изначальному договору через /invoces/creatives
Если ваша работа предполагает формирование актов чаще, чем раз в месяц (например, раз в неделю)
По составлении каждого акта, он регистрируется в ЕРИР через /invoices
В течение 30 дней после окончания отчетного периода, регистрируется статистика череp /creative-statistics
После подтверждения регистрации статистики и последнего акта в ЕРИР (получения статуса APPROVED) зарегистрировать связки каждого акта со статистикой через /invoces/creatives

Invoice object - Акт и статистика выполнения РК

Версия	Атрибут	Тип	Описание
All	type	string;required	Тип акта, возможные значения: invoice - Акт выполненных работ, intermediary-report - Отчет посредника (поверенного/ комиссионера/агента)
All	contractId	string(uuid);required	Идентификатор зарегистрированного в ОРД договора (или доп. соглашения), к которому относится акт
All	number	string	Номер акта
All	clientRole	string; required	Роль заказчика в акте
All	contractorRole	string; required	Роль исполнителя в акте
All	date	date; required	Дата акта
All	startDate	date; required	Дата начала периода
All	endDate	date; required	Дата окончания периода
All	amount	InvoiceWithStatisticAmount	Сведения о суммах акта/отчета (amount)
All	items[]	InvoiceItemWithStatistic[]	Разаллокация акта по атрибутам изначального договора
All	id	string(uuid)	Идентификатор акта, выданный ОРД
All	irRelevant	bool	Флаг не актуальности акта

InvoiceWithStatisticAmount - Сведения о суммах акта/отчета (amount)

Атрибут	Тип	Описание
services	InvoiceWithStatisticAmountServices	Детализация суммы акта
commission	InvoiceWithStatisticAmountCommission	Детализация суммы акта, если отчет включает вознаграждение посредника или составлен отдельный акт на вознаграждение посредника

InvoiceWithStatisticAmountServices - Детализация суммы акта

Атрибут	Тип	column3
excludingVat	number	Сумма акта/отчета без учета НДС, 2 знака после запятой
vatRate	number	Ставка НДС, 2 знака после запятой
vat	number	Сумма НДС в акте/отчете, 2 знака после запятой
includingVat	number	Сумма акт/отчета, включая НДС, 2 знака после запятой

InvoiceWithStatisticAmountCommission - Детализация суммы акта, если отчет включает вознаграждение посредника или составлен отдельный акт на вознаграждение посредника:

Атрибут	Тип	Описание
number	string	Номер акта вознаграждения посредника
date	date ( YYYY-MM-DD)	Дата акта вознаграждения посредника
excludingVat	number	Сумма вознаграждения посредника без учета НДС, 2 знака после запятой
vatRate	number	Ставка НДС, 2 знака после запятой
vat	number	Сумма НДС для вознаграждения посредника, 2 знака после запятой
includingVat	number	Сумма вознаграждения посредника, включая НДС, 2 знака после запятой

Значения clientRole и contractorRole

Значение	Описание
ra	Рекламное агентство
rr	Рекламораспространитель
ors	Оператор рекламной системы
rd	Рекламодатель
psr	Посредник

InvoiceItemWithStatistic

Атрибут	Тип	Описание
contractId	string(uuid);	Идентификатор изначального договора (или доп. соглашения) в ОРД
amount	InvoiceItemWithStatisticAmount; required	Сумма в привязке к изначальному договору по размещенным креативам
creatives[]	InvoiceItemCreative[]	Разаллокация по креативам за период акта
cid	string(uuid);	Идентификатор изначального договора, обязан быть null если contractId не null

InvoiceItemWithStatisticAmount - Детализация суммы акта

Атрибут	Тип	Описание
excludingVat	number	Сумма детализации без учета НДС, 2 знака после запятой
vatRatе	number	Ставка НДС, 2 знака после запятой
vat	number	Сумма НДС в детализации, 2 знака после запятой
includingVat	number	Сумма детализации, включая НДС, 2 знака после запятой

InvoiceItemCreative

Версия	Атрибут	Тип	Описание
All	creativeId	string(uuid)	ID креатива
All	marker	string	Маркер креатива (только в запросах POST/PUT, и только, если не указан ID креатива)
All	platforms[]	InvoiceItemCreativePlatform[]	Статистика по креативу в разрезе по площадкам

InvoiceItemCreativePlatform

Версия	Атрибут	Тип	Описание
v4	campaignType	string; required	Тип рекламы
v4	impsPlan	int64; required	Количество показов по плану
v4	dateStartPlan	date; required	Дата начала показов по плану
v4	dateEndPlan	date; required	Дата окончания показов по плану
v4	impsFact	int64; required	Количество показов фактическое
v4	dateStartFact	date; required	Дата начала показов фактическая
v4	dateEndFact	date; required	Дата окончания показов фактическая
v4	amount	InvoiceItemCreativePlatformAmount; required	Стоимость оказанных услуг
v4	amountPerShow	number (double); required	Стоимость единицы оказания услуг
v4	platformId	string; required	Идентификатор площадки

Значение campaignType

Значение	Описание
CPM	Оплата за просмотры
CPC	Оплата за клики
CPA	Оплата за действия
other	Иное

InvoiceItemCreativePlatformAmount - Сведения о стоимостях оказанных услуг

Атрибут	Тип	Описание
excludingVat	number	Стоимость оказанных услуг без учета НДС, 5 знаков после запятой
vatRate	number	Ставка НДС, 2 знака после запятой
vat	number	Сумма НДС для стоимости оказанных услуг, 5 знаков посл запятой
includingVat	number	Стоимость оказанных услуг, включая НДС, 5 знаков после запятой

POST /invoices/with-statistic - Передача информации об Акте и статистике выполнения РК в ОРД.

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

Атрибут	Тип	Описание
requestBody
В теле запроса передается объект Invoice без id
short	bool	по умолчанию false - отдавать созданный объект целиком, true - отдавать статус объекта

Ответ:

HTTP Status	Response Body
2xx	Объект Status ) short = true)
4xx	Объект Error
2xx	Объект InvoiceWithStatistic (short = false)

Примеры v4:

Запрос:

{"contractId": "9e931562-20c3-4d37-bb9a-d0b5d0d038c4"
"type": "intermediary-report",
"clientRole": "rd",
"contractorRole": "rr",
"startDate": "2024-10-01",
"endDate": "2024-10-13",
"amount": {
"services": {"excludingVat": 83.33,
"includingVat": 100,
"vat": 16.67,
"vatRate": 20.00},
"commission": {
"date": "2025-01-01",
"number": "AAAAA",
"excludingVat": 83.33,
"includingVat": 100,
"vat": 16.67,
"vatRate": 20.00,}},
"date": "2024-10-16",
"number": "detalnaya2",
"items": [{"contractId": "9e931562-20c3-4d37-bb9a-d0b5d0d038c4",
"amount": {
"excludingVat": 83.33,
"includingVat": 100,
"vat": 16.67,
"vatRate": 20.00},
"creatives": [{"creativeId": "f93736e2-8283-464b-8c48-5eb311d54195"
"marker": null,
"platforms": [{"platformId": "cc91e529-da79-4a61-a61a-dfad2b5f4e24"
"externalId": null,
"impsFact": 1234,
"impsPlan": 1234,
"dateStartFact": "2024-10-06",
"dateEndFact": "2024-10-06",
"dateStartPlan": "2024-10-06",
"dateEndPlan": "2024-10-06",
"amount": {
"excludingVat": 83.33333,
"includingVat": 100.00000,
"vat": 16.66667,
"vatRate": 20.00},
"amountPerShow": 1,
"campaignType": "cpc"]}]}}]

Ответ:

202 Accepted
{"id": "eb4fc8dd-2074-4471-99e7-19369f0048f2",
"state": "ACCEPTED",
"erirRegisteredAt": "2024-09-29T21:26:18+03:00"}

PUT /invoices/{id} - Обновление информации об Акте и статистике выполнения РК

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

Атрибут	Тип	Описание
id	string(uuid)	Идентификатор Акта, полученный в ответе от ОРД при регистрации
requestBody
В теле запроса передается объект Invoice
short	bool	по умолчанию false - отдавать созданный объект целиком, true - отдавать статус объекта

Ответ:

HTTP Status	Response Body
2xx	Объект Status (short = true)
4xx	Объект Error
2xx	Объект InvoiceWithStatistic (short = false)

GET /invoices/with-statistic/{id} - Получение информации об Акте и статистике выполнения РК

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

Атрибут	Тип	Описание
id	string(uuid)	Идентификатор Акта, полученный в ответе от ОРД при регистрации

Ответ:

HTTP Status	Response Body
200	Объект InvoiceWithStatistic
4xx	Объект Error

HEAD /invoices/with-statistic/{id} - Получение статуса Акта

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

Атрибут	Тип	Описание
id	string(uuid)	Идентификатор, под которым акт зарегистрирован в ОРД

Ответ:

HTTP Status	Response Body
200	–
4xx	–

GET /invoices/with-statistic/{id}/status - Получение информации о статусе зарегистрированного в ОРД Акта

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

Атрибут	Тип	Описание
id	string(uuid)	Идентификатор, под которым акт зарегистрирован в ОРД

Ответ:

HTTP Status	Response Body
200	Объект Status
4xx	Объект Error

POST /invoices/{id}/sync - Возобновление неоконченной регистрации или обновления данных Акта

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

Атрибут	Тип	Описание
id	string(uuid)	Идентификатор, под которым акт зарегистрирован в ОРД

Ответ:

HTTP Status	Response Body
200	Объект Status
4xx	Объект Error

Invoice/creatives object - Связка акта и статистики, поданных раздельно:

Версия	Атрибут	Тип	Описание
All	id	string(uuid); required	Связки креатива
All	invoiceId	string(uuid); required	Идентификатор акта, выданный ОРД
All	contractId	string(uuid)	Идентификатор зарегистрированного в ОРД Изначального договора (или доп. соглашения), обязателен если не указан cid
All	creatives	InvoiceCreativesItem[]	–
All	creativeId*	string(uuid)	Идентификатор креатива, выданный ОРД должен быть пуст если передан marker
All	marker*	string	Маркер креатива (только в запросах POST/PUT, и только, если не указан ID креатива)
All	cid	string(uuid)	Идентификатор изначального договора, обязан быть null если contractId не null

* InvoiceCreativeItem object - creativeId, marker

POST /invoices/creatives - Передача информации об Акте и статистике выполнения РК в ОРД

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

Атрибут	Тип	Описание
requestBody
В теле запроса передается объект Invoice/creatives без id
short	bool	по умолчанию false - отдавать созданный объект целиком, true - отдавать статус объекта

Ответ:

HTTP Status	Response Body
2xx	Объект Status (short = true)
4xx	Объект Error
2xx	Объекты InvoiceCreative (short = false)

Примеры:

Запрос:

POST /invoices/creatives
{"creatives": [
{"invoiceId": "8caed80f-3c0b-4c4c-aab0-ecf1e9118127"
"cid": "d613b0fe-dc8f-010a-11f3-0a66aa5e078a",
"creatives": [
{"creativeId": "cf7af5df-3c20-419d-8d01-1e0bbd4ed712"},
{"creativeId": "cf7af5df-3c20-419d-8d01-1e0bbd4ed712"},
{"creativeId": "cf7af5df-3c20-419d-8d01-1e0bbd4ed712"}]}]}

Ответ:

// short=true
2202 Accepted
{"statuses": [
{"id": "815ca9ae-86d6-4634-b33d-15de32bc2f9e"
"state": "PENDING",}]}

PUT /invoices/creatives/{id} - Обновление информации об Акте и статистике выполнения РК

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

Атрибут	Тип	Описание
id	string(uuid)	Идентификатор Акта, полученный в ответе от ОРД при регистрации
requestBody
В теле запроса передается объект Invoice/creatives

Ответ:

HTTP Status	Response Body
2xx	Объект Status
4xx	Объект Error

GET /invoices/creatives/{id} - Получение информации об Акте

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

Атрибут	Тип	Описание
id	string(uuid)	Идентификатор связки акта со статистикой, полученный в ответе от ОРД при регистрации

Ответ:

HTTP Status	Response Body
200	Объект Invoice
4xx	Объект Error

HEAD /invoices/creatives/{id} - Получение статуса связки

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

Атрибут	Тип	Описание
id	string(uuid)	Идентификатор, под которым акт зарегистрирован в ОРД

Ответ:

HTTP Status	Response Body
200	–
4xx

GET /invoices/creatives/{id}/status - Получение информации о статусе зарегистрированной в ОРД связки креативов с актом

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

Атрибут	Тип	Описание
id	string(uuid)	Идентификатор, под которым акт зарегистрирован в ОРД

Ответ:

HTTP Status	Response Body
200	Объект Status
4xx	Объект Error

POST /invoices/creatives/{id}/sync - Возобновление неоконченной регистрации или обновления данных Акта

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

Атрибут	Тип	Описание
id	string(uuid)	Идентификатор, под которым акт зарегистрирован в ОРД

Ответ:

HTTP Status	Response Body
200	Объект Status
4xx	Объект Error

CreativeStatistic object - Статистика выполнения РК

Версия	Атрибут	Тип	Описание
v4	id	string(uuid)
v4	creativeId	string(uuid)	ID креатива, по которому передается статистика
v4	marker	string	Маркер креатива, по которому передается статистика, (только в запросах POST/PUT, и только, если не указан ID креатива)
v4	platformId	string; required	Идентификатор площадки
v4	impsPlan	int64; required	Количество показов по плану
v4	dateStartPlan	date; required	Дата начала показов по плану
v4	dateEndPlan	date; required	Дата окончания показов по плану
v4	impsFact	int64; required	Количество показов фактическое
v4	dateStartFact	date; required	Дата начала показов фактическая
v4	dateEndFact	date; required	Дата окончания показов фактическая
v4	amount	CreativeStatisticAmount;; required	Сведения о стоимостях оказанных услуг
v4	amountPerShow	number (double); required	Стоимость единицы оказания услуг
v4	campaingType	string; required	Тип рекламной кампании
v4	invoiceID	string (uuid)	Идентификатор акта
v4	cid	string(uuid)	Уникальный идентификатор изначального договора

CreativeStatisticAmount - Сведения о стоимостях оказанных услуг

Атрибут	Тип	Описание
excludingVat	number	Стоимость оказанных услуг без учета НДС, 5 знаков после запятой
vatRate	number	Ставка НДС, 2 знака после запятой
vat	number	Сумма НДС для стоимости оказанных услуг, 5 знаков после запятой
includingVat	number	Стоимость оказанных услуг, включая НДС, 5 знаков после

Значения campaignType

Значение	описание
СРМ	Оплата за просмотры
СРС	Оплата за клики
СРА	Оплата за действия
other	Прочее

POST / CreativeStatistics

Передача информации об Акте и статистике выполнения РК в ОРД

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

Атрибут	Тип	Описание
requestBody
statistics	CreativeStatistic[]	Массив объектов типа CreativeStatistic без id
short	bool	по умолчанию false - отдавать созданный объект целиком, true - отдавать статус объекта

Ответ:

HTTP Status	Response Body
2xx	Объект CreativeStatistic[] (short = false)
4xx	Объект Error
2xx	Объект Status[] (short = true)

Примеры:

Запрос:

{"statistics": [
{"creativeId": "f8762bf2-07dd-483e-8164-64e9bedef67b"
"marker": null,
"platformId": "e12e40be-c692-4953-baa7-0ec60b119194"
"externalId": null,
"impsFact": 100,
"impsPlan": 101,
"dateStartFact": "2024-10-10",
"dateEndFact": "2024-10-25",
"dateStartPlan": "2024-10-12",
"dateEndPlan": "2024-10-26",
"amount": {"excludingVat": 83.33333,
"includingVat": 100.00000,
"vat": 16.66667,
"vatRate": 20.00},
"amountPerShow": 1,
"campaignType": "cpa",}

Ответ:

202 Accepted
{"statuses": [
{"id": "957367c1-47a5-4079-afc5-15118d147307",
"state": "ACCEPTED",
"erirRegisteredAt": "2024-09-29T20:15:12+03:00"}]}

PUT /creativeStatistics - Обновление информации об Акте и статистике выполнения РК

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

Атрибут	Тип	Описание
requestBody
statistics	CreativeStatistic[]	Массив объектов типа CreativeStatistic
short	bool	по умолчанию false - отдавать созданный объект целиком, true - отдавать статус объекта

Ответ:

HTTP Status	Response Body
2xx	Объект Status (short = true)
4xx	Объект Error
2xx	Объект CreativeStatistic (short = false)

GET /creativeStatistics/{id} - Получение информации о статистике выполнения РК

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

Атрибут	Тип	Описание
id	string(uuid)	Идентификатор Акта, полученный в ответе от ОРД при регистрации

Ответ:

HTTP Status	Response Body
200	Объект creativeStatistics
4xx	Объект Error

HEAD /creativeStatistics/{id} - Получение статуса Акта

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

Атрибут	Тип	Описание
id	string(uuid)	Идентификатор, под которым элемент статистики зарегистрирован в ОРД

Ответ:

HTTP Status	Response Body
200	–
4xx	–

GET /creative-statistics/{id}/status - Получение информации о статусе зарегистрированной в ОРД Статистики по креативу

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

Атрибут	Тип	Описание
id	string(uuid)	Идентификатор, под которым элемент статистики зарегистрирован в ОРД

Ответ:

HTTP Status	Response Body
200	Объект Status
4xx	Объект Error

POST /creativeStatistics/{id}/sync - Возобновление неоконченной регистрации или обновления Статистики

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

Атрибут	Тип	Описание
id	string(uuid)	Идентификатор, под которым элемент статистики зарегистрирован в ОРД

Ответ:

HTTP Status	Response Body
200	Объект Status
4xx	Объект Error

Формато-логический контроль#

Organization object - Организация

Атрибут	ФЛК
id
type	Возможные значения: ffl - Иностранное физическое лицо; ful - Иностранное юридическое лицо; ip - Индивидуальный предприниматель; fl - Физическое лицо; ul - Юридическое лицо.
isOrs
isRr
inn	Максимальная длина: 12 Обязательно для заполнения для следующих типов организаций: ip - Индивидуальный предприниматель; fl - Физическое лицо; ul - Юридическое лицо. Если тип организации "fl" - Физическое лицо или "ip" - Индивидуальный предприниматель 12-значный ИНН: 0. Пропускать только 12 цифр 1. Вычислить 1-ю контрольную цифру: 1.1 Вычислить сумму произведений цифр ИНН (с 1-й по 10-ю) на следующие коэффициенты — 7, 2, 4, 10, 3, 5, 9, 4, 6, 8 (т.е. 7 * ИНН[1] + 2 * ИНН[2] + ...). 1.2 Вычислить младший разряд остатка от деления полученной суммы на 11. 2. Вычислить 2-ю контрольную цифру: 2.1 Вычислить сумму произведений цифр ИНН (с 1-й по 11-ю) на следующие коэффициенты — 3, 7, 2, 4, 10, 3, 5, 9, 4, 6, 8 (т.е. 3 * ИНН[1] + 7 * ИНН[2] + ...). 2.2 Вычислить младший разряд остатка от деления полученной суммы на 11. 3. Сравнить 1-ю контрольную цифру с 11-й цифрой ИНН и сравнить 2-ю контрольную цифру с 12-й цифрой ИНН. Если они равны, то ИНН верный. Если тип организации "ul" - Юридическое лицо 10-значный ИНН: 0. Пропускать только 10 цифр 1. Вычислить сумму произведений цифр ИНН (с 1-й по 9-ю) на следующие коэффициенты — 2, 4, 10, 3, 5, 9, 4, 6, 8 (т.е. 2 * ИНН[1] + 4 * ИНН[2] + ...). 2. Вычислить остаток от деления полученной суммы на 11. 3. Сравнить младший разряд полученного остатка от деления с младшим разрядом ИНН. Если они равны, то ИНН верный.
name	Максимальная длина: 255 Длина строки от 1 до 255, может содержать цифры и буквы, а также любые спецсимволы - пробел Регулярки для проверки имени в зависимости от типа fl - ^([а-яёА-ЯЁ-]+\s?[а-яёА-ЯЁ-]+){1,255}$ ip/ul - ^([а-яёА-ЯЁ0-9?!$]+(-\|\s\|\s"\|"\s))[а-яёА-ЯЁ0-9?!$][^(\s\|\-)]+$ other - ^([a-zA-Zа-яёА-ЯЁ0-9?!$]+(-\|\s\|\s"\|"\s))[a-zA-Zа-яёА-ЯЁ0-9?!$][^(\s\|\-)]+$ Для типа организации "fl" - Физическое лицо: 1. Только русские буквы 2. Допускается пробел (не более одного между словами. При этом в начале и в конце пробелов не должно быть) 3. Допускается тире (не более одного между словами. При этом в начале и в конце тире не должно быть)
mobilePhone	Обязательно для заполнения для типа организации ffl - Иностранное физическое лицо. Если не заполнено, то должно быть заполнено epayNumber Максимальная длина: 50 Если заполнено, то: Длина строки от 1 до 50, может содержать цифры от 0 до 9 и плюс (pattern: ^+[0-9]{1,50}$) Формат номера начинать с + и далее только цифры
epayNumber	Обязательно для заполнения для типа организации ffl - Иностранное физическое лицо. Если не заполнено, то должно быть заполнено mobilePhone Максимальная длина: 50 Если заполнено, то: Длина строки от 1 до 255, может содержать цифры и буквы, а также любые спецсимволы, пробел (pattern: ^[?!*$-_a-zA-Z0-9]{1,255}$ Не пустое и не превышает 255)
regNumber	Обязательно для заполнения для типа организации ful - Иностранное юридическое лицо. Если не заполнено, то должно быть заполнено alternativeInn Максимальная длина: 50 Если заполнено, то: Длина строки от 1 до 255, может содержать цифры и буквы, а также любые спецсимволы, пробел (pattern: ^[?!*$-_a-zA-Z0-9]{1,255}$ Не пустое и не превышает 255)
alternativeInn	Обязательно для заполнения для типов организации: 1. ffl - Иностранное физическое лицо, если стоит признак isOrs=true; 2. ful - Иностранное юридическое лицо. Если не заполнено, то должно быть заполнено regNumber. Максимальная длина: 50 Если заполнено, то: Длина строки от 1 до 255, может содержать цифры и буквы, а также любые спецсимволы, пробел (pattern: ^[?!*$-_a-zA-Z0-9]{1,255}$ Не пустое и не превышает 255)
oksmNumber	Обязательно для заполнения для следующих типов организаций: 1. ffl - Иностранное физическое лицо; 2. ful - Иностранное юридическое лицо. Максимальная длина: 3 Длина строки 3, может содержать цифры (pattern: ^\d{3}$)
rsUrl	Обязательно для всех типов, если признак isOrs = true Минимальная длина: 1 Максимальная длина: 2000 Проверка URL: 1. Проверить протокол http\|https 2. Проверить хост: в нем не должно содержаться punycode или urlencode (т.е. не должно быть символов %, &, xn-, и т.д) 3. Проверить путь - здесь не должно содержаться urlencode
kpp	Длина строки 9, может содержать цифры 0-9. Поле может быть заполнено только для российских юридических лиц. Не принимать от ip/fl/ful/ffl

Platform object - Площадка

Атрибут	ФЛК
platformId
externalId
isOwned	Возможные значения: true / false
type
name	Минимальная длина: 1 Максимальная длина: 100 В начале и в конце не должно быть пробела и переноса на другую строку
url	Необязательно, если тип площадки равен is - Информационная система Минимальная длина: 1 Максимальная длина: 2000 Проверка URL: 1. Проверить протокол http\|https 2. Проверить хост: в нем не должно содержаться punycode или urlencode (т.е. не должно быть символов %, &, xn-, и т.д) 3. Проверить путь - здесь не должно содержаться urlencode

Contract object - Договор

Атрибут	ФЛК
id
type
clientId	В ЕРИР должна быть зарегистрирована организация с таким id от конкретного ОРД . Поле "clientId" не должно быть равно "contractorId". Не может быть изменен идентификатор Контрагента-заказчика в договоре, для которого выдан cid.
contractorId	В ЕРИР должна быть зарегистрирована организация с таким id от конкретного ОРД; Договор не может быть зарегистрирован/обновлен, если идентификатор Контрагента-заказчика был отправлен в сервис удаления в ЕРИР и находится на согласовании.
isRegRepor	Возможные значения: true/ false.
actionType	Возможные значения: other - Иное; distribution - Действия в целях распространения рекламы; conclude - Заключение договоров; commercial - Коммерческое представительство.
subjectType	Возможные значения: other - Иное; org-distribution - Договор на организацию распространения рекламы; mediation - Посредничество; distribution - Договор на распространение рекламы; representation - Представительство
number	Минимальная длина: 1 Максимальная длина: 255 В начале и в конце не должно быть пробела и переноса на другую строку
date	ГГГГ-ММ-ДД где ГГГГ - любые 4 цифры, ММ - от 1 до 12, ДД - значение от 1 до 31. Разделителем является тире. (pattern: ^\d{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[12][0-9]\|3[01])$) 1. Дата должна быть не ниже, чем 01.01.1991 2. Дата должна быть меньше или равна текущей дате
amount	Положительные числа или нулевые Формат: два знака после запятой, разделитель - точка 22.23. Нельзя указывать 0 для договора, у которого type = "intermediary-contract" (посреднический договор). Нельзя указывать 0 для договора, у которого type = "additional-agreement" (дополнительное соглашение) и родительский договор с типом "intermediary-contract" (посреднический договор).
contractId	Если тип договора равен "additional-agreement" - Дополнительное соглашение, то указывается. В других случаях атрибут исключается В ЕРИР должен быть зарегистрирован договор с таким id от конкретного ОРД 1. Указывается только договор, у которого совпадают Заказчик и Исполнитель с текущим доп. соглашением 2. При добавлении доп. соглашения (ДС) - проверить, что существует основной договор в цепочке у ДС, так как ДС может быть к ДС2.
agentActingForPublisher	"Обязательность заполнения поля Если выбран тип договора ""intermediary-contract"" - Посреднический договор, то указывать явным образом, либо false, либо true. Если другие типы договоров, то его игнорировать, даже если передали и по умолчанию ставить false".

Creative object - Креатив

Атрибут	ФЛК
id
erirId
erirIdType
marker
contractId	В ЕРИР должен быть зарегистрирован договор с таким id от конкретного ОРД
description	Минимальная длина: 1 Максимальная длина: 1000 Если заполнено, то: Длина строки от 1 до 1000, может содержать цифры и буквы, а также любые спецсимволы, пробел (pattern: ^(?!\s*$)[\s\S]{1,1000} 1000 и непустое) В начале и в конце не должно быть пробела и переноса на другую строку. Обязательность заполнения поля при выполнении одного из условий: - в "creativeType" любое допустимое значение и в массиве "kktuCode" передан один элемент и этот элемент равен "30.15.1".
selfPromotionOrganizationId	Для креатива с “creativeType” равным “feed_element” запрещается передавать поле "Идентификатор контрагента, которому принадлежит саморекламный креатив" (selfPromotionOrganizationId). В ЕРИР должен быть зарегистрирован контрагент с таким id от конкретного ОРД.
form
url	Минимальная длина: 1 Максимальная длина: 2000 Проверка URL: 1. Проверить протокол http\|https 2. Проверить хост: в нем не должно содержаться punycode или urlencode (т.е. не должно быть символов %, &, xn-, и т.д) 3. Проверить путь - здесь не должно содержаться urlencode
isSocial
isSocialQuota
creativeData
targetAudience	"1. Для типа ""geo"": Максимальная длина: 2 Может содержать цифры 0-9 В элементах массива передаются коды регионов. Если массив пустой, то геотаргетинг направлен на всю Россию 2. Для типа ""sex"": male - мужчины female - женщины Если таргетинг на аудиторию не зависящую от пола, то параметр targetAudienceList.type = ""sex"" не передается. 3. Для типа ""age"": ""<минимальный возраст>:<максимальный возраст>"". До двоеточия и после двоеточия должны быть указаны целые числа: - <минимальный возраст>: от 0 до 100, - <максимальный возраст>: от 0 до 100, где <максимальный возраст> должен быть >= <минимальный возраст> Например, ""25:45"" - означает, что реклама таргетируется на аудиторию от 25 до 45 лет. Если таргетинг на любой возраст, то параметр targetAudienceList.type = ""age"" не передается (pattern: ""((?!00)^0(?:[0-9][0-9]?\|100))(:)((?!00)0(?:[0-9][0-9]?\|100)$)"")"
coBranding	Возможные значения: true/ false
kktuCode	Три числа от 1-999 с разделителем точка между ними. Значения в массиве должны передаваться в соответствии с третьим уровнем значений в справочнике ККТУ.
cid	Может содержать спец символ - , а также латинские буквы a-z и цифры 0-9.

CreativeData object - Медиаданные креатива

Атрибут	ФЛК
description	Если поле "Ссылка на образец" не заполнено, то должно быть пустым Минимальная длина: 1 Максимальная длина: 1000 Если заполнено, то: Длина строки от 1 до 1000, может содержать цифры и буквы, а также любые спецсимволы, пробел (pattern: ^(?!\s*$)[\s\S]{1,1000} Не пустое и не превышает 1000) В начале и в конце не должно быть пробела и переноса на другую строку
textData	Должно быть заполнено, только если пустое mediaUrl. В другом случае исключается Минимальная длина: 1 Максимальная длина: 65000 1. В начале и в конце не должно быть пробела и переноса на другую строку 2. Если у креатива несколько медиаданных, то сумма всех текстовых данных креатива не должна превышать 65к
mediaUrl	Должно быть заполнено, только если пустое textData. В другом случае исключается
mediaUrlFileType	Возможные значения: image - изображение video - видео audio - аудио zip - архив other - иное Если в mediaUrl передается ссылка на файл, который является: - статичным растровым изображением, то в поле указывается тип ""image"", - видео - указывается тип ""video"", - аудио - указывается тип ""audio"", - каким-либо архивом - указывается тип ""zip"", - каким-либо файлом, который не соответствует выше описанным видам - указывается тип ""other"". Для анимационного GIF выбирается тип ""video"". Для векторного изображения выбирается тип ""other"". Значение "zip" может быть указано только для формы распространения креатива (form) HTML5-баннер (banner-html5).

Invoice object - Акт и статистика выполнения РК

Атрибут	ФЛК
id
contractId	В ЕРИР должен быть зарегистрирован договор с таким id от конкретного ОРД 1. Если contractid принадлежит договору саморекламы, то во всех пунктах разаллокации по атрибутам изначального договора допустим только тот же contractid в качестве изначального. 2. Если contractid не принадлежит договору саморекламы, то во всех пунктах разаллокации по атрибутам изначального договора contractid не должны принадлежать договорам саморекламы.
number	Минимальная длина: 1 Максимальная длина: 255 В начале и в конце не должно быть пробела и переноса на другую строку
clientRole	В случае обычного договора и посреднического договора, когда РА представляет РД: - Если роль заказчика РД, то роль исполнителя может быть РА, ОРС, РР. - Если роль заказчика РА, то роль исполнителя может быть РА, ОРС, РР. - Если роль заказчика ОРС, то роль исполнителя может быть ОРС, РР. - Заказчик не может быть в роли РР. В случае посреднического договора, когда РА представляет РР: - Если роль заказчика РР, то роль исполнителя РА. Если регистрируется акт к посредническому договору (либо к доп соглашению такого договора), у которого признак agentActingForPublisher=true, то в ролях сторон нельзя передавать роль РД.
contractorRole	Возможные значения: ra - Рекламное агентство; rr - Рекламораспространитель; ors - Оператор рекламной системы; psr - Посредник". В акте роль РР не может быть у Исполнителя (агента) к договору с признаком agentActingForPublisher=true.
date	ГГГГ-ММ-ДД где ГГГГ - любые 4 цифры, ММ - от 1 до 12, ДД - значение от 1 до 31. Разделителем является тире. (pattern: ^\d{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[12][0-9]\|3[01])$) 1. Дата должна быть не ниже, чем 01.01.1991 2. Дата должна быть меньше или равна текущей дате Дата акта должна быть больше, чем дата контракта
startDate	ГГГГ-ММ-ДД где ГГГГ - любые 4 цифры, ММ - от 1 до 12, ДД - значение от 1 до 31. Разделителем является тире. (pattern: ^\d{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[12][0-9]\|3[01])$) 1. Дата должна быть не ниже, чем 01.01.1991 2. Дата должна быть меньше или равна, чем дата окончания периода акта 3. Дата должна быть меньше или равна текущей дате
endDate	ГГГГ-ММ-ДД где ГГГГ - любые 4 цифры, ММ - от 1 до 12, ДД - значение от 1 до 31. Разделителем является тире. (pattern: ^\d{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[12][0-9]\|3[01])$) 1. Дата должна быть не ниже, чем 01.01.1991 2. Дата должна быть больше или равна, чем дата начала периода акта 3. Дата должна быть меньше или равна текущей дате
irrelevant	Признак неактуальности записи. Возможные значения: true / false.
items[]
contractId	В ЕРИР должен быть зарегистрирован договор с таким id от конкретного ОРД
creatives[]
creativeId	В ЕРИР должен быть зарегистрирован креатив с таким id от конкретного ОРД " Креатив с “creativeType” равным “feed_element” запрещается передавать в метод статистики Статистика не может быть зарегистрирована/обновлена, если идентификатор креатива был отправлен был отправлен в сервис удаления в ЕРИР и находится на согласовании.
marker
platforms[]
platformId	Минимальная длина: 1 Максимальная длина: 255 В ЕРИР должна быть зарегистрирована площадка с таким id от конкретного ОРД
impsPlan	Целое положительное число или нулевое Если у креатива, к которому относится статистика, признак isNative равен true, то значение должно равняться 0
dateStartPlan	ГГГГ-ММ-ДД где ГГГГ - любые 4 цифры, ММ - от 1 до 12, ДД - значение от 1 до 31. Разделителем является тире. (pattern: ^\d{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[12][0-9]\|3[01])$) 1. Дата должна быть не ниже, чем 01.01.1991 2. Дата должна быть меньше или равна, чем дата окончания показов по акту 3. Дата должна быть меньше или равна текущей дате
dateEndPlan	ГГГГ-ММ-ДД где ГГГГ - любые 4 цифры, ММ - от 1 до 12, ДД - значение от 1 до 31. Разделителем является тире. (pattern: ^\d{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[12][0-9]\|3[01])$) 1. Дата должна быть не ниже, чем 01.01.1991 2. Дата должна быть больше или равна, чем дата начала показов по акту 3. Дата должна быть меньше или равна текущей дате
impsFact	Целое положительное число Целое положительное число Если у креатива, к которому относится статистика, признак isNative равен true, то значение должно равняться 0
dateStartFact	ГГГГ-ММ-ДД где ГГГГ - любые 4 цифры, ММ - от 1 до 12, ДД - значение от 1 до 31. Разделителем является тире. (pattern: ^\d{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[12][0-9]\|3[01])$) 1. Дата должна быть не ниже, чем 01.01.1991 2. Дата должна быть меньше или равна, чем дата окончания показов фактическая 3. Дата должна быть меньше или равна текущей дате
dateEndFact	ГГГГ-ММ-ДД где ГГГГ - любые 4 цифры, ММ - от 1 до 12, ДД - значение от 1 до 31. Разделителем является тире. (pattern: ^\d{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[12][0-9]\|3[01])$) 1. Дата должна быть не ниже, чем 01.01.1991 Дата должна быть больше или равна, чем дата начала показов фактическая 3. Дата должна быть меньше или равна текущей дате
amountPerShow	Положительные числа или нулевые Формат: до пяти знаков после запятой, разделитель - точка 22.23456 Если деньги списываются за клик, то указывается стоимость клика. Если деньги списываются за показы, то стоимость указывается за 1000 показов. Если деньги списываются за действие, то стоимость указывается за какое-то действие.
type	Возможные значения: invoice - Акт выполненных работ intermediary-report - Отчет посредника (поверенного/комиссионера/агента)". "Тип акта ""Акт выполненных работ"" (invoice) должен проставляться в следующих случаях: - Договор акта - ""Договор оказания услуг"" (contract) - Договор акта - ""Дополнительное соглашение"" (additional-agreement), у которого родительский договор с типом ""Договор оказания услуг"" (contract)". "Тип акта ""Отчет посредника"" (intermediary-report) должен проставляться в следующих случаях: - Договор акта - ""Посреднический договор"" (intermediary-contract) - Договор акта - ""Дополнительное соглашение"" (additional-agreement), у которого родительский договор с типом ""Посреднический договор"" (intermediary-contract)".
cid	Может содержать спец символ - , а также латинские буквы a-z и цифры 0-9 Не может быть зарегистрирован, так как указанный cid не выдавался Не может быть заполнен при наличии contractId, и наоборот.
amount.services.excludingVat	Сумма акта/отчета без учета НДС должна быть больше или равна сумме всех сумм без НДС в пунктах разаллокации. Положительные числа или нулевые Формат: два знака после запятой, разделитель - точка 22.23 11 цифр до точки, т.е. максимальное число, которое может быть передано = 10 000 000 000.
amount.services.vatRate	Положительные числа или нулевые Формат: два знака после запятой, разделитель - точка 22.23 2 цифры до точки, т.е. максимальное число, которое может быть передано = 20.00
amount.services.vat	Положительные числа или нулевые Формат: два знака после запятой, разделитель - точка 22.23. Сумма НДС в акте/отчете не должна быть больше произведения максимальной ставки НДС в РФ (20%) на сумму акта/отчета без учета НДС, т.е. vat <= excludingVat * 20%
amount.services.includingVat	"Положительные числа или нулевые Формат: два знака после запятой, разделитель - точка 22.23" Сумма акт/отчета, включая НДС, должна быть равна сумме полей "Сумма акта/отчета без учета НДС" и "Сумма НДС в акте/отчете" "Сумма акта/отчета, включая НДС, должна быть больше нуля, исключение, если акт относится к безвозмездным договорам, когда в договоре явным образом указана стоимость договора равная 0. Ошибка выдается в следующих случаях: - Если в акте передана сумма равная 0, а договор акта имеет тип ""contract"" и указана сумма договора больше 0, либо отсутствует; - Если в акте передана сумма равная 0, а договор акта имеет тип ""additional-agreement"" и указана сумма договора больше 0, либо отсутствует." "Сумма акта/отчета, включая НДС, должна быть больше нуля, исключение, если акт относится к безвозмездным договорам, когда в договоре явным образом указана стоимость договора равная 0. Ошибка выдается в следующих случаях: - Если в акте передана сумма равная 0, а договор акта имеет тип ""intermediary-contract""; - Если в акте передана сумма равная 0, а договор акта имеет тип ""additional-agreement"" и родительский договор ДС имеет тип ""intermediary-contract"" или у ДС Сведения о предмете договора указано ""Посредничество"" (subjectType = mediation)
amount.commission.number	Номер акта вознаграждения посредника. Минимальная длина: 1 Максимальная длина: 255 В начале и в конце не должно быть пробела и переноса на другую строку. Pattern: ""^[^\s]$\|^[^\s].*[^\s]$""
amount.commission.date	ГГГГ-ММ-ДД где ГГГГ - любые 4 цифры, ММ - от 1 до 12, ДД - значение от 1 до 31. Разделителем является тире. (pattern: ^\d{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[12][0-9]\|3[01])$)
amount.commission.excludingVat	Положительные числа или нулевые Формат: два знака после запятой, разделитель - точка 22.23 11 цифр до точки, т.е. максимальное число, которое может быть передано = 10 000 000 000
amount.commission.vatRate	Положительные числа или нулевые Формат: два знака после запятой, разделитель - точка 22.23 2 цифры до точки, т.е. максимальное число, которое может быть передано = 20.00
amount.commission.vat	Положительные числа или нулевые Формат: два знака после запятой, разделитель - точка 22.23" Сумма НДС для вознаграждения посредника не должна быть больше произведения максимальной ставки НДС в РФ (20%) на сумму вознаграждения посредника без учета НДС, т.е. vat <= excludingVat * 20
amount.commission.includingVat	Положительные числа или нулевые Формат: два знака после запятой, разделитель - точка 22.23" Сумма вознаграждения посредника, включая НДС, должна быть равна сумме полей "Сумма вознаграждения посредника без учета НДС" и "Сумма НДС для вознаграждения посредника.
cid	Может содержать спец символ - , а также латинские буквы a-z и цифры 0-9 Не может быть зарегистрирован акт, так как указанный cid не выдавался Не может быть заполнен при наличии contractId в items.
items.amount.excludingVat	Положительные числа или нулевые Формат: два знака после запятой, разделитель - точка 22.23 11 цифр до точки, т.е. максимальное число, которое может быть передано = 10 000 000 000.
items.amount.vatRate	Положительные числа или нулевые Формат: два знака после запятой, разделитель - точка 22.23 2 цифры до точки, т.е. максимальное число, которое может быть передано = 20.00.
items.amount.vat	Положительные числа или нулевые Формат: два знака после запятой, разделитель - точка 22.23" Сумма НДС в детализации не должна быть больше произведения максимальной ставки НДС в РФ (20%) на сумму детализации без учета НДС, т.е. vat <= excludingVat * 20%
items.amount.includingVat	Положительные числа или нулевые Формат: два знака после запятой, разделитель - точка 22.23" Сумма детализации, включая НДС , должна быть равна сумме полей "Сумма детализации без учета НДС" и "Сумма НДС в детализации.
contractId	Минимальная длина: 1 Максимальная длина: 255 Длина строки от 1 до 255, может содержать спец символы - и _, а также латинские буквы a-z и A-Z и цифры 0-9 (pattern: ^[-_a-zA-Z0-9]{1,255}$ 255 и непустое)" "В ЕРИР должен быть зарегистрирован изначальный договор таким id от конкретного ОРД " "Поле можно не передавать. Но если передано invoiceId, то должно быть передано contractId или cid" Идентификатор договора должен быть указан в качестве изначального у данного акта Статистика не может быть зарегистрирована/обновлена, если идентификатор изначального договора был отправлен в сервис удаления в ЕРИР и находится на согласовании.
type	Возможные значения: other - Иное; cpm - CPM; cpc - CPC; cpa - CPA.
items.creatives.platforms.amount.excludingVat	Положительные числа или нулевые Формат: до пяти знаков после запятой, разделитель - точка 22.23456 11 цифр до точки, т.е. максимальное число, которое может быть передано = 10 000 000 000.00000" Если креатив, к которому относится статистика, относится к саморекламе (“selfPromotionOrganizationId”={идентификатор контрагента}), то стоимость оказанных услуг без учета НДС должна равняться 0. "Стоимость оказанных услуг без учета НДС всех статистик по акту и изначальному договору не должна быть больше суммы, указанной в акте для соответствующего изначального договора Данная проверка проводится при следующих условиях: - Наличие у статистик указанных invoiceId и contractId - Передача данных по HLS v.6 - Дата акта должна быть >= 1.04.2025.
items.creatives.platforms.amount.vatRate	Положительные числа или нулевые Формат: два знака после запятой, разделитель - точка 22.23 2 цифры до точки, т.е. максимальное число, которое может быть передано = 20.00.
items.creatives.platforms.amount.vat	Положительные числа или нулевые Формат: до пяти знаков после запятой, разделитель - точка 22.23456" Сумма НДС для стоимости оказанных услуг не должна быть больше произведения максимальной ставки НДС в РФ (20%) на стоимость оказанных услуг без НДС, т.е. vat <= excludingVat * 20%.
items.creatives.platforms.amount.includingVat	Положительные числа или нулевые Формат: до пяти знаков после запятой, разделитель - точка 22.23456Стоимость оказанных услуг, включая НДС, должна быть равна сумме полей "Стоимость оказанных услуг без учета НДС" и "Сумма НДС для стоимости оказанных услуг.

InvoicesCreative object - Акт без статистики

Атрибут	Тип контроля	ФЛК
invoiced	Форматный	Минимальная длина: 1 Максимальная длина: 255 Длина строки от 1 до 255, может содержать спец символы - и _, а также латинские буквы a-z и A-Z и цифры 0-9 (pattern: ^[-_a-zA-Z0-9]{1,255}$ 255 и непустое).
	Логический	В ЕРИР должен быть зарегистрирован акт с таким id от конкретного ОРД Сущность invoices-creatives не может быть зарегистрирована/обновлена, если идентификатор акта был отправлен в сервис удаления в ЕРИР и находится на согласовании.
contractId	Логический	В ЕРИР должен быть зарегистрирован договор с таким id от конкретного ОРД В разаллокации акта должен быть зарегистрирован этот идентификатор изначального договора.
cid	Форматный	Не может быть заполнен при наличии contractId, и наоборот.
–	Логический	Не может быть зарегистрирован, так как указанный cid не выдавался.
creativeIds	Логический	Если признак “irrelevant” равен true, то переданные идентификаторы креативов должны быть зарегистрированы в акте в соответствующей разаллокации по атрибутам изначального договора. Проверка по составному ключу [invoiceId, contractId, creativeId].
irrelevant	Форматный	Возможные значения: true / false.

InvoicesCreative object - Акт без статистики

Атрибут	Тип контроля	ФЛК
invoiceId	Форматный	Минимальная длина: 1 Максимальная длина: 255 Длина строки от 1 до 255, может содержать спец символы - и _, а также латинские буквы a-z и A-Z и цифры 0-9 (pattern: ^[-_a-zA-Z0-9]{1,255}$ 255 и непустое)
	Логический	В ЕРИР должен быть зарегистрирован акт с таким id от конкретного ОРД
	Форматный	Обязательность заполнения поля
contractId	Форматный	Минимальная длина: 1 Максимальная длина: 255 Длина строки от 1 до 255, может содержать спец символы - и _, а также латинские буквы a-z и A-Z и цифры 0-9 (pattern: ^[-_a-zA-Z0-9]{1,255}$ 255 и непустое)
	Логический	В ЕРИР должен быть зарегистрирован договор с таким id от конкретного ОРД
	Логический	В разаллокации акта должен быть зарегистрирован этот идентификатор изначального договора
	Форматный	Обязательность заполнения поля
creativeId	Форматный	Минимальная длина: 1 Максимальная длина: 255 Длина строки от 1 до 255, может содержать спец символы - и _, а также латинские буквы a-z и A-Z и цифры 0-9 (pattern: ^[-_a-zA-Z0-9]{1,255}$ 255 и непустое)
	Логический	В ЕРИР должен быть зарегистрирован креатив с таким id от конкретного ОРД
	Форматный	Обязательность заполнения поля
cid	Форматный	Может содержать спец символ - , а также латинские буквы a-z и цифры 0-9
–	Логический	Не может быть зарегистрирован, так как указанный cid не выдавался.
–	Форматный	Не может быть заполнен при наличии contractId, и наоборот.
platformId	Форматный	Минимальная длина: 1 Максимальная длина: 255 Длина строки от 1 до 255, может содержать спец символы - и _, а также латинские буквы a-z и A-Z и цифры 0-9 (pattern: ^[-_a-zA-Z0-9]{1,255}$ 255 и непустое).
–	Логический	В ЕРИР должна быть зарегистрирована площадка с таким id от конкретного ОРД.
–	Логический	Статистика не может быть зарегистрирована/обновлена, если идентификатор площадки был отправлен в сервис удаления в ЕРИР и находится на согласовании.
impsFact	Форматный	Целое положительное число или нулевое.
–	Логический	Если в креативе в поле “type” (тип рекламной кампании) передано значение “CPA”, то допустимо указывать количество фактических показов равным 0, если сумма оказанных услуг больше 0.
impsPlan	Форматный	Целое положительное число или нулевое
dateStartFact	Форматный	"ГГГГ-ММ-ДД где ГГГГ - любые 4 цифры, ММ - от 1 до 12, ДД - значение от 1 до 31. Разделителем является тире. (pattern: ^\d{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[12][0-9]\|3[01])$).
dateEndFact	Форматный	Дата должна быть больше или равна, чем дата начала показов фактическая. Дата должна быть меньше или равна текущей дате.
dateStartPlan	Форматный	Дата должна быть меньше или равна, чем дата окончания показов по акту. Дата должна быть меньше или равна текущей дате.
dateEndPlan	Форматный	Дата должна быть меньше или равна, чем дата начала показов по акту. Дата должна быть меньше или равна текущей дате.
amountPerUnit	Форматный	Положительные числа или нулевые Формат: до пяти знаков после запятой, разделитель - точка 22.23456 11 цифр до точки, т.е. максимальное число, которое может быть передано = 10 000 000 000.00000 Если деньги списываются за клик, то указывается стоимость клика. Если деньги списываются за показы, то стоимость указывается за 1000 показов. Если деньги списываются за действие, то стоимость указывается за какое-то действие.
–	Логический	Если креатив, к которому относится статистика, относится к саморекламе (“selfPromotionOrganizationId”={идентификатор контрагента}), то стоимость единицы оказанных услуг должна равняться 0.
irrelevant	Форматный	Возможные значения: true / false.
type	Форматный	"Возможные значения: other - Иное; cpm - CPM; cpc - CPC; cpa - CPA."
amount.excludingVat	Форматный	Положительные числа или нулевые Формат: до пяти знаков после запятой, разделитель - точка 22.23456 11 цифр до точки, т.е. максимальное число, которое может быть передано = 10 000 000 000.00000.
–	Логический	Если креатив, к которому относится статистика, относится к саморекламе (“selfPromotionOrganizationId”={идентификатор контрагента}), то стоимость единицы оказанных услуг должна равняться 0.
amount.vatRate	Форматный	Положительные числа или нулевые Формат: два знака после запятой, разделитель - точка 22.23 2 цифры до точки, т.е. максимальное число, которое может быть передано = 20.00.
amount.vat	Форматный	Сумма НДС для стоимости оказанных услуг не должна быть больше произведения максимальной ставки НДС в РФ (20%) на стоимость оказанных услуг без НДС, т.е. vat <= excludingVat * 20%.
amount.includingVat	Форматный	Стоимость оказанных услуг, включая НДС, должна быть равна сумме полей "Стоимость оказанных услуг без учета НДС" и Сумма НДС для стоимости оказанных услуг.

Change log#

V 1.0.0

Релиз документация v3 API

V 1.0.1

Обновлен раздел "Регистрация Организации в ОРД"
Обновлен раздел "Обновление информации об Организации в ОРД"

V 1.0.2

Обновлен раздел "Общая информация по API" - - дополнена информация по объекту Объект Status
Обновлен раздел "Креативы" - убран устаревший параметр targetGeo

V 2.0.0

Обновлен раздел "Общая информация по API" - дополнена информация по объекту объектам Status, Pagination, убран объект EntityInfo
Обновлен раздел "Креативы" - убран устаревший параметр type, creativedata.description, isNative, добавлен параметр isSocialQuota
Обновлен раздел "Акты" - добавлен параметр type, изменены объекты amount
Обновлен раздел "Статистика" - изменен объект amount

Руководство по API ОРД

Спецификация API#

Общая информация по API#

Детальная информация по вызовам API#

Примеры v4:

Примеры:

Примеры:

Формато-логический контроль#

Change log#

V 1.0.0

V 1.0.1

V 1.0.2

V 2.0.0