Method: advertisers.invoices.list

Перечисляет счета-фактуры, выставленные рекламодателю за указанный месяц.

Счета-фактуры, созданные с использованием профилей выставления счетов с уровнем счета «Партнер», не подлежат извлечению этим методом.

HTTP-запрос

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/invoices

URL использует синтаксис перекодировки gRPC .

Параметры пути

Параметры
advertiserId

string ( int64 format)

Обязательно. Идентификатор рекламодателя, для которого необходимо выставить счета.

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

Параметры
issueMonth

string

Месяц, за который нужно вывести счета. Если не указано, запрос будет получать счета за предыдущий месяц.

Должен быть в формате ГГГГММ.

loiSapinInvoiceType

enum ( LoiSapinInvoiceType )

Выберите тип счета-фактуры для получения рекламодателями Loi Sapin.

Применимо только к рекламодателям, подпадающим под действие Закона Сапена. В противном случае будет проигнорировано.

pageSize

integer

Запрошенный размер страницы. Должен быть от 1 до 200 Если не указан, по умолчанию будет 100 Возвращает код ошибки INVALID_ARGUMENT если указано недопустимое значение.

pageToken

string

Токен, идентифицирующий страницу результатов, которую должен вернуть сервер. Обычно это значение nextPageToken , возвращаемое предыдущим вызовом метода invoices.list . Если не указано иное, будет возвращена первая страница результатов.

Текст запроса

Тело запроса должно быть пустым.

Тело ответа

В случае успеха тело ответа содержит данные со следующей структурой:

JSON-представление 
{
  "invoices": [
    {
      object (Invoice)
    }
  ],
  "nextPageToken": string
}
Поля
invoices[]

object ( Invoice )

Список счетов-фактур.

Если список пуст, он будет отсутствовать.

nextPageToken

string

Токен для получения следующей страницы результатов. Передайте это значение в поле pageToken при последующем вызове метода invoices.list для получения следующей страницы результатов.

Этот токен будет отсутствовать, если больше нет invoices для возврата.

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/display-video
  • https://www.googleapis.com/auth/display-video-mediaplanning

Для получения более подробной информации см.OAuth 2.0 Overview .

LoiSapinInvoiceType

Возможные типы счетов-фактур для рекламодателей Loi Sapin.

Перечисления
LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED Стоимость не указана.
LOI_SAPIN_INVOICE_TYPE_MEDIA Счета-фактуры с указанием стоимости рекламы.
LOI_SAPIN_INVOICE_TYPE_PLATFORM Счета-фактуры с комиссией за платформу.

Счет

Единый счет-фактура.

JSON-представление 
{
  "name": string,
  "invoiceId": string,
  "displayName": string,
  "paymentsProfileId": string,
  "paymentsAccountId": string,
  "issueDate": {
    object (Date)
  },
  "dueDate": {
    object (Date)
  },
  "serviceDateRange": {
    object (DateRange)
  },
  "currencyCode": string,
  "subtotalAmountMicros": string,
  "totalTaxAmountMicros": string,
  "totalAmountMicros": string,
  "purchaseOrderNumber": string,
  "budgetInvoiceGroupingId": string,
  "invoiceType": enum (InvoiceType),
  "correctedInvoiceId": string,
  "replacedInvoiceIds": [
    string
  ],
  "pdfUrl": string,
  "budgetSummaries": [
    {
      object (BudgetSummary)
    }
  ],
  "nonBudgetMicros": string
}
Поля
name

string

Имя ресурса счета-фактуры.

invoiceId

string

Уникальный идентификатор счета.

displayName

string

Отображаемое название счета.

paymentsProfileId

string

Идентификатор платежного профиля, к которому принадлежит счет.

Отображается в счете-фактуре PDF как Billing ID .

paymentsAccountId

string

Идентификатор платежного счета, к которому принадлежит счет.

Отображается в счете-фактуре PDF как Billing Account Number .

issueDate

object ( Date )

Дата выставления счета.

dueDate

object ( Date )

Дата, когда необходимо оплатить счет.

serviceDateRange

object ( DateRange )

Даты начала и окончания обслуживания, указанные в данном счете.

currencyCode

string

Валюта, используемая в счете, в формате ISO 4217.

subtotalAmountMicros

string ( int64 format)

Промежуточная сумма до вычета налогов, в микродолях валюты счета.

Например, если currencyCode — USD , то 1000000 представляет один доллар США.

totalTaxAmountMicros

string ( int64 format)

Сумма всех налогов в счете-фактуре, в микродолях валюты счета-фактуры.

Например, если currencyCode — USD , то 1000000 представляет один доллар США.

totalAmountMicros

string ( int64 format)

Общая сумма счета в микродолях валюты счета.

Например, если currencyCode — USD , то 1000000 представляет один доллар США.

purchaseOrderNumber

string

Номер заказа на покупку, связанный со счетом-фактурой.

budgetInvoiceGroupingId

string

Идентификатор группировки бюджета для этого счета-фактуры.

Это поле будет заполнено только в том случае, если уровень счета-фактуры соответствующего профиля выставления счетов установлен на «Идентификатор группировки бюджетных счетов-фактур».

invoiceType

enum ( InvoiceType )

Тип документа-фактуры.

correctedInvoiceId

string

Идентификатор исходного счета-фактуры, корректируемого данным счетом-фактурой, если применимо.

Может отображаться в счете-фактуре PDF как Reference invoice number .

Если установлено replacedInvoiceIds , это поле будет пустым.

replacedInvoiceIds[]

string

Идентификатор(ы) любого первоначально выставленного счета, который отменяется данным счетом, если применимо. Можно указать несколько счетов, если они объединяются в один.

В счете-фактуре PDF может отображаться как Replaced invoice numbers ».

Если установлено correctedInvoiceId , это поле будет пустым.

pdfUrl

string

URL для загрузки копии счета в формате PDF.

Этот URL-адрес привязан к пользователю и требует действительного токена доступа OAuth 2.0. Токен доступа должен быть указан в HTTP-заголовке Authorization: Bearer и должен быть авторизован для одной из следующих областей:

  • https://www.googleapis.com/auth/display-video-mediaplanning
  • https://www.googleapis.com/auth/display-video

URL-адрес будет действителен в течение 7 дней после извлечения этого объекта счета-фактуры или до тех пор, пока этот счет-фактура не будет извлечен снова.

budgetSummaries[]

object ( BudgetSummary )

Список обобщенной информации по каждому бюджету, связанному с этим счетом.

Это поле будет заполнено только в том случае, если уровень детализации счета-фактуры соответствующего профиля выставления счетов установлен на «Уровень бюджета PO».

nonBudgetMicros

string ( int64 format)

Общая сумма расходов или корректировок, не привязанных к конкретному бюджету, в микродолях валюты счета.

Например, если currencyCode — USD , то 1000000 представляет один доллар США.

InvoiceType

Возможные типы счетов-фактур.

Перечисления
INVOICE_TYPE_UNSPECIFIED В данной версии не указано или неизвестно.
INVOICE_TYPE_CREDIT Сумма в счете отрицательная.
INVOICE_TYPE_INVOICE Сумма счета положительная.

БюджетРезюме

Обобщенная информация о бюджете отдельной кампании.

JSON-представление 
{
  "externalBudgetId": string,
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "preTaxAmountMicros": string,
  "taxAmountMicros": string,
  "totalAmountMicros": string
}
Поля
externalBudgetId

string

Соответствует значению externalBudgetId бюджета кампании. Если значение не задано в бюджете кампании, это поле будет пустым.

prismaCpeCode

object ( PrismaCpeCode )

Соответствующие коды клиентов, продуктов и смет из инструмента Mediaocean Prisma.

Применимо только для бюджетов кампаний с externalBudgetSource EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN .

preTaxAmountMicros

string ( int64 format)

Сумма расходов по данному бюджету до вычета налогов, в микродолях валюты счета.

Например, если currencyCode — USD , то 1000000 представляет один доллар США.

taxAmountMicros

string ( int64 format)

Сумма налога, применяемая к платежам в рамках данного бюджета, в микродолях валюты счета.

Например, если currencyCode — USD , то 1000000 представляет один доллар США.

totalAmountMicros

string ( int64 format)

Общая сумма расходов по данному бюджету, включая налоги, в микродолях валюты счета.

Например, если currencyCode — USD , то 1000000 представляет один доллар США.