Method: customers.invoices.list

Menampilkan semua invoice yang terkait dengan penyiapan penagihan, untuk bulan tertentu.

Daftar error yang ditampilkan: AuthenticationError AuthorizationError FieldError HeaderError InternalError InvoiceError QuotaError RequestError

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
customerId

string

Wajib. ID pelanggan untuk mengambil invoice.

Parameter kueri

Parameter
billingSetup

string

Wajib. Nama resource penyiapan penagihan dari invoice yang diminta.

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

string

Wajib. Tahun penerbitan untuk mengambil invoice, dalam format yyyy. Hanya invoice yang diterbitkan pada tahun 2019 atau setelahnya yang dapat diambil.
issueMonth

enum (MonthOfYear)

Wajib. Bulan penerbitan untuk mengambil invoice.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Pesan respons untuk InvoiceService.ListInvoices.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "invoices": [
    {
      object (Invoice)
    }
  ]
}
Kolom
invoices[]

object (Invoice)

Daftar invoice yang cocok dengan konfigurasi penagihan dan jangka waktu.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

  • https://www.googleapis.com/auth/adwords

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

Invoice

Faktur. Semua informasi invoice dibuat agar sesuai dengan invoice PDF. Untuk invoice yang lebih lama dari peluncuran InvoiceService, informasi yang diambil mungkin tidak cocok dengan invoice PDF.

Representasi 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
}
Kolom
resourceName

string

Hanya output. Nama resource invoice. Beberapa pelanggan dapat berbagi invoice yang diberikan, sehingga beberapa nama fasilitas dapat menunjuk ke invoice yang sama. Nama resource invoice memiliki bentuk:

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

enum (InvoiceType)

Hanya output. Jenis invoice.
serviceDateRange

object (DateRange)

Hanya output. Rentang tanggal periode layanan invoice ini. Tanggal akhir bersifat inklusif.
adjustmentsSubtotalAmountMicros

string (int64 format)

Hanya output. Jumlah subtotal penyesuaian tingkat invoice sebelum pajak, dalam mikro.
adjustmentsTaxAmountMicros

string (int64 format)

Hanya output. Jumlah pajak pada penyesuaian tingkat invoice, dalam mikros.
adjustmentsTotalAmountMicros

string (int64 format)

Hanya output. Jumlah total penyesuaian tingkat invoice, dalam mikro.
regulatoryCostsSubtotalAmountMicros

string (int64 format)

Hanya output. Jumlah subtotal sebelum pajak dari biaya peraturan tingkat invoice, dalam mikro.
regulatoryCostsTaxAmountMicros

string (int64 format)

Hanya output. Jumlah pajak pada biaya peraturan tingkat invoice, dalam mikro.
regulatoryCostsTotalAmountMicros

string (int64 format)

Hanya output. Jumlah total biaya peraturan tingkat invoice, dalam mikro.
replacedInvoices[]

string

Hanya output. Nama referensi dari invoice asli yang ditagih kembali atau diganti dengan invoice ini, jika ada. Mungkin ada beberapa faktur yang diganti karena penggabungan faktur. Invoice yang diganti mungkin bukan milik akun pembayaran yang sama. Jika replacedInvoices disetel, correctedInvoice tidak akan disetel. Nama resource invoice memiliki bentuk:

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

object (AccountBudgetSummary)

Hanya output. Daftar ringkasan informasi anggaran akun yang terkait dengan invoice ini.
accountSummaries[]

object (AccountSummary)

Hanya output. Daftar ringkasan informasi akun yang terkait dengan invoice ini.
id

string

Hanya output. ID invoice. Alamat ini akan tercantum pada PDF invoice sebagai "Nomor invoice".
billingSetup

string

Hanya output. Nama resource penyiapan penagihan invoice ini.

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

string

Hanya output. ID 16 digit yang digunakan untuk mengidentifikasi akun pembayaran yang terkait dengan penyiapan penagihan, misalnya, "1234-5678-9012-3456". Alamat ini akan muncul pada PDF invoice sebagai "Nomor Rekening Penagihan".
paymentsProfileId

string

Hanya output. ID 12 digit yang digunakan untuk mengidentifikasi profil pembayaran yang terkait dengan penyiapan penagihan, misalnya, "1234-5678-9012". ID tersebut akan muncul di PDF invoice sebagai "ID Penagihan".
issueDate

string

Hanya output. Tanggal penerbitan dalam format yyyy-mm-dd. Invoice tersebut akan tercantum pada PDF invoice sebagai "Tanggal penerbitan" atau "Tanggal invoice".
dueDate

string

Hanya output. Batas waktu dalam format yyyy-mm-dd.
currencyCode

string

Hanya output. Kode mata uang. Semua biaya dikembalikan dalam mata uang ini. Subset kode mata uang yang berasal dari standar ISO 4217 didukung.
exportChargeSubtotalAmountMicros

string (int64 format)

Hanya output. Jumlah subtotal sebelum pajak dari biaya ekspor tingkat invoice, dalam mikro.
exportChargeTaxAmountMicros

string (int64 format)

Hanya output. Jumlah pajak pada biaya ekspor tingkat invoice, dalam mikro.
exportChargeTotalAmountMicros

string (int64 format)

Hanya output. Jumlah total biaya ekspor tingkat invoice, dalam mikro.
subtotalAmountMicros

string (int64 format)

Hanya output. Jumlah subtotal sebelum pajak, dalam mikro. Jumlah ini sama dengan jumlah subtotal AccountBudgetSummary dan Invoice.penyesuaian_subtotal_amount_micros.
taxAmountMicros

string (int64 format)

Hanya output. Jumlah semua pajak pada invoice, dalam mikro. Ini sama dengan jumlah pajak AccountBudgetSummary, ditambah pajak yang tidak terkait dengan anggaran akun tertentu.
totalAmountMicros

string (int64 format)

Hanya output. Jumlah total, dalam mikro. Ini sama dengan jumlah Invoice.subtotal_amount_micros, Invoice.tax_amount_micros, Invoice.regulatory_costs_subtotal_amount_micros, dan Invoice.export_charge_subtotal_amount_micros (yang dipisahkan menjadi item baris terpisah yang dimulai dengan V14.1).
correctedInvoice

string

Hanya output. Nama referensi invoice asli yang dikoreksi, dihapus, atau dibatalkan oleh invoice ini, jika ada. Jika correctedInvoice disetel, replacedInvoices tidak akan disetel. Nama resource invoice memiliki bentuk:

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

string

Hanya output. URL ke salinan invoice PDF. Pengguna harus meneruskan token OAuth untuk meminta PDF dengan URL ini.

InvoiceType

Kemungkinan jenis invoice.

Enum
UNSPECIFIED Tidak ditentukan.
UNKNOWN Hanya digunakan untuk nilai hasil. Mewakili nilai yang tidak diketahui dalam versi ini.
CREDIT_MEMO Invoice dengan jumlah negatif. Akun menerima kredit.
INVOICE Invoice dengan jumlah positif. Akun berutang saldo.

AccountBudgetSummary

Mewakili ringkasan biaya yang dapat ditagih dari anggaran akun.

Representasi 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
}
Kolom
billableActivityDateRange

object (DateRange)

Hanya output. Rentang tanggal aktivitas yang dapat ditagih dari anggaran akun, dalam rentang tanggal layanan invoice ini. Tanggal akhir bersifat inklusif. Waktu mulai dan berakhir anggaran akun dapat berbeda.
invalidActivitySummaries[]

object (InvalidActivitySummary)

Hanya output. Daftar kredit aktivitas tidak valid yang diringkas dengan penautan asli.
customer

string

Hanya output. Nama resource pelanggan yang dikaitkan dengan anggaran akun ini. ID ini berisi ID pelanggan, yang muncul di PDF invoice sebagai "ID Akun". Nama resource pelanggan memiliki format:

customers/{customerId}
customerDescriptiveName

string

Hanya output. Nama deskriptif pelanggan anggaran akun. Alamat ini akan muncul di PDF invoice sebagai "Akun".
accountBudget

string

Hanya output. Nama resource anggaran akun yang terkait dengan ringkasan biaya yang dapat ditagih ini. Nama resource Anggaran Akun memiliki bentuk:

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

string

Hanya output. Nama anggaran akun. Nilai ini akan muncul di PDF invoice sebagai "Anggaran akun".
purchaseOrderNumber

string

Hanya output. Nomor pesanan pembelian (PO) anggaran akun. Nilai tersebut akan muncul di PDF invoice sebagai "Pesanan pembelian".
subtotalAmountMicros

string (int64 format)

Hanya output. Jumlah subtotal sebelum pajak yang dapat diatribusikan ke anggaran ini selama periode layanan, dalam mikro.
taxAmountMicros

string (int64 format)

Hanya output. Jumlah pajak yang dapat diatribusikan ke anggaran ini selama periode layanan, dalam mikro.
totalAmountMicros

string (int64 format)

Hanya output. Jumlah total yang dapat diatribusikan ke anggaran ini selama periode layanan, dalam mikro. Ini sama dengan jumlah subtotal anggaran akun dan jumlah pajak anggaran akun.
servedAmountMicros

string (int64 format)

Hanya output. Jumlah penayangan sebelum pajak yang dapat diatribusikan ke anggaran ini selama periode layanan, dalam mikro. Metode ini hanya dapat digunakan untuk merekonsiliasi data invoice dan pengiriman.
billedAmountMicros

string (int64 format)

Hanya output. Jumlah tagihan sebelum pajak yang dapat diatribusikan ke anggaran ini selama periode layanan, dalam mikro. Jumlah ini tidak memperhitungkan penyesuaian apa pun.
overdeliveryAmountMicros

string (int64 format)

Hanya output. Jumlah kelebihan tayangan sebelum pajak yang dapat diatribusikan ke anggaran ini selama periode layanan, dalam mikro (nilai negatif).
invalidActivityAmountMicros

string (int64 format)

Hanya output. Jumlah aktivitas tidak valid sebelum pajak yang dapat diatribusikan ke anggaran ini pada bulan-bulan sebelumnya, dalam mikro (nilai negatif).

InvalidActivitySummary

Detail tentang aktivitas tidak valid untuk invoice yang berisi detail tambahan tentang invoice yang diperbaiki.

Representasi JSON 
{
  "originalMonthOfService": enum (MonthOfYear),
  "originalYearOfService": string,
  "originalInvoiceId": string,
  "originalAccountBudgetName": string,
  "originalPurchaseOrderNumber": string,
  "amountMicros": string
}
Kolom
originalMonthOfService

enum (MonthOfYear)

Hanya output. Bulan layanan awal yang terkait dengan kredit aktivitas yang tidak valid ini.
originalYearOfService

string

Hanya output. Tahun layanan awal yang terkait dengan kredit aktivitas yang tidak valid ini.
originalInvoiceId

string

Hanya output. Nomor invoice asli yang terkait dengan kredit aktivitas yang tidak valid ini.
originalAccountBudgetName

string

Hanya output. Nama anggaran akun asli yang terkait dengan kredit aktivitas yang tidak valid ini.
originalPurchaseOrderNumber

string

Hanya output. Nomor pesanan pembelian (PO) asli yang terkait dengan kredit aktivitas yang tidak valid ini.
amountMicros

string (int64 format)

Hanya output. Jumlah aktivitas tidak valid dalam mikro.

AccountSummary

Mewakili tampilan ringkasan di tingkat akun.

Representasi 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
}
Kolom
customer

string

Hanya output. Akun yang terkait dengan ringkasan akun.
billingCorrectionSubtotalAmountMicros

string (int64 format)

Hanya output. Jumlah subtotal koreksi penagihan sebelum pajak, dalam mikro.
billingCorrectionTaxAmountMicros

string (int64 format)

Hanya output. Pajak atas koreksi penagihan, dalam mikro.
billingCorrectionTotalAmountMicros

string (int64 format)

Hanya output. Total jumlah koreksi tagihan, dalam mikro.
couponAdjustmentSubtotalAmountMicros

string (int64 format)

Hanya output. Jumlah subtotal penyesuaian kupon sebelum pajak, dalam mikro.
couponAdjustmentTaxAmountMicros

string (int64 format)

Hanya output. Pajak atas penyesuaian kupon, dalam mikro.
couponAdjustmentTotalAmountMicros

string (int64 format)

Hanya output. Jumlah penyesuaian kupon total, dalam mikro.
excessCreditAdjustmentSubtotalAmountMicros

string (int64 format)

Hanya output. Jumlah subtotal penyesuaian kredit lebih sebelum pajak, dalam mikro.
excessCreditAdjustmentTaxAmountMicros

string (int64 format)

Hanya output. Pajak atas penyesuaian kredit berlebih, dalam mikro.
excessCreditAdjustmentTotalAmountMicros

string (int64 format)

Hanya output. Total jumlah penyesuaian kredit lebih, dalam mikro.
regulatoryCostsSubtotalAmountMicros

string (int64 format)

Hanya output. Jumlah subtotal biaya berdasarkan peraturan sebelum pajak, dalam mikro.
regulatoryCostsTaxAmountMicros

string (int64 format)

Hanya output. Pajak atas biaya berdasarkan peraturan, dalam mikro.
regulatoryCostsTotalAmountMicros

string (int64 format)

Hanya output. Jumlah total biaya berdasarkan peraturan, dalam mikro.
exportChargeSubtotalAmountMicros

string (int64 format)

Hanya output. Jumlah subtotal biaya ekspor sebelum pajak, dalam mikro.
exportChargeTaxAmountMicros

string (int64 format)

Hanya output. Pajak atas biaya ekspor, dalam mikro.
exportChargeTotalAmountMicros

string (int64 format)

Hanya output. Jumlah total tagihan ekspor, dalam mikro.
subtotalAmountMicros

string (int64 format)

Hanya output. Total jumlah subtotal sebelum pajak yang dapat diatribusikan ke akun selama periode layanan, dalam mikro.
taxAmountMicros

string (int64 format)

Hanya output. Jumlah total pajak yang dapat diatribusikan ke akun selama periode layanan, dalam mikro.
totalAmountMicros

string (int64 format)

Hanya output. Jumlah total yang dapat diatribusikan ke akun selama periode layanan, dalam mikro. Ini sama dengan jumlah subtotalAmountMicros dan taxAmountMicros.