Method: customers.invoices.list

Belirli bir ay için bir faturalandırma ayarlarıyla ilişkili tüm faturaları döndürür.

Verilen hataların listesi: AuthenticationError AuthorizationError FieldError HeaderError InternalError InvoiceError QuotaError RequestError

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
customerId

string

Zorunlu. Faturalarının alınacağı müşterinin kimliği.

Sorgu parametreleri

Parametreler
billingSetup

string

Zorunlu. İstenen faturaların faturalandırma kurulumu kaynak adı.

customers/{customerId}/billingSetups/{billing_setup_id}

issueYear

string

Zorunlu. Faturaların alındığı yıl, yyyy biçiminde belirtilir. Yalnızca 2019 veya sonrasında düzenlenen faturalar alınabilir.

issueMonth

enum (MonthOfYear)

Zorunlu. Faturaların alındığı ay.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

InvoiceService.ListInvoices için yanıt mesajı.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi
{
  "invoices": [
    {
      object (Invoice)
    }
  ]
}
Alanlar
invoices[]

object (Invoice)

Faturalandırma ayarları ve dönemiyle eşleşen faturaların listesi.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için OAuth 2.0'a Genel Bakış başlıklı makaleye bakın.

Fatura

Fatura. Tüm fatura bilgileri, PDF faturayla eşleşecek şekilde anlık olarak görüntülenir. InvoiceService'in kullanıma sunulmasından daha eski faturalar için anlık görüntü alınan bilgiler PDF faturayla eşleşmeyebilir.

JSON gösterimi
{
  "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
}
Alanlar
resourceName

string

Yalnızca çıkış. Faturanın kaynak adı. Belirli bir faturayı birden çok müşteri paylaşabilir. Bu nedenle, birden fazla kaynak adı aynı faturayı işaret edebilir. Fatura kaynak adları şu biçimdedir:

customers/{customerId}/invoices/{invoice_id}

type

enum (InvoiceType)

Yalnızca çıkış. Faturanın türü.

serviceDateRange

object (DateRange)

Yalnızca çıkış. Bu faturanın hizmet dönemi tarih aralığı. Bitiş tarihi kapsayıcıdır.

adjustmentsSubtotalAmountMicros

string (int64 format)

Yalnızca çıkış. Fatura seviyesindeki düzenlemelerin vergi öncesi ara toplam tutarı (mikrosaniye cinsinden).

adjustmentsTaxAmountMicros

string (int64 format)

Yalnızca çıkış. Fatura seviyesindeki düzenlemelerdeki vergilerin toplamı (mikro ölçekte).

adjustmentsTotalAmountMicros

string (int64 format)

Yalnızca çıkış. Fatura seviyesindeki düzenlemelerin mikro cinsinden toplam tutarı.

regulatoryCostsSubtotalAmountMicros

string (int64 format)

Yalnızca çıkış. Fatura seviyesindeki yasal maliyetlerin vergi öncesi ara toplam tutarı (mikro ölçekte).

regulatoryCostsTaxAmountMicros

string (int64 format)

Yalnızca çıkış. Fatura düzeyinde yasal maliyetler üzerinden vergilerin toplamı (mikro ölçekte).

regulatoryCostsTotalAmountMicros

string (int64 format)

Yalnızca çıkış. Fatura düzeyindeki yasal maliyetlerin mikro cinsinden toplam tutarı.

replacedInvoices[]

string

Yalnızca çıkış. Yeniden düzenlenen veya bu faturayla değiştirilen orijinal faturaların(varsa) kaynak adı. Fatura birleştirme nedeniyle birden fazla fatura değiştirilmiş olabilir. Değiştirilen faturalar aynı ödeme hesabına ait olmayabilir. replacedInvoices ayarlanırsa correctedInvoice ayarlanmaz. Fatura kaynak adları şu biçimdedir:

customers/{customerId}/invoices/{invoice_id}

accountBudgetSummaries[]

object (AccountBudgetSummary)

Yalnızca çıkış. Bu faturayla ilişkili hesap bütçesi bilgilerinin bir özeti.

accountSummaries[]

object (AccountSummary)

Yalnızca çıkış. Bu faturayla ilişkili hesap bilgilerinin bir özeti.

id

string

Yalnızca çıkış. Faturanın kimliği. PDF'de "Fatura numarası" olarak görünür.

billingSetup

string

Yalnızca çıkış. Bu faturanın faturalandırma ayarlarının kaynak adı.

customers/{customerId}/billingSetups/{billing_setup_id}

paymentsAccountId

string

Yalnızca çıkış. Faturalandırma ayarlarıyla ilişkili ödeme hesabını tanımlamak için kullanılan 16 haneli kimlik (ör. "1234-5678-9012-3456"). Bu numara, fatura PDF'sinde "Faturalandırma Hesabı Numarası" olarak görünür.

paymentsProfileId

string

Yalnızca çıkış. Faturalandırma ayarlarıyla ilişkili ödeme profilini tanımlamak için kullanılan 12 haneli kimlik (ör. "1234-5678-9012"). PDF'de "Faturalandırma Kimliği" olarak görünür.

issueDate

string

Yalnızca çıkış. yyyy-aa-gg biçimindeki verilme tarihi. PDF dosyasında "Düzenlenme tarihi" veya "Fatura tarihi" olarak görünür.

dueDate

string

Yalnızca çıkış. yyyy-aa-gg biçiminde teslim tarihi.

currencyCode

string

Yalnızca çıkış. Para birimi kodu. Tüm maliyetler bu para biriminde döndürülür. ISO 4217 standardından türetilen para birimi kodlarının alt kümesi desteklenir.

exportChargeSubtotalAmountMicros

string (int64 format)

Yalnızca çıkış. Fatura düzeyinde dışa aktarma ücretlerinin vergi öncesi ara toplam tutarı (mikrosaniye cinsinden).

exportChargeTaxAmountMicros

string (int64 format)

Yalnızca çıkış. Fatura düzeyinde ihracat masraflarının mikro cinsinden toplamı.

exportChargeTotalAmountMicros

string (int64 format)

Yalnızca çıkış. Fatura düzeyinde dışa aktarma ücretlerinin mikro cinsinden toplam tutarı.

subtotalAmountMicros

string (int64 format)

Yalnızca çıkış. Vergi öncesi ara toplam tutar (mikrosaniye cinsinden). Bu, AccountBudgetSummary ara toplam tutarları ile Invoice.adjustments_subtotal_amount_micros değerlerinin toplamına eşittir.

taxAmountMicros

string (int64 format)

Yalnızca çıkış. Faturadaki tüm vergilerin mikro cinsinden toplamı. Bu tutar, AccountBudgetSummary vergi tutarlarının ve belirli bir hesap bütçesiyle ilişkili olmayan vergilerin toplamına eşittir.

totalAmountMicros

string (int64 format)

Yalnızca çıkış. Mikro cinsinden toplam tutar. Bu, Invoice.subtotal_amount_micros, Invoice.tax_amount_micros, Invoice.regulatory_costs_subtotal_amount_micros ve Invoice.export_charge_subtotal_amount_micros (V14.1'den itibaren ayrı bir satır öğesine ayrılır) toplamına eşittir.

correctedInvoice

string

Yalnızca çıkış. Orijinal faturanın kaynak adı, bu faturayla düzeltildi veya iptal edildiyse (varsa). correctedInvoice ayarlanırsa replacedInvoices ayarlanmaz. Fatura kaynak adları şu biçimdedir:

customers/{customerId}/invoices/{invoice_id}

pdfUrl

string

Yalnızca çıkış. Faturanın PDF kopyasının URL'si. Kullanıcıların bu URL'yi kullanarak PDF isteğinde bulunabilmek için OAuth jetonlarını iletmesi gerekir.

InvoiceType

Olası fatura türleri.

Sıralamalar
UNSPECIFIED Belirtilmedi.
UNKNOWN Yalnızca döndürülen değer için kullanılır. Bu sürümde bilinmeyen değeri temsil eder.
CREDIT_MEMO Negatif tutarı olan bir fatura. Hesaba bir kredi aktarılır.
INVOICE Pozitif tutarı olan bir fatura. Hesabın bakiyesi.

AccountBudgetSummary

Özet hesap bütçesi faturalandırılabilir maliyetini temsil eder.

JSON gösterimi
{
  "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
}
Alanlar
billableActivityDateRange

object (DateRange)

Yalnızca çıkış. Hesap bütçesinin, bu faturanın hizmet tarihi aralığı içindeki faturalandırılabilir etkinlik tarih aralığı. Bitiş tarihi kapsayıcıdır. Bu tarih, hesap bütçesinin başlangıç ve bitiş zamanından farklı olabilir.

invalidActivitySummaries[]

object (InvalidActivitySummary)

Yalnızca çıkış. Orijinal bağlantıları içeren geçersiz etkinlik kredilerinin özeti.

customer

string

Yalnızca çıkış. Bu hesap bütçesiyle ilişkilendirilmiş müşterinin kaynak adı. Bu kimlik, fatura PDF'sinde "Hesap Kimliği" olarak görünen müşteri kimliğini içerir. Müşteri kaynakları şu biçimdedir:

customers/{customerId}

customerDescriptiveName

string

Yalnızca çıkış. Hesap bütçesi müşterisinin açıklayıcı adı. PDF'de "Hesap" olarak görünür.

accountBudget

string

Yalnızca çıkış. Bu özet faturalandırılabilir maliyetle ilişkili hesap bütçesinin kaynak adı. Hesap Bütçesi kaynak adları şu biçimdedir:

customers/{customerId}/accountBudgets/{account_budget_id}

accountBudgetName

string

Yalnızca çıkış. Hesap bütçesinin adı. Fatura PDF'sinde "Hesap bütçesi" olarak görünür.

purchaseOrderNumber

string

Yalnızca çıkış. Hesap bütçesinin satın alma siparişi numarası. PDF dosyasında "Satın alma siparişi" olarak görünür.

subtotalAmountMicros

string (int64 format)

Yalnızca çıkış. Hizmet dönemi boyunca bu bütçeyle ilişkilendirilebilen vergi öncesi ara toplam tutar (mikro cinsinden).

taxAmountMicros

string (int64 format)

Yalnızca çıkış. Hizmet dönemi boyunca bu bütçeyle ilişkilendirilebilecek vergi tutarı (mikro ölçekte).

totalAmountMicros

string (int64 format)

Yalnızca çıkış. Hizmet dönemi boyunca bu bütçeyle ilişkilendirilebilecek toplam tutar (mikro ölçekte). Bu tutar, hesap bütçesi ara toplam tutarı ile hesap bütçesi vergi tutarının toplamına eşittir.

servedAmountMicros

string (int64 format)

Yalnızca çıkış. Hizmet dönemi boyunca bu bütçeyle ilişkilendirilebilecek vergi öncesi tutar (mikro ölçekte). Bu yalnızca fatura ve teslimat verilerinin mutabakatını yapmak için yararlıdır.

billedAmountMicros

string (int64 format)

Yalnızca çıkış. Hizmet dönemi boyunca bu bütçeyle ilişkilendirilebilen vergi öncesi faturalanan tutar (mikro ölçekte). Bu, herhangi bir düzenlemeyi hesaba katmaz.

overdeliveryAmountMicros

string (int64 format)

Yalnızca çıkış. Hizmet dönemi boyunca bu bütçeyle ilişkilendirilebilecek, vergi öncesi fazla yayın tutarı (mikro ölçekte (negatif değer).

invalidActivityAmountMicros

string (int64 format)

Yalnızca çıkış. Önceki aylarda bu bütçeyle ilişkilendirilebilen, vergi öncesi geçersiz etkinlik tutarı (mikro ölçekte (negatif değer)).

InvalidActivitySummary

Düzeltme yapılan faturayla ilgili ek ayrıntıları içeren, faturadaki geçersiz etkinlikle ilgili ayrıntılar.

JSON gösterimi
{
  "originalMonthOfService": enum (MonthOfYear),
  "originalYearOfService": string,
  "originalInvoiceId": string,
  "originalAccountBudgetName": string,
  "originalPurchaseOrderNumber": string,
  "amountMicros": string
}
Alanlar
originalMonthOfService

enum (MonthOfYear)

Yalnızca çıkış. Bu geçersiz etkinlik kredisiyle ilgili orijinal hizmet ayı.

originalYearOfService

string

Yalnızca çıkış. Bu geçersiz etkinlik kredisiyle ilgili orijinal hizmet yılı.

originalInvoiceId

string

Yalnızca çıkış. Bu geçersiz etkinlik kredisine ilişkin orijinal fatura numarası.

originalAccountBudgetName

string

Yalnızca çıkış. Bu geçersiz etkinlik kredisiyle ilgili orijinal hesap bütçesi adı.

originalPurchaseOrderNumber

string

Yalnızca çıkış. Bu geçersiz etkinlik kredisiyle ilgili orijinal satın alma siparişi numarası.

amountMicros

string (int64 format)

Yalnızca çıkış. Mikro cinsinden geçersiz etkinlik miktarı.

AccountSummary

Hesap düzeyinde bir özet görünümü sunar.

JSON gösterimi
{
  "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
}
Alanlar
customer

string

Yalnızca çıkış. Hesap özetiyle ilişkilendirilen hesap.

billingCorrectionSubtotalAmountMicros

string (int64 format)

Yalnızca çıkış. Vergi öncesi faturalandırma düzeltmesi ara toplam tutarı (mikro cinsinden).

billingCorrectionTaxAmountMicros

string (int64 format)

Yalnızca çıkış. Faturalandırma düzeltmesi vergisi (mikrosaniye cinsinden).

billingCorrectionTotalAmountMicros

string (int64 format)

Yalnızca çıkış. Toplam faturalandırma düzeltme tutarı (mikro ölçekte).

couponAdjustmentSubtotalAmountMicros

string (int64 format)

Yalnızca çıkış. Vergi öncesi kupon düzenlemesi ara toplam tutarı (mikro cinsinden).

couponAdjustmentTaxAmountMicros

string (int64 format)

Yalnızca çıkış. Kupon düzenlemesindeki vergi (mikro ölçekte).

couponAdjustmentTotalAmountMicros

string (int64 format)

Yalnızca çıkış. Kupon düzenleme tutarının mikro cinsinden toplam tutarı.

excessCreditAdjustmentSubtotalAmountMicros

string (int64 format)

Yalnızca çıkış. Vergi öncesi fazla kredi düzenlemesi ara toplam tutarı (mikrosaniye cinsinden).

excessCreditAdjustmentTaxAmountMicros

string (int64 format)

Yalnızca çıkış. Fazla kredi düzenlemesi üzerinden alınan vergi (mikro ölçekte).

excessCreditAdjustmentTotalAmountMicros

string (int64 format)

Yalnızca çıkış. Toplam kalan kredi düzenleme tutarı (mikrosaniye cinsinden).

regulatoryCostsSubtotalAmountMicros

string (int64 format)

Yalnızca çıkış. Vergi öncesi yasal maliyetlerin mikro cinsinden ara toplam tutarı.

regulatoryCostsTaxAmountMicros

string (int64 format)

Yalnızca çıkış. Yasal maliyetlerden alınan vergi (mikro ölçekte).

regulatoryCostsTotalAmountMicros

string (int64 format)

Yalnızca çıkış. Toplam yasal maliyet tutarı (mikro ölçekte).

exportChargeSubtotalAmountMicros

string (int64 format)

Yalnızca çıkış. Vergi öncesi dışa aktarma ücreti ara toplam tutarı (mikrosaniye cinsinden).

exportChargeTaxAmountMicros

string (int64 format)

Yalnızca çıkış. İhracat ücretinin vergisi (mikro ölçekte).

exportChargeTotalAmountMicros

string (int64 format)

Yalnızca çıkış. Toplam dışa aktarma ücretinin tutarı (mikro ölçekte).

subtotalAmountMicros

string (int64 format)

Yalnızca çıkış. Hizmet dönemi süresince hesapla ilişkilendirilebilecek toplam vergi öncesi ara toplam tutar (mikro ölçekte).

taxAmountMicros

string (int64 format)

Yalnızca çıkış. Hizmet dönemi süresince hesapla ilişkilendirilebilecek toplam vergi tutarı (mikro ölçekte).

totalAmountMicros

string (int64 format)

Yalnızca çıkış. Hizmet dönemi süresince hesapla ilişkilendirilebilecek toplam tutar (mikro ölçekte). Bu, subtotalAmountMicros ve taxAmountMicros değerlerinin toplamına eşittir.