Method: customers.invoices.list

Trả về tất cả hoá đơn được liên kết với thông tin thanh toán cho một tháng cụ thể.

Danh sách các lỗi đã gửi: AuthenticationError AuthorizationError FieldError HeaderError InternalError InvoiceError QuotaError RequestError

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Tham số
customerId

string

Bắt buộc. Mã của khách hàng cần tìm nạp hoá đơn.

Tham số truy vấn

Tham số
billingSetup

string

Bắt buộc. Tên tài nguyên thông tin thanh toán của các hoá đơn được yêu cầu.

customers/{customerId}/billingSetups/{billing_setup_id}
issueYear

string

Bắt buộc. Năm phát hành để truy xuất hoá đơn, theo định dạng yyyy. Bạn chỉ có thể truy xuất những hoá đơn phát hành trong năm 2019 trở đi.
issueMonth

enum (MonthOfYear)

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 (Invoice)
    }
  ]
}
Trường
invoices[]

object (Invoice)

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 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 ở định dạng PDF. Đối với các hoá đơn cũ hơn thời điểm triển khai BillService, thông tin tổng quan nhanh có thể không khớp với hoá đơn dạng PDF.

Biểu diễn dưới dạng 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
}
Trường
resourceName

string

Chỉ có đầu ra. Tên tài nguyên của hoá đơn. Nhiều khách hàng có thể sử dụng cùng một hoá đơn nhất định, do đó, nhiều tên tài nguyên có thể trỏ đến cùng một hoá đơn. Tên tài nguyên hoá đơn có dạng:

customers/{customerId}/invoices/{invoice_id}
type

enum (InvoiceType)

Chỉ có đầu ra. Loại hoá đơn.
serviceDateRange

object (DateRange)

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 bao gồm cả ngày kết thúc.
adjustmentsSubtotalAmountMicros

string (int64 format)

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 micro.
adjustmentsTaxAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng các khoản thuế trên các khoản điều chỉnh cấp hoá đơn, tính bằng micrô giây.
adjustmentsTotalAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng số tiền điều chỉnh ở cấp hoá đơn, tính bằng micrô.
regulatoryCostsSubtotalAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng phụ trước thuế của chi phí theo quy định ở cấp hoá đơn, tính bằng micro.
regulatoryCostsTaxAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng các khoản thuế tính trên chi phí theo quy định ở cấp hoá đơn, tính bằng micro.
regulatoryCostsTotalAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng chi phí theo quy định ở cấp hoá đơn, tính bằng micro.
replacedInvoices[]

string

Chỉ có đầu ra. Tên tài nguyên của(các) hoá đơn gốc đượ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 tổng hợp hoá đơn. Các hoá đơn thay thế có thể không thuộc cùng một tài khoản thanh toán. Nếu bạn đặt replacedInvoices, correctedInvoice sẽ không được đặt. Tên tài nguyên hoá đơn có dạng:

customers/{customerId}/invoices/{invoice_id}
accountBudgetSummaries[]

object (AccountBudgetSummary)

Chỉ có đầu ra. Danh sách thông tin tóm tắt về ngân sách tài khoản được liên kết với hoá đơn này.
accountSummaries[]

object (AccountSummary)

Chỉ có đầu ra. Danh sách thông tin tài khoản tóm tắt được liên kết với hoá đơn này.
id

string

Chỉ có đầu ra. Mã hoá đơn. Mã số này xuất hiện trên bản PDF hoá đơn dưới dạng "Số hoá đơn".
billingSetup

string

Chỉ có đầu ra. Tên tài nguyên của thông tin thanh toán của hoá đơn này.

customers/{customerId}/billingSetups/{billing_setup_id}
paymentsAccountId

string

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

string

Chỉ có đầu ra. Mã nhận dạng 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 bản PDF hoá đơn dưới dạng "Mã thanh toán".
issueDate

string

Chỉ có đầu ra. Ngày phát hành ở định dạng yyyy-mm-dd. Địa chỉ này xuất hiện trên bản PDF hoá đơn dưới dạng "Ngày phát hành" hoặc "Ngày lập hoá đơn".
dueDate

string

Chỉ có đầu ra. Ngày đến hạn ở định dạng yyyy-mm-dd.
currencyCode

string

Chỉ có đầu ra. Mã đơn vị tiền tệ. Tất cả chi phí đều được trả về theo đơn vị tiền tệ này. Có hỗ trợ một số mã đơn vị tiền tệ bắt nguồn từ tiêu chuẩn ISO 4217.
exportChargeSubtotalAmountMicros

string (int64 format)

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.
exportChargeTaxAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng các khoản thuế tính trên các khoản phí xuất khẩu ở cấp hoá đơn, tính bằng micrô giây.
exportChargeTotalAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng số tiền phí xuất ở cấp hoá đơn, tính bằng micro.
subtotalAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng phụ trước thuế, tính bằng micrô Số tiền này bằng với tổng số tiền của tổng phụ AccountBudgetSummary và cân bằng Hóa.
taxAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng tất cả các khoản thuế trên hoá đơn, tính bằng micro giây. 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 ngân sách tài khoản cụ thể.
totalAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng số tiền, tính bằng micrô. Số tiền này bằng tổng củaTạo hóa đơn.subtotal_amount_micros, Hóa đơn.tax_amount_micros, Hóa đơn.regulatory_costs_subtotal_amount_micros và Hóa đơn
correctedInvoice

string

Chỉ có đầu ra. Tên tài nguyên của hoá đơn gốc đã được hoá đơn này sửa, xoá bỏ hoặc huỷ (nếu có). Nếu bạn đặt correctedInvoice, replacedInvoices sẽ không được đặt. Tên tài nguyên hoá đơn có dạng:

customers/{customerId}/invoices/{invoice_id}
pdfUrl

string

Chỉ có đầu ra. URL đến bản sao PDF của hoá đơn. Người dùng cần truyền mã thông báo OAuth để 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ề. Đại diện cho 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ợ một số dư.

AccountBudgetSummary

Thể hiện chi phí phải thanh toán của ngân sách tài khoản tóm tắt.

Biểu diễn dưới dạng 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
}
Trường
billableActivityDateRange

object (DateRange)

Chỉ có đầu ra. Phạm vi ngày hoạt động có thể thanh toán của ngân sách tài khoản, trong phạm vi ngày dịch vụ của hoá đơn này. Ngày kết thúc bao gồm cả ngày kết thúc. 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[]

object (InvalidActivitySummary)

Chỉ có đầu ra. Danh sách tín dụng tóm tắt cho hoạt động không hợp lệ có các mối liên kết ban đầu.
customer

string

Chỉ có đầu ra. Tên tài nguyên của khách hàng 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 dưới dạng "Mã tài khoản" trên hoá đơn dưới dạng PDF. Tên tài nguyên của khách hàng có dạng:

customers/{customerId}
customerDescriptiveName

string

Chỉ có đầu ra. Tên mô tả về khách hàng sử dụng ngân sách tài khoản. Địa chỉ email này xuất hiện trên bản PDF hoá đơn dưới dạng "Tài khoản".
accountBudget

string

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 được tóm tắt này. Tên tài nguyên AccountBudget có dạng:

customers/{customerId}/accountBudgets/{account_budget_id}
accountBudgetName

string

Chỉ có đầu ra. Tên của ngân sách tài khoản. Ngân sách tài khoản sẽ xuất hiện trên tệp PDF hoá đơn dưới dạng "Ngân sách tài khoản".
purchaseOrderNumber

string

Chỉ có đầu ra. Số đơn đặt hàng của ngân sách tài khoản. Đơn đặt hàng này sẽ xuất hiện trên tệp PDF hoá đơn dưới dạng "Đơn đặt hàng".
subtotalAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng phụ trước thuế có thể quy 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.
taxAmountMicros

string (int64 format)

Chỉ có đầu ra. Số tiền thuế có thể phân bổ cho ngân sách này trong thời gian cung cấp dịch vụ, tính bằng micrô giây.
totalAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng số tiền được phân bổ cho ngân sách này trong thời gian cung cấp dịch vụ, tính bằng micrô. Số tiền này bằng tổng số tiền của ngân sách tài khoản và thuế suất của ngân sách tài khoản.
servedAmountMicros

string (int64 format)

Chỉ có đầu ra. Số tiền được phân phát trước thuế có thể 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. Thông tin này chỉ hữu ích khi điều chỉnh dữ liệu hoá đơn và giao hàng.
billedAmountMicros

string (int64 format)

Chỉ có đầu ra. Số tiền trước thuế được lập hoá đơn 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. Cột này không tính đến bất kỳ sự điều chỉnh nào.
overdeliveryAmountMicros

string (int64 format)

Chỉ có đầu ra. Số tiền phân phối quá 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 micrô (giá trị âm).
invalidActivityAmountMicros

string (int64 format)

Chỉ có đầu ra. Số tiền của hoạt động không hợp lệ trước thuế được quy cho ngân sách này trong các tháng trước, tính bằng micrô (giá trị âm).

InvalidActivitySummary

Thông tin chi tiết về hoạt động không hợp lệ đối với hoá đơn, bao gồm cả thông tin chi tiết bổ sung về hoá đơn đã được điều chỉnh.

Biểu diễn dưới dạng JSON 
{
  "originalMonthOfService": enum (MonthOfYear),
  "originalYearOfService": string,
  "originalInvoiceId": string,
  "originalAccountBudgetName": string,
  "originalPurchaseOrderNumber": string,
  "amountMicros": string
}
Trường
originalMonthOfService

enum (MonthOfYear)

Chỉ có đầu ra. Tháng sử dụng dịch vụ ban đầu liên quan đến khoản tín dụng cho hoạt động không hợp lệ này.
originalYearOfService

string

Chỉ có đầu ra. Năm sử dụng dịch vụ ban đầu có liên quan đến khoản tín dụng hoạt động không hợp lệ này.
originalInvoiceId

string

Chỉ có đầu ra. Số hoá đơn ban đầu liên quan đến khoản tín dụng hoạt động không hợp lệ này.
originalAccountBudgetName

string

Chỉ có đầu ra. Tên ngân sách tài khoản ban đầu liên quan đến khoản tín dụng cho hoạt động không hợp lệ này.
originalPurchaseOrderNumber

string

Chỉ có đầu ra. Số đơn đặt hàng ban đầu có liên quan đến khoản tín dụng hoạt động không hợp lệ này.
amountMicros

string (int64 format)

Chỉ có đầu ra. Số lượng hoạt động không hợp lệ tính theo micrô phần.

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

string

Chỉ có đầu ra. Tài khoản được liên kết với phần tóm tắt tài khoản.
billingCorrectionSubtotalAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng phụ của khoản điều chỉnh thanh toán trước thuế, tính bằng micrô giây.
billingCorrectionTaxAmountMicros

string (int64 format)

Chỉ có đầu ra. Thuế dựa trên việc điều chỉnh việc thanh toán, tính theo phần triệu.
billingCorrectionTotalAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng số tiền điều chỉnh thanh toán, tính bằng micrô giây.
couponAdjustmentSubtotalAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng phụ của khoản điều chỉnh phiếu giảm giá trước thuế, tính bằng micrô.
couponAdjustmentTaxAmountMicros

string (int64 format)

Chỉ có đầu ra. Thuế điều chỉnh phiếu giảm giá, tính bằng micrô giây.
couponAdjustmentTotalAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng số tiền điều chỉnh của phiếu giảm giá, tính bằng micrô giây.
excessCreditAdjustmentSubtotalAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng số tiền của khoản điều chỉnh tín dụng vượt quá trước thuế, tính bằng micrô.
excessCreditAdjustmentTaxAmountMicros

string (int64 format)

Chỉ có đầu ra. Thuế đối với khoản điều chỉnh tín dụng vượt quá, tính bằng micro.
excessCreditAdjustmentTotalAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng số tiền điều chỉnh tín dụng vượt quá, tính bằng micro.
regulatoryCostsSubtotalAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng chi phí trước thuế theo quy định, tính bằng micro.
regulatoryCostsTaxAmountMicros

string (int64 format)

Chỉ có đầu ra. Thuế đánh vào chi phí theo quy định, tính bằng micro.
regulatoryCostsTotalAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng chi phí theo quy định, tính bằng micrô.
exportChargeSubtotalAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng số tiền của phí xuất khẩu trước thuế, tính bằng micrô.
exportChargeTaxAmountMicros

string (int64 format)

Chỉ có đầu ra. Thuế đối với phí xuất khẩu, tính theo phần triệu.
exportChargeTotalAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng số tiền phí xuất khẩu, tính bằng micrô giây.
subtotalAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng số tiền tổng phụ trước thuế có thể quy cho tài khoản trong thời gian sử dụng dịch vụ, tính bằng phần triệu.
taxAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng số tiền thuế có thể phân bổ cho tài khoản trong thời gian sử dụng dịch vụ, tính bằng phần triệu.
totalAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng số tiền có thể phân bổ cho tài khoản trong thời gian sử dụng dịch vụ, tính bằng micrô giây. Giá trị này bằng tổng của subtotalAmountMicros và taxAmountMicros.