Method: customers.invoices.list

किसी महीने के लिए, बिलिंग सेटअप से जुड़े सभी इनवॉइस दिखाता है.

जनरेट की गई गड़बड़ियों की सूची: AuthenticationError AuthorizationError FieldError HeaderError InternalError InvoiceError QuotaError RequestError

एचटीटीपी अनुरोध

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

यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

पाथ पैरामीटर

पैरामीटर
customerId

string

ज़रूरी है. उस ग्राहक का आईडी जिसके लिए इनवॉइस फ़ेच करना है.

क्वेरी पैरामीटर

पैरामीटर
billingSetup

string

ज़रूरी है. अनुरोध किए गए इनवॉइस के बिलिंग सेटअप संसाधन का नाम.

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

string

ज़रूरी है. yyyy फ़ॉर्मैट में, इनवॉइस फिर से पाने के लिए, जारी करने का साल. सिर्फ़ साल 2019 या उसके बाद जारी किए गए इनवॉइस फिर से पाए जा सकते हैं.
issueMonth

enum (MonthOfYear)

ज़रूरी है. इनवॉइस फिर से पाने के लिए जारी करने वाला महीना.

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

InvoiceService.ListInvoices के लिए जवाब देने वाला मैसेज.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

जेएसओएन के काेड में दिखाना 
{
  "invoices": [
    {
      object (Invoice)
    }
  ]
}
फ़ील्ड
invoices[]

object (Invoice)

बिलिंग सेटअप और समयावधि से मैच होने वाले इनवॉइस की सूची.

अनुमति के दायरे

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

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

ज़्यादा जानकारी के लिए, OAuth 2.0 की खास जानकारी देखें.

बिल

इनवॉइस. PDF इनवॉइस से मैच करने के लिए इनवॉइस की पूरी जानकारी का स्नैपशॉट लिया जाता है. ऐसा हो सकता है कि इनवॉइस के लॉन्च से पहले के इनवॉइस के लिए स्नैपशॉट में दी गई जानकारी, PDF इनवॉइस से मेल न खाए.

जेएसओएन के काेड में दिखाना 
{
  "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 सबटोटल रकम और इनवॉइस.adjustments_subtotal_amount_micros के योग के बराबर है.
taxAmountMicros

string (int64 format)

सिर्फ़ आउटपुट के लिए. इनवॉइस पर मौजूद सभी टैक्स का योग, माइक्रो में. यह खाता बजट सारांश में दी गई टैक्स की रकम के योग के बराबर होता है. साथ ही, इसमें ऐसे टैक्स भी शामिल होते हैं जो किसी खास खाते के बजट से जुड़े नहीं होते.
totalAmountMicros

string (int64 format)

सिर्फ़ आउटपुट के लिए. माइक्रो में कुल राशि. यह इनवॉइस.subtotal_amount_micros, इनवॉइस.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

सिर्फ़ आउटपुट के लिए. इनवॉइस की PDF कॉपी का यूआरएल. इस यूआरएल की मदद से PDF फ़ाइल का अनुरोध करने के लिए, उपयोगकर्ताओं को अपना OAuth टोकन पास करना होगा.

InvoiceType

इनवॉइस किस तरह के हो सकते हैं.

Enums
UNSPECIFIED तय नहीं किया गया.
UNKNOWN सिर्फ़ रिटर्न वैल्यू के लिए इस्तेमाल किया जाता है. इस वर्शन में वह वैल्यू दिखाता है जिसकी जानकारी नहीं है.
CREDIT_MEMO ऋणात्मक राशि वाला इनवॉइस. खाते को एक क्रेडिट मिलता है.
INVOICE शून्य से ज़्यादा रकम वाला इनवॉइस. खाते में कुछ रकम बकाया है.

AccountBudgetSummary

इससे, खाते के बजट की खास जानकारी मिलती है, जिसकी बिलिंग की जा सकती है.

जेएसओएन के काेड में दिखाना 
{
  "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

सिर्फ़ आउटपुट के लिए. बिल करने लायक इस लागत से जुड़े खाते के बजट का संसाधन नाम. खाता बजट संसाधन के नाम इस तरह के होते हैं:

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

इनवॉइस की अमान्य गतिविधि के बारे में जानकारी, जिसमें इनवॉइस के बारे में अतिरिक्त जानकारी दी गई है. इनवॉइस में बदलाव किए गए हैं.

जेएसओएन के काेड में दिखाना 
{
  "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

खाता लेवल पर खास जानकारी वाला व्यू दिखाता है.

जेएसओएन के काेड में दिखाना 
{
  "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)

सिर्फ़ आउटपुट के लिए. माइक्रो में निर्यात शुल्क पर कर.
exportChargeTotalAmountMicros

string (int64 format)

सिर्फ़ आउटपुट के लिए. माइक्रो में, एक्सपोर्ट शुल्क की कुल रकम.
subtotalAmountMicros

string (int64 format)

सिर्फ़ आउटपुट के लिए. सेवा अवधि के दौरान खाते में दी जा सकने वाली कुल टैक्स से पहले की कुल रकम. यह रकम माइक्रो में.
taxAmountMicros

string (int64 format)

सिर्फ़ आउटपुट के लिए. सेवा अवधि के दौरान खाते में जमा की जाने वाली कुल टैक्स रकम (माइक्रो में).
totalAmountMicros

string (int64 format)

सिर्फ़ आउटपुट के लिए. सेवा अवधि के दौरान खाते में जमा की जाने वाली कुल रकम (माइक्रो में). यह subtotalAmountMi Cros औरtaxAmountMi Cros का योग है.