Method: advertisers.invoices.list

Muestra las facturas publicadas de un anunciante en un mes determinado.

Facturas generadas por perfiles de facturación con un "socio" a nivel de factura no se pueden recuperar a través de este método.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
advertiserId

string (int64 format)

Obligatorio. Es el ID del anunciante para el que se incluirán las facturas.

Parámetros de consulta

Parámetros
issueMonth

string

El mes para el que se enumeran las facturas. Si no se establece, la solicitud recuperará las facturas del mes anterior.

Debe tener el formato AAAAMM.
loiSapinInvoiceType

enum (LoiSapinInvoiceType)

Seleccione el tipo de factura que desea recuperar para los anunciantes de la Loi Sapin.

Solo se aplica a los anunciantes de la Loi Sapin. De lo contrario, se ignorará.
pageSize

integer

Indica el tamaño de la página solicitada. El valor debe estar comprendido entre 1 y 200. Si no se especifica, se usará el valor predeterminado 100. Muestra el código de error INVALID_ARGUMENT si se especifica un valor no válido.
pageToken

string

Un token que identifica una página de resultados que el servidor debe mostrar. Por lo general, este es el valor de nextPageToken que se muestra en la llamada anterior al método invoices.list. Si no se especifica, se mostrará la primera página de resultados.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si el proceso es satisfactorio, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "invoices": [
    {
      object (Invoice)
    }
  ],
  "nextPageToken": string
}
Campos
invoices[]

object (Invoice)

La lista de facturas.

Esta lista no se mostrará si está vacía.
nextPageToken

string

Un token para recuperar los resultados de la página siguiente. Pasa este valor en el campo pageToken en la llamada posterior al método invoices.list para recuperar la siguiente página de resultados.

Este token estará ausente si no hay más invoices para mostrar.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.

LoiSapinInvoiceType

Posibles tipos de facturas para los anunciantes de la Loi Sapin.

Enumeraciones
LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED No se especificó el valor.
LOI_SAPIN_INVOICE_TYPE_MEDIA Facturas con costo de medios.
LOI_SAPIN_INVOICE_TYPE_PLATFORM Facturas con tarifa de la plataforma.

Factura

Una sola factura.

Representación 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

El nombre del recurso de la factura.
invoiceId

string

El ID único de la factura.
displayName

string

El nombre visible de la factura
paymentsProfileId

string

Es el ID del perfil de pagos al que pertenece la factura.

Aparece en la factura en PDF como Billing ID.
paymentsAccountId

string

Es el ID de la cuenta de pagos a la que pertenece la factura.

Aparece en la factura en PDF como Billing Account Number.
issueDate

object (Date)

Es la fecha en la que se emitió la factura.
dueDate

object (Date)

Es la fecha de vencimiento de la factura.
serviceDateRange

object (DateRange)

Las fechas de inicio y finalización del servicio que abarca esta factura.
currencyCode

string

Es la moneda que se utiliza en la factura en formato ISO 4217.
subtotalAmountMicros

string (int64 format)

El importe del subtotal antes de impuestos, en micrones de la moneda de la factura.

Por ejemplo, si currencyCode es USD, entonces 1,000,000 representa un dólar estadounidense.
totalTaxAmountMicros

string (int64 format)

Es la suma de todos los impuestos de la factura, en micrones de la moneda de la factura.

Por ejemplo, si currencyCode es USD, entonces 1,000,000 representa un dólar estadounidense.
totalAmountMicros

string (int64 format)

Es el importe total de la factura, expresado en micrones de la moneda correspondiente.

Por ejemplo, si currencyCode es USD, entonces 1,000,000 representa un dólar estadounidense.
purchaseOrderNumber

string

Es el número de orden de compra asociado a la factura.
budgetInvoiceGroupingId

string

El ID de agrupación de presupuesto para esta factura.

Este campo solo se establecerá si el nivel de factura del perfil de facturación correspondiente se estableció en “ID de agrupación de facturas del presupuesto”.
invoiceType

enum (InvoiceType)

Es el tipo de documento facturado.
correctedInvoiceId

string

El ID de la factura original que se ajusta en esta factura, si corresponde.

Puede aparecer en la factura en PDF como Reference invoice number.

Si estableces replacedInvoiceIds, este campo estará vacío.
replacedInvoiceIds[]

string

Los IDs de cualquier factura emitida originalmente que esta factura se cancele, si corresponde. Pueden aparecer varias facturas si esas facturas se consolidan en una sola factura.

Puede aparecer en la factura en PDF como Replaced invoice numbers.

Si estableces correctedInvoiceId, este campo estará vacío.
pdfUrl

string

Es la URL para descargar una copia en PDF de la factura.

Esta URL es específica del usuario y requiere un token de acceso de OAuth 2.0 válido para acceder. El token de acceso debe proporcionarse en un encabezado HTTP Authorization: Bearer y estar autorizado para uno de los siguientes alcances:

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

La URL será válida durante 7 días después de la recuperación de este objeto de factura o hasta que se recupere esta factura.
budgetSummaries[]

object (BudgetSummary)

Es la lista de información resumida de cada presupuesto asociado con esta factura.

Este campo solo se establecerá si el nivel de detalle de la factura del perfil de facturación correspondiente se estableció en "PO a nivel del presupuesto".
nonBudgetMicros

string (int64 format)

El importe total de los costos o los ajustes no vinculados a un presupuesto en particular, en micros de la moneda de la factura.

Por ejemplo, si currencyCode es USD, entonces 1,000,000 representa un dólar estadounidense.

InvoiceType

Posibles tipos de facturas.

Enumeraciones
INVOICE_TYPE_UNSPECIFIED No se especifica en esta versión o es desconocida.
INVOICE_TYPE_CREDIT La factura tiene un importe negativo.
INVOICE_TYPE_INVOICE La factura tiene un importe positivo.

BudgetSummary

Información resumida del presupuesto de una campaña individual.

Representación JSON 
{
  "externalBudgetId": string,
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "preTaxAmountMicros": string,
  "taxAmountMicros": string,
  "totalAmountMicros": string
}
Campos
externalBudgetId

string

Corresponde al externalBudgetId del presupuesto de una campaña. Si no se establece el valor en el presupuesto de la campaña, este campo estará vacío.
prismaCpeCode

object (PrismaCpeCode)

Códigos de cliente, producto y estimación relevantes de la herramienta Mediaocean Prisma.

Solo se aplica a los presupuestos de campañas con una externalBudgetSource de EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN.
preTaxAmountMicros

string (int64 format)

Es la suma de los cargos realizados con este presupuesto sin impuestos, en micrones de la moneda de la factura.

Por ejemplo, si currencyCode es USD, entonces 1,000,000 representa un dólar estadounidense.
taxAmountMicros

string (int64 format)

El importe del impuesto aplicado a los cargos dentro de este presupuesto, expresado en micrones de la moneda de la factura.

Por ejemplo, si currencyCode es USD, entonces 1,000,000 representa un dólar estadounidense.
totalAmountMicros

string (int64 format)

Es la suma total de los cargos realizados con este presupuesto, incluidos los impuestos, en micrones de la moneda de la factura.

Por ejemplo, si currencyCode es USD, entonces 1,000,000 representa un dólar estadounidense.