- درخواست HTTP
- پارامترهای مسیر
- پارامترهای پرس و جو
- درخواست بدن
- بدن پاسخگو
- محدوده مجوز
- صورتحساب
- نوع فاکتور
- AccountBudgetSummary
- InvalidActivitySummary
- خلاصه حساب
- آن را امتحان کنید!
همه فاکتورهای مرتبط با تنظیم صورتحساب را برای یک ماه معین برمیگرداند.
لیست خطاهای پرتاب شده: AuthenticationError AuthorizationError FieldError HeaderError داخلی خطای فاکتور خطا QuotaError RequestError
درخواست HTTP
GET https://googleads.googleapis.com/v16/customers/{customerId}/invoices
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
مولفه های | |
---|---|
customerId | ضروری. شناسه مشتری برای واکشی فاکتورها. |
پارامترهای پرس و جو
مولفه های | |
---|---|
billingSetup | ضروری. نام منبع تنظیم صورتحساب فاکتورهای درخواستی. |
issueYear | ضروری. سال صدور برای بازیابی فاکتورها، در قالب سالی. فقط فاکتورهای صادر شده در سال 2019 یا بعد از آن قابل بازیابی هستند. |
issueMonth | ضروری. ماه صدور برای بازیابی فاکتورها. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
پیام پاسخ برای InvoiceService.ListInvoices
.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{
"invoices": [
{
object ( |
زمینه های | |
---|---|
invoices[] | فهرست فاکتورهایی که با تنظیم صورتحساب و دوره زمانی مطابقت دارند. |
محدوده مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/adwords
برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.
صورتحساب
یک فاکتور فروش. تمام اطلاعات فاکتور برای مطابقت با فاکتور PDF به صورت فوری گرفته می شود. برای فاکتورهای قدیمی تر از راه اندازی InvoiceService، اطلاعات عکس فوری ممکن است با فاکتور PDF مطابقت نداشته باشد.
نمایندگی JSON |
---|
{ "resourceName": string, "type": enum ( |
زمینه های | |
---|---|
resourceName | فقط خروجی نام منبع فاکتور. چندین مشتری می توانند یک فاکتور معین را به اشتراک بگذارند، بنابراین نام چندین منبع ممکن است به یک فاکتور اشاره کند. نام منابع فاکتور به شکل زیر است: |
type | فقط خروجی نوع فاکتور. |
serviceDateRange | فقط خروجی محدوده تاریخ دوره خدمات این فاکتور. تاریخ پایان شامل است. |
adjustmentsSubtotalAmountMicros | فقط خروجی مبلغ فرعی پیش از مالیات تعدیل سطح فاکتور، بر حسب میکرو. |
adjustmentsTaxAmountMicros | فقط خروجی مجموع مالیات بر تعدیل سطح فاکتور، در میکرو. |
adjustmentsTotalAmountMicros | فقط خروجی مقدار کل تنظیمات سطح فاکتور، در میکرو. |
regulatoryCostsSubtotalAmountMicros | فقط خروجی مبلغ فرعی قبل از مالیات هزینه های نظارتی سطح فاکتور، در میکرو. |
regulatoryCostsTaxAmountMicros | فقط خروجی مجموع مالیات بر هزینه های نظارتی سطح فاکتور، در میکرو. |
regulatoryCostsTotalAmountMicros | فقط خروجی مجموع هزینه های نظارتی سطح فاکتور، بر حسب میکرو. |
replacedInvoices[] | فقط خروجی نام منبع فاکتور(های) اصلی که مجدداً صورتحساب می شود یا با این فاکتور جایگزین می شود، در صورت وجود. ممکن است به دلیل ادغام فاکتورها چندین فاکتور جایگزین شده باشد. فاکتورهای جایگزین شده ممکن است متعلق به همان حساب پرداخت نباشند. در صورت تنظیم |
accountBudgetSummaries[] | فقط خروجی فهرست خلاصهای از اطلاعات بودجه حساب مرتبط با این فاکتور. |
accountSummaries[] | فقط خروجی فهرست خلاصه اطلاعات حساب مرتبط با این فاکتور. |
id | فقط خروجی شناسه فاکتور. در PDF فاکتور به عنوان "شماره فاکتور" ظاهر می شود. |
billingSetup | فقط خروجی نام منبع تنظیم صورتحساب این فاکتور. |
paymentsAccountId | فقط خروجی یک شناسه 16 رقمی که برای شناسایی حساب پرداختهای مرتبط با تنظیم صورتحساب استفاده میشود، به عنوان مثال، «1234-5678-9012-3456». در PDF فاکتور به عنوان "شماره حساب صورتحساب" ظاهر می شود. |
paymentsProfileId | فقط خروجی شناسه 12 رقمی که برای شناسایی نمایه پرداختهای مرتبط با تنظیم صورتحساب استفاده میشود، بهعنوان مثال، «1234-5678-9012». در PDF فاکتور به عنوان "شناسه صورتحساب" ظاهر می شود. |
issueDate | فقط خروجی تاریخ صدور در قالب yyyy-mm-dd. در PDF فاکتور به صورت "تاریخ صدور" یا "تاریخ فاکتور" ظاهر می شود. |
dueDate | فقط خروجی تاریخ سررسید در قالب yyyy-mm-dd. |
currencyCode | فقط خروجی رمز ارز تمام هزینه ها با این ارز برگشت داده می شود. زیر مجموعه ای از کدهای ارز مشتق شده از استاندارد ISO 4217 پشتیبانی می شود. |
exportChargeSubtotalAmountMicros | فقط خروجی مبلغ فرعی پیش از مالیات هزینههای صادراتی سطح فاکتور، بر حسب میکرو. |
exportChargeTaxAmountMicros | فقط خروجی مجموع مالیات بر هزینه های صادراتی سطح فاکتور، بر حسب میکرو. |
exportChargeTotalAmountMicros | فقط خروجی مجموع هزینه های صادرات در سطح فاکتور، بر حسب میکرو. |
subtotalAmountMicros | فقط خروجی مبلغ فرعی قبل از مالیات، بر حسب میکرو. این برابر است با مجموع مبالغ فرعی AccountBudgetSummary و Invoice.adjustments_subtotal_amount_micros. |
taxAmountMicros | فقط خروجی مجموع همه مالیات ها در فاکتور، در میکرو. این برابر است با مجموع مبالغ مالیات AccountBudgetSummary، به اضافه مالیاتهایی که با بودجه حساب خاصی مرتبط نیستند. |
totalAmountMicros | فقط خروجی مقدار کل، بر حسب میکرو این برابر است با مجموع Invoice.subtotal_amount_micros، Invoice.tax_amount_micros، Invoice.regulatory_costs_subtotal_amount_micros، و Invoice.export_charge_subtotal_amount_micros (که با یک آیتم خط جداگانه شروع می شود). |
correctedInvoice | فقط خروجی نام منبع فاکتور اصلی توسط این فاکتور تصحیح، حذف یا لغو شد، در صورت وجود. اگر |
pdfUrl | فقط خروجی URL یک نسخه PDF از فاکتور. کاربران باید رمز OAuth خود را برای درخواست PDF با این URL ارسال کنند. |
نوع فاکتور
نوع احتمالی فاکتورها
Enums | |
---|---|
UNSPECIFIED | مشخص نشده است. |
UNKNOWN | فقط برای مقدار برگشتی استفاده می شود. نشان دهنده مقدار ناشناخته در این نسخه است. |
CREDIT_MEMO | فاکتوری با مبلغ منفی حساب اعتباری دریافت می کند. |
INVOICE | یک فاکتور با مبلغ مثبت. حساب بدهکار است. |
AccountBudgetSummary
هزینه قابل پرداخت بودجه حساب خلاصه شده را نشان می دهد.
نمایندگی JSON |
---|
{ "billableActivityDateRange": { object ( |
زمینه های | |
---|---|
billableActivityDateRange | فقط خروجی محدوده تاریخ فعالیت قابل پرداخت بودجه حساب، در محدوده تاریخ خدمات این فاکتور. تاریخ پایان شامل است. این می تواند با زمان شروع و پایان بودجه حساب متفاوت باشد. |
invalidActivitySummaries[] | فقط خروجی فهرست خلاصه اعتبار فعالیت نامعتبر با پیوندهای اصلی. |
customer | فقط خروجی نام منبع مشتری مرتبط با این بودجه حساب. این شامل شناسه مشتری است که در PDF فاکتور به عنوان "شناسه حساب" ظاهر می شود. نام منابع مشتری به شکل زیر است: |
customerDescriptiveName | فقط خروجی نام توصیفی مشتری بودجه حساب. در PDF فاکتور به عنوان "حساب" ظاهر می شود. |
accountBudget | فقط خروجی نام منبع بودجه حساب مرتبط با این هزینه قابل صورتحساب خلاصه شده. نام منابع AccountBudget به شکل زیر است: |
accountBudgetName | فقط خروجی نام بودجه حساب. در PDF فاکتور به عنوان "بودجه حساب" ظاهر می شود. |
purchaseOrderNumber | فقط خروجی شماره سفارش خرید بودجه حساب. در PDF فاکتور به عنوان "سفارش خرید" ظاهر می شود. |
subtotalAmountMicros | فقط خروجی مبلغ فرعی قبل از مالیات قابل انتساب به این بودجه در طول دوره خدمات، بر حسب میکرو. |
taxAmountMicros | فقط خروجی مبلغ مالیات قابل انتساب به این بودجه در طول دوره خدمت، بر حسب میکرو. |
totalAmountMicros | فقط خروجی کل مبلغ قابل انتساب به این بودجه در طول دوره خدمات، بر حسب میکرو. این معادل مجموع مبلغ فرعی بودجه حساب و مبلغ مالیات بودجه حساب است. |
servedAmountMicros | فقط خروجی مبلغ ارائه شده قبل از مالیات قابل انتساب به این بودجه در طول دوره خدمات، به صورت میکرو. این فقط برای تطبیق دادههای فاکتور و تحویل مفید است. |
billedAmountMicros | فقط خروجی مبلغ صورتحساب قبل از مالیات قابل انتساب به این بودجه در طول دوره خدمات، به صورت میکرو. این هیچ تعدیلی را در نظر نمی گیرد. |
overdeliveryAmountMicros | فقط خروجی مبلغ اضافه تحویل قبل از مالیات قابل انتساب به این بودجه در طول دوره خدمات، بر حسب میکرو (ارزش منفی). |
invalidActivityAmountMicros | فقط خروجی مبلغ فعالیت نامعتبر قبل از مالیات قابل انتساب به این بودجه در ماه های گذشته، به میکرو (مقدار منفی). |
InvalidActivitySummary
جزئیات مربوط به فعالیت نامعتبر برای فاکتور که حاوی جزئیات اضافی در مورد فاکتور است که در آن اصلاحات انجام شده است.
نمایندگی JSON |
---|
{
"originalMonthOfService": enum ( |
زمینه های | |
---|---|
originalMonthOfService | فقط خروجی ماه اصلی خدمات مربوط به این اعتبار فعالیت نامعتبر. |
originalYearOfService | فقط خروجی سال خدمات اصلی مربوط به این اعتبار فعالیت نامعتبر. |
originalInvoiceId | فقط خروجی شماره فاکتور اصلی مربوط به این اعتبار فعالیت نامعتبر. |
originalAccountBudgetName | فقط خروجی نام اصلی بودجه حساب مربوط به این اعتبار فعالیت نامعتبر است. |
originalPurchaseOrderNumber | فقط خروجی شماره سفارش خرید اصلی مربوط به این اعتبار فعالیت نامعتبر است. |
amountMicros | فقط خروجی مقدار فعالیت نامعتبر در میکرو. |
خلاصه حساب
نمایانگر یک نمای خلاصه شده در سطح حساب است.
نمایندگی 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 | فقط خروجی حساب مرتبط با خلاصه حساب. |
billingCorrectionSubtotalAmountMicros | فقط خروجی مبلغ فرعی تصحیح صورتحساب قبل از مالیات، در میکرو. |
billingCorrectionTaxAmountMicros | فقط خروجی مالیات بر اصلاح صورتحساب، در میکرو. |
billingCorrectionTotalAmountMicros | فقط خروجی کل مبلغ تصحیح صورتحساب، در میکرو. |
couponAdjustmentSubtotalAmountMicros | فقط خروجی مبلغ فرعی تعدیل کوپن قبل از مالیات، بر حسب میکرو. |
couponAdjustmentTaxAmountMicros | فقط خروجی مالیات بر تعدیل کوپن، در میکرو. |
couponAdjustmentTotalAmountMicros | فقط خروجی مقدار کل تعدیل کوپن، در میکرو. |
excessCreditAdjustmentSubtotalAmountMicros | فقط خروجی مبلغ خرده کل تعدیل اعتبار اضافی قبل از مالیات، بر حسب میکرو. |
excessCreditAdjustmentTaxAmountMicros | فقط خروجی مالیات بر تعدیل اعتبار اضافی، در میکرو. |
excessCreditAdjustmentTotalAmountMicros | فقط خروجی کل مبلغ تعدیل اعتبار اضافی، در میکرو. |
regulatoryCostsSubtotalAmountMicros | فقط خروجی هزینه های نظارتی قبل از مالیات مبلغ فرعی، در میکرو. |
regulatoryCostsTaxAmountMicros | فقط خروجی مالیات بر هزینه های نظارتی، در میکرو. |
regulatoryCostsTotalAmountMicros | فقط خروجی مجموع هزینه های نظارتی، بر حسب میکرو. |
exportChargeSubtotalAmountMicros | فقط خروجی مبلغ کل هزینه صادرات قبل از مالیات، بر حسب میکرو. |
exportChargeTaxAmountMicros | فقط خروجی مالیات بر هزینه صادرات، در میکرو. |
exportChargeTotalAmountMicros | فقط خروجی مبلغ کل هزینه صادرات، بر حسب میکرو. |
subtotalAmountMicros | فقط خروجی کل مبلغ فرعی قبل از مالیات قابل انتساب به حساب در طول دوره خدمات، بر حسب میکرو. |
taxAmountMicros | فقط خروجی کل مبلغ مالیات قابل انتساب به حساب در طول دوره خدمات، بر حسب میکرو. |
totalAmountMicros | فقط خروجی کل مبلغ قابل انتساب به حساب در طول دوره خدمات، بر حسب میکرو. این برابر با مجموع subtotalAmountMicros و taxAmountMicros است. |