contract

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

Формат запроса

https://adfox.yandex.ru/api/v1
  ? object=account
  & action=add
  & actionObject=contract
  & type=<integer>
  & customerID=<integer>
  & executorID=<integer>
  & [intermediaryContractID=<integer>]
  & [subjectType=<integer>]
  & [actionType=<integer>]
  & [number=<string>]
  & [amountRub=<string>]
  & [dateConclusion=<string>]
  & [isVat=<integer>]
  & [isRegReport=<integer>]
  & [isFinalAgreement=<integer>]

type*

Тип контракта.

Допустимые значения:

  • 0 — Договор оказания услуг.
  • 1 — Посреднический договор.
  • 2 — Дополнительное соглашение. Обязательно заполнить поле intermediaryContractID.

customerID*

Идентификатор заказчика.

executorID*

Идентификатор исполнителя.

intermediaryContractID

Идентификатор родительского договора.

subjectType

Сведения о предмете договора.

Допустимые значения:

  • 0 — Остальное.
  • 1 — Договор на распространение рекламы.
  • 2 — Договор на организацию распространения рекламы.
  • 3 — Посредничество.
  • 4 — Представительство.

Значение по умолчанию: 0.

actionType

Описание действий посредника-представителя.

Допустимые значения:

  • 0 — Иное.
  • 1 — Действия в целях распространения рекламы.
  • 2 — Заключение договоров.
  • 3 — Коммерческое представительство.

Значение по умолчанию: 0.

number

Номер договора/дополнительного соглашения.

amountRub

Цена договора.

dateConclusion

Дата договора/дополнительного соглашения. Формат: ГГГГ-ММ-ДД. Дата договора/дополнительного соглашения не может быть больше текущей.

isVat

Цена включает НДС.

Доступные значения:

  • 0 — цена не включает НДС;
  • 1 — цена включает НДС.

Значение по умолчанию: 0.

isRegReport

На контрагенте-исполнителе лежит обязанность регистрировать и отправлять креативы.

Доступные значения:

  • 0 — нет;
  • 1 — да.

Значение по умолчанию: 0.

isFinalAgreement

Первичный договор между площадкой и конечным рекламодателем (без посредников).

Допустимые значения:

  • 0 — нет;
  • 1 — да.

Значение по умолчанию: 0.

* Обязательный параметр

Формат ответа

<response>
<status>
  <code>{integer}</code>
  <ID>{integer}</ID>
</status>
</response>

Параметры ответа

code

Статус обработки запроса. Значение 0 — запрос выполнен успешно. Расшифровку смотрите в разделе Обработка ошибок.

ID

Идентификатор созданного объекта.

Пример запроса и ответа

Запрос:

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&isVat=0&intermediaryContractID=43792&dateConclusion=2022-08-24&isFinalAgreement=1

Ответ:

<response>
<status>
  <code>0</code>
  <ID>1111</ID>
</status>
</response>

Другие действия с объектом

Читайте также о других действиях с объектом contract:

Тип контракта.

Допустимые значения:

  • 0 — Договор оказания услуг.

  • 1 — Посреднический договор.

  • 2 — Дополнительное соглашение. Обязательно заполнить поле intermediaryContractID.

Идентификатор заказчика.

Идентификатор исполнителя.

Идентификатор родительского договора.

Сведения о предмете договора.

Допустимые значения:

  • 0 — Остальное.

  • 1 — Договор на распространение рекламы.

  • 2 — Договор на организацию распространения рекламы.

  • 3 — Посредничество.

  • 4 — Представительство.

Значение по умолчанию: 0.

Описание действий посредника-представителя.

Допустимые значения:

  • 0 — Иное.

  • 1 — Действия в целях распространения рекламы.

  • 2 — Заключение договоров.

  • 3 — Коммерческое представительство.

Значение по умолчанию: 0.

Номер договора/дополнительного соглашения.

Цена договора.

Дата договора/дополнительного соглашения. Формат: ГГГГ-ММ-ДД. Дата договора/дополнительного соглашения не может быть больше текущей.

Цена включает НДС.

Доступные значения:

  • 0 — цена не включает НДС;

  • 1 — цена включает НДС.

Значение по умолчанию: 0.

На контрагенте-исполнителе лежит обязанность регистрировать и отправлять креативы.

Доступные значения:

  • 0 — нет;

  • 1 — да.

Значение по умолчанию: 0.

Первичный договор между площадкой и конечным рекламодателем (без посредников).

Допустимые значения:

  • 0 — нет;

  • 1 — да.

Значение по умолчанию: 0.

Обязательный параметр

Предыдущая
category
Следующая
contractor