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 nhất định.

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/v14/customers/{customerId}/invoices

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

Tham số đường dẫn

Các tham số
customerId

string

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

Tham số truy vấn

Các 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 các hoá đơn được phát hành vào 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 trả lờ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)
    }
  ]
}
Các 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 dạng PDF. Đối với các hoá đơn cũ hơn thời điểm khởi chạy BillingService, thông tin được chụp nhanh có thể không khớp với hoá đơn 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
}
Các 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ể dùng chung 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 thời hạn dịch vụ của hoá đơn này. Ngày kết thúc có tính toàn bộ.

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 giây.

adjustmentsTaxAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng các khoản thuế đối với các khoản điều chỉnh cấp hoá đơn, tính bằng micro 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 micro.

regulatoryCostsSubtotalAmountMicros

string (int64 format)

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

regulatoryCostsTaxAmountMicros

string (int64 format)

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

regulatoryCostsTotalAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng chi phí theo quy định ở cấp hoá đơn, tính bằng micrô giây.

replacedInvoices[]

string

Chỉ có đầu ra. Tên tài nguyên của(các) hoá đơn ban đầu được thanh toán 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 hợp nhất 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 quan đến 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 liên quan đến hoá đơn này.

id

string

Chỉ có đầu ra. Mã hoá đơn. Mã này xuất hiện trên hoá đơn PDF 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ố 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"). Mã 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ã gồm 12 chữ số 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

string

Chỉ có đầu ra. Ngày phát hành ở định dạng yyyy-mm-dd. Ngày lập hoá đơn 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ả các chi phí đều được trả lại theo đơn vị tiền tệ này. Chúng tôi 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 phụ trước thuế của phí xuất khẩu ở cấp hoá đơn, tính bằng micrô giây.

exportChargeTaxAmountMicros

string (int64 format)

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

exportChargeTotalAmountMicros

string (int64 format)

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

subtotalAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng phụ tiền trước thuế, tính bằng micrô giây. Số tiền này bằng tổng số tiền của tổng phụ AccountNgân sách và Hoá đơn.

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 micrô giây. Số tiền này bằng tổng số tiền thuế của 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ủa Hoá đơn.subtotal_amount_micros, Hoá đơn.tax_amount_micros, Hoá đơn.regulatory_costs_subtotal_amount_micros và Hoá đơn.export_charge_subtotal_amount_micros (được tách riêng thành một mục riêng bắt đầu bằng V14.1).

correctedInvoice

string

Chỉ có đầu ra. Tên tài nguyên của hoá đơn gốc đã được sửa, xoá bỏ hoặc huỷ theo hoá đơn này (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 sang 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ể dùng.

Enum
UNSPECIFIED Chưa xác đị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 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ợ số dư.

AccountBudgetSummary

Thể hiện chi phí có thể lập hoá đơ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
}
Các trường
billableActivityDateRange

object (DateRange)

Chỉ có đầu ra. Phạm vi ngày hoạt động có thể lập hoá đơ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 có tính toàn bộ. Thời gian này có thể khác với thời gian bắt đầu và thời gian 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ệ với các đường liên kết ban đầu.

customer

string

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. Hồ sơ thanh toán chứa mã khách hàng dưới dạng "Mã tài khoản" trên hoá đơn 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 của ngân sách tài khoản. Mã này xuất hiện trên hoá đơn ở định dạng PDF 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 được liên kết với chi phí lập hoá đơn tóm tắt này. Tên tài nguyên Ngân sách tài khoản 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. Mã này xuất hiện trên hoá đơn PDF 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 hoá đơn PDF dưới dạng "Đơn đặt hàng".

subtotalAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng phụ phí trước thuế có thể quy cho ngân sách này trong thời hạn dịch vụ, tính bằng micro giây.

taxAmountMicros

string (int64 format)

Chỉ có đầu ra. Số tiền thuế quy cho ngân sách này trong thời hạn dịch vụ, tính bằng micro 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 suốt thời gian sử dụng dịch vụ, tính bằng micro giây. Số tiền này bằng tổng số tiền phụ của ngân sách tài khoản và số thuế trong ngân sách tài khoản.

servedAmountMicros

string (int64 format)

Chỉ có đầu ra. Số tiền phân phát 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 micro giây. Thông tin này chỉ hữu ích khi điều chỉnh dữ liệu hoá đơn và dữ liệu phân phối.

billedAmountMicros

string (int64 format)

Chỉ có đầu ra. Số tiền trước thuế đã lập hóa đơn có thể quy cho ngân sách này trong thời gian sử dụng dịch vụ, tính bằng micro giây. Giá trị này không tính đến các khoản điều chỉnh.

overdeliveryAmountMicros

string (int64 format)

Chỉ có đầu ra. Số tiền phân phối quá trước thuế có thể quy cho ngân sách này trong thời hạn dịch vụ, tính bằng micro giây (giá trị âm).

invalidActivityAmountMicros

string (int64 format)

Chỉ có đầu ra. Số tiền hoạt động không hợp lệ trước thuế có thể quy cho ngân sách này trong các tháng trước, tính bằng micro (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 (MonthOfYear),
  "originalYearOfService": string,
  "originalInvoiceId": string,
  "originalAccountBudgetName": string,
  "originalPurchaseOrderNumber": string,
  "amountMicros": string
}
Các 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 hoạt động không hợp lệ này.

originalYearOfService

string

Chỉ có đầu ra. Năm sử dụng dịch vụ gố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 gốc 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 hoạt động không hợp lệ này.

originalPurchaseOrderNumber

string

Chỉ có đầu ra. Số đơn đặt hàng ban đầu 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. Lượng hoạt động không hợp lệ cực nhỏ.

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
}
Các trường
customer

string

Chỉ có đầu ra. Tài khoản được liên kết với bả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 khoản điều chỉnh thanh toán, tính bằng micro giây.

billingCorrectionTotalAmountMicros

string (int64 format)

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

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 micro giây.

couponAdjustmentTaxAmountMicros

string (int64 format)

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

couponAdjustmentTotalAmountMicros

string (int64 format)

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

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 thuế trước thuế, tính theo phần triệu.

excessCreditAdjustmentTaxAmountMicros

string (int64 format)

Chỉ có đầu ra. Thuế áp dụng cho khoản điều chỉnh tín dụng vượt mức, 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 phụ của chi phí theo quy định trước thuế, tính bằng micrô giây.

regulatoryCostsTaxAmountMicros

string (int64 format)

Chỉ có đầu ra. Thuế trên chi phí theo quy định, tính bằng micro giây.

regulatoryCostsTotalAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng số tiền chi phí theo quy định, tính bằng micro.

exportChargeSubtotalAmountMicros

string (int64 format)

Chỉ có đầu ra. Tổng phụ phí xuất khẩu trước thuế, tính bằng micrô giây.

exportChargeTaxAmountMicros

string (int64 format)

Chỉ có đầu ra. Thuế phí xuất khẩu, tính bằng micro.

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 hạn dịch vụ, tính bằng micro giây.

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 micro giây.

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 hạn dịch vụ, tính bằng micro. Số tiền này bằng tổng của subtotalAmountMicros và taxAmountMicros.