- Yêu cầu HTTP
- Tham số đường dẫn
- Tham số truy vấn
- Nội dung yêu cầu
- Nội dung phản hồi
- Phạm vi uỷ quyền
- Hoá đơn
- InvoiceType
- AccountBudgetSummary
- InvalidActivitySummary
- AccountSummary
- Hãy làm thử!
Trả về tất cả hoá đơn được liên kết với thông tin thanh toán trong một tháng cụ thể.
Danh sách các lỗi được gửi: AuthenticationError AuthorizationError FieldError HeaderError InternalError InvoiceError QuotaError RequestError
Yêu cầu HTTP
GET https://googleads.googleapis.com/v17/customers/{customerId}/invoices
URL sử dụng cú pháp Chuyển mã gRPC.
Tham số đường dẫn
Tham số | |
---|---|
customerId |
Bắt buộc. Mã của khách hàng để tìm nạp hoá đơn. |
Tham số truy vấn
Tham số | |
---|---|
billingSetup |
Bắt buộc. Tên tài nguyên thông tin thanh toán của các hóa đơn được yêu cầu.
|
issueYear |
Bắt buộc. Năm phát hành để truy xuất hoá đơn, ở định dạng yyyy. Bạn chỉ có thể truy xuất các hoá đơn được phát hành trong năm 2019 trở đi. |
issueMonth |
Bắt buộc. Tháng phát hành để truy xuất hoá đơn. |
Nội dung yêu cầu
Nội dung yêu cầu phải trống.
Nội dung phản hồi
Tin nhắn phản hồi cho InvoiceService.ListInvoices
.
Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:
Biểu diễn dưới dạng JSON |
---|
{
"invoices": [
{
object ( |
Trường | |
---|---|
invoices[] |
Danh sách hoá đơn khớp với thông tin thanh toán và khoảng thời gian. |
Phạm vi uỷ quyền
Yêu cầu phạm vi OAuth sau:
https://www.googleapis.com/auth/adwords
Để biết thêm thông tin, hãy xem bài viết Tổng quan về OAuth 2.0.
Hóa đơn
Hoá đơn. Tất cả thông tin hoá đơn đều được chụp nhanh để khớp với hoá đơn PDF. Đối với các hóa đơn cũ hơn thời gian ra mắt Hóa đơn, thông tin được chụp nhanh có thể không khớp với hóa đơn PDF.
Biểu diễn dưới dạng JSON |
---|
{ "resourceName": string, "type": enum ( |
Trường | |
---|---|
resourceName |
Chỉ có đầu ra. Tên tài nguyên của hoá đơn. Nhiều khách hàng có thể dùng chung một hoá đơn nhất định, vì vậy, nhiều tên tài nguyên có thể trỏ đến cùng một hoá đơn. Tên nguồn tài nguyên trên hoá đơn có dạng:
|
type |
Chỉ có đầu ra. Loại hoá đơn. |
serviceDateRange |
Chỉ có đầu ra. Phạm vi ngày sử dụng dịch vụ của hoá đơn này. Ngày kết thúc có tính toàn bộ. |
adjustmentsSubtotalAmountMicros |
Chỉ có đầu ra. Tổng số tiền phụ trước thuế của các khoản điều chỉnh ở cấp hoá đơn, tính bằng phần triệu. |
adjustmentsTaxAmountMicros |
Chỉ có đầu ra. Tổng thuế trên các mức điều chỉnh cấp hoá đơn, tính bằng phần triệu. |
adjustmentsTotalAmountMicros |
Chỉ có đầu ra. Tổng số tiền điều chỉnh cấp hoá đơn, tính bằng phần triệu. |
regulatoryCostsSubtotalAmountMicros |
Chỉ có đầu ra. Tổng số tiền phụ trước thuế của các chi phí theo quy định ở cấp hoá đơn, tính bằng phần triệu. |
regulatoryCostsTaxAmountMicros |
Chỉ có đầu ra. Tổng thuế đối với chi phí theo quy định ở cấp hoá đơn, tính bằng phần triệu. |
regulatoryCostsTotalAmountMicros |
Chỉ có đầu ra. Tổng chi phí theo quy định ở cấp hoá đơn, tính bằng phần triệu. |
replacedInvoices[] |
Chỉ có đầu ra. Tên tài nguyên của(các) hoá đơn gốc đang được lập lại hoặc thay thế bằng hoá đơn này, nếu có. Có thể có nhiều hoá đơn được thay thế do việc hợp nhất hoá đơn. Các hoá đơn được thay thế có thể không thuộc về cùng một tài khoản thanh toán. Nếu bạn đặt
|
accountBudgetSummaries[] |
Chỉ có đầu ra. Danh sách thông tin tóm tắt về ngân sách tài khoản liên quan đến hoá đơn này. |
accountSummaries[] |
Chỉ có đầu ra. Danh sách thông tin tài khoản tóm tắt liên quan đến hoá đơn này. |
id |
Chỉ có đầu ra. Mã hoá đơn. Số này xuất hiện trên bản PDF của hoá đơn dưới dạng "Số hoá đơn". |
billingSetup |
Chỉ có đầu ra. Tên tài nguyên của thông tin thanh toán của hóa đơn này.
|
paymentsAccountId |
Chỉ có đầu ra. Mã gồm 16 chữ số được dùng để xác định tài khoản thanh toán được liên kết với thông tin thanh toán, ví dụ: "1234-5678-9012-3456". Số này xuất hiện trên hoá đơn PDF dưới dạng "Số tài khoản thanh toán". |
paymentsProfileId |
Chỉ có đầu ra. Mã gồm 12 chữ số được dùng để xác định hồ sơ thanh toán được liên kết với thông tin thanh toán, ví dụ: "1234-5678-9012". Mã này xuất hiện trên hoá đơn PDF dưới dạng "Mã thanh toán". |
issueDate |
Chỉ có đầu ra. Ngày phát hành ở định dạng yyyy-mm-dd. Ngày này xuất hiện trên hoá đơn PDF dưới dạng "Ngày phát hành" hoặc "Ngày lập hoá đơn". |
dueDate |
Chỉ có đầu ra. Ngày đến hạn có định dạng yyyy-mm-dd. |
currencyCode |
Chỉ có đầu ra. Mã đơn vị tiền tệ. Tất cả chi phí đều được trả về bằng đơn vị tiền tệ này. Một số mã đơn vị tiền tệ bắt nguồn từ tiêu chuẩn ISO 4217 sẽ được hỗ trợ. |
exportChargeSubtotalAmountMicros |
Chỉ có đầu ra. Tổng số tiền phụ trước thuế của phí xuất khẩu ở cấp hoá đơn, tính bằng micro giây. |
exportChargeTaxAmountMicros |
Chỉ có đầu ra. Tổng thuế đối với phí xuất khẩu ở cấp hoá đơn, tính theo phần triệu. |
exportChargeTotalAmountMicros |
Chỉ có đầu ra. Tổng số tiền phí xuất khẩu ở cấp hoá đơn, tính theo phần triệu. |
subtotalAmountMicros |
Chỉ có đầu ra. Tổng số tiền trước thuế, tính bằng phần triệu. Số tiền này bằng tổng số tiền của tổng số tiền AccountBudgetsummary và hoá đơn.điều chỉnh_subtotal_amount_micros. |
taxAmountMicros |
Chỉ có đầu ra. Tổng tất cả các khoản thuế trên hoá đơn, tính bằng phần triệu. Số tiền này bằng tổng số tiền thuế AccountBudgetsummary, cộng với các khoản thuế không liên quan đến một ngân sách tài khoản cụ thể. |
totalAmountMicros |
Chỉ có đầu ra. Tổng số tiền, tính bằng phần triệu. Số tiền này bằng tổng của Bill.subtotal_amount_micros, Bill.tax_amount_micros, Bill.regulatory_costs_subtotal_amount_micros và Bill.export_charge_subtotal_amount_micros (được tách riêng thành một mục riêng bắt đầu từ phiên bản V14.1). |
correctedInvoice |
Chỉ có đầu ra. Tên tài nguyên của hóa đơn gốc đã được sửa đổi, xóa sổ hoặc hủy bởi hóa đơn này, nếu có. Nếu bạn đặt
|
pdfUrl |
Chỉ có đầu ra. URL đến bản sao PDF của hoá đơn. Người dùng cần chuyển mã thông báo OAuth của họ để yêu cầu tệp PDF bằng URL này. |
InvoiceType
Loại hoá đơn có thể sử dụng.
Enum | |
---|---|
UNSPECIFIED |
Chưa chỉ định. |
UNKNOWN |
Chỉ dùng cho giá trị trả về. Biểu thị giá trị không xác định trong phiên bản này. |
CREDIT_MEMO |
Hoá đơn có số tiền âm. Tài khoản sẽ nhận được một khoản tín dụng. |
INVOICE |
Hoá đơn có số tiền dương. Tài khoản này còn nợ số dư. |
AccountBudgetSummary
Biểu thị chi phí tóm tắt có thể lập hoá đơn của ngân sách tài khoản.
Biểu diễn dưới dạng JSON |
---|
{ "billableActivityDateRange": { object ( |
Trường | |
---|---|
billableActivityDateRange |
Chỉ có đầu ra. Phạm vi ngày của hoạt động có thể lập hoá đơn của ngân sách tài khoản, nằm trong phạm vi ngày sử dụng dịch vụ của hoá đơn này. Ngày kết thúc có tính toàn bộ. Thời gian này có thể khác với thời gian bắt đầu và kết thúc của ngân sách tài khoản. |
invalidActivitySummaries[] |
Chỉ có đầu ra. Danh sách tóm tắt các khoản tín dụng cho hoạt động không hợp lệ kèm theo các mối liên kết ban đầu. |
customer |
Chỉ có đầu ra. Tên tài nguyên của khách hàng được liên kết với ngân sách tài khoản này. Mã này chứa mã khách hàng xuất hiện trên hoá đơn dạng PDF dưới dạng "Mã tài khoản". Tên tài nguyên dành cho khách hàng có dạng:
|
customerDescriptiveName |
Chỉ có đầu ra. Tên mô tả của khách hàng trong ngân sách tài khoản. Tài khoản này xuất hiện trên hoá đơn PDF dưới dạng "Tài khoản". |
accountBudget |
Chỉ có đầu ra. Tên tài nguyên của ngân sách tài khoản liên quan đến chi phí có thể lập hoá đơn tóm tắt này. Tên tài nguyên AccountBudget có dạng:
|
accountBudgetName |
Chỉ có đầu ra. Tên ngân sách tài khoản. Ngân sách này xuất hiện trên hoá đơn PDF dưới dạng "Ngân sách tài khoản". |
purchaseOrderNumber |
Chỉ có đầu ra. Số đơn đặt hàng của ngân sách tài khoản. Khoản phí này xuất hiện trên hoá đơn dạng PDF dưới dạng "Đơn đặt hàng". |
subtotalAmountMicros |
Chỉ có đầu ra. Số tiền tổng phụ trước thuế được phân bổ cho ngân sách này trong thời gian dịch vụ, tính bằng phần triệu. |
taxAmountMicros |
Chỉ có đầu ra. Số tiền thuế được phân bổ cho ngân sách này trong thời gian dịch vụ, tính bằng phần triệu. |
totalAmountMicros |
Chỉ có đầu ra. Tổng số tiền được phân bổ cho ngân sách này trong thời gian dịch vụ, tính bằng phần triệu. Giá trị này bằng tổng của tổng chi phí (dưới dạng ngân sách tài khoản) và số tiền thuế trong ngân sách tài khoản. |
servedAmountMicros |
Chỉ có đầu ra. Số tiền phân phát trước thuế có thể phân bổ cho ngân sách này trong thời gian dịch vụ, tính bằng phần triệu. Việc này chỉ hữu ích để điều chỉnh dữ liệu hoá đơn và giao hàng. |
billedAmountMicros |
Chỉ có đầu ra. Số tiền đã lập hoá đơn trước thuế được phân bổ cho ngân sách này trong thời gian sử dụng dịch vụ, tính bằng phần triệu. Quá trình này không tính đến bất kỳ sự điều chỉnh nào. |
overdeliveryAmountMicros |
Chỉ có đầu ra. Số tiền phân phối quá trước thuế có thể được phân bổ cho ngân sách này trong thời gian dịch vụ, tính bằng micro (giá trị âm). |
invalidActivityAmountMicros |
Chỉ có đầu ra. Số tiền hoạt động không hợp lệ trước thuế có thể được phân bổ cho ngân sách này trong những tháng trước, tính bằng phần triệu (giá trị âm). |
InvalidActivitySummary
Thông tin chi tiết về hoạt động không hợp lệ đối với hoá đơn có chứa thông tin bổ sung về hoá đơn đã được điều chỉnh.
Biểu diễn dưới dạng JSON |
---|
{
"originalMonthOfService": enum ( |
Trường | |
---|---|
originalMonthOfService |
Chỉ có đầu ra. Tháng sử dụng dịch vụ ban đầu có liên quan đến khoản tín dụng cho hoạt động không hợp lệ này. |
originalYearOfService |
Chỉ có đầu ra. Năm sử dụng dịch vụ gốc có liên quan đến khoản tín dụng cho hoạt động không hợp lệ này. |
originalInvoiceId |
Chỉ có đầu ra. Số hoá đơn ban đầu liên quan đến khoản tín dụng cho hoạt động không hợp lệ này. |
originalAccountBudgetName |
Chỉ có đầu ra. Tên ngân sách tài khoản ban đầu có liên quan đến khoản tín dụng cho hoạt động không hợp lệ này. |
originalPurchaseOrderNumber |
Chỉ có đầu ra. Số đơn đặt hàng ban đầu có liên quan đến khoản tín dụng cho hoạt động không hợp lệ này. |
amountMicros |
Chỉ có đầu ra. Lượng hoạt động không hợp lệ tính bằng phần triệu. |
AccountSummary
Đại diện cho chế độ xem tóm tắt ở cấp tài khoản.
Biểu diễn dưới dạng 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 } |
Trường | |
---|---|
customer |
Chỉ có đầu ra. Tài khoản được liên kết với phần tóm tắt về tài khoản. |
billingCorrectionSubtotalAmountMicros |
Chỉ có đầu ra. Tổng số phụ của khoản điều chỉnh thanh toán trước thuế, tính bằng phần triệu. |
billingCorrectionTaxAmountMicros |
Chỉ có đầu ra. Thuế điều chỉnh khoản thanh toán, tính theo phần triệu. |
billingCorrectionTotalAmountMicros |
Chỉ có đầu ra. Tổng số tiền điều chỉnh thanh toán, tính bằng phần triệu. |
couponAdjustmentSubtotalAmountMicros |
Chỉ có đầu ra. Tổng số tiền điều chỉnh của phiếu giảm giá trước thuế, tính bằng phần triệu. |
couponAdjustmentTaxAmountMicros |
Chỉ có đầu ra. Thuế điều chỉnh phiếu giảm giá, tính theo phần triệu. |
couponAdjustmentTotalAmountMicros |
Chỉ có đầu ra. Tổng số tiền điều chỉnh phiếu giảm giá, tính bằng phần triệu. |
excessCreditAdjustmentSubtotalAmountMicros |
Chỉ có đầu ra. Tổng số tiền điều chỉnh tín dụng dư trước thuế, tính bằng phần triệu. |
excessCreditAdjustmentTaxAmountMicros |
Chỉ có đầu ra. Thuế đối với khoản điều chỉnh tín dụng dư thừa, tính theo phần triệu. |
excessCreditAdjustmentTotalAmountMicros |
Chỉ có đầu ra. Tổng số tiền điều chỉnh tín dụng dư thừa, tính bằng phần triệu. |
regulatoryCostsSubtotalAmountMicros |
Chỉ có đầu ra. Tổng chi phí theo quy định trước thuế là tổng số tiền, tính bằng phần triệu. |
regulatoryCostsTaxAmountMicros |
Chỉ có đầu ra. Thuế đối với chi phí theo quy định, tính bằng phần triệu. |
regulatoryCostsTotalAmountMicros |
Chỉ có đầu ra. Tổng số tiền chi phí theo quy định, tính bằng phần triệu. |
exportChargeSubtotalAmountMicros |
Chỉ có đầu ra. Tổng số tiền cho phí xuất khẩu trước thuế, tính bằng phần triệu. |
exportChargeTaxAmountMicros |
Chỉ có đầu ra. Thuế tính trên phí xuất khẩu, tính theo phần triệu. |
exportChargeTotalAmountMicros |
Chỉ có đầu ra. Tổng số tiền phí xuất, tính bằng phần triệu. |
subtotalAmountMicros |
Chỉ có đầu ra. Tổng số tiền phụ trước thuế có thể phân bổ cho tài khoản trong thời gian dịch vụ, tính bằng phần triệu. |
taxAmountMicros |
Chỉ có đầu ra. Tổng số tiền thuế có thể quy cho tài khoản trong thời gian dịch vụ, tính bằng phần triệu. |
totalAmountMicros |
Chỉ có đầu ra. Tổng số tiền có thể phân bổ cho tài khoản trong thời gian dịch vụ, tính theo phần triệu. Số tiền này bằng tổng của subtotalAmountMicros và taxAmountMicros. |