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/v14/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 सिर्फ़ आउटपुट के लिए. dd-mm-yyyy फ़ॉर्मैट में, पूरा होने की तारीख.
currencyCode	string सिर्फ़ आउटपुट के लिए. मुद्रा कोड. सभी लागतें इस मुद्रा में वापस की जाती हैं. ISO 4217 स्टैंडर्ड से मिले मुद्रा कोड के सबसेट का इस्तेमाल किया जा सकता है.
exportChargeSubtotalAmountMicros	string (int64 format) सिर्फ़ आउटपुट के लिए. इनवॉइस लेवल के एक्सपोर्ट शुल्क की प्रीटैक्स सबटोटल रकम, माइक्रो में.
exportChargeTaxAmountMicros	string (int64 format) सिर्फ़ आउटपुट के लिए. इनवॉइस लेवल पर एक्सपोर्ट हुए टैक्स का कुल जोड़, माइक्रो में.
exportChargeTotalAmountMicros	string (int64 format) सिर्फ़ आउटपुट के लिए. इनवॉइस लेवल पर एक्सपोर्ट के लिए लगने वाले कुल शुल्क, माइक्रो में.
subtotalAmountMicros	string (int64 format) सिर्फ़ आउटपुट के लिए. माइक्रो में, प्रीटैक्स सबटोटल रकम. यह AccountBudgetखास रकम की सबटोटल रकम और Invoice.adjustments_subtotal_amount_micros के कुल योग के बराबर है.
taxAmountMicros	string (int64 format) सिर्फ़ आउटपुट के लिए. इनवॉइस पर मौजूद सभी टैक्स का कुल योग, माइक्रो में. यह खाताबजट सारांश टैक्स राशि के योग के बराबर है, साथ ही वे टैक्स भी हैं जो किसी खास खाता बजट से जुड़े नहीं हैं.
totalAmountMicros	string (int64 format) सिर्फ़ आउटपुट के लिए. माइक्रो में कुल रकम. इनवॉइस, इनवॉइस, सबटोटल_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 सिर्फ़ आउटपुट के लिए. बिल करने लायक इस कम शब्दों में दी गई लागत से जुड़े खाते के बजट के संसाधन का नाम. Accountबजट के संसाधन नामों में ये फ़ॉर्म हैं: 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) सिर्फ़ आउटपुट के लिए. सेवा की अवधि के दौरान खाते में क्रेडिट की जाने वाली कुल रकम, माइक्रो में. यह subtotalAmountMicros और टैक्सAmountMicros के कुल योग के बराबर है.