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/v14/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) เอาต์พุตเท่านั้น จำนวนเงินรวมที่มาจากบัญชีในระหว่างช่วงเวลาของบริการ ซึ่งเท่ากับผลรวมของผลรวมย่อยAmountMicros และ taxAmountMicros