- HTTP isteği
- Yol parametreleri
- Sorgu parametreleri
- İstek metni
- Yanıt metni
- Yetkilendirme kapsamları
- Fatura
- InvoiceType
- AccountBudgetSummary
- InvalidActivitySummary
- AccountSummary
- Deneyin.
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 |
Zorunlu. Faturalarının alınacağı müşterinin kimliği. |
Sorgu parametreleri
Parametreler | |
---|---|
billingSetup |
Zorunlu. İstenen faturaların faturalandırma kurulumu kaynak adı.
|
issueYear |
Zorunlu. Faturaların alındığı yıl, yyyy biçiminde belirtilir. Yalnızca 2019 veya sonrasında düzenlenen faturalar alınabilir. |
issueMonth |
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 ( |
Alanlar | |
---|---|
invoices[] |
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 ( |
Alanlar | |
---|---|
resourceName |
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:
|
type |
Yalnızca çıkış. Faturanın türü. |
serviceDateRange |
Yalnızca çıkış. Bu faturanın hizmet dönemi tarih aralığı. Bitiş tarihi kapsayıcıdır. |
adjustmentsSubtotalAmountMicros |
Yalnızca çıkış. Fatura seviyesindeki düzenlemelerin vergi öncesi ara toplam tutarı (mikrosaniye cinsinden). |
adjustmentsTaxAmountMicros |
Yalnızca çıkış. Fatura seviyesindeki düzenlemelerdeki vergilerin toplamı (mikro ölçekte). |
adjustmentsTotalAmountMicros |
Yalnızca çıkış. Fatura seviyesindeki düzenlemelerin mikro cinsinden toplam tutarı. |
regulatoryCostsSubtotalAmountMicros |
Yalnızca çıkış. Fatura seviyesindeki yasal maliyetlerin vergi öncesi ara toplam tutarı (mikro ölçekte). |
regulatoryCostsTaxAmountMicros |
Yalnızca çıkış. Fatura düzeyinde yasal maliyetler üzerinden vergilerin toplamı (mikro ölçekte). |
regulatoryCostsTotalAmountMicros |
Yalnızca çıkış. Fatura düzeyindeki yasal maliyetlerin mikro cinsinden toplam tutarı. |
replacedInvoices[] |
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.
|
accountBudgetSummaries[] |
Yalnızca çıkış. Bu faturayla ilişkili hesap bütçesi bilgilerinin bir özeti. |
accountSummaries[] |
Yalnızca çıkış. Bu faturayla ilişkili hesap bilgilerinin bir özeti. |
id |
Yalnızca çıkış. Faturanın kimliği. PDF'de "Fatura numarası" olarak görünür. |
billingSetup |
Yalnızca çıkış. Bu faturanın faturalandırma ayarlarının kaynak adı.
|
paymentsAccountId |
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 |
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 |
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 |
Yalnızca çıkış. yyyy-aa-gg biçiminde teslim tarihi. |
currencyCode |
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 |
Yalnızca çıkış. Fatura düzeyinde dışa aktarma ücretlerinin vergi öncesi ara toplam tutarı (mikrosaniye cinsinden). |
exportChargeTaxAmountMicros |
Yalnızca çıkış. Fatura düzeyinde ihracat masraflarının mikro cinsinden toplamı. |
exportChargeTotalAmountMicros |
Yalnızca çıkış. Fatura düzeyinde dışa aktarma ücretlerinin mikro cinsinden toplam tutarı. |
subtotalAmountMicros |
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 |
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 |
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 |
Yalnızca çıkış. Orijinal faturanın kaynak adı, bu faturayla düzeltildi veya iptal edildiyse (varsa).
|
pdfUrl |
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 ( |
Alanlar | |
---|---|
billableActivityDateRange |
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[] |
Yalnızca çıkış. Orijinal bağlantıları içeren geçersiz etkinlik kredilerinin özeti. |
customer |
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:
|
customerDescriptiveName |
Yalnızca çıkış. Hesap bütçesi müşterisinin açıklayıcı adı. PDF'de "Hesap" olarak görünür. |
accountBudget |
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:
|
accountBudgetName |
Yalnızca çıkış. Hesap bütçesinin adı. Fatura PDF'sinde "Hesap bütçesi" olarak görünür. |
purchaseOrderNumber |
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 |
Yalnızca çıkış. Hizmet dönemi boyunca bu bütçeyle ilişkilendirilebilen vergi öncesi ara toplam tutar (mikro cinsinden). |
taxAmountMicros |
Yalnızca çıkış. Hizmet dönemi boyunca bu bütçeyle ilişkilendirilebilecek vergi tutarı (mikro ölçekte). |
totalAmountMicros |
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 |
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 |
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 |
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 |
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 ( |
Alanlar | |
---|---|
originalMonthOfService |
Yalnızca çıkış. Bu geçersiz etkinlik kredisiyle ilgili orijinal hizmet ayı. |
originalYearOfService |
Yalnızca çıkış. Bu geçersiz etkinlik kredisiyle ilgili orijinal hizmet yılı. |
originalInvoiceId |
Yalnızca çıkış. Bu geçersiz etkinlik kredisine ilişkin orijinal fatura numarası. |
originalAccountBudgetName |
Yalnızca çıkış. Bu geçersiz etkinlik kredisiyle ilgili orijinal hesap bütçesi adı. |
originalPurchaseOrderNumber |
Yalnızca çıkış. Bu geçersiz etkinlik kredisiyle ilgili orijinal satın alma siparişi numarası. |
amountMicros |
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 |
Yalnızca çıkış. Hesap özetiyle ilişkilendirilen hesap. |
billingCorrectionSubtotalAmountMicros |
Yalnızca çıkış. Vergi öncesi faturalandırma düzeltmesi ara toplam tutarı (mikro cinsinden). |
billingCorrectionTaxAmountMicros |
Yalnızca çıkış. Faturalandırma düzeltmesi vergisi (mikrosaniye cinsinden). |
billingCorrectionTotalAmountMicros |
Yalnızca çıkış. Toplam faturalandırma düzeltme tutarı (mikro ölçekte). |
couponAdjustmentSubtotalAmountMicros |
Yalnızca çıkış. Vergi öncesi kupon düzenlemesi ara toplam tutarı (mikro cinsinden). |
couponAdjustmentTaxAmountMicros |
Yalnızca çıkış. Kupon düzenlemesindeki vergi (mikro ölçekte). |
couponAdjustmentTotalAmountMicros |
Yalnızca çıkış. Kupon düzenleme tutarının mikro cinsinden toplam tutarı. |
excessCreditAdjustmentSubtotalAmountMicros |
Yalnızca çıkış. Vergi öncesi fazla kredi düzenlemesi ara toplam tutarı (mikrosaniye cinsinden). |
excessCreditAdjustmentTaxAmountMicros |
Yalnızca çıkış. Fazla kredi düzenlemesi üzerinden alınan vergi (mikro ölçekte). |
excessCreditAdjustmentTotalAmountMicros |
Yalnızca çıkış. Toplam kalan kredi düzenleme tutarı (mikrosaniye cinsinden). |
regulatoryCostsSubtotalAmountMicros |
Yalnızca çıkış. Vergi öncesi yasal maliyetlerin mikro cinsinden ara toplam tutarı. |
regulatoryCostsTaxAmountMicros |
Yalnızca çıkış. Yasal maliyetlerden alınan vergi (mikro ölçekte). |
regulatoryCostsTotalAmountMicros |
Yalnızca çıkış. Toplam yasal maliyet tutarı (mikro ölçekte). |
exportChargeSubtotalAmountMicros |
Yalnızca çıkış. Vergi öncesi dışa aktarma ücreti ara toplam tutarı (mikrosaniye cinsinden). |
exportChargeTaxAmountMicros |
Yalnızca çıkış. İhracat ücretinin vergisi (mikro ölçekte). |
exportChargeTotalAmountMicros |
Yalnızca çıkış. Toplam dışa aktarma ücretinin tutarı (mikro ölçekte). |
subtotalAmountMicros |
Yalnızca çıkış. Hizmet dönemi süresince hesapla ilişkilendirilebilecek toplam vergi öncesi ara toplam tutar (mikro ölçekte). |
taxAmountMicros |
Yalnızca çıkış. Hizmet dönemi süresince hesapla ilişkilendirilebilecek toplam vergi tutarı (mikro ölçekte). |
totalAmountMicros |
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. |