Precaución: Estás viendo la documentación de la interfaz REST de la API. La mayoría de nuestras bibliotecas cliente oficiales usan gRPC. Consulta la Introducción a REST para obtener más detalles.

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

Method: customers.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
Permisos de autorización
Factura
- Representación JSON
InvoiceType
AccountBudgetSummary
- Representación JSON
InvalidActivitySummary
- Representación JSON
AccountSummary
- Representación JSON
Pruébala

Muestra todas las facturas asociadas con una configuración de facturación de un mes determinado.

Lista de errores arrojados: AuthenticationError AuthorizationError FieldError HeaderError InternalError InvoiceError QuotaError RequestError

Solicitud HTTP

GET https://googleads.googleapis.com/v14/customers/{customerId}/invoices

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

Parámetros de ruta de acceso

Parámetros

Parámetros
`customerId`	`string` Obligatorio. El ID del cliente para el que se recuperan las facturas.

customerId

string

Obligatorio. El ID del cliente para el que se recuperan las facturas.

Parámetros de consulta

Parámetros

Parámetros
`billingSetup`	`string` Obligatorio. El nombre del recurso de configuración de facturación de las facturas solicitadas. `customers/{customerId}/billingSetups/{billing_setup_id}`
`issueYear`	`string` Obligatorio. El año de emisión para recuperar las facturas, en formato aaaa. Solo se pueden recuperar las facturas emitidas en 2019 o en fechas posteriores.
`issueMonth`	`enum (MonthOfYear)` Obligatorio. El mes de emisión para recuperar las facturas.

billingSetup

string

Obligatorio. El nombre del recurso de configuración de facturación de las facturas solicitadas.

customers/{customerId}/billingSetups/{billing_setup_id}

issueYear

string

Obligatorio. El año de emisión para recuperar las facturas, en formato aaaa. Solo se pueden recuperar las facturas emitidas en 2019 o en fechas posteriores.

issueMonth

enum (MonthOfYear)

Obligatorio. El mes de emisión para recuperar las facturas.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje de respuesta para InvoiceService.ListInvoices.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON
{ "invoices": [ { object (`Invoice`) } ] }

Campos

Campos
`invoices[]`	`object (Invoice)` La lista de facturas que coinciden con la configuración de facturación y el período.

invoices[]

object (Invoice)

La lista de facturas que coinciden con la configuración de facturación y el período.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

https://www.googleapis.com/auth/adwords

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

Facturas

Una factura Toda la información de la factura se captura para que coincida con la factura en formato PDF. En el caso de las facturas anteriores al lanzamiento de InvoiceService, es posible que la información resumida no coincida con la factura en PDF.

Representación JSON

Representación JSON
{ "resourceName": string, "type": enum (`InvoiceType`), "serviceDateRange": { object (`DateRange`) }, "adjustmentsSubtotalAmountMicros": string, "adjustmentsTaxAmountMicros": string, "adjustmentsTotalAmountMicros": string, "regulatoryCostsSubtotalAmountMicros": string, "regulatoryCostsTaxAmountMicros": string, "regulatoryCostsTotalAmountMicros": string, "replacedInvoices": [ string ], "accountBudgetSummaries": [ { object (`AccountBudgetSummary`) } ], "accountSummaries": [ { object (`AccountSummary`) } ], "id": string, "billingSetup": string, "paymentsAccountId": string, "paymentsProfileId": string, "issueDate": string, "dueDate": string, "currencyCode": string, "exportChargeSubtotalAmountMicros": string, "exportChargeTaxAmountMicros": string, "exportChargeTotalAmountMicros": string, "subtotalAmountMicros": string, "taxAmountMicros": string, "totalAmountMicros": string, "correctedInvoice": string, "pdfUrl": string }

{
  "resourceName": string,
  "type": enum (InvoiceType),
  "serviceDateRange": {
    object (DateRange)
  },
  "adjustmentsSubtotalAmountMicros": string,
  "adjustmentsTaxAmountMicros": string,
  "adjustmentsTotalAmountMicros": string,
  "regulatoryCostsSubtotalAmountMicros": string,
  "regulatoryCostsTaxAmountMicros": string,
  "regulatoryCostsTotalAmountMicros": string,
  "replacedInvoices": [
    string
  ],
  "accountBudgetSummaries": [
    {
      object (AccountBudgetSummary)
    }
  ],
  "accountSummaries": [
    {
      object (AccountSummary)
    }
  ],
  "id": string,
  "billingSetup": string,
  "paymentsAccountId": string,
  "paymentsProfileId": string,
  "issueDate": string,
  "dueDate": string,
  "currencyCode": string,
  "exportChargeSubtotalAmountMicros": string,
  "exportChargeTaxAmountMicros": string,
  "exportChargeTotalAmountMicros": string,
  "subtotalAmountMicros": string,
  "taxAmountMicros": string,
  "totalAmountMicros": string,
  "correctedInvoice": string,
  "pdfUrl": string
}

Campos
`resourceName`	`string` Solo salida. El nombre del recurso de la factura. Varios clientes pueden compartir una factura determinada, por lo que varios nombres de recursos pueden apuntar a la misma factura. Los nombres de los recursos de facturación tienen el siguiente formato: `customers/{customerId}/invoices/{invoice_id}`
`type`	`enum (InvoiceType)` Solo salida. Es el tipo de factura.
`serviceDateRange`	`object (DateRange)` Solo salida. Es el período del período de servicio de esta factura. La fecha de finalización es inclusiva.
`adjustmentsSubtotalAmountMicros`	`string (int64 format)` Solo salida. El importe del subtotal antes de impuestos de los ajustes a nivel de factura, en micros
`adjustmentsTaxAmountMicros`	`string (int64 format)` Solo salida. La suma de los impuestos en los ajustes a nivel de factura, en micros.
`adjustmentsTotalAmountMicros`	`string (int64 format)` Solo salida. El importe total de los ajustes a nivel de factura, en micros.
`regulatoryCostsSubtotalAmountMicros`	`string (int64 format)` Solo salida. El importe del subtotal antes de impuestos de los costos regulatorios a nivel de factura, en micros.
`regulatoryCostsTaxAmountMicros`	`string (int64 format)` Solo salida. La suma de los impuestos sobre los costos regulatorios a nivel de factura, en micros.
`regulatoryCostsTotalAmountMicros`	`string (int64 format)` Solo salida. El importe total de los costos regulatorios a nivel de factura, en micros.
`replacedInvoices[]`	`string` Solo salida. El nombre del recurso de las facturas originales que se vuelven a facturar o reemplazadas por esta factura, si corresponde. Es posible que se reemplacen varias facturas debido a la consolidación de facturas. Es posible que las facturas reemplazadas no pertenezcan a la misma cuenta de pagos. Si estableces `replacedInvoices`, no se establecerá `correctedInvoice`. Los nombres de los recursos de facturación tienen el siguiente formato: `customers/{customerId}/invoices/{invoice_id}`
`accountBudgetSummaries[]`	`object (AccountBudgetSummary)` Solo salida. Es la lista resumida de información del presupuesto de la cuenta asociada con esta factura.
`accountSummaries[]`	`object (AccountSummary)` Solo salida. Es la lista resumida de la información de la cuenta asociada con esta factura.
`id`	`string` Solo salida. Es el ID de la factura. Aparece en el PDF de la factura como “Número de factura”.
`billingSetup`	`string` Solo salida. El nombre del recurso de la configuración de facturación de esta factura. `customers/{customerId}/billingSetups/{billing_setup_id}`
`paymentsAccountId`	`string` Solo salida. Es un ID de 16 dígitos que se usa para identificar la cuenta de pagos asociada con la configuración de facturación, por ejemplo, “1234-5678-9012-3456”. Aparece en el PDF de la factura como “Número de cuenta de facturación”.
`paymentsProfileId`	`string` Solo salida. Es un ID de 12 dígitos que se usa para identificar el perfil de pagos asociado con la configuración de facturación, por ejemplo, “1234-5678-9012”. Aparece en el PDF de la factura como “ID de facturación”.
`issueDate`	`string` Solo salida. Corresponde a la fecha de emisión en el formato aaaa-mm-dd. Aparece en la factura en PDF como “Fecha de emisión” o “Fecha de facturación”.
`dueDate`	`string` Solo salida. Es la fecha límite en formato yyyy-mm-dd.
`currencyCode`	`string` Solo salida. Es el código de moneda. Todos los costos se muestran en esta moneda. Se admite un subconjunto de códigos de moneda derivados de la norma ISO 4217.
`exportChargeSubtotalAmountMicros`	`string (int64 format)` Solo salida. El importe del subtotal antes de impuestos de los cargos de exportación a nivel de factura, en micros
`exportChargeTaxAmountMicros`	`string (int64 format)` Solo salida. La suma de los impuestos sobre los cargos de exportación a nivel de factura, en micros.
`exportChargeTotalAmountMicros`	`string (int64 format)` Solo salida. El importe total de los cargos de exportación a nivel de factura, en micros.
`subtotalAmountMicros`	`string (int64 format)` Solo salida. El importe del subtotal antes de impuestos, en micros Esto es igual a la suma de los importes del subtotal de AccountBudgetSummary y Invoice.adjustments_subtotal_amount_micros.
`taxAmountMicros`	`string (int64 format)` Solo salida. La suma de todos los impuestos en la factura, en micros. Esto equivale a la suma de los importes fiscales de AccountBudgetSummary, más los impuestos no asociados con un presupuesto de la cuenta específico.
`totalAmountMicros`	`string (int64 format)` Solo salida. El importe total, en micros. Esto es igual a la suma de Invoice.subtotal_amount_micros, Invoice.tax_amount_micros, Invoice.regulatory_costs_subtotal_amount_micros y Invoice.export_charge_subtotal_amount_micros (que se divide en un elemento de una sola línea aparte que comienza con V14.1).
`correctedInvoice`	`string` Solo salida. El nombre del recurso de la factura original corregida, anulada o cancelada por esta factura, si corresponde. Si estableces `correctedInvoice`, no se establecerá `replacedInvoices`. Los nombres de los recursos de facturación tienen el siguiente formato: `customers/{customerId}/invoices/{invoice_id}`
`pdfUrl`	`string` Solo salida. La URL a la copia en PDF de la factura. Los usuarios deben pasar su token de OAuth para solicitar el PDF con esta URL.

InvoiceType

Es el tipo posible de facturas.

Enumeradores
`UNSPECIFIED`	No se especifica.
`UNKNOWN`	Se usa solo para el valor de retorno. Representa un valor desconocido en esta versión.
`CREDIT_MEMO`	Una factura con un importe negativo. La cuenta recibe un crédito.
`INVOICE`	Es una factura con un importe positivo. La cuenta debe tener un saldo.

AccountBudgetSummary

Representa un resumen del costo facturable del presupuesto de la cuenta.

Representación JSON

Representación JSON
{ "billableActivityDateRange": { object (`DateRange`) }, "invalidActivitySummaries": [ { object (`InvalidActivitySummary`) } ], "customer": string, "customerDescriptiveName": string, "accountBudget": string, "accountBudgetName": string, "purchaseOrderNumber": string, "subtotalAmountMicros": string, "taxAmountMicros": string, "totalAmountMicros": string, "servedAmountMicros": string, "billedAmountMicros": string, "overdeliveryAmountMicros": string, "invalidActivityAmountMicros": string }

{
  "billableActivityDateRange": {
    object (DateRange)
  },
  "invalidActivitySummaries": [
    {
      object (InvalidActivitySummary)
    }
  ],
  "customer": string,
  "customerDescriptiveName": string,
  "accountBudget": string,
  "accountBudgetName": string,
  "purchaseOrderNumber": string,
  "subtotalAmountMicros": string,
  "taxAmountMicros": string,
  "totalAmountMicros": string,
  "servedAmountMicros": string,
  "billedAmountMicros": string,
  "overdeliveryAmountMicros": string,
  "invalidActivityAmountMicros": string
}

Campos
`billableActivityDateRange`	`object (DateRange)` Solo salida. El período de la actividad facturable del presupuesto de la cuenta, dentro del período de servicio de esta factura. La fecha de finalización es inclusiva. Puede ser diferente de la hora de inicio y finalización del presupuesto de la cuenta.
`invalidActivitySummaries[]`	`object (InvalidActivitySummary)` Solo salida. Es la lista resumida de créditos de actividad no válida con vinculaciones originales.
`customer`	`string` Solo salida. El nombre de recurso del cliente asociado con el presupuesto de esta cuenta. Contiene el ID de cliente, que aparece en la factura en PDF como “ID de la cuenta”. Los nombres de los recursos del cliente tienen la siguiente forma: `customers/{customerId}`
`customerDescriptiveName`	`string` Solo salida. Es el nombre descriptivo del cliente del presupuesto de la cuenta. Aparece en la factura en PDF como “Cuenta”.
`accountBudget`	`string` Solo salida. Es el nombre del recurso del presupuesto de la cuenta asociado con este costo facturable resumido. Los nombres de los recursos de AccountBudget tienen el siguiente formato: `customers/{customerId}/accountBudgets/{account_budget_id}`
`accountBudgetName`	`string` Solo salida. El nombre del presupuesto de la cuenta. Aparece en el PDF de la factura como “Presupuesto de la cuenta”.
`purchaseOrderNumber`	`string` Solo salida. Es el número de orden de compra del presupuesto de la cuenta. Aparece en la factura en PDF como “Orden de compra”.
`subtotalAmountMicros`	`string (int64 format)` Solo salida. El importe del subtotal antes de impuestos atribuible a este presupuesto durante el período de servicio, en micros.
`taxAmountMicros`	`string (int64 format)` Solo salida. El importe del impuesto atribuible a este presupuesto durante el período de servicio, en micros.
`totalAmountMicros`	`string (int64 format)` Solo salida. El importe total atribuible a este presupuesto durante el período de servicio, en micros. Esto equivale a la suma del importe subtotal del presupuesto de la cuenta y el importe del impuesto del presupuesto de la cuenta.
`servedAmountMicros`	`string (int64 format)` Solo salida. El importe antes de impuestos emitidos atribuible a este presupuesto durante el período de servicio, en micros. Esto solo es útil para conciliar datos de facturas y de entrega.
`billedAmountMicros`	`string (int64 format)` Solo salida. El importe facturado antes de impuestos atribuible a este presupuesto durante el período de servicio, en micros. Esto no considera ningún ajuste.
`overdeliveryAmountMicros`	`string (int64 format)` Solo salida. El importe de sobreimpresión antes de impuestos atribuible a este presupuesto durante el período de servicio, en micros (valor negativo).
`invalidActivityAmountMicros`	`string (int64 format)` Solo salida. El importe de la actividad no válida antes de impuestos atribuible a este presupuesto en los meses anteriores, en micros (valor negativo).

InvalidActivitySummary

Son detalles sobre la actividad no válida en la factura que contienen detalles adicionales sobre la factura en la que se realizaron correcciones.

Representación JSON

Representación JSON
{ "originalMonthOfService": enum (`MonthOfYear`), "originalYearOfService": string, "originalInvoiceId": string, "originalAccountBudgetName": string, "originalPurchaseOrderNumber": string, "amountMicros": string }

{
  "originalMonthOfService": enum (MonthOfYear),
  "originalYearOfService": string,
  "originalInvoiceId": string,
  "originalAccountBudgetName": string,
  "originalPurchaseOrderNumber": string,
  "amountMicros": string
}

Campos
`originalMonthOfService`	`enum (MonthOfYear)` Solo salida. Mes original de servicio relacionado con este crédito de actividad no válida.
`originalYearOfService`	`string` Solo salida. Es el año original de servicio relacionado con este crédito de actividad no válida.
`originalInvoiceId`	`string` Solo salida. Número de factura original relacionado con este crédito por actividad no válida.
`originalAccountBudgetName`	`string` Solo salida. Es el nombre del presupuesto original de la cuenta relacionado con este crédito por actividad no válida.
`originalPurchaseOrderNumber`	`string` Solo salida. Número de orden de compra original relacionado con este crédito por actividad no válida.
`amountMicros`	`string (int64 format)` Solo salida. Cantidad de actividad no válida en micros.

AccountSummary

Representa una vista resumida a nivel de la cuenta.

Representación JSON
{ "customer": string, "billingCorrectionSubtotalAmountMicros": string, "billingCorrectionTaxAmountMicros": string, "billingCorrectionTotalAmountMicros": string, "couponAdjustmentSubtotalAmountMicros": string, "couponAdjustmentTaxAmountMicros": string, "couponAdjustmentTotalAmountMicros": string, "excessCreditAdjustmentSubtotalAmountMicros": string, "excessCreditAdjustmentTaxAmountMicros": string, "excessCreditAdjustmentTotalAmountMicros": string, "regulatoryCostsSubtotalAmountMicros": string, "regulatoryCostsTaxAmountMicros": string, "regulatoryCostsTotalAmountMicros": string, "exportChargeSubtotalAmountMicros": string, "exportChargeTaxAmountMicros": string, "exportChargeTotalAmountMicros": string, "subtotalAmountMicros": string, "taxAmountMicros": string, "totalAmountMicros": string }

Representación JSON

{
  "customer": string,
  "billingCorrectionSubtotalAmountMicros": string,
  "billingCorrectionTaxAmountMicros": string,
  "billingCorrectionTotalAmountMicros": string,
  "couponAdjustmentSubtotalAmountMicros": string,
  "couponAdjustmentTaxAmountMicros": string,
  "couponAdjustmentTotalAmountMicros": string,
  "excessCreditAdjustmentSubtotalAmountMicros": string,
  "excessCreditAdjustmentTaxAmountMicros": string,
  "excessCreditAdjustmentTotalAmountMicros": string,
  "regulatoryCostsSubtotalAmountMicros": string,
  "regulatoryCostsTaxAmountMicros": string,
  "regulatoryCostsTotalAmountMicros": string,
  "exportChargeSubtotalAmountMicros": string,
  "exportChargeTaxAmountMicros": string,
  "exportChargeTotalAmountMicros": string,
  "subtotalAmountMicros": string,
  "taxAmountMicros": string,
  "totalAmountMicros": string
}

Campos
`customer`	`string` Solo salida. Indica la cuenta asociada con el resumen de la cuenta.
`billingCorrectionSubtotalAmountMicros`	`string (int64 format)` Solo salida. Importe del subtotal de la corrección de facturación antes de impuestos, en micros.
`billingCorrectionTaxAmountMicros`	`string (int64 format)` Solo salida. Impuesto sobre la corrección de la facturación, en micros
`billingCorrectionTotalAmountMicros`	`string (int64 format)` Solo salida. Importe total de corrección de la facturación, en micros
`couponAdjustmentSubtotalAmountMicros`	`string (int64 format)` Solo salida. Importe del subtotal del ajuste de cupones antes de impuestos, en microsegundos
`couponAdjustmentTaxAmountMicros`	`string (int64 format)` Solo salida. Impuesto sobre el ajuste de cupones, en micros
`couponAdjustmentTotalAmountMicros`	`string (int64 format)` Solo salida. Importe total del ajuste del cupón, en micros
`excessCreditAdjustmentSubtotalAmountMicros`	`string (int64 format)` Solo salida. Importe del subtotal del ajuste de crédito por exceso de impuestos, en micros.
`excessCreditAdjustmentTaxAmountMicros`	`string (int64 format)` Solo salida. Impuesto sobre el ajuste de crédito excedente, en micros.
`excessCreditAdjustmentTotalAmountMicros`	`string (int64 format)` Solo salida. Importe total del ajuste de crédito excedente, en micros.
`regulatoryCostsSubtotalAmountMicros`	`string (int64 format)` Solo salida. Importe del subtotal de los costos regulatorios antes de impuestos, en micros.
`regulatoryCostsTaxAmountMicros`	`string (int64 format)` Solo salida. Impuesto sobre los costos regulatorios, en micros
`regulatoryCostsTotalAmountMicros`	`string (int64 format)` Solo salida. Importe total de los costos regulatorios, en micros.
`exportChargeSubtotalAmountMicros`	`string (int64 format)` Solo salida. Importe del subtotal del cargo antes de impuestos, en micros.
`exportChargeTaxAmountMicros`	`string (int64 format)` Solo salida. Impuesto sobre el cargo de exportación, en micros
`exportChargeTotalAmountMicros`	`string (int64 format)` Solo salida. Importe total del cargo de exportación, en micros
`subtotalAmountMicros`	`string (int64 format)` Solo salida. Importe total del subtotal antes de impuestos atribuible a la cuenta durante el período de servicio, en micros.
`taxAmountMicros`	`string (int64 format)` Solo salida. Importe total del impuesto atribuible a la cuenta durante el período de servicio, en micros.
`totalAmountMicros`	`string (int64 format)` Solo salida. Importe total atribuible a la cuenta durante el período de servicio, en micros. Esto es igual a la suma de los subtotalAmountMicros y taxAmountMicros.