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ébalo

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

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

Solicitud HTTP

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

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

Parámetros de ruta de acceso

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

Parámetros de consulta

Parámetros
billingSetup	string Obligatorio. Es el nombre del recurso de configuración de facturación de las facturas solicitadas. customers/{customerId}/billingSetups/{billing_setup_id}
issueYear	string Obligatorio. Es el año de emisión para recuperar las facturas, en formato aaaa. Solo se pueden recuperar las facturas emitidas en 2019 o después.
issueMonth	enum (MonthOfYear) Obligatorio. El mes del problema 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
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 OAuth 2.0 Overview.

Factura

Una factura Se crea una instantánea de toda la información de la factura 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 de la instantánea no coincida con la factura en formato PDF.

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 }

Campos
resourceName	string Solo salida. Es 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 facturas 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 de la factura del servicio. La fecha de finalización está incluida.
adjustmentsSubtotalAmountMicros	string (int64 format) Solo salida. Es el importe del subtotal sin impuestos de los ajustes a nivel de la factura, en micros.
adjustmentsTaxAmountMicros	string (int64 format) Solo salida. Es la suma de los impuestos sobre los ajustes a nivel de la factura, en micros.
adjustmentsTotalAmountMicros	string (int64 format) Solo salida. Es el importe total de los ajustes a nivel de la factura, en micros.
regulatoryCostsSubtotalAmountMicros	string (int64 format) Solo salida. Es el importe del subtotal antes de impuestos de los costos regulatorios a nivel de la factura, en micros.
regulatoryCostsTaxAmountMicros	string (int64 format) Solo salida. Es la suma de los impuestos sobre los costos regulatorios a nivel de la factura, en micros.
regulatoryCostsTotalAmountMicros	string (int64 format) Solo salida. Es el importe total de los costos regulatorios a nivel de la factura, expresado en micros.
replacedInvoices[]	string Solo salida. Es el nombre del recurso de las facturas originales que se vuelven a facturar o se reemplazan por esta factura, si corresponde. Es posible que haya varias facturas reemplazadas debido a la consolidación de facturas. Es posible que las facturas reemplazadas no pertenezcan a la misma cuenta de pagos. Si se establece replacedInvoices, no se establecerá correctedInvoice. Los nombres de los recursos de facturas tienen el siguiente formato: customers/{customerId}/invoices/{invoice_id}
accountBudgetSummaries[]	object (AccountBudgetSummary) Solo salida. Es la lista de información resumida del presupuesto de la cuenta asociada con esta factura.
accountSummaries[]	object (AccountSummary) Solo salida. Es la lista de información resumida 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. Es 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 "Billing Account Number".
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. Es la fecha del problema en formato aaaa-mm-dd. Aparece en el PDF de la factura como "Fecha de emisión" o "Fecha de facturación".
dueDate	string Solo salida. Es la fecha límite en formato aaaa-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 los códigos de moneda derivados del estándar ISO 4217.
exportChargeSubtotalAmountMicros	string (int64 format) Solo salida. Es el importe del subtotal sin impuestos de los cargos de exportación a nivel de la factura, en micros.
exportChargeTaxAmountMicros	string (int64 format) Solo salida. Es la suma de los impuestos de los cargos de exportación a nivel de la factura, en micros.
exportChargeTotalAmountMicros	string (int64 format) Solo salida. Es el importe total de los cargos de exportación a nivel de la factura, en micros.
subtotalAmountMicros	string (int64 format) Solo salida. Es el importe del subtotal antes de impuestos, en micros. Es igual a la suma de los importes del subtotal de AccountBudgetSummary y Invoice.adjustments_subtotal_amount_micros.
taxAmountMicros	string (int64 format) Solo salida. Es la suma de todos los impuestos de la factura, en micros. Esto equivale a la suma de los importes de impuestos de AccountBudgetSummary, más los impuestos no asociados con un presupuesto de cuenta específico.
totalAmountMicros	string (int64 format) Solo salida. Es el importe total, expresado 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 separa en un elemento de una sola línea a partir de la versión 14.1).
correctedInvoice	string Solo salida. Es el nombre del recurso de la factura original que esta factura corrige, cancela o da de baja, si corresponde. Si se establece correctedInvoice, no se establecerá replacedInvoices. Los nombres de los recursos de facturas tienen el siguiente formato: customers/{customerId}/invoices/{invoice_id}
pdfUrl	string Solo salida. Es la URL de una copia en formato PDF de la factura. Los usuarios deben pasar su token de OAuth para solicitar el PDF con esta URL.

InvoiceType

Es el tipo de facturas posible.

Enumeraciones
UNSPECIFIED	No se especifica.
UNKNOWN	Solo se usa para el valor que se muestra. Representa un valor desconocido en esta versión.
CREDIT_MEMO	Una factura con un importe negativo La cuenta recibe un crédito.
INVOICE	Una factura con un importe positivo La cuenta tiene un saldo pendiente.

AccountBudgetSummary

Representa un costo facturable resumido del presupuesto de la cuenta.

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 }

Campos
billableActivityDateRange	object (DateRange) Solo salida. Es el período de actividad facturable del presupuesto de la cuenta, dentro del período de servicio de esta factura. La fecha de finalización está incluida. Puede ser diferente de la hora de inicio y finalización del presupuesto de la cuenta.
invalidActivitySummaries[]	object (InvalidActivitySummary) Solo salida. Es la lista de créditos relacionados con actividades no válidas resumidos con los vínculos originales.
customer	string Solo salida. Es el nombre del recurso del cliente asociado con este presupuesto de la cuenta. Contiene el ID de cliente, que aparece en el PDF de la factura como "ID de la cuenta". Los nombres de los recursos del cliente tienen el siguiente formato: customers/{customerId}
customerDescriptiveName	string Solo salida. Es el nombre descriptivo del cliente del presupuesto de la cuenta. Aparece en el PDF de la factura 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. Es 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 el PDF de la factura como “Orden de compra”.
subtotalAmountMicros	string (int64 format) Solo salida. Es el importe del subtotal antes de impuestos atribuido a este presupuesto durante el período del servicio, en micros.
taxAmountMicros	string (int64 format) Solo salida. Es el importe de los impuestos atribuidos a este presupuesto durante el período del servicio, en micros.
totalAmountMicros	string (int64 format) Solo salida. Es el importe total atribuible a este presupuesto durante el período del servicio, en micros. Esto equivale a la suma del importe del subtotal del presupuesto de la cuenta y el importe de los impuestos del presupuesto de la cuenta.
servedAmountMicros	string (int64 format) Solo salida. Es el importe publicado antes de impuestos atribuido a este presupuesto durante el período del servicio, en micros. Esto solo es útil para conciliar los datos de facturación y publicación.
billedAmountMicros	string (int64 format) Solo salida. Es el importe facturado antes de impuestos atribuido a este presupuesto durante el período del servicio, en micros. Esto no tiene en cuenta ningún ajuste.
overdeliveryAmountMicros	string (int64 format) Solo salida. Es el importe de la entrega superior a lo previsto antes de impuestos atribuido a este presupuesto durante el período del servicio, en micros (valor negativo).
invalidActivityAmountMicros	string (int64 format) Solo salida. Es el importe de actividad no válida antes de impuestos atribuido a este presupuesto en meses anteriores, en micros (valor negativo).

InvalidActivitySummary

Detalles sobre la actividad no válida de la factura que contienen detalles adicionales sobre la factura en la que se realizan las correcciones.

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

Campos
originalMonthOfService	enum (MonthOfYear) Solo salida. Es el mes de servicio original relacionado con este crédito por actividad no válida.
originalYearOfService	string Solo salida. Es el año de servicio original relacionado con este crédito por 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 de la cuenta original relacionado con este crédito de actividad no válido.
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. El importe de la actividad en micros no es válido.

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 }

Campos
customer	string Solo salida. La cuenta asociada con el resumen de la cuenta.
billingCorrectionSubtotalAmountMicros	string (int64 format) Solo salida. Es el importe del subtotal de la corrección de facturación antes de impuestos, expresado en micros.
billingCorrectionTaxAmountMicros	string (int64 format) Solo salida. Impuesto sobre la corrección de facturación, en micros.
billingCorrectionTotalAmountMicros	string (int64 format) Solo salida. Es el importe total de la corrección de facturación, expresado en micros.
couponAdjustmentSubtotalAmountMicros	string (int64 format) Solo salida. Es el importe del subtotal del ajuste del cupón antes de impuestos, expresado en micros.
couponAdjustmentTaxAmountMicros	string (int64 format) Solo salida. Impuesto sobre el ajuste del cupón, en micros.
couponAdjustmentTotalAmountMicros	string (int64 format) Solo salida. Es el importe total del ajuste del cupón, en micros.
excessCreditAdjustmentSubtotalAmountMicros	string (int64 format) Solo salida. Es el importe del subtotal del ajuste de crédito excedente antes de impuestos, expresado en micros.
excessCreditAdjustmentTaxAmountMicros	string (int64 format) Solo salida. Impuesto sobre el ajuste de crédito excesivo, en micros.
excessCreditAdjustmentTotalAmountMicros	string (int64 format) Solo salida. Es el importe total del ajuste de crédito excesivo, expresado en micros.
regulatoryCostsSubtotalAmountMicros	string (int64 format) Solo salida. Es el importe del subtotal de los costos regulatorios antes de impuestos, expresado en micros.
regulatoryCostsTaxAmountMicros	string (int64 format) Solo salida. Impuesto sobre los costos regulatorios, en micros.
regulatoryCostsTotalAmountMicros	string (int64 format) Solo salida. Es el importe total de los costos regulatorios, expresado en micros.
exportChargeSubtotalAmountMicros	string (int64 format) Solo salida. Es el importe del subtotal del cargo de exportación antes de impuestos, expresado en micros.
exportChargeTaxAmountMicros	string (int64 format) Solo salida. Impuesto sobre el cargo de exportación, en micros.
exportChargeTotalAmountMicros	string (int64 format) Solo salida. Es el importe total de los cargos de exportación, expresado en micros.
subtotalAmountMicros	string (int64 format) Solo salida. Es el importe total del subtotal sin impuestos atribuible a la cuenta durante el período de servicio, en micros.
taxAmountMicros	string (int64 format) Solo salida. Es el importe total de los impuestos atribuidos a la cuenta durante el período de servicio, expresado en micros.
totalAmountMicros	string (int64 format) Solo salida. Es el importe total atribuible a la cuenta durante el período de servicio, expresado en micros. Esto equivale a la suma de subtotalAmountMicros y taxAmountMicros.