Method: customers.invoices.list

מחזירה את כל החשבוניות שמשויכות להגדרת חיוב מסוימת, עבור חודש נתון.

רשימת שגיאות שקרו: AuthenticationError AuthorizationError FieldError HeaderError InternalError InvoiceError QuotaError RequestError

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
customerId

string

חובה. המזהה של הלקוח שבשבילו צריך לאחזר את החשבוניות.

פרמטרים של שאילתה

פרמטרים
billingSetup

string

חובה. שם המשאב של הגדרת החיוב בחשבוניות המבוקשות.

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

string

חובה. שנת ההנפקה לאחזור החשבוניות, בפורמט yyyy. אפשר לאחזר רק חשבוניות שהונפקו בשנת 2019 ואילך.
issueMonth

enum (MonthOfYear)

חובה. החודש שבו הונפק לאחזור חשבוניות.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

הודעת תשובה לגבי InvoiceService.ListInvoices.

אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "invoices": [
    {
      object (Invoice)
    }
  ]
}
שדות
invoices[]

object (Invoice)

רשימת החשבוניות שתואמות להגדרת החיוב ולתקופת הזמן.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

למידע נוסף, עיינו בסקירה הכללית על OAuth 2.0.

חשבונית

חשבונית. כל פרטי החשבונית נשמרים בתמונת מצב, בהתאם לחשבונית ה-PDF. בחשבוניות שהונפקו לפני השקת InvoiceService, ייתכן שהנתונים המצולמים לא יהיו זהים לאלו שבחשבונית ה-PDF.

ייצוג 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
}
שדות
resourceName

string

פלט בלבד. שם המשאב של החשבונית. כמה לקוחות יכולים לחלוק חשבונית נתונה, כך ששמות מרובים של משאבים יכולים להפנות לאותה חשבונית. הפורמט של שמות משאבי החשבוניות הוא:

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

enum (InvoiceType)

פלט בלבד. סוג החשבונית.
serviceDateRange

object (DateRange)

פלט בלבד. טווח התאריכים של תקופת השירות בחשבונית הזו. תאריך הסיום כולל.
adjustmentsSubtotalAmountMicros

string (int64 format)

פלט בלבד. סכום הביניים לפני מס של ההתאמות ברמת החשבונית, במיליוניות השנייה.
adjustmentsTaxAmountMicros

string (int64 format)

פלט בלבד. סכום המיסים בהתאמות ברמת החשבונית, במיליוניות השנייה.
adjustmentsTotalAmountMicros

string (int64 format)

פלט בלבד. הסכום הכולל של ההתאמות ברמת החשבונית, במיליוניות השנייה.
regulatoryCostsSubtotalAmountMicros

string (int64 format)

פלט בלבד. סכום הביניים לפני מס של עלויות רגולטוריות ברמת החשבונית, במיליוניות השנייה.
regulatoryCostsTaxAmountMicros

string (int64 format)

פלט בלבד. סכום המיסים שחל על העלויות הרגולטוריות ברמת החשבונית, במיליוניות השנייה.
regulatoryCostsTotalAmountMicros

string (int64 format)

פלט בלבד. הסכום הכולל של עלויות רגולטוריות ברמת החשבונית, במיליוניות השנייה.
replacedInvoices[]

string

פלט בלבד. שם המשאב של החשבוניות המקוריות לחיוב או להחלפה בחשבונית הזו, אם רלוונטי. יכול להיות שיש כמה חשבוניות שהוחלפו בגלל איחוד החשבוניות. יכול להיות שהחשבוניות המוחלפות לא שייכות לאותו חשבון תשלומים. אם המדיניות replacedInvoices מוגדרת, correctedInvoice לא תוגדר. הפורמט של שמות משאבי החשבוניות הוא:

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

object (AccountBudgetSummary)

פלט בלבד. רשימה של סיכום פרטי תקציב החשבון המשויכים לחשבונית זו.
accountSummaries[]

object (AccountSummary)

פלט בלבד. רשימה של סיכום פרטי החשבון המשויכים לחשבונית זו.
id

string

פלט בלבד. המזהה של החשבונית. המספר מופיע כ "מספר חשבונית" בקובץ ה-PDF של החשבונית.
billingSetup

string

פלט בלבד. שם המשאב של הגדרת החיוב בחשבונית הזו.

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

string

פלט בלבד. מזהה בן 16 ספרות המשמש לזיהוי חשבון התשלומים המשויך להגדרת החיוב, לדוגמה: '1234-5678-9012-3456'. המספר מופיע בקובץ ה-PDF של החשבונית בתור 'מספר חשבון לחיוב'.
paymentsProfileId

string

פלט בלבד. מזהה בן 12 ספרות המשמש לזיהוי פרופיל התשלומים המשויך להגדרת החיוב, לדוגמה: '1234-5678-9012'. המספר מופיע בקובץ ה-PDF של החשבונית בתור "מזהה חיוב".
issueDate

string

פלט בלבד. תאריך ההנפקה בפורמט yyyy-mm-dd. השם מופיע בקובץ ה-PDF של החשבונית בתור 'תאריך הנפקה' או 'תאריך החשבונית'.
dueDate

string

פלט בלבד. תאריך היעד בפורמט yyyy-mm-dd.
currencyCode

string

פלט בלבד. קוד המטבע. כל העלויות מוחזרות במטבע הזה. יש תמיכה בקבוצת משנה של קודי מטבע שנגזרים מתקן ISO 4217.
exportChargeSubtotalAmountMicros

string (int64 format)

פלט בלבד. סכום הביניים לפני מס של חיובים על ייצוא ברמת החשבונית, במיליוניות השנייה.
exportChargeTaxAmountMicros

string (int64 format)

פלט בלבד. סכום המיסים בחיובים על הייצוא ברמת החשבונית, במיליוניות השנייה.
exportChargeTotalAmountMicros

string (int64 format)

פלט בלבד. הסכום הכולל של חיובים על ייצוא ברמת החשבונית, במיליוניות השנייה.
subtotalAmountMicros

string (int64 format)

פלט בלבד. סכום הביניים לפני מס, במיליוניות השנייה. סכום זה שווה לסך הסכומים של סיכום הביניים של AccountBudgetSummary ו-Invoice.adjustments_subtotal_amount_micros.
taxAmountMicros

string (int64 format)

פלט בלבד. סכום כל המיסים בחשבונית, במיליוניות השנייה. הוא שווה לסיכום סכומי המס של AccountBudgetSummary, בתוספת המיסים שלא משויכים לתקציב חשבון ספציפי.
totalAmountMicros

string (int64 format)

פלט בלבד. הסכום הכולל, במיליוניות השנייה. הוא שווה לסכום של Invoice.subtotal_amount_micros, Invoice.tax_amount_micros, Invoice.regulatory_costs_subtotal_amount_micros ו-Invoice.export_charge_subtotal_amount_micros (שמופרד לפריט נפרד, שמתחיל ב-V14.1).
correctedInvoice

string

פלט בלבד. שם המשאב של החשבונית המקורית שתוקן, נמחק או בוטל על ידי החשבונית הזו, אם רלוונטי. אם המדיניות correctedInvoice מוגדרת, replacedInvoices לא תוגדר. הפורמט של שמות משאבי החשבוניות הוא:

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

string

פלט בלבד. כתובת ה-URL של עותק ה-PDF של החשבונית. המשתמשים צריכים להעביר את אסימון ה-OAuth שלהם כדי לבקש את קובץ ה-PDF עם כתובת ה-URL הזו.

InvoiceType

הסוג האפשרי של החשבוניות.

טיפוסים בני מנייה (enums)
UNSPECIFIED לא צוין.
UNKNOWN משמש לציון הערך המוחזר בלבד. מייצג ערך לא ידוע בגרסה הזו.
CREDIT_MEMO חשבונית עם סכום שלילי. החשבון מקבל זיכוי.
INVOICE חשבונית עם סכום חיובי. יש יתרה בחשבון.

AccountBudgetSummary

מייצג סיכום של עלות לחיוב על תקציב חשבון.

ייצוג 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
}
שדות
billableActivityDateRange

object (DateRange)

פלט בלבד. טווח התאריכים של הפעילות לחיוב בתקציב החשבון, בטווח התאריכים של השירות בחשבונית הזו. תאריך הסיום כולל. הן יכולות להיות שונות משעת ההתחלה והסיום של תקציב החשבון.
invalidActivitySummaries[]

object (InvalidActivitySummary)

פלט בלבד. רשימה של סיכום זיכויים על פעילות לא חוקית עם הקישורים המקוריים.
customer

string

פלט בלבד. שם המשאב של הלקוח שמשויך לתקציב החשבון הזה. כאן יופיע מספר הלקוח, שמופיע בקובץ ה-PDF של החשבונית בתור "מספר חשבון". השמות של משאבי הלקוחות הם בפורמט הבא:

customers/{customerId}
customerDescriptiveName

string

פלט בלבד. השם התיאורי של הלקוח שמגדיר את תקציב החשבון. השם מופיע בתור "חשבון" בקובץ ה-PDF של החשבונית.
accountBudget

string

פלט בלבד. שם המשאב של תקציב החשבון שמשויך לעלות המסוכמת הזו לחיוב. שמות המשאבים של AccountBudget נוצרים בצורה הבאה:

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

string

פלט בלבד. השם של תקציב החשבון. התקציב מופיע בקובץ ה-PDF של החשבונית בתור "תקציב החשבון".
purchaseOrderNumber

string

פלט בלבד. מספר הזמנת הרכש בתקציב החשבון. השם הזה יופיע בקובץ ה-PDF של החשבונית בתור 'הזמנת רכש'.
subtotalAmountMicros

string (int64 format)

פלט בלבד. סכום הביניים לפני מס שאפשר לשייך לתקציב הזה במהלך תקופת השירות, במיליוניות השנייה.
taxAmountMicros

string (int64 format)

פלט בלבד. סכום המס שניתן לשייך לתקציב הזה במהלך תקופת השירות, במיליוניות השנייה.
totalAmountMicros

string (int64 format)

פלט בלבד. הסכום הכולל שניתן לשייך לתקציב הזה במהלך תקופת השירות, במיליוניות השנייה. זהו הסכום של סכום הביניים של תקציב החשבון וסכום המס של תקציב החשבון.
servedAmountMicros

string (int64 format)

פלט בלבד. סכום ההצגה לפני מס שניתן לשייך לתקציב הזה במהלך תקופת השירות, במיליוניות השנייה. הדבר שימושי רק להתאמת נתוני חשבוניות ומשלוחים.
billedAmountMicros

string (int64 format)

פלט בלבד. סכום החיוב לפני מס שאפשר לשייך לתקציב הזה במהלך תקופת השירות, במיליוניות השנייה. ההתאמות האלה לא נלקחות בחשבון.
overdeliveryAmountMicros

string (int64 format)

פלט בלבד. סכום הצגת יתר של מודעות לפני מס שניתן לשייך לתקציב הזה במהלך תקופת השירות, במיליוניות (ערך שלילי).
invalidActivityAmountMicros

string (int64 format)

פלט בלבד. סכום הפעילות הלא חוקית לפני מס שאפשר לשייך לתקציב הזה בחודשים הקודמים, במיליוניות (ערך שלילי).

InvalidActivitySummary

פרטים על הפעילות הלא חוקית בחשבונית, שכוללים פרטים נוספים על החשבונית שלגביה מתבצעים התיקונים.

ייצוג JSON 
{
  "originalMonthOfService": enum (MonthOfYear),
  "originalYearOfService": string,
  "originalInvoiceId": string,
  "originalAccountBudgetName": string,
  "originalPurchaseOrderNumber": string,
  "amountMicros": string
}
שדות
originalMonthOfService

enum (MonthOfYear)

פלט בלבד. חודש השירות המקורי שקשור לזיכוי הזה על פעילות לא חוקית.
originalYearOfService

string

פלט בלבד. שנת השירות המקורית שקשורה לזיכוי הזה על פעילות לא חוקית.
originalInvoiceId

string

פלט בלבד. מספר החשבונית המקורית שקשורה לזיכוי הזה בעקבות פעילות לא חוקית.
originalAccountBudgetName

string

פלט בלבד. השם המקורי של תקציב החשבון שקשור לזיכוי הזה בגין פעילות לא חוקית.
originalPurchaseOrderNumber

string

פלט בלבד. המספר המקורי של הזמנת הרכש שקשור לזיכוי הזה בעקבות פעילות לא חוקית.
amountMicros

string (int64 format)

פלט בלבד. כמות הפעילות לא תקינה במיליוניות השנייה.

AccountSummary

מייצג תצוגה מסכמת ברמת החשבון.

ייצוג 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
}
שדות
customer

string

פלט בלבד. החשבון שמשויך לסיכום החשבון.
billingCorrectionSubtotalAmountMicros

string (int64 format)

פלט בלבד. סכום הביניים של תיקון החיוב לפני מס, במיליוניות השנייה.
billingCorrectionTaxAmountMicros

string (int64 format)

פלט בלבד. מס על תיקון חיוב, ב-Micros.
billingCorrectionTotalAmountMicros

string (int64 format)

פלט בלבד. הסכום הכולל של תיקון החיוב, במיליוניות השנייה.
couponAdjustmentSubtotalAmountMicros

string (int64 format)

פלט בלבד. סכום הביניים של התאמת השובר לפני מס, במיליוניות השנייה.
couponAdjustmentTaxAmountMicros

string (int64 format)

פלט בלבד. מס על התאמת שובר, במיליוניות השנייה
couponAdjustmentTotalAmountMicros

string (int64 format)

פלט בלבד. הסכום הכולל של התאמת השובר, במיליוניות השנייה.
excessCreditAdjustmentSubtotalAmountMicros

string (int64 format)

פלט בלבד. סכום ביניים של התאמת זיכוי עודף לפני מס, במיליוניות השנייה.
excessCreditAdjustmentTaxAmountMicros

string (int64 format)

פלט בלבד. מס על התאמת זיכוי עודף, במיליוניות השנייה.
excessCreditAdjustmentTotalAmountMicros

string (int64 format)

פלט בלבד. הסכום הכולל של התאמת הזיכויים העודפים, במיליוניות השנייה.
regulatoryCostsSubtotalAmountMicros

string (int64 format)

פלט בלבד. סכום הביניים של העלויות הרגולטוריות לפני מס, במיליוניות השנייה
regulatoryCostsTaxAmountMicros

string (int64 format)

פלט בלבד. מס על עלויות רגולטוריות, במיליוניות השנייה.
regulatoryCostsTotalAmountMicros

string (int64 format)

פלט בלבד. הסכום הכולל של העלויות הרגולטוריות, במיליוניות השנייה.
exportChargeSubtotalAmountMicros

string (int64 format)

פלט בלבד. סכום הביניים של חיוב הייצוא לפני מס, במיליוניות השנייה
exportChargeTaxAmountMicros

string (int64 format)

פלט בלבד. מס על חיוב על ייצוא, ב-Micros.
exportChargeTotalAmountMicros

string (int64 format)

פלט בלבד. סכום החיוב הכולל על הייצוא, במיליוניות השנייה.
subtotalAmountMicros

string (int64 format)

פלט בלבד. הסכום הכולל לפני מס, שמיוחס לחשבון במהלך תקופת השירות, במיליוניות השנייה.
taxAmountMicros

string (int64 format)

פלט בלבד. סכום המס הכולל שניתן לשייך לחשבון במהלך תקופת השירות, במיליוניות השנייה.
totalAmountMicros

string (int64 format)

פלט בלבד. הסכום הכולל שניתן לשייך לחשבון במהלך תקופת השירות, במיליוניות השנייה. הוא שווה לסכום של סכום הבינייםAmountMicros ו-taxAmountMicros.