Method: customers.invoices.list

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

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

בקשת HTTP

GET https://googleads.googleapis.com/v14/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_billing_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)

פלט בלבד. כמות הפעילות לא חוקית ב-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)

פלט בלבד. מס על תיקון חיוב, במיליוניות השנייה.
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)

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