Method: customers.invoices.list

Renvoie toutes les factures associées à une configuration de facturation pour un mois donné.

Liste des erreurs générées: AuthenticationError AuthorizationError FieldError HeaderError InternalError InvoiceError QuotaError RequestError

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
customerId

string

Obligatoire. Numéro du client pour lequel extraire les factures.

Paramètres de requête

Paramètres
billingSetup

string

Obligatoire. Nom de la ressource de configuration de facturation des factures demandées.

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

string

Obligatoire. Année d'émission pour récupérer les factures, au format aaaa. Seules les factures émises en 2019 ou à une date ultérieure peuvent être récupérées.
issueMonth

enum (MonthOfYear)

Obligatoire. Mois d'émission pour récupérer les factures.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Message de réponse pour InvoiceService.ListInvoices.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "invoices": [
    {
      object (Invoice)
    }
  ]
}
Champs
invoices[]

object (Invoice)

Liste des factures correspondant à la configuration de facturation et à la période.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez la présentation d'OAuth 2.0.

Facture

Une facture Toutes les informations de facturation sont capturées pour correspondre à la facture PDF. Pour les factures antérieures au lancement de InvoiceService, les informations instantanées peuvent ne pas correspondre à la facture PDF.

Représentation 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
}
Champs
resourceName

string

Uniquement en sortie. Nom de ressource de la facture. Plusieurs clients peuvent partager une facture donnée. Par conséquent, plusieurs noms de ressources peuvent correspondre à la même facture. Le nom des ressources de facturation se présente sous la forme suivante:

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

enum (InvoiceType)

Uniquement en sortie. Type de facture.
serviceDateRange

object (DateRange)

Uniquement en sortie. Période de service de cette facture. La date de fin est inclusive.
adjustmentsSubtotalAmountMicros

string (int64 format)

Uniquement en sortie. Montant du sous-total avant taxes des ajustements au niveau de la facture, en micros.
adjustmentsTaxAmountMicros

string (int64 format)

Uniquement en sortie. Somme des taxes sur les ajustements au niveau de la facture, en micros.
adjustmentsTotalAmountMicros

string (int64 format)

Uniquement en sortie. Montant total des ajustements au niveau de la facture, en micros.
regulatoryCostsSubtotalAmountMicros

string (int64 format)

Uniquement en sortie. Montant sous-total avant taxes des coûts réglementaires au niveau de la facture, en micro-unités.
regulatoryCostsTaxAmountMicros

string (int64 format)

Uniquement en sortie. Somme des taxes sur les coûts réglementaires au niveau de la facture, en micro-unités.
regulatoryCostsTotalAmountMicros

string (int64 format)

Uniquement en sortie. Montant total des coûts réglementaires au niveau de la facture, en micro-unités.
replacedInvoices[]

string

Uniquement en sortie. Nom de ressource de la ou des factures d'origine qui font l'objet d'une refacturation ou de leur remplacement par cette facture, le cas échéant. Plusieurs factures peuvent être remplacées en raison du regroupement des factures. Il est possible que les factures remplacées n'appartiennent pas au même compte de paiement. Si replacedInvoices est défini, correctedInvoice ne sera pas défini. Le nom des ressources de facturation se présente sous la forme suivante:

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

object (AccountBudgetSummary)

Uniquement en sortie. Liste des informations budgétaires du compte associées à cette facture.
accountSummaries[]

object (AccountSummary)

Uniquement en sortie. Liste des informations de compte récapitulatives associées à cette facture.
id

string

Uniquement en sortie. Identifiant de la facture. Il apparaît sur le PDF de la facture avec la mention "Numéro de facture".
billingSetup

string

Uniquement en sortie. Nom de ressource de la configuration de facturation de cette facture.

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

string

Uniquement en sortie. Identifiant à 16 chiffres permettant d'identifier le compte de paiement associé à la configuration de la facturation (par exemple, "1234-5678-9012-3456"). Il apparaît sur le PDF de la facture avec la mention "Numéro de compte de facturation".
paymentsProfileId

string

Uniquement en sortie. Identifiant à 12 chiffres permettant d'identifier le profil de paiement associé à la configuration de la facturation (par exemple, "1234-5678-9012"). Il apparaît sur le PDF de la facture avec la mention "N° compte facturation".
issueDate

string

Uniquement en sortie. Date d'émission au format aaaa-mm-jj. Sur le PDF de la facture, il apparaît sous la forme "Date d'émission" ou "Date de facture".
dueDate

string

Uniquement en sortie. Date limite au format aaaa-mm-jj.
currencyCode

string

Uniquement en sortie. Code de la devise. Tous les coûts sont renvoyés dans cette devise. Un sous-ensemble des codes de devise issus de la norme ISO 4217 est accepté.
exportChargeSubtotalAmountMicros

string (int64 format)

Uniquement en sortie. Montant du sous-total avant taxes des frais d'exportation au niveau de la facture, en micros.
exportChargeTaxAmountMicros

string (int64 format)

Uniquement en sortie. Somme des taxes au niveau de la facture, en micro-unités.
exportChargeTotalAmountMicros

string (int64 format)

Uniquement en sortie. Montant total des frais d'exportation au niveau de la facture, en micros.
subtotalAmountMicros

string (int64 format)

Uniquement en sortie. Montant du sous-total avant taxes, en micros. Cela correspond à la somme des sous-totaux de AccountBudgetSummary et de Invoice.adjustments_subtotal_amount_micros.
taxAmountMicros

string (int64 format)

Uniquement en sortie. Somme de toutes les taxes sur la facture, en micros. Cela correspond à la somme des taxes AccountBudgetSummary, plus les taxes non associées à un budget de compte spécifique.
totalAmountMicros

string (int64 format)

Uniquement en sortie. Montant total, en micros. Cela correspond à la somme de Invoice.subtotal_amount_micros, Invoice.tax_amount_micros, Invoice.regulatory_costs_subtotal_amount_micros et de la facture.export_charge_subtotal_amount_micros (qui sont séparées dans une ligne distincte commençant par la version 14.1).
correctedInvoice

string

Uniquement en sortie. Nom de la ressource de la facture d'origine corrigée, annulée ou annulée par cette facture, le cas échéant. Si correctedInvoice est défini, replacedInvoices ne sera pas défini. Le nom des ressources de facturation se présente sous la forme suivante:

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

string

Uniquement en sortie. URL d'une copie de la facture au format PDF. Les utilisateurs doivent transmettre leur jeton OAuth pour demander le PDF avec cette URL.

InvoiceType

Types de factures possibles.

Enums
UNSPECIFIED Non spécifié.
UNKNOWN Utilisé pour la valeur renvoyée uniquement. Représente une valeur inconnue dans cette version.
CREDIT_MEMO Facture avec un montant négatif Le compte reçoit un avoir.
INVOICE Une facture dont le montant est positif Le compte doit être débiteur.

AccountBudgetSummary

Représente le coût facturable résumé du budget de compte.

Représentation 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
}
Champs
billableActivityDateRange

object (DateRange)

Uniquement en sortie. Plage de dates de l'activité facturable du budget du compte, dans la plage de dates de service de cette facture. La date de fin est inclusive. Elles peuvent être différentes des heures de début et de fin du budget de compte.
invalidActivitySummaries[]

object (InvalidActivitySummary)

Uniquement en sortie. Liste des avoirs pour activité incorrecte résumés avec les associations d'origine.
customer

string

Uniquement en sortie. Nom de la ressource du client associé au budget de ce compte. Il contient le numéro client, qui apparaît sur le PDF de la facture sous la forme "ID du compte". Le nom des ressources client se présente sous la forme suivante:

customers/{customerId}
customerDescriptiveName

string

Uniquement en sortie. Nom descriptif du client du budget de compte. Il apparaît sur le PDF de la facture avec la mention "Compte".
accountBudget

string

Uniquement en sortie. Nom de ressource du budget du compte associé à ce coût facturable résumé. Le nom des ressources AccountBudget se présente sous la forme suivante:

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

string

Uniquement en sortie. Nom du budget du compte. Il apparaît sur le fichier PDF de la facture avec la mention "Budget du compte".
purchaseOrderNumber

string

Uniquement en sortie. Numéro de bon de commande associé au budget du compte. Il apparaît sur le PDF de la facture avec la mention "Bon de commande".
subtotalAmountMicros

string (int64 format)

Uniquement en sortie. Montant du sous-total avant taxes attribuable à ce budget pendant la période de service, en micros.
taxAmountMicros

string (int64 format)

Uniquement en sortie. Montant des taxes attribuables à ce budget pendant la période de service, en micros.
totalAmountMicros

string (int64 format)

Uniquement en sortie. Montant total attribuable à ce budget pendant la période de service, en micros. Cela correspond à la somme du sous-total du budget du compte et du montant de la taxe sur ce budget.
servedAmountMicros

string (int64 format)

Uniquement en sortie. Montant de la diffusion avant taxes qui peut être attribué à ce budget pendant la période de service, en micro-unités. Cette opération sert uniquement à rapprocher les données de facturation et de livraison.
billedAmountMicros

string (int64 format)

Uniquement en sortie. Montant hors taxes facturé pour ce budget pendant la période de service, en micros. Cela ne tient pas compte des ajustements.
overdeliveryAmountMicros

string (int64 format)

Uniquement en sortie. Montant des impressions excessives hors taxes qui peut être attribué à ce budget pendant la période de service, en micro-unités (valeur négative).
invalidActivityAmountMicros

string (int64 format)

Uniquement en sortie. Montant de l'activité incorrecte hors taxes qui peut être attribué à ce budget au cours des mois précédents, en micros (valeur négative).

InvalidActivitySummary

Détails concernant l'activité incorrecte sur la facture, incluant des détails supplémentaires sur la facture pour laquelle des corrections ont été apportées.

Représentation JSON 
{
  "originalMonthOfService": enum (MonthOfYear),
  "originalYearOfService": string,
  "originalInvoiceId": string,
  "originalAccountBudgetName": string,
  "originalPurchaseOrderNumber": string,
  "amountMicros": string
}
Champs
originalMonthOfService

enum (MonthOfYear)

Uniquement en sortie. Mois d'origine du service lié à cet avoir pour activité incorrecte.
originalYearOfService

string

Uniquement en sortie. Année d'origine du service pour activité incorrecte.
originalInvoiceId

string

Uniquement en sortie. Numéro de la facture d'origine associée à cet avoir pour activité incorrecte.
originalAccountBudgetName

string

Uniquement en sortie. Nom du budget d'origine du compte associé à cet avoir pour activité incorrecte.
originalPurchaseOrderNumber

string

Uniquement en sortie. Numéro de bon de commande d'origine lié à cet avoir pour activité incorrecte.
amountMicros

string (int64 format)

Uniquement en sortie. Montant de l'activité incorrecte en micros.

AccountSummary

Représente une vue récapitulative au niveau du compte.

Représentation 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
}
Champs
customer

string

Uniquement en sortie. Compte associé au récapitulatif du compte.
billingCorrectionSubtotalAmountMicros

string (int64 format)

Uniquement en sortie. Montant du sous-total de la correction avant taxes, en micros.
billingCorrectionTaxAmountMicros

string (int64 format)

Uniquement en sortie. Taxe sur la correction de la facturation, en micros.
billingCorrectionTotalAmountMicros

string (int64 format)

Uniquement en sortie. Montant total de la correction de facturation, en micros.
couponAdjustmentSubtotalAmountMicros

string (int64 format)

Uniquement en sortie. Montant du sous-total de l'ajustement du bon de réduction avant taxes, en micros.
couponAdjustmentTaxAmountMicros

string (int64 format)

Uniquement en sortie. Taxe sur l'ajustement des bons de réduction, en micros.
couponAdjustmentTotalAmountMicros

string (int64 format)

Uniquement en sortie. Montant total de l'ajustement du bon de réduction, en micros.
excessCreditAdjustmentSubtotalAmountMicros

string (int64 format)

Uniquement en sortie. Montant du sous-total de l'ajustement de crédit excédentaire avant taxes, en micros.
excessCreditAdjustmentTaxAmountMicros

string (int64 format)

Uniquement en sortie. Taxe sur l'ajustement de crédit excédentaire, en micros.
excessCreditAdjustmentTotalAmountMicros

string (int64 format)

Uniquement en sortie. Montant total de l'ajustement de crédit excédentaire, en micros.
regulatoryCostsSubtotalAmountMicros

string (int64 format)

Uniquement en sortie. Montant du sous-total des coûts réglementaires avant taxes, en micro-unités.
regulatoryCostsTaxAmountMicros

string (int64 format)

Uniquement en sortie. Taxe sur les coûts réglementaires, en micro-unités.
regulatoryCostsTotalAmountMicros

string (int64 format)

Uniquement en sortie. Montant total des coûts réglementaires, en micro-unités.
exportChargeSubtotalAmountMicros

string (int64 format)

Uniquement en sortie. Montant du sous-total des frais d'exportation avant taxes, en micros.
exportChargeTaxAmountMicros

string (int64 format)

Uniquement en sortie. Taxe sur les frais d'exportation, en micros.
exportChargeTotalAmountMicros

string (int64 format)

Uniquement en sortie. Montant total des frais d'exportation, en micros.
subtotalAmountMicros

string (int64 format)

Uniquement en sortie. Montant total du sous-total avant taxes attribuable au compte pendant la période de service, en micros.
taxAmountMicros

string (int64 format)

Uniquement en sortie. Montant total des taxes attribuables au compte pendant la période de service, en micros.
totalAmountMicros

string (int64 format)

Uniquement en sortie. Montant total attribuable au compte pendant la période de service, en micros. Cela correspond à la somme des sous-totalAmountMicros et taxAmountMicros.