contract
Добавить новый договор для маркировки рекламы.
Формат запроса
https://adfox.yandex.ru/api/v1
? object=account
& action=add
& actionObject=contract
& type=<integer>
& [agentActingForPublisher=<integer>]
& [chargePaidByAgent=<integer>]
& [intermediaryContractID=<integer>]
& customerID=<integer>
& executorID=<integer>
& [subjectType=<integer>]
& [number=<string>]
& [dateConclusion=<string>]
& [amountType=<string>]
& [amountRub=<string>]
& [actionType=<integer>]
& [isRegReport=<integer>]
& [socialType=<integer>]
& contractRole=<integer>
|
|
Тип контракта. Допустимые значения:
|
|
|
Идентификатор заказчика. Как получить список ID контрагентов, см. в разделе contractor. |
|
|
Идентификатор исполнителя. Как получить список ID контрагентов, см. в разделе contractor. |
|
|
Роль договора. Доступные значения:
|
|
|
Идентификатор родительского договора. Передается, только если |
|
|
Сведения о предмете договора. Допустимые значения:
Значение по умолчанию: |
|
|
Описание действий посредника-представителя. Допустимые значения:
Значение по умолчанию: |
|
|
Номер договора/дополнительного соглашения. В начале и в конце строки не должно быть пробелов и символов перевода строки. |
|
|
Цена договора. Передается, только если |
|
|
Цена договора. Допустимые значения:
Значение по умолчанию: |
|
|
Дата договора/дополнительного соглашения. Формат: |
|
|
На контрагенте-исполнителе лежит обязанность регистрировать и отправлять креативы. Доступные значения:
Значение по умолчанию: |
|
|
Вид договора. Значение параметра не получится изменить после создания договора. Доступные значения:
Значение по умолчанию: |
|
|
Функция посредника, признак направления денежного потока в сторону принципала. Обязателен, если выбран тип договора
|
|
|
Признак «Сбор по этому договору оплачивает посредник, поверенный, комиссионер или агент». Поле может передаваться только в посредническом договоре
|
* Обязательный параметр
Формат ответа
<response>
<status>
<code>{integer}</code>
<ID>{integer}</ID>
</status>
</response>
Параметры ответа
|
|
Статус обработки запроса. Значение |
|
|
Идентификатор созданного объекта. |
Пример запроса и ответа
Запрос:
https://adfox.yandex.ru/api/v1?object=account&action=add&actionObject=contract&type=2&customerID=108&executorID=109&isRegReport=1&subjectType=0&actionType=3&number=number&amountRub=77&intermediaryContractID=43792&dateConclusion=2022-08-24Ответ:
<response> <status> <code>0</code> <ID>1111</ID> </status> </response>
Другие действия с объектом
Читайте также о других действиях с объектом contract:
Тип контракта.
Допустимые значения:
0— Договор оказания услуг.1— Посреднический договор. Доступны параметры:agentActingForPublisher— функция посредника.chargePaidByAgent— опция «Сбор по этому договору оплачивает посредник, поверенный, комиссионер или агент».
2— Дополнительное соглашение. Обязательно заполнить полеintermediaryContractID.
Идентификатор заказчика. Как получить список ID контрагентов, см. в разделе contractor.
Идентификатор исполнителя. Как получить список ID контрагентов, см. в разделе contractor.
Идентификатор родительского договора. Передается, только если type = 2.
Сведения о предмете договора.
Допустимые значения:
-
0— Иное. -
1— Договор на распространение рекламы. -
2— Договор на организацию распространения рекламы. -
3— Посредничество. -
4— Представительство.
Значение по умолчанию: 0. Чтобы значение перешло в состояние «Не задано», можно передать null или пустое значение ''. При редактировании перевести в состояние «Не задано» можно так: actionType=&.
Описание действий посредника-представителя.
Допустимые значения:
-
0— Иное. -
1— Действия в целях распространения рекламы. -
2— Заключение договоров. -
3— Коммерческое представительство.
Значение по умолчанию: 0. Чтобы значение перешло в состояние «Не задано», можно передать null или пустое значение ''. При редактировании перевести в состояние «Не задано» можно так: actionType=&.
Номер договора/дополнительного соглашения. В начале и конце не должно быть пробела и переноса на другую строку.
Цена договора. Передается, только если amountType = 0 (возмездный).
Цена договора. Допустимые значения:
0— Возмездный (при этом значении обязательным становитсяamountRub).1— Безвозмездный.2— В договоре нет цены.
Значение по умолчанию: 1 — безвоздмездный.
Роль договора. Доступные значения:
0— Первичный.1— Конечный.2— Прямой.
Вид договора. Значение параметра не получится изменить после создания договора. Доступные значения:
0— Коммерческий.1— Договор социальной рекламы с оплатой.2— Договор социальной рекламы по квоте.
Значение по умолчанию: 0 — коммерческий.
Функция посредника, признак направления денежного потока в сторону принципала. Обязателен, если выбран тип договора type = 1, в противном случае указывать нельзя. Доступные значения:
0— Агент действует в интересах РД в этом агентском договоре (является представителем рекламодателя).1— Агент действует в интересах РР в этом агентском договоре (является представителем рекламной площадки).
Признак «Сбор по этому договору оплачивает посредник, поверенный, комиссионер или агент». Поле может передаваться только в посредническом договоре type = 1 и при признаке направления денежного потока в сторону принципала agentActingForPublisher = 0. Доступные значения:
0— Выключено.1— Включено (сбор по этому договору оплачивает посредник, поверенный, комиссионер или агент).
Дата договора/дополнительного соглашения. Формат: ГГГГ-ММ-ДД. Дата договора/дополнительного соглашения не может быть больше текущей.
На контрагенте-исполнителе лежит обязанность регистрировать и отправлять креативы.
Доступные значения:
-
0— нет; -
1— да.
Значение по умолчанию: 0.
Обязательный параметр