Uwaga: przeglądasz dokumentację interfejsu REST interfejsu API. Większość oficjalnych bibliotek klienta używa gRPC. Więcej informacji znajdziesz we wprowadzeniu do REST.

Ta strona została przetłumaczona przez Cloud Translation API.

Method: customers.invoices.list

Zwraca wszystkie faktury powiązane z konfiguracją płatności za dany miesiąc.

Lista zgłaszanych błędów: AuthenticationError AuthorizationError FieldError HeaderError InternalError InvoiceError QuotaError RequestError (Lista zgłoszonych błędów): AuthenticationError AuthorizationError FieldError HeaderError InternalError InvoiceError QuotaError RequestError

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry

Parametry
`customerId`	`string` Wymagane. Identyfikator klienta, dla którego chcesz pobrać faktury.

customerId

string

Wymagane. Identyfikator klienta, dla którego chcesz pobrać faktury.

Parametry zapytania

Parametry

Parametry
`billingSetup`	`string` Wymagane. Nazwa zasobu konfiguracji płatności na fakturach, o które prosisz. `customers/{customerId}/billingSetups/{billing_setup_id}`
`issueYear`	`string` Wymagane. Rok wystawienia faktur w formacie rrrr. Możesz pobrać tylko faktury wystawione w 2019 roku lub później.
`issueMonth`	`enum (MonthOfYear)` Wymagane. Miesiąc wystawienia faktur.

billingSetup

string

Wymagane. Nazwa zasobu konfiguracji płatności na fakturach, o które prosisz.

customers/{customerId}/billingSetups/{billing_setup_id}

issueYear

string

Wymagane. Rok wystawienia faktur w formacie rrrr. Możesz pobrać tylko faktury wystawione w 2019 roku lub później.

issueMonth

enum (MonthOfYear)

Wymagane. Miesiąc wystawienia faktur.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Wiadomość z odpowiedzią dla: InvoiceService.ListInvoices.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON
{ "invoices": [ { object (`Invoice`) } ] }

Pola

Pola
`invoices[]`	`object (Invoice)` Lista faktur, które pasują do konfiguracji płatności i okresu.

invoices[]

object (Invoice)

Lista faktur, które pasują do konfiguracji płatności i okresu.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie protokołu OAuth 2.0.

Faktura

faktury; Wszystkie informacje o fakturach mają charakter poglądowy, tak aby były zgodne z fakturą w formacie PDF. W przypadku faktur sprzed wprowadzenia usługi InvoiceService podane informacje mogą nie być zgodne z fakturami w formacie PDF.

Zapis JSON

Zapis 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 }

{
  "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
}

Pola
`resourceName`	`string` Tylko dane wyjściowe. Nazwa zasobu faktury. Jedna faktura może być współdzielona przez wielu klientów, dlatego wiele nazw zasobów może wskazywać na tę samą fakturę. Nazwy zasobów faktur mają następujący format: `customers/{customerId}/invoices/{invoice_id}`
`type`	`enum (InvoiceType)` Tylko dane wyjściowe. Typ faktury.
`serviceDateRange`	`object (DateRange)` Tylko dane wyjściowe. Zakres dat świadczenia usługi na tej fakturze. Data zakończenia jest włącznie.
`adjustmentsSubtotalAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Kwota sumy częściowej (przed opodatkowaniem) korekt na poziomie faktury (w mikro).
`adjustmentsTaxAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Suma podatków na korektach na poziomie faktury w mikro.
`adjustmentsTotalAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Łączna kwota korekt na poziomie faktury w mikro.
`regulatoryCostsSubtotalAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Suma częściowa kosztów regulacyjnych na poziomie faktury przed naliczeniem podatku (w częściach mikro).
`regulatoryCostsTaxAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Suma podatków od kosztów ustawowych na poziomie faktury w mikro.
`regulatoryCostsTotalAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Łączna kwota kosztów regulacyjnych na poziomie faktury w mikro.
`replacedInvoices[]`	`string` Tylko dane wyjściowe. Nazwa zasobu oryginalnych faktur, które są ponownie rozliczone lub zastąpione tą fakturą(w stosownych przypadkach). Z powodu konsolidacji faktur może być kilka zastąpionych faktur. Zastąpione faktury mogą nie należeć do tego samego konta płatności. Jeśli zasada `replacedInvoices` jest skonfigurowana, zasada `correctedInvoice` nie jest skonfigurowana. Nazwy zasobów faktur mają następujący format: `customers/{customerId}/invoices/{invoice_id}`
`accountBudgetSummaries[]`	`object (AccountBudgetSummary)` Tylko dane wyjściowe. Lista podsumowania informacji o budżecie konta powiązanych z tą fakturą.
`accountSummaries[]`	`object (AccountSummary)` Tylko dane wyjściowe. Lista podsumowania informacji o koncie związanych z tą fakturą.
`id`	`string` Tylko dane wyjściowe. Identyfikator faktury. Na fakturze w formacie PDF występuje on jako „Numer faktury”.
`billingSetup`	`string` Tylko dane wyjściowe. Nazwa zasobu konfiguracji płatności na tej fakturze. `customers/{customerId}/billingSetups/{billing_setup_id}`
`paymentsAccountId`	`string` Tylko dane wyjściowe. 16-cyfrowy identyfikator służący do identyfikowania konta płatności powiązanego z konfiguracją płatności, np. „1234-5678-9012-3456”. Na fakturze w formacie PDF występuje on jako „Numer konta rozliczeniowego”.
`paymentsProfileId`	`string` Tylko dane wyjściowe. 12-cyfrowy identyfikator służący do identyfikowania profilu płatności powiązanego z konfiguracją płatności, np. „1234-5678-9012”. Na fakturze w formacie PDF występuje on jako „Identyfikator płatności”.
`issueDate`	`string` Tylko dane wyjściowe. Data wydania w formacie rrrr-mm-dd. Na fakturze w formacie PDF może on występować jako „Data wystawienia” lub „Data faktury”.
`dueDate`	`string` Tylko dane wyjściowe. Termin w formacie rrrr-mm-dd.
`currencyCode`	`string` Tylko dane wyjściowe. Kod waluty. Wszystkie koszty są zwracane w tej walucie. Obsługiwany jest podzbiór kodów walut zgodnie ze standardem ISO 4217.
`exportChargeSubtotalAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Suma częściowa (przed opodatkowaniem) opłat eksportowych na poziomie faktury (w mikro).
`exportChargeTaxAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Suma podatków od opłat eksportowych na poziomie faktury w mikro.
`exportChargeTotalAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Łączna kwota opłat eksportowych na poziomie faktury w mikro.
`subtotalAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Kwota sumy częściowej przed naliczeniem podatku (w częściach mikro). Odpowiada to sumie kwot częściowych sum częściowych budżetu AccountSummary i parametrów Invoice.adjustments_subtotal_amount_micros.
`taxAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Suma wszystkich podatków na fakturze w mikro. To suma podatków w kolumnie AccountBudgetSummary powiększona o podatki niepowiązane z konkretnym budżetem konta.
`totalAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Łączna kwota w mikro. Odpowiada to sumie wartości Invoice.subtotal_amount_micros, Invoice.tax_amount_micros, Invoice.regulatory_costs_subtotal_amount_micros i Invoice.export_charge_subtotal_amount_micros (które są rozdzielane na osobną pozycję rozpoczynającą się od wersji 14.1).
`correctedInvoice`	`string` Tylko dane wyjściowe. Nazwa zasobu pierwotnej faktury, która została skorygowana, odpisana lub anulowana na podstawie tej faktury (w stosownych przypadkach). Jeśli zasada `correctedInvoice` jest skonfigurowana, zasada `replacedInvoices` nie jest skonfigurowana. Nazwy zasobów faktur mają następujący format: `customers/{customerId}/invoices/{invoice_id}`
`pdfUrl`	`string` Tylko dane wyjściowe. Adres URL kopii faktury w formacie PDF. Aby poprosić o plik PDF z tym adresem URL, użytkownicy muszą przekazać swój token OAuth.

InvoiceType

Możliwy typ faktur.

Wartości w polu enum
`UNSPECIFIED`	Nie określono.
`UNKNOWN`	Używany tylko w przypadku zwracanej wartości. Reprezentuje wartość nieznaną w tej wersji.
`CREDIT_MEMO`	Faktura z ujemną kwotą. Na konto zostaną przypisane środki.
`INVOICE`	faktury z kwotą dodatnią. Konto musi mieć zaległą należność.

AccountBudgetSummary

Reprezentuje podsumowany koszt naliczany z budżetu konta.

Zapis JSON

Zapis 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 }

{
  "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
}

Pola
`billableActivityDateRange`	`object (DateRange)` Tylko dane wyjściowe. Zakres dat aktywności podlegającej rozliczeniu budżetu konta mieszczący się w zakresie dat świadczenia usługi podanym na tej fakturze. Data zakończenia jest włącznie. Może się różnić od czasu rozpoczęcia i zakończenia budżetu konta.
`invalidActivitySummaries[]`	`object (InvalidActivitySummary)` Tylko dane wyjściowe. Lista podsumowanych środków za nieprawidłową aktywność z pierwotnymi połączeniami.
`customer`	`string` Tylko dane wyjściowe. Nazwa zasobu klienta powiązanego z tym budżetem konta. Zawiera on identyfikator klienta widoczny na fakturze w formacie PDF jako „Account ID”. Nazwy zasobów klientów mają następujący format: `customers/{customerId}`
`customerDescriptiveName`	`string` Tylko dane wyjściowe. Opisowa nazwa klienta budżetu konta. Na fakturze w formacie PDF widnieje jako „Konto”.
`accountBudget`	`string` Tylko dane wyjściowe. Nazwa zasobu budżetu konta powiązanego z tym podsumowaniem naliczanych kosztów. Nazwy zasobów budżetu konta mają następujący format: `customers/{customerId}/accountBudgets/{account_budget_id}`
`accountBudgetName`	`string` Tylko dane wyjściowe. Nazwa budżetu konta. Na fakturze w formacie PDF widnieje jako „Budżet konta”.
`purchaseOrderNumber`	`string` Tylko dane wyjściowe. Numer zamówienia powiązany z budżetem konta. Na fakturze w formacie PDF widnieje jako „Zamówienie”.
`subtotalAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Suma częściowa przed naliczeniem podatku przypisana do tego budżetu w okresie świadczenia usługi (w mikro).
`taxAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Kwota podatku przypisana do tego budżetu w okresie świadczenia usługi (w mikro).
`totalAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Łączna kwota przypisana do tego budżetu w okresie świadczenia usługi (w mikro). To suma sumy częściowej budżetu konta i kwoty podatku budżetu konta.
`servedAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Kwota należności przed opodatkowaniem, która należy do tego budżetu w okresie świadczenia usługi, w mikro. Jest to przydatne tylko do uzgodnienia danych dotyczących faktury i dostawy.
`billedAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Kwota przed opodatkowaniem, która należy do tego budżetu w okresie świadczenia usługi, wyrażona w mikro. Nie uwzględnia to żadnych korekt.
`overdeliveryAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Kwota przed nadmiernymi wyświetleniami przed opodatkowaniem, która należy do tego budżetu w okresie świadczenia usługi, wyrażona w mikro (wartość ujemna).
`invalidActivityAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Kwota przed opodatkowaniem, którą można przypisać do tego budżetu w poprzednich miesiącach, w mikro (wartość ujemna).

InvalidActivitySummary

Szczegóły nieprawidłowej aktywności na fakturze obejmujące dodatkowe informacje na temat faktury, na której wprowadzono poprawki.

Zapis JSON

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

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

Pola
`originalMonthOfService`	`enum (MonthOfYear)` Tylko dane wyjściowe. Pierwotny miesiąc korzystania z usługi związany z tą kwotą środków za nieprawidłową aktywność.
`originalYearOfService`	`string` Tylko dane wyjściowe. Pierwotny rok świadczenia usługi związany z kredytem za nieprawidłową aktywność.
`originalInvoiceId`	`string` Tylko dane wyjściowe. Oryginalny numer faktury za nieprawidłową aktywność.
`originalAccountBudgetName`	`string` Tylko dane wyjściowe. Pierwotna nazwa budżetu konta powiązana z kwotami za nieprawidłową aktywność.
`originalPurchaseOrderNumber`	`string` Tylko dane wyjściowe. Oryginalny numer zamówienia powiązany z tymi środkami za nieprawidłową aktywność.
`amountMicros`	`string (int64 format)` Tylko dane wyjściowe. Nieprawidłowa ilość aktywności w mikro.

AccountSummary

Przedstawia widok podsumowania na poziomie konta.

Zapis 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 }

Zapis 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
}

Pola
`customer`	`string` Tylko dane wyjściowe. Konto powiązane z podsumowaniem konta.
`billingCorrectionSubtotalAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Kwota częściowa korekty płatności przed opodatkowaniem (w mikro).
`billingCorrectionTaxAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Podatek od korekty płatności (w mikro).
`billingCorrectionTotalAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Łączna kwota korekty płatności w mikro.
`couponAdjustmentSubtotalAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Suma częściowa korekty kuponu przed opodatkowaniem (w mikro).
`couponAdjustmentTaxAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Podatek od korekty kuponu w mikro.
`couponAdjustmentTotalAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Łączna kwota korekty kuponu w mikro.
`excessCreditAdjustmentSubtotalAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Kwota częściowa korekty nadmiarowej kwoty przed naliczeniem podatku (w mikro).
`excessCreditAdjustmentTaxAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Podatek od korekty nadmiarowej kredytu (w mikro).
`excessCreditAdjustmentTotalAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Łączna kwota korekty nadmiarowej kredytu (w mikro).
`regulatoryCostsSubtotalAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Suma częściowa kosztów regulacyjnych przed opodatkowaniem (w częściach mikro).
`regulatoryCostsTaxAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Podatek od kosztów regulacyjnych w milionowych częściach jednostki
`regulatoryCostsTotalAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Całkowita kwota kosztów regulacyjnych w milionowych częściach jednostki.
`exportChargeSubtotalAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Suma częściowa opłaty za eksport przed opodatkowaniem (w mikro).
`exportChargeTaxAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Podatek od opłaty eksportowej w mikro.
`exportChargeTotalAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Łączna kwota opłaty eksportowej w mikro.
`subtotalAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Łączna kwota częściowa przed opodatkowaniem, którą można przypisać do konta w okresie świadczenia usługi (w mikro).
`taxAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Łączna kwota podatku przypisana do konta w okresie świadczenia usługi (w mikro).
`totalAmountMicros`	`string (int64 format)` Tylko dane wyjściowe. Łączna kwota przypisywana kontu w okresie obsługi klienta (w mikro). Jest to suma wartości częściowa sumaAmountMicros i taxAmountMicros.