Получение данных о рекламодателе

Возвращает данные о рекламодателе

Request

GET

https://geoadv-api.yandex.ru/priority/v5/get-campaign-beneficiary

Query parameters

Name

Description

campaignId

Type: number

ID рекламной кампании

Responses

200 OK

Найденные рекламные кампании

Body

application/json
{
  "client": {
    "type": "FOREIGN_LEGAL иностранное юридическое лицо",
    "inn": "example",
    "name": "example",
    "kpp": "example",
    "epayNumber": "example",
    "oksmNumber": "example",
    "vat": "example",
    "regNumber": "example"
  },
  "contractor": {
    "type": "FOREIGN_LEGAL иностранное юридическое лицо",
    "inn": "example",
    "name": "example",
    "kpp": "example",
    "epayNumber": "example",
    "oksmNumber": "example",
    "vat": "example",
    "regNumber": "example"
  },
  "contract": {
    "type": "contract  договор оказания услуг",
    "isChargePaidByAgent": true,
    "actionType": "distribution действия в целях распространения рекламы",
    "subjectType": "org-distribution договор на организацию распространения рекламы",
    "number": "example",
    "date": "example",
    "amount": 0.5,
    "isVat": true
  }
}

Name

Description

client

Type: CampaignBeneficiaryClient

Данные конечного рекламодателя

Example
{
  "type": "FOREIGN_LEGAL иностранное юридическое лицо",
  "inn": "example",
  "name": "example",
  "kpp": "example",
  "epayNumber": "example",
  "oksmNumber": "example",
  "vat": "example",
  "regNumber": "example"
}

contract

Type: CampaignBeneficiaryContract

Договор между клиентом и посредником

Example
{
  "type": "contract  договор оказания услуг",
  "isChargePaidByAgent": true,
  "actionType": "distribution действия в целях распространения рекламы",
  "subjectType": "org-distribution договор на организацию распространения рекламы",
  "number": "example",
  "date": "example",
  "amount": 0.5,
  "isVat": true
}

contractor

Type: CampaignBeneficiaryContractor

Данные посредника

Example
{
  "type": "FOREIGN_LEGAL иностранное юридическое лицо",
  "inn": "example",
  "name": "example",
  "kpp": "example",
  "epayNumber": "example",
  "oksmNumber": "example",
  "vat": "example",
  "regNumber": "example"
}

CampaignBeneficiaryClient

Данные конечного рекламодателя

Name

Description

name

Type: string

ФИО или наименование клиента

Example: example

type

Type: string

тип клиента

Enum: FOREIGN_LEGAL иностранное юридическое лицо, FOREIGN_PHYSICAL иностранное физическое лицо, INDIVIDUAL ИП, LEGAL юридическое лицо, PHYSICAL физическое лицо

epayNumber

Type: string

Номер электронного средства платежа. Обязателен для рекламодателей типа: - FOREIGN_PHYSICAL

Example: example

inn

Type: string

ИНН. Обязателен для рекламодателей типа: - PHYSICAL - INDIVIDUAL - LEGAL

Example: example

kpp

Type: string

КПП. Указывается для рекламодателей типа: - LEGAL

Example: example

oksmNumber

Type: string

Код страны регистрации лица в соответствии с ОКСМ. Обязателен для рекламодателей типа: - FOREIGN_PHYSICAL - FOREIGN_LEGAL

Example: example

regNumber

Type: string

Регистрационный номер либо его аналог Обязателен для рекламодателей типа: - FOREIGN_LEGAL (обязателен, если нет vat)

Example: example

vat

Type: string

Номер налогоплательщика либо его аналог в стране регистрации. Обязателен для рекламодателей типа: - FOREIGN_LEGAL (обязателен, если нет regNumber)

Example: example

Example
{
  "type": "FOREIGN_LEGAL иностранное юридическое лицо",
  "inn": "example",
  "name": "example",
  "kpp": "example",
  "epayNumber": "example",
  "oksmNumber": "example",
  "vat": "example",
  "regNumber": "example"
}

CampaignBeneficiaryContractor

Данные посредника

Name

Description

name

Type: string

ФИО или наименование клиента

Example: example

type

Type: string

тип клиента

Enum: FOREIGN_LEGAL иностранное юридическое лицо, FOREIGN_PHYSICAL иностранное физическое лицо, INDIVIDUAL ИП, LEGAL юридическое лицо, PHYSICAL физическое лицо

epayNumber

Type: string

Номер электронного средства платежа. Обязателен для рекламодателей типа: - FOREIGN_PHYSICAL

Example: example

inn

Type: string

ИНН. Обязателен для рекламодателей типа: - PHYSICAL - INDIVIDUAL - LEGAL

Example: example

kpp

Type: string

КПП. Указывается для рекламодателей типа: - LEGAL

Example: example

oksmNumber

Type: string

Код страны регистрации лица в соответствии с ОКСМ. Обязателен для рекламодателей типа: - FOREIGN_PHYSICAL - FOREIGN_LEGAL

Example: example

regNumber

Type: string

Регистрационный номер либо его аналог Обязателен для рекламодателей типа: - FOREIGN_LEGAL (обязателен, если нет vat)

Example: example

vat

Type: string

Номер налогоплательщика либо его аналог в стране регистрации. Обязателен для рекламодателей типа: - FOREIGN_LEGAL (обязателен, если нет regNumber)

Example: example

Example
{
  "type": "FOREIGN_LEGAL иностранное юридическое лицо",
  "inn": "example",
  "name": "example",
  "kpp": "example",
  "epayNumber": "example",
  "oksmNumber": "example",
  "vat": "example",
  "regNumber": "example"
}

CampaignBeneficiaryContract

Договор между клиентом и посредником

Name

Description

date

Type: string

Дата заключения договора в формате YYYY-MM-DD

Example: example

subjectType

Type: string

Предмет договора

Enum: org-distribution договор на организацию распространения рекламы, mediation посредничество, distribution договор на распространение рекламы, representation представительство, other иное

type

Type: string

Тип договора

Enum: contract договор оказания услуг, intermediary-contract посреднический договор

actionType

Type: string

Роль посредника-представителя. Обязателен для договоров с типом: - intermediary-contract

Enum: distribution действия в целях распространения рекламы, conclude заключение договоров, commercial коммерческое представительство, other иное

amount

Type: number

Сумма

isChargePaidByAgent

Type: boolean

Посредник/поверенный/комиссионер/агент по указанному договору берет на себя оплату сбора. Указывается для договоров с типом: - intermediary-contract

isVat

Type: boolean

Включён ли НДС в сумму. Обязателен если есть amount.

number

Type: string

Номер договора

Example: example

Example
{
  "type": "contract  договор оказания услуг",
  "isChargePaidByAgent": true,
  "actionType": "distribution действия в целях распространения рекламы",
  "subjectType": "org-distribution договор на организацию распространения рекламы",
  "number": "example",
  "date": "example",
  "amount": 0.5,
  "isVat": true
}

500 Internal Server Error

Непредвиденная ошибка