Method: advertisers.invoices.list

Enumera las facturas registradas para un anunciante en un mes determinado.

Las facturas generadas por los perfiles de facturación con un nivel de factura "Socio" no se pueden recuperar con 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 enumerarán las facturas.

Parámetros de consulta

Parámetros
issueMonth

string

Mes para el que se enumerarán las facturas. Si no se configura, la solicitud recuperará las facturas del mes anterior.

Debe tener el formato AAAAMM.
loiSapinInvoiceType

enum (LoiSapinInvoiceType)

Selecciona el tipo de factura que se recuperará para los anunciantes de la Ley Sapin.

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

integer

Indica el tamaño de la página solicitada. La hora debe configurarse entre 1 y 200. Si no se especifica, se establecerá de forma predeterminada como 100. Devuelve 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 devolver. Por lo general, este es el valor de nextPageToken que se devolvió de la llamada anterior al método invoices.list. Si no se especifica, se devolverá 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)

Es la lista de facturas.

Esta lista no estará presente 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 no estará presente si no hay más invoices para devolver.

Permisos 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 OAuth 2.0 Overview.

LoiSapinInvoiceType

Son los posibles tipos de facturas para los anunciantes sujetos a la Loi Sapin.

Enumeraciones
LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED No se especificó el valor.
LOI_SAPIN_INVOICE_TYPE_MEDIA Son las facturas que incluyen el costo de los medios.
LOI_SAPIN_INVOICE_TYPE_PLATFORM Facturas con comisión 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

Es el nombre del recurso de la factura.
invoiceId

string

Es el ID único de la factura.
displayName

string

Es el nombre visible de la factura.
paymentsProfileId

string

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

Aparece en el PDF de la factura como Billing ID.
paymentsAccountId

string

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

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

object (Date)

Fecha en la que se emitió la factura.
dueDate

object (Date)

Es la fecha límite de pago de la factura.
serviceDateRange

object (DateRange)

Son las fechas de inicio y finalización del servicio que cubre esta factura.
currencyCode

string

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

string (int64 format)

Es el importe del subtotal antes de impuestos, en micros de la moneda de la factura.

Por ejemplo, si currencyCode es USD, 1000000 representa un dólar estadounidense.
totalTaxAmountMicros

string (int64 format)

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

Por ejemplo, si currencyCode es USD, 1000000 representa un dólar estadounidense.
totalAmountMicros

string (int64 format)

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

Por ejemplo, si currencyCode es USD, 1000000 representa un dólar estadounidense.
purchaseOrderNumber

string

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

string

Es el ID de agrupación de presupuesto de esta factura.

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

enum (InvoiceType)

Es el tipo de documento de factura.
correctedInvoiceId

string

Es el ID de la factura original que se ajusta con esta factura, si corresponde.

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

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

string

Son los IDs de las facturas emitidas originalmente que se cancelan con esta factura, si corresponde. Es posible que se muestren varias facturas si estas se consolidan en una sola.

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

Si se configura 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 a ella. El token de acceso se debe proporcionar en un encabezado HTTP Authorization: Bearer y debe estar autorizado para uno de los siguientes permisos:

  • 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 vuelva a recuperar esta factura.
budgetSummaries[]

object (BudgetSummary)

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

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

string (int64 format)

Es el importe total de los costos o ajustes que no están vinculados a un presupuesto en particular, expresado en micros de la moneda de la factura.

Por ejemplo, si currencyCode es USD, 1000000 representa un dólar estadounidense.

InvoiceType

Son los tipos de facturas posibles.

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

BudgetSummary

Es un resumen de la información de un presupuesto de campaña individual.

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

string

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

object (PrismaCpeCode)

Son los códigos de cliente, producto y estimación pertinentes de la herramienta Prisma de Mediaocean.

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

string (int64 format)

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

Por ejemplo, si currencyCode es USD, 1000000 representa un dólar estadounidense.
taxAmountMicros

string (int64 format)

Es el importe del impuesto aplicado a los cargos de este presupuesto, en micros de la moneda de la factura.

Por ejemplo, si currencyCode es USD, 1000000 representa un dólar estadounidense.
totalAmountMicros

string (int64 format)

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

Por ejemplo, si currencyCode es USD, 1000000 representa un dólar estadounidense.