Method: advertisers.invoices.list

Lista as faturas postadas para um anunciante em um determinado mês.

As faturas geradas por perfis de faturamento com um nível de fatura "Parceiro" não podem ser recuperadas por esse método.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
advertiserId

string (int64 format)

Obrigatório. O ID do anunciante para listar as faturas.

Parâmetros de consulta

Parâmetros
issueMonth

string

O mês para listar as faturas. Se não for definido, a solicitação vai recuperar as faturas do mês anterior.

Precisa estar no formato AAAAMM.
loiSapinInvoiceType

enum (LoiSapinInvoiceType)

Selecione o tipo de fatura a ser recuperada para anunciantes da Lei Sapin.

Aplicável apenas a anunciantes da Lei Sapin. Caso contrário, será ignorado.
pageSize

integer

Tamanho da página solicitada. Precisa estar entre 1 e 200. Se não for especificado, o padrão será 100. Retorna o código de erro INVALID_ARGUMENT se um valor inválido for especificado.
pageToken

string

Um token que identifica a página de resultados que o servidor retornará. Normalmente, esse é o valor de nextPageToken retornado da chamada anterior ao método invoices.list. Se não for especificado, a primeira página de resultados será retornada.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se bem-sucedido, o corpo da resposta exibirá os dados com a seguinte estrutura:

Representação JSON 
{
  "invoices": [
    {
      object (Invoice)
    }
  ],
  "nextPageToken": string
}
Campos
invoices[]

object (Invoice)

A lista de faturas.

Essa lista não vai aparecer se estiver vazia.
nextPageToken

string

Um token para recuperar a próxima página de resultados. Transmita esse valor no campo pageToken na chamada subsequente ao método invoices.list para recuperar a próxima página de resultados.

Esse token não vai aparecer se não houver mais invoices para retornar.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte OAuth 2.0 Overview.

LoiSapinInvoiceType

Possíveis tipos de faturas para anunciantes da Lei Sapin.

Tipos enumerados
LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED O valor não foi especificado.
LOI_SAPIN_INVOICE_TYPE_MEDIA Faturas com custo de mídia.
LOI_SAPIN_INVOICE_TYPE_PLATFORM Faturas com taxa da plataforma.

Fatura

Uma única fatura.

Representação 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
}
Campos
name

string

O nome do recurso da fatura.
invoiceId

string

O ID exclusivo da fatura.
displayName

string

O nome de exibição da fatura.
paymentsProfileId

string

O ID do perfil para pagamentos a que a fatura pertence.

Aparece no PDF da fatura como Billing ID.
paymentsAccountId

string

O ID da conta para pagamentos a que a fatura pertence.

Aparece no PDF da fatura como Billing Account Number.
issueDate

object (Date)

A data de emissão da fatura.
dueDate

object (Date)

A data de vencimento da fatura.
serviceDateRange

object (DateRange)

As datas de início e término do serviço cobertas por esta fatura.
currencyCode

string

A moeda usada na fatura no formato ISO 4217.
subtotalAmountMicros

string (int64 format)

O valor do subtotal sem tributos, em micros da moeda da fatura.

Por exemplo, se currencyCode for USD, 1000000 representará um dólar americano.
totalTaxAmountMicros

string (int64 format)

A soma de todos os tributos na fatura, em micros da moeda da fatura.

Por exemplo, se currencyCode for USD, 1000000 representará um dólar americano.
totalAmountMicros

string (int64 format)

O valor total da fatura, em micros da moeda da fatura.

Por exemplo, se currencyCode for USD, 1000000 representará um dólar americano.
purchaseOrderNumber

string

Número da ordem de compra associado à fatura.
budgetInvoiceGroupingId

string

O ID do agrupamento de orçamento para esta fatura.

Esse campo só será definido se o nível da fatura do perfil de faturamento correspondente estiver definido como "ID de agrupamento de faturas do orçamento".
invoiceType

enum (InvoiceType)

O tipo de documento de fatura.
correctedInvoiceId

string

O ID da fatura original que está sendo ajustada por esta fatura, se aplicável.

Pode aparecer no PDF da fatura como Reference invoice number.

Se replacedInvoiceIds estiver definido, este campo vai estar vazio.
replacedInvoiceIds[]

string

Os IDs de qualquer fatura emitida originalmente que está sendo cancelada por esta fatura, se aplicável. Várias faturas podem ser listadas se estiverem sendo consolidadas em uma única fatura.

Pode aparecer no PDF da fatura como Replaced invoice numbers.

Se correctedInvoiceId estiver definido, este campo vai estar vazio.
pdfUrl

string

O URL para fazer o download de uma cópia em PDF da fatura.

Esse URL é específico do usuário e exige um token de acesso OAuth 2.0 válido para acesso. O token de acesso precisa ser fornecido em um cabeçalho HTTP Authorization: Bearer e autorizado para um dos seguintes escopos:

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

O URL será válido por sete dias após a recuperação desse objeto de fatura ou até que a fatura seja recuperada novamente.
budgetSummaries[]

object (BudgetSummary)

A lista de informações resumidas para cada orçamento associado a esta fatura.

Esse campo só será definido se o nível de detalhe da fatura do perfil de faturamento correspondente estiver definido como "OC no nível do orçamento".
nonBudgetMicros

string (int64 format)

O valor total de custos ou ajustes não vinculados a um orçamento específico, em micros da moeda da fatura.

Por exemplo, se currencyCode for USD, 1000000 representará um dólar americano.

InvoiceType

Tipos possíveis de faturas.

Tipos enumerados
INVOICE_TYPE_UNSPECIFIED Não especificado ou desconhecido nesta versão.
INVOICE_TYPE_CREDIT A fatura tem um valor negativo.
INVOICE_TYPE_INVOICE A fatura tem um valor positivo.

BudgetSummary

Informações resumidas de um orçamento de campanha individual.

Representação JSON 
{
  "externalBudgetId": string,
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "preTaxAmountMicros": string,
  "taxAmountMicros": string,
  "totalAmountMicros": string
}
Campos
externalBudgetId

string

Corresponde ao externalBudgetId de um orçamento de campanha. Se o valor não estiver definido no orçamento da campanha, esse campo vai ficar em branco.
prismaCpeCode

object (PrismaCpeCode)

Códigos relevantes de cliente, produto e estimativa da ferramenta Mediaocean Prisma.

Aplicável somente a orçamentos de campanha com um externalBudgetSource de EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN.
preTaxAmountMicros

string (int64 format)

A soma das cobranças feitas com este orçamento antes dos tributos, em micros da moeda da fatura.

Por exemplo, se currencyCode for USD, 1000000 representará um dólar americano.
taxAmountMicros

string (int64 format)

O valor do tributo aplicado às cobranças desse orçamento, em micros da moeda da fatura.

Por exemplo, se currencyCode for USD, 1000000 representará um dólar americano.
totalAmountMicros

string (int64 format)

A soma total das cobranças feitas com esse orçamento, incluindo tributos, em micros da moeda da fatura.

Por exemplo, se currencyCode for USD, 1000000 representará um dólar americano.