Method: customers.invoices.list

• एचटीटीपी अनुरोध
• पाथ पैरामीटर
• क्वेरी पैरामीटर
• अनुरोध का मुख्य हिस्सा
• जवाब का मुख्य हिस्सा
  • JSON फ़ॉर्मैट में दिखाना
• अनुमति के दायरे
• इनवॉइस
  • JSON फ़ॉर्मैट में दिखाना
• InvoiceType
• AccountBudgetSummary
  • JSON फ़ॉर्मैट में दिखाना
• InvalidActivitySummary
  • JSON फ़ॉर्मैट में दिखाना
• AccountSummary
  • JSON फ़ॉर्मैट में दिखाना
• इसे आज़माएं!

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

अपलोड की गई गड़बड़ियों की सूची: AuthenticationError AuthorizationError FieldError HeaderError InternalError InvoiceError QuotaError RequestError

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

GET https://googleads.googleapis.com/v16/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 की सबटोटल रकम और इनवॉइस.अडजस्टमेंट_subtotal_amount_micros के योग के बराबर है.
taxAmountMicros	string (int64 format) सिर्फ़ आउटपुट के लिए. इनवॉइस पर मौजूद सभी टैक्स का कुल योग, माइक्रो में. यह AccountBudget Summary में शामिल टैक्स की रकम के कुल योग के बराबर है. इसमें ऐसे टैक्स भी शामिल हैं जो किसी खाते के बजट से नहीं जुड़े हैं.
totalAmountMicros	string (int64 format) सिर्फ़ आउटपुट के लिए. माइक्रो में कुल राशि. यह Invoice.subtotal_amount_micros, इनवॉइस.tax_amount_micros, इनवॉइस.regulatory_costs_subtotal_amount_micros, और इनवॉइस.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 सिर्फ़ आउटपुट के लिए. बिल करने लायक इस कम शब्दों में बताई गई लागत से जुड़े खाते के बजट के संसाधन का नाम. 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

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

जेएसओएन के काेड में दिखाना
{ "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) सिर्फ़ आउटपुट के लिए. Pretax कूपन अडजस्टमेंट की कुल रकम, माइक्रो में.
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 और टैक्सAmountMicros के कुल योग के बराबर है.