Method: customers.invoices.list

Restituisce tutte le fatture associate a una configurazione di fatturazione per un determinato mese.

Elenco degli errori generati: AuthenticationError AuthorizationError FieldError HeaderError InternalError InvoiceError QuotaError RequestError

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
customerId

string

Obbligatorio. L'ID del cliente per cui recuperare le fatture.

Parametri di ricerca

Parametri
billingSetup

string

Obbligatorio. Il nome della risorsa di configurazione della fatturazione delle fatture richieste.

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

string

Obbligatorio. L'anno di emissione per il recupero delle fatture, nel formato aaaa. Possono essere recuperate solo le fatture emesse a partire dal 2019.
issueMonth

enum (MonthOfYear)

Obbligatorio. Il mese di emissione per il recupero delle fatture.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Messaggio di risposta per InvoiceService.ListInvoices.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "invoices": [
    {
      object (Invoice)
    }
  ]
}
Campi
invoices[]

object (Invoice)

L'elenco delle fatture corrispondenti alla configurazione di fatturazione e al periodo di tempo.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.

Fattura

Una fattura. Tutti i dati della fattura vengono convertiti in un'istantanea della fattura in formato PDF. Per le fatture precedenti al lancio di InvoiceService, le informazioni ottenute con un'istantanea potrebbero non corrispondere a quelle della fattura in formato PDF.

Rappresentazione 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
}
Campi
resourceName

string

Solo output. Il nome risorsa della fattura. Più clienti possono condividere una determinata fattura, pertanto più nomi di risorse possono indirizzare alla stessa fattura. I nomi delle risorse di fatturazione hanno il seguente formato:

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

enum (InvoiceType)

Solo output. Il tipo di fattura.
serviceDateRange

object (DateRange)

Solo output. L'intervallo di date del periodo di servizio di questa fattura. La data di fine è inclusa.
adjustmentsSubtotalAmountMicros

string (int64 format)

Solo output. L'importo del subtotale al lordo delle imposte degli aggiustamenti a livello di fattura, in micro.
adjustmentsTaxAmountMicros

string (int64 format)

Solo output. La somma delle imposte relative agli aggiustamenti a livello di fattura in micro.
adjustmentsTotalAmountMicros

string (int64 format)

Solo output. L'importo totale degli aggiustamenti a livello di fattura in micro.
regulatoryCostsSubtotalAmountMicros

string (int64 format)

Solo output. L'importo del subtotale al lordo delle imposte dei costi normativi a livello di fattura, in micro.
regulatoryCostsTaxAmountMicros

string (int64 format)

Solo output. La somma delle imposte sui costi normativi a livello di fattura, in micro.
regulatoryCostsTotalAmountMicros

string (int64 format)

Solo output. L'importo totale dei costi normativi a livello di fattura, in micro.
replacedInvoices[]

string

Solo output. Il nome risorsa delle fatture originali oggetto di rifatturazione o di sostituzione da questa fattura, se applicabile. Potrebbero esserci più fatture sostituite a causa del consolidamento delle fatture. Le fatture sostituite potrebbero non appartenere allo stesso account pagamenti. Se replacedInvoices è impostato, correctedInvoice non verrà impostato. I nomi delle risorse di fatturazione hanno il seguente formato:

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

object (AccountBudgetSummary)

Solo output. L'elenco di informazioni riepilogative sul budget dell'account associate a questa fattura.
accountSummaries[]

object (AccountSummary)

Solo output. L'elenco riepilogativo dei dati dell'account associati a questa fattura.
id

string

Solo output. L'ID della fattura. È visualizzato nel PDF della fattura come "Numero fattura".
billingSetup

string

Solo output. Il nome risorsa della configurazione di fatturazione di questa fattura.

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

string

Solo output. Un ID di 16 cifre utilizzato per identificare l'account pagamenti associato alla configurazione di fatturazione, ad esempio "1234-5678-9012-3456". È visualizzato nel PDF della fattura come "Numero dell'account di fatturazione".
paymentsProfileId

string

Solo output. Un ID di 12 cifre utilizzato per identificare il profilo pagamenti associato alla configurazione di fatturazione, ad esempio "1234-5678-9012". È riportato nel PDF della fattura come "ID fatturazione".
issueDate

string

Solo output. La data di emissione nel formato aaaa-mm-gg. Appare nel PDF della fattura come "Data di emissione" o "Data della fattura".
dueDate

string

Solo output. La data di scadenza nel formato aaaa-mm-gg.
currencyCode

string

Solo output. Il codice valuta. Tutti i costi vengono restituiti in questa valuta. È supportato un sottoinsieme dei codici valuta derivati dallo standard ISO 4217.
exportChargeSubtotalAmountMicros

string (int64 format)

Solo output. L'importo del subtotale al lordo delle imposte delle spese di esportazione a livello di fattura, in micro.
exportChargeTaxAmountMicros

string (int64 format)

Solo output. La somma delle imposte sulle spese di esportazione a livello di fattura in micro.
exportChargeTotalAmountMicros

string (int64 format)

Solo output. L'importo totale delle spese di esportazione a livello di fattura in micro.
subtotalAmountMicros

string (int64 format)

Solo output. L'importo del subtotale al lordo delle tasse, in micro. Corrisponde alla somma dei subtotali AccountBudgetSummary e della Invoice.adjustments_subtotal_amount_micros.
taxAmountMicros

string (int64 format)

Solo output. La somma di tutte le imposte sulla fattura, in micro. che corrisponde alla somma degli importi delle imposte di AccountBudgetSummary, più le imposte non associate a un budget dell'account specifico.
totalAmountMicros

string (int64 format)

Solo output. L'importo totale in micro. che corrisponde alla somma dei valori di Invoice.subtotal_amount_micros, Invoice.tax_amount_micros, Invoice.regulatory_costs_subtotal_amount_micros e Invoice.export_charge_subtotal_amount_micros (che sono separate in una riga separata a partire dalla V14.1).
correctedInvoice

string

Solo output. Il nome risorsa della fattura originale corretto, cancellato o annullato da questa fattura, se applicabile. Se correctedInvoice è impostato, replacedInvoices non verrà impostato. I nomi delle risorse di fatturazione hanno il seguente formato:

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

string

Solo output. L'URL a una copia in formato PDF della fattura. Gli utenti devono trasmettere il proprio token OAuth per richiedere il PDF con questo URL.

InvoiceType

Il tipo di fatture possibile.

Enum
UNSPECIFIED Non specificato.
UNKNOWN Utilizzato solo per il valore restituito. Rappresenta un valore sconosciuto in questa versione.
CREDIT_MEMO Una fattura con importo negativo. L'account riceve un credito.
INVOICE Una fattura con un importo positivo. L'account ha un saldo dovuto.

AccountBudgetSummary

Rappresenta un riepilogo del costo fatturabile del budget dell'account.

Rappresentazione 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
}
Campi
billableActivityDateRange

object (DateRange)

Solo output. L'intervallo di date dell'attività fatturabile del budget dell'account, compreso nell'intervallo di date di servizio di questa fattura. La data di fine è inclusa. Può essere diversa dall'ora di inizio e di fine del budget dell'account.
invalidActivitySummaries[]

object (InvalidActivitySummary)

Solo output. L'elenco riepilogativo dei crediti per le attività non valide con i collegamenti originali.
customer

string

Solo output. Il nome della risorsa del cliente associato a questo budget dell'account. contenente l'ID cliente, visualizzato nel PDF della fattura come "ID account". I nomi delle risorse cliente hanno il seguente formato:

customers/{customerId}
customerDescriptiveName

string

Solo output. Il nome descrittivo del cliente del budget dell'account. È riportato nel PDF della fattura come "Account".
accountBudget

string

Solo output. Il nome della risorsa del budget dell'account associato a questo costo fatturabile riepilogativo. I nomi delle risorse AccountBudget hanno il seguente formato:

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

string

Solo output. Il nome del budget dell'account. Appare nel PDF della fattura come "Budget dell'account".
purchaseOrderNumber

string

Solo output. Il numero dell'ordine di acquisto del budget dell'account. È visualizzato nel PDF della fattura come "Ordine di acquisto".
subtotalAmountMicros

string (int64 format)

Solo output. L'importo subtotale al lordo delle tasse attribuibile a questo budget durante il periodo del servizio, in microsecondi.
taxAmountMicros

string (int64 format)

Solo output. L'importo delle imposte attribuibile a questo budget durante il periodo di servizio, in microsecondi.
totalAmountMicros

string (int64 format)

Solo output. L'importo totale attribuibile a questo budget durante il periodo di servizio, in microsecondi. che corrisponde alla somma del subtotale del budget dell'account e dell'importo delle imposte sul budget dell'account.
servedAmountMicros

string (int64 format)

Solo output. L'importo al lordo delle tasse pubblicato attribuibile a questo budget durante il periodo di servizio, in microsecondi. Questa opzione è utile solo per riconciliare i dati di fatturazione e di recapito.
billedAmountMicros

string (int64 format)

Solo output. L'importo fatturato al lordo delle tasse attribuibile a questo budget durante il periodo di servizio, in microsecondi. Non vengono presi in considerazione eventuali aggiustamenti.
overdeliveryAmountMicros

string (int64 format)

Solo output. L'importo della sovrapubblicazione al lordo delle tasse attribuibile a questo budget durante il periodo di servizio, in micro (valore negativo).
invalidActivityAmountMicros

string (int64 format)

Solo output. L'importo al lordo delle tasse di attività non valide attribuibile a questo budget nei mesi precedenti, in micro (valore negativo).

InvalidActivitySummary

Dettagli sulle attività non valide per la fattura, contenenti ulteriori dettagli sulla fattura in base alla quale vengono apportate correzioni.

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

enum (MonthOfYear)

Solo output. Mese originale del servizio correlato a questo credito per attività non valide.
originalYearOfService

string

Solo output. Anno originale del servizio correlato a questo credito per attività non valide.
originalInvoiceId

string

Solo output. Numero della fattura originale relativo a questo credito per attività non valide.
originalAccountBudgetName

string

Solo output. Nome del budget dell'account originale correlato a questo credito per attività non valide.
originalPurchaseOrderNumber

string

Solo output. Numero dell'ordine di acquisto originale relativo a questo credito per attività non valide.
amountMicros

string (int64 format)

Solo output. Quantità di attività non valide in micro.

AccountSummary

Rappresenta una vista di riepilogo a livello di account.

Rappresentazione 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
}
Campi
customer

string

Solo output. L'account associato al riepilogo dell'account.
billingCorrectionSubtotalAmountMicros

string (int64 format)

Solo output. Importo subtotale della correzione della fatturazione al lordo delle imposte, in micro.
billingCorrectionTaxAmountMicros

string (int64 format)

Solo output. Imposta sulla correzione della fatturazione in micro.
billingCorrectionTotalAmountMicros

string (int64 format)

Solo output. Importo totale della correzione della fatturazione, in micro.
couponAdjustmentSubtotalAmountMicros

string (int64 format)

Solo output. Importo parziale parziale di aggiustamento coupon al lordo delle imposte, in micro.
couponAdjustmentTaxAmountMicros

string (int64 format)

Solo output. Imposta sull'aggiustamento dei coupon in micro.
couponAdjustmentTotalAmountMicros

string (int64 format)

Solo output. Importo totale aggiustamento coupon, in micro.
excessCreditAdjustmentSubtotalAmountMicros

string (int64 format)

Solo output. Subtotale dell'aggiustamento del credito in eccesso al lordo delle tasse, in micro.
excessCreditAdjustmentTaxAmountMicros

string (int64 format)

Solo output. Imposta sull'aggiustamento a credito in eccesso, in micro.
excessCreditAdjustmentTotalAmountMicros

string (int64 format)

Solo output. Importo totale dell'aggiustamento del credito in eccesso, in micro.
regulatoryCostsSubtotalAmountMicros

string (int64 format)

Solo output. Subtotale dei costi normativi al lordo delle tasse, in micro.
regulatoryCostsTaxAmountMicros

string (int64 format)

Solo output. Imposta sui costi normativi, in micro.
regulatoryCostsTotalAmountMicros

string (int64 format)

Solo output. Importo totale dei costi normativi, in micro.
exportChargeSubtotalAmountMicros

string (int64 format)

Solo output. Importo parziale parziale della spesa di esportazione al lordo delle tasse, in micro.
exportChargeTaxAmountMicros

string (int64 format)

Solo output. Imposta sulla spesa di esportazione, in micro.
exportChargeTotalAmountMicros

string (int64 format)

Solo output. Importo totale delle spese di esportazione, in micro.
subtotalAmountMicros

string (int64 format)

Solo output. Importo parziale totale al lordo delle tasse attribuibile all'account durante il periodo del servizio, in microsecondi.
taxAmountMicros

string (int64 format)

Solo output. Importo totale delle imposte attribuibile all'account durante il periodo di servizio, in microsecondi.
totalAmountMicros

string (int64 format)

Solo output. Importo totale attribuibile all'account durante il periodo del servizio, in microsecondi. Corrisponde alla somma dei subtotalAmountMicros e taxAmountMicros.