Method: advertisers.invoices.list

Elenca le fatture registrate per un inserzionista in un determinato mese.

Le fatture generate dai profili di fatturazione con un livello di fattura "Partner" non sono recuperabili con questo metodo.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
advertiserId

string (int64 format)

Obbligatorio. L'ID dell'inserzionista per cui elencare le fatture.

Parametri di query

Parametri
issueMonth

string

Il mese per cui elencare le fatture. Se non viene impostato, la richiesta recupererà le fatture del mese precedente.

Deve essere nel formato AAAAMM.
loiSapinInvoiceType

enum (LoiSapinInvoiceType)

Seleziona il tipo di fattura da recuperare per gli inserzionisti della legge Sapin.

Valido solo per gli inserzionisti Loi Sapin. Altrimenti, verrà ignorato.
pageSize

integer

Dimensioni della pagina richiesta. Il valore deve essere compreso tra 1 e 200. Se non specificato, il valore predefinito è 100. Restituisce il codice di errore INVALID_ARGUMENT se viene specificato un valore non valido.
pageToken

string

Un token che identifica una pagina di risultati che il server deve restituire. In genere, questo è il valore di nextPageToken restituito dalla chiamata precedente al metodo invoices.list. Se non specificato, verrà restituita la prima pagina dei risultati.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

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

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

object (Invoice)

L'elenco delle fatture.

Questo elenco non sarà presente se è vuoto.
nextPageToken

string

Un token per recuperare la pagina successiva dei risultati. Passa questo valore nel campo pageToken nella chiamata successiva al metodo invoices.list per recuperare la pagina successiva dei risultati.

Questo token non sarà presente se non ci sono altri invoices da restituire.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/display-video
  • https://www.googleapis.com/auth/display-video-mediaplanning

Per ulteriori informazioni, consulta la OAuth 2.0 Overview.

LoiSapinInvoiceType

Possibili tipi di fatture per gli inserzionisti conformi alla legge Sapin.

Enum
LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED Il valore non è specificato.
LOI_SAPIN_INVOICE_TYPE_MEDIA Fatture con costo dei media.
LOI_SAPIN_INVOICE_TYPE_PLATFORM Fatture con commissione per la piattaforma.

Fattura

Una sola fattura.

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

string

Il nome della risorsa della fattura.
invoiceId

string

L'ID univoco della fattura.
displayName

string

Il nome visualizzato della fattura.
paymentsProfileId

string

L'ID del profilo pagamenti a cui appartiene la fattura.

Viene visualizzato nel PDF della fattura come Billing ID.
paymentsAccountId

string

L'ID dell'account pagamenti a cui appartiene la fattura.

Viene visualizzato nel PDF della fattura come Billing Account Number.
issueDate

object (Date)

La data di emissione della fattura.
dueDate

object (Date)

La data di scadenza della fattura.
serviceDateRange

object (DateRange)

Le date di inizio e di fine del servizio coperte da questa fattura.
currencyCode

string

La valuta utilizzata nella fattura in formato ISO 4217.
subtotalAmountMicros

string (int64 format)

L'importo del totale parziale al lordo delle imposte, in micro della valuta della fattura.

Ad esempio, se currencyCode è USD, 1000000 rappresenta un dollaro statunitense.
totalTaxAmountMicros

string (int64 format)

La somma di tutte le imposte nella fattura, in micro della valuta della fattura.

Ad esempio, se currencyCode è USD, 1000000 rappresenta un dollaro statunitense.
totalAmountMicros

string (int64 format)

L'importo totale della fattura, in micro della valuta della fattura.

Ad esempio, se currencyCode è USD, 1000000 rappresenta un dollaro statunitense.
purchaseOrderNumber

string

Numero dell'ordine di acquisto associato alla fattura.
budgetInvoiceGroupingId

string

L'ID di raggruppamento del budget per questa fattura.

Questo campo verrà impostato solo se il livello fattura del profilo di fatturazione corrispondente è stato impostato su "ID di raggruppamento delle fatture del budget".
invoiceType

enum (InvoiceType)

Il tipo di documento della fattura.
correctedInvoiceId

string

L'ID della fattura originale che viene modificata da questa fattura, se applicabile.

Potrebbe essere visualizzato nel PDF della fattura come Reference invoice number.

Se replacedInvoiceIds è impostato, questo campo sarà vuoto.
replacedInvoiceIds[]

string

L'ID o gli ID di eventuali fatture emesse originariamente che vengono annullate da questa fattura, se applicabile. Potrebbero essere elencate più fatture se queste vengono consolidate in un'unica fattura.

Potrebbe essere visualizzato nel PDF della fattura come Replaced invoice numbers.

Se correctedInvoiceId è impostato, questo campo sarà vuoto.
pdfUrl

string

L'URL per scaricare una copia in PDF della fattura.

Questo URL è specifico per l'utente e richiede un token di accesso OAuth 2.0 valido per l'accesso. Il token di accesso deve essere fornito in un'intestazione HTTP Authorization: Bearer ed essere autorizzato per uno dei seguenti ambiti:

  • https://www.googleapis.com/auth/display-video-mediaplanning
  • https://www.googleapis.com/auth/display-video

L'URL sarà valido per 7 giorni dopo il recupero di questo oggetto fattura o fino a quando la fattura non verrà recuperata di nuovo.
budgetSummaries[]

object (BudgetSummary)

L'elenco delle informazioni riepilogative per ogni budget associato a questa fattura.

Questo campo verrà impostato solo se il livello di dettaglio della fattura del profilo di fatturazione corrispondente è stato impostato su "Ordine di acquisto a livello di budget".
nonBudgetMicros

string (int64 format)

L'importo totale dei costi o degli aggiustamenti non collegati a un budget specifico, in micro della valuta della fattura.

Ad esempio, se currencyCode è USD, 1000000 rappresenta un dollaro statunitense.

InvoiceType

Tipi di fatture possibili.

Enum
INVOICE_TYPE_UNSPECIFIED Non specificato o sconosciuto in questa versione.
INVOICE_TYPE_CREDIT La fattura ha un importo negativo.
INVOICE_TYPE_INVOICE La fattura ha un importo positivo.

BudgetSummary

Informazioni riepilogative di un singolo budget della campagna.

Rappresentazione JSON 
{
  "externalBudgetId": string,
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "preTaxAmountMicros": string,
  "taxAmountMicros": string,
  "totalAmountMicros": string
}
Campi
externalBudgetId

string

Corrisponde a externalBudgetId del budget di una campagna. Se il valore non è impostato nel budget della campagna, questo campo sarà vuoto.
prismaCpeCode

object (PrismaCpeCode)

Codici cliente, prodotto e stima pertinenti dello strumento Mediaocean Prisma.

Valido solo per i budget delle campagne con un externalBudgetSource di EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN.
preTaxAmountMicros

string (int64 format)

La somma degli addebiti effettuati in base a questo budget prima delle imposte, in micro della valuta della fattura.

Ad esempio, se currencyCode è USD, 1000000 rappresenta un dollaro statunitense.
taxAmountMicros

string (int64 format)

L'importo della tassa applicata agli addebiti nell'ambito di questo budget, in micro della valuta della fattura.

Ad esempio, se currencyCode è USD, 1000000 rappresenta un dollaro statunitense.
totalAmountMicros

string (int64 format)

La somma totale degli addebiti effettuati nell'ambito di questo budget, incluse le tasse, in micro della valuta della fattura.

Ad esempio, se currencyCode è USD, 1000000 rappresenta un dollaro statunitense.