تنبيه: يتم عرض مستندات واجهة REST API. تستخدم معظم مكتبات العملاء الرسمية خدمة gRPC. يمكنك الاطلاع على مقدمة عن REST للحصول على التفاصيل.

تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

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` مطلوبة. رقم تعريف العميل المطلوب استرجاع الفواتير الخاصة به

customerId

string

مطلوبة. رقم تعريف العميل المطلوب استرجاع الفواتير الخاصة به

معلمات طلب البحث

المعلمات

المعلمات
`billingSetup`	`string` مطلوبة. اسم مورد إعداد الفوترة للفواتير المطلوبة. `customers/{customerId}/billingSetups/{billing_setup_id}`
`issueYear`	`string` مطلوبة. سنة إصدار الفواتير بتنسيق yyyy. ويمكن استرداد الفواتير التي تم إصدارها في عام 2019 أو بعد ذلك فقط.
`issueMonth`	`enum (MonthOfYear)` مطلوبة. شهر الإصدار لاسترداد الفواتير.

billingSetup

string

مطلوبة. اسم مورد إعداد الفوترة للفواتير المطلوبة.

customers/{customerId}/billingSetups/{billing_setup_id}

issueYear

string

مطلوبة. سنة إصدار الفواتير بتنسيق yyyy. ويمكن استرداد الفواتير التي تم إصدارها في عام 2019 أو بعد ذلك فقط.

issueMonth

enum (MonthOfYear)

مطلوبة. شهر الإصدار لاسترداد الفواتير.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

رسالة ردّ على InvoiceService.ListInvoices.

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON
{ "invoices": [ { object (`Invoice`) } ] }

الحقول

الحقول
`invoices[]`	`object (Invoice)` قائمة الفواتير التي تتطابق مع إعداد الفوترة والفترة الزمنية

invoices[]

object (Invoice)

قائمة الفواتير التي تتطابق مع إعداد الفوترة والفترة الزمنية

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، يُرجى الاطِّلاع على نظرة عامة على OAuth 2.0.

فاتورة

الفاتورة. يتم أخذ لقطة شاشة لكل معلومات الفاتورة لمطابقة الفاتورة بتنسيق PDF. بالنسبة إلى الفواتير التي مرّ عليها أكثر من تاريخ إطلاق InvoiceService، قد لا تتطابق المعلومات الموجزة مع الفاتورة بتنسيق PDF.

تمثيل JSON

تمثيل 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,
  "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 رقمًا يُستخدَم لتحديد الملف الشخصي للدفع المرتبط بإعدادات الفوترة، على سبيل المثال "9012-5678-1234". ويظهر هذا العنوان في ملف 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)` النتائج فقط. المبلغ الإجمالي بالمايكرو. يساوي هذا مجموع Bill.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

تمثّل هذه السمة نوع الفواتير المحتمَلة.

عمليات التعداد
`UNSPECIFIED`	لم يتم تحديده.
`UNKNOWN`	تُستخدَم للقيمة المعروضة فقط. يمثل هذا الحقل قيمة غير معروفة في هذا الإصدار.
`CREDIT_MEMO`	فاتورة بقيمة سالبة. يتلقّى الحساب رصيدًا.
`INVOICE`	فاتورة بقيمة موجبة. ثمة رصيد في الحساب.

AccountBudgetSummary

يمثل هذا الملخص تكلفة ملخّصة قابلة للفوترة لميزانية الحساب.

تمثيل JSON

تمثيل 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,
  "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

تمثيل 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
}

الحقول
`originalMonthOfService`	`enum (MonthOfYear)` النتائج فقط. شهر الخدمة الأصلي المرتبط برصيد النشاط غير الصالح هذا.
`originalYearOfService`	`string` النتائج فقط. سنة الخدمة الأصلية المرتبطة برصيد النشاط غير الصالح هذا.
`originalInvoiceId`	`string` النتائج فقط. رقم الفاتورة الأصلي المرتبط برصيد النشاط غير الصالح هذا
`originalAccountBudgetName`	`string` النتائج فقط. اسم ميزانية الحساب الأصلي المرتبط برصيد النشاط غير الصالح هذا.
`originalPurchaseOrderNumber`	`string` النتائج فقط. رقم طلب الشراء الأصلي المرتبط برصيد النشاط غير الصالح هذا
`amountMicros`	`string (int64 format)` النتائج فقط. مقدار النشاط غير الصالح بالمايكرو.

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 }

تمثيل 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)` النتائج فقط. الضريبة على رسوم التصدير، بالمايكرو
`exportChargeTotalAmountMicros`	`string (int64 format)` النتائج فقط. إجمالي مبلغ رسوم التصدير بالمايكرو
`subtotalAmountMicros`	`string (int64 format)` النتائج فقط. إجمالي مبلغ المجموع الفرعي قبل احتساب الضريبة والناتجة إلى الحساب أثناء فترة الخدمة، بالميكرو
`taxAmountMicros`	`string (int64 format)` النتائج فقط. إجمالي مبلغ الضريبة المنسوب إلى الحساب أثناء فترة الخدمة بالمايكرو.
`totalAmountMicros`	`string (int64 format)` النتائج فقط. إجمالي المبلغ المنسوب إلى الحساب أثناء فترة الخدمة بوحدات المايكرو. يساوي هذا مجموع subtotalAmountMicros وtaxAmountMicros.