Se usó la API de Cloud Translation para traducir esta página.

Method: advertisers.invoices.list

Solicitud HTTP
Parámetros de ruta de acceso
Parámetros de consulta
Cuerpo de la solicitud
Cuerpo de la respuesta
- Representación JSON
Alcances de la autorización
LoiSapinInvoiceType
Factura
- Representación JSON
InvoiceType
BudgetSummary
- Representación JSON
Pruébala

Muestra una lista de las facturas publicadas para un anunciante en un mes determinado.

Las facturas generadas por perfiles de facturación con un nivel de factura de “Socio” no se recuperan a través de este método.

Solicitud HTTP

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

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

Parámetros de ruta de acceso

Parámetros

Parámetros
`advertiserId`	`string (int64 format)` Obligatorio. El ID del anunciante para el que se enumeran las facturas.

advertiserId

string (int64 format)

Obligatorio. El ID del anunciante para el que se enumeran 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 obtener para los anunciantes de la Ley Sapin. Solo se aplica a los anunciantes de la Ley Sapin. Se ignorará de lo contrario.
`pageSize`	`integer` Indica el tamaño de la página solicitada. Debe ser un valor entre `1` y `200`. Si no se especifica, el valor predeterminado será `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, 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

Campos
`invoices[]`	`object (Invoice)` Es la lista de facturas. Esta lista no estará disponible 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.

invoices[]

object (Invoice)

Es la lista de facturas.

Esta lista no estará disponible 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 la autorización

Se necesita uno de los siguientes alcances 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 Ley Sapin.

Enumeradores
`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 la tarifa de la plataforma.

Facturas

Una sola factura.

Representación JSON

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 }

{
  "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 en la que vence la factura.
`serviceDateRange`	`object (DateRange)` Las fechas de inicio y finalización del servicio que se incluyen en esta factura
`currencyCode`	`string` Es la moneda que se usa en la factura con el formato ISO 4217.
`subtotalAmountMicros`	`string (int64 format)` El importe del subtotal antes de impuestos, en micros 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 micros 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, en micros de la moneda correspondiente. Por ejemplo, si `currencyCode` es `USD`, entonces 1,000,000 representa un dólar estadounidense.
`purchaseOrderNumber`	`string` Número de orden de compra asociado con la factura.
`budgetInvoiceGroupingId`	`string` El ID de agrupación de presupuestos de 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 de la factura.
`correctedInvoiceId`	`string` Es el ID de la factura original que se ajustará con esta factura, si corresponde. Puede aparecer en la factura en PDF como `Reference invoice number`. Si se configura `replacedInvoiceIds`, este campo estará vacío.
`replacedInvoiceIds[]`	`string` Los ID de las facturas emitidas originalmente que se cancelan con esta factura, si corresponde. Es posible que aparezcan varias facturas si 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` La URL para descargar una copia en formato 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 se debe proporcionar 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 que se recupere este objeto de factura o hasta que esta se recupere de nuevo.
`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 detalles de la factura del perfil de facturación correspondiente se estableció en "PO a nivel del presupuesto".
`nonBudgetMicros`	`string (int64 format)` Es el importe total de costos o ajustes no vinculados a un presupuesto determinado, 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.

Enumeradores
`INVOICE_TYPE_UNSPECIFIED`	No se especifica 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 la 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 relevantes de clientes, productos y estimaciones de la herramienta Mediaocean Prisma. Solo se aplica a los presupuestos de campañas con un `externalBudgetSource` de `EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN`.
`preTaxAmountMicros`	`string (int64 format)` Es la suma de los cargos efectuados de conformidad con este presupuesto antes de impuestos, en micros 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 por debajo de este presupuesto, en micros 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 según este presupuesto, incluidos los impuestos, en micros de la moneda de la factura. Por ejemplo, si `currencyCode` es `USD`, entonces 1,000,000 representa un dólar estadounidense.