Method: customers.invoices.list

Retorna todas as faturas associadas a uma configuração de faturamento de um determinado mês.

Lista de erros gerados: AuthenticationError AuthorizationError FieldError HeaderError InternalError InvoiceError QuotaError RequestError

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
customerId

string

Obrigatório. O ID do cliente para buscar as faturas.

Parâmetros de consulta

Parâmetros
billingSetup

string

Obrigatório. O nome do recurso da configuração de faturamento das faturas solicitadas.

customers/{customerId}/billingSetups/{billing_setup_id}
issueYear

string

Obrigatório. O ano de emissão para recuperar faturas, no formato aaaa. Só é possível recuperar faturas emitidas a partir de 2019.
issueMonth

enum (MonthOfYear)

Obrigatório. O mês de emissão para recuperar faturas.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para InvoiceService.ListInvoices.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "invoices": [
    {
      object (Invoice)
    }
  ]
}
Campos
invoices[]

object (Invoice)

A lista de faturas que correspondem à configuração de faturamento e ao período.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.

Fatura

Uma fatura Todas as informações da fatura são resumidas para corresponder à fatura em PDF. Para faturas anteriores ao lançamento do InvoiceService, as informações resumidas podem não corresponder à fatura em PDF.

Representação 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

Apenas saída. O nome do recurso da fatura. Vários clientes podem compartilhar a mesma fatura. Sendo assim, vários nomes de recursos podem apontar para a mesma fatura. Os nomes dos recursos das faturas têm o seguinte formato:

customers/{customerId}/invoices/{invoice_id}
type

enum (InvoiceType)

Apenas saída. O tipo de fatura.
serviceDateRange

object (DateRange)

Apenas saída. O período de serviço dessa fatura. A data de término é inclusiva.
adjustmentsSubtotalAmountMicros

string (int64 format)

Apenas saída. O valor subtotal sem tributos dos ajustes no nível da fatura, em micros.
adjustmentsTaxAmountMicros

string (int64 format)

Apenas saída. A soma dos tributos sobre os ajustes no nível da fatura, em micros.
adjustmentsTotalAmountMicros

string (int64 format)

Apenas saída. Valor total dos ajustes no nível da fatura, em micros.
regulatoryCostsSubtotalAmountMicros

string (int64 format)

Apenas saída. O valor subtotal sem tributos dos custos regulamentares no nível da fatura, em micros.
regulatoryCostsTaxAmountMicros

string (int64 format)

Apenas saída. A soma dos tributos sobre os custos regulatórios no nível da fatura, em micros.
regulatoryCostsTotalAmountMicros

string (int64 format)

Apenas saída. O valor total dos custos regulamentares no nível da fatura, em micros.
replacedInvoices[]

string

Apenas saída. O nome do recurso das faturas originais que estão sendo faturadas ou substituídas por esta fatura, se aplicável. Pode haver várias faturas substituídas devido à consolidação delas. As faturas substituídas podem não pertencer à mesma conta para pagamentos. Se replacedInvoices estiver definido, correctedInvoice não será definido. Os nomes dos recursos das faturas têm o seguinte formato:

customers/{customerId}/invoices/{invoice_id}
accountBudgetSummaries[]

object (AccountBudgetSummary)

Apenas saída. É a lista de informações resumidas de orçamento da conta associadas a esta fatura.
accountSummaries[]

object (AccountSummary)

Apenas saída. A lista de informações resumidas da conta associadas a esta fatura.
id

string

Apenas saída. O ID da fatura. Ele aparece no PDF da fatura como "Número da fatura".
billingSetup

string

Apenas saída. O nome do recurso da configuração de faturamento desta fatura.

customers/{customerId}/billingSetups/{billing_setup_id}
paymentsAccountId

string

Apenas saída. Um ID de 16 dígitos usado para identificar a conta para pagamentos associada à configuração de faturamento, por exemplo, "1234-5678-9012-3456". Ele aparece no PDF da fatura como "Número da conta de faturamento".
paymentsProfileId

string

Apenas saída. Um ID de 12 dígitos usado para identificar o perfil para pagamentos associado à configuração de faturamento, por exemplo, "1234-5678-9012". Ele aparece no PDF da fatura como "ID do faturamento".
issueDate

string

Apenas saída. A data de emissão no formato aaaa-mm-dd. Ela aparece no PDF da fatura como "Data de emissão" ou "Data da fatura".
dueDate

string

Apenas saída. A data de vencimento no formato aaaa-mm-dd.
currencyCode

string

Apenas saída. O código da moeda. Todos os custos são retornados nessa moeda. Há suporte a um subconjunto dos códigos de moeda derivados do padrão ISO 4217.
exportChargeSubtotalAmountMicros

string (int64 format)

Apenas saída. O valor subtotal antes do total das cobranças de exportação no nível da fatura, em micros.
exportChargeTaxAmountMicros

string (int64 format)

Apenas saída. A soma dos tributos nas cobranças de exportação no nível da fatura, em micros.
exportChargeTotalAmountMicros

string (int64 format)

Apenas saída. O valor total das cobranças de exportação no nível da fatura, em micros.
subtotalAmountMicros

string (int64 format)

Apenas saída. O valor subtotal preto, em micros. É igual à soma dos valores do subtotal AccountBudgetSummary e de Invoice.adjustments_subtotal_amount_micros.
taxAmountMicros

string (int64 format)

Apenas saída. A soma de todos os tributos na fatura, em micros. Isso equivale à soma dos valores de tributos de AccountBudgetSummary, mais os tributos não associados a um orçamento de conta específico.
totalAmountMicros

string (int64 format)

Apenas saída. O valor total, em micros. Isso é igual à soma de Invoice.subtotal_amount_micros, Invoice.tax_amount_micros, Invoice.regulatory_costs_subtotal_amount_micros e Invoice.export_charge_subtotal_amount_micros (separado em um item de linha separado a partir de V14.1).
correctedInvoice

string

Apenas saída. O nome do recurso da fatura original corrigido, cancelado ou cancelado por esta fatura, se aplicável Se correctedInvoice estiver definido, replacedInvoices não será definido. Os nomes dos recursos das faturas têm o seguinte formato:

customers/{customerId}/invoices/{invoice_id}
pdfUrl

string

Apenas saída. O URL para uma cópia em PDF da fatura. Os usuários precisam transmitir o token OAuth para solicitar o PDF com esse URL.

InvoiceType

Os tipos possíveis de faturas.

Enums
UNSPECIFIED Não especificado.
UNKNOWN Usado apenas para valor de retorno. Representa o valor desconhecido nesta versão.
CREDIT_MEMO Uma fatura com um valor negativo. A conta recebe um crédito.
INVOICE Uma fatura com um valor positivo. A conta deve ter um saldo.

AccountBudgetSummary

Representa um custo faturável do orçamento da conta resumido.

Representação 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)

Apenas saída. O período das atividades faturáveis do orçamento da conta, dentro do período de serviço desta fatura. A data de término é inclusiva. Pode ser diferente do horário de início e término do orçamento da conta.
invalidActivitySummaries[]

object (InvalidActivitySummary)

Apenas saída. A lista de créditos resumidos por atividades inválidas com vinculações originais.
customer

string

Apenas saída. O nome do recurso do cliente associado a esse orçamento da conta. Ele contém o ID de cliente, que aparece no PDF da fatura como "ID da conta". Os nomes dos recursos do cliente têm o formato:

customers/{customerId}
customerDescriptiveName

string

Apenas saída. O nome descritivo do cliente do orçamento da conta. Ela aparece no PDF da fatura como "Conta".
accountBudget

string

Apenas saída. O nome do recurso do orçamento da conta associado a esse custo faturável resumido. Os nomes dos recursos AccountBudget têm o formato:

customers/{customerId}/accountBudgets/{account_budget_id}
accountBudgetName

string

Apenas saída. O nome do orçamento da conta. Ele aparece no PDF da fatura como "Orçamento da conta".
purchaseOrderNumber

string

Apenas saída. O número da ordem de compra do orçamento da conta. Ela aparece no PDF da fatura como "Ordem de compra".
subtotalAmountMicros

string (int64 format)

Apenas saída. O valor subtotal negativo atribuível a este orçamento durante o período de serviço, em micros.
taxAmountMicros

string (int64 format)

Apenas saída. O valor dos tributos atribuíveis ao orçamento durante o período de serviço, em micros.
totalAmountMicros

string (int64 format)

Apenas saída. O valor total atribuível a este orçamento durante o período de serviço, em micros. Isso é igual à soma do valor subtotal do orçamento da conta e do valor dos tributos do orçamento da conta.
servedAmountMicros

string (int64 format)

Apenas saída. O valor negativo de exibição que pode ser atribuído a esse orçamento durante o período de serviço, em micros. Isso é útil apenas para reconciliar dados de faturamento e envio.
billedAmountMicros

string (int64 format)

Apenas saída. O valor faturado faturado que pode ser atribuído a este orçamento durante o período de serviço, em micros. Isso não leva em conta ajustes.
overdeliveryAmountMicros

string (int64 format)

Apenas saída. O valor antes do superfornecimento atribuível a esse orçamento durante o período do serviço, em micros (valor negativo).
invalidActivityAmountMicros

string (int64 format)

Apenas saída. O valor antes da atividade inválida atribuível a este orçamento nos meses anteriores, em micros (valor negativo).

InvalidActivitySummary

Detalhes sobre a atividade inválida da fatura que contêm detalhes adicionais sobre a fatura em que as correções são feitas.

Representação JSON 
{
  "originalMonthOfService": enum (MonthOfYear),
  "originalYearOfService": string,
  "originalInvoiceId": string,
  "originalAccountBudgetName": string,
  "originalPurchaseOrderNumber": string,
  "amountMicros": string
}
Campos
originalMonthOfService

enum (MonthOfYear)

Apenas saída. Mês de serviço original relacionado a esse crédito por atividade inválida.
originalYearOfService

string

Apenas saída. Ano de serviço original relacionado a esse crédito por atividade inválida.
originalInvoiceId

string

Apenas saída. Número da fatura original relacionada a esse crédito por atividade inválida.
originalAccountBudgetName

string

Apenas saída. Nome do orçamento da conta original relacionado a esse crédito por atividade inválida.
originalPurchaseOrderNumber

string

Apenas saída. Número da ordem de compra original relacionada a este crédito por atividade inválida.
amountMicros

string (int64 format)

Apenas saída. Valor de atividade inválido em micros.

AccountSummary

Representa uma visualização resumida no nível da conta.

Representação 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

Apenas saída. A conta associada ao resumo da conta.
billingCorrectionSubtotalAmountMicros

string (int64 format)

Apenas saída. Valor do subtotal da correção de faturamento sem tributos, em micros.
billingCorrectionTaxAmountMicros

string (int64 format)

Apenas saída. Tributo sobre a correção de faturamento, em micros.
billingCorrectionTotalAmountMicros

string (int64 format)

Apenas saída. Valor total de correção do faturamento, em micros.
couponAdjustmentSubtotalAmountMicros

string (int64 format)

Apenas saída. Valor subtotal do ajuste de cupom sem tributos, em micros.
couponAdjustmentTaxAmountMicros

string (int64 format)

Apenas saída. Tributo sobre o ajuste do cupom, em micros.
couponAdjustmentTotalAmountMicros

string (int64 format)

Apenas saída. Valor total de ajuste do cupom, em micros.
excessCreditAdjustmentSubtotalAmountMicros

string (int64 format)

Apenas saída. Valor subtotal do ajuste de crédito excedente sem tributos, em micros.
excessCreditAdjustmentTaxAmountMicros

string (int64 format)

Apenas saída. Tributo sobre ajuste de crédito excedente, em micros.
excessCreditAdjustmentTotalAmountMicros

string (int64 format)

Apenas saída. Valor total de ajuste de crédito excedente, em micros.
regulatoryCostsSubtotalAmountMicros

string (int64 format)

Apenas saída. Valor subtotal dos custos regulamentares sem tributos, em micros.
regulatoryCostsTaxAmountMicros

string (int64 format)

Apenas saída. Tributos sobre custos regulamentares, em micros.
regulatoryCostsTotalAmountMicros

string (int64 format)

Apenas saída. Valor total dos custos regulamentares, em micros.
exportChargeSubtotalAmountMicros

string (int64 format)

Apenas saída. Valor subtotal da cobrança de exportação sem tributos, em micros.
exportChargeTaxAmountMicros

string (int64 format)

Apenas saída. Imposto sobre a taxa de exportação, em micros.
exportChargeTotalAmountMicros

string (int64 format)

Apenas saída. Valor total da cobrança pela exportação, em micros.
subtotalAmountMicros

string (int64 format)

Apenas saída. Valor do subtotal total negativo que pode ser atribuído à conta durante o período do serviço, em micros.
taxAmountMicros

string (int64 format)

Apenas saída. Valor total dos tributos atribuível à conta durante o período do serviço, em micros.
totalAmountMicros

string (int64 format)

Apenas saída. Valor total atribuível à conta durante o período do serviço, em micros. Isso é igual à soma dos subtotalAmountMicros e taxAmountMicros.