Method: customers.invoices.list

• درخواست HTTP
• پارامترهای مسیر
• پارامترهای پرس و جو
• درخواست بدن
• بدن پاسخگو
  • نمایندگی JSON
• محدوده مجوز
• صورتحساب
  • نمایندگی JSON
• نوع فاکتور
• AccountBudgetSummary
  • نمایندگی JSON
• InvalidActivitySummary
  • نمایندگی JSON
• خلاصه حساب
  • نمایندگی JSON
• آن را امتحان کنید!

همه فاکتورهای مرتبط با تنظیم صورت‌حساب را برای یک ماه معین برمی‌گرداند.

لیست خطاهای پرتاب شده: AuthenticationError AuthorizationError FieldError HeaderError داخلی خطای فاکتور خطا QuotaError RequestError

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
customerId	string ضروری. شناسه مشتری برای واکشی فاکتورها.

پارامترهای پرس و جو

مولفه های
billingSetup	string ضروری. نام منبع تنظیم صورت‌حساب فاکتورهای درخواستی. customers/{customerId}/billingSetups/{billing_setup_id}
issueYear	string ضروری. سال صدور برای بازیابی فاکتورها، در قالب سالی. فقط فاکتورهای صادر شده در سال 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_charge_subtotal_amount_micros (که در یک آیتم خط جداگانه شروع می شود).
correctedInvoice	string فقط خروجی نام منبع فاکتور اصلی توسط این فاکتور تصحیح، حذف یا لغو شد، در صورت وجود. اگر correctedInvoice تنظیم شده باشد، replacedInvoices تنظیم نخواهد شد. نام منابع فاکتور به شکل زیر است: customers/{customerId}/invoices/{invoice_id}
pdfUrl	string فقط خروجی URL یک نسخه PDF از فاکتور. کاربران باید رمز OAuth خود را برای درخواست PDF با این URL ارسال کنند.

نوع فاکتور

نوع احتمالی فاکتورها

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) فقط خروجی مقدار فعالیت نامعتبر در میکرو.

خلاصه حساب

نمایانگر یک نمای خلاصه شده در سطح حساب است.

نمایندگی 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) فقط خروجی کل مبلغ قابل انتساب به حساب در طول دوره خدمات، بر حسب میکرو. این معادل مجموع زیرمجموعهAmountMicros و taxAmountMicros است.