Method: advertisers.invoices.list

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

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

HTTP-запрос

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

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

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

Параметры
advertiserId

string ( int64 format)

Необходимый. Идентификатор рекламодателя, для которого нужно перечислить счета.

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

Параметры
issueMonth

string

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

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

loiSapinInvoiceType

enum ( LoiSapinInvoiceType )

Выберите тип счета, который необходимо получить для рекламодателей Закона Сапена.

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

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 .

LoiSapinInvoiceType

Возможные типы счетов для рекламодателей по Закону Сапена.

Перечисления
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 )

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

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

nonBudgetMicros

string ( int64 format)

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

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

Тип счета

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

Перечисления
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 представляет один доллар США.