Method: customers.invoices.list

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

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

בקשת HTTP

GET https://googleads.googleapis.com/v17/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.Adjustmentments_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

סוג החשבוניות.

טיפוסים בני מנייה (enum)
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)

פלט בלבד. כמות פעילות לא חוקית ב-micros.

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)

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

string (int64 format)

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

string (int64 format)

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

string (int64 format)

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

string (int64 format)

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