Method: customers.invoices.list

• คำขอ HTTP
• พารามิเตอร์เส้นทาง
• พารามิเตอร์การค้นหา
• เนื้อความของคำขอ
• เนื้อหาการตอบกลับ
  • การแสดง JSON
• ขอบเขตการให้สิทธิ์
• ใบแจ้งหนี้
  • การแสดง JSON
• InvoiceType
• AccountBudgetSummary
  • การแสดง JSON
• InvalidActivitySummary
  • การแสดง JSON
• AccountSummary
  • การแสดง JSON
• ลองใช้งาน

แสดงใบแจ้งหนี้ทั้งหมดที่เกี่ยวข้องกับการตั้งค่าการเรียกเก็บเงินของเดือนที่ระบุ

รายการข้อผิดพลาด: AuthenticationError AuthorizationError FieldError HeaderError InternalError InvoiceError QuotaError RequestError

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
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 เอาต์พุตเท่านั้น วันที่ออกในรูปแบบ ปปปป-ดด-วว ซึ่งจะปรากฏในไฟล์ PDF ของใบแจ้งหนี้เป็น "วันที่ออก" หรือ "วันที่ในใบแจ้งหนี้"
dueDate	string เอาต์พุตเท่านั้น วันที่ครบกำหนดในรูปแบบ ปปปป-ดด-วว
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 (ซึ่งแยกเป็นบรรทัดรายการแยกต่างหากโดยขึ้นต้นด้วย V14.1)
correctedInvoice	string เอาต์พุตเท่านั้น ชื่อทรัพยากรของใบแจ้งหนี้ต้นฉบับมีการแก้ไข ตัดค่าใช้จ่าย หรือยกเลิกโดยใบแจ้งหนี้นี้ ถ้ามี หากตั้งค่า correctedInvoice ไว้ ระบบจะไม่ตั้งค่า replacedInvoices ชื่อทรัพยากรใบแจ้งหนี้จะมีรูปแบบดังนี้ customers/{customerId}/invoices/{invoice_id}
pdfUrl	string เอาต์พุตเท่านั้น URL ไปยังสำเนาของใบแจ้งหนี้แบบ PDF ผู้ใช้ต้องส่งโทเค็น OAuth เพื่อขอไฟล์ PDF ด้วย URL นี้

InvoiceType

ประเภทของใบแจ้งหนี้ที่เป็นไปได้

Enum
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) เอาต์พุตเท่านั้น จำนวนกิจกรรมที่ไม่ถูกต้องในระดับไมโคร

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 }

ช่อง
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