Method: customers.invoices.list

Zwraca wszystkie faktury powiązane z konfiguracją płatności w danym miesiącu.

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

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
customerId

string

To pole jest wymagane. Identyfikator klienta, dla którego chcesz pobrać faktury.

Parametry zapytania

Parametry
billingSetup

string

To pole jest wymagane. Nazwa zasobu konfiguracji płatności na potrzeby faktur.

customers/{customerId}/billingSetups/{billing_setup_id}

issueYear

string

To pole jest wymagane. Rok wystawienia faktury w formacie rrrr. Możesz pobrać tylko faktury wystawione w 2019 roku i później.

issueMonth

enum (MonthOfYear)

To pole jest wymagane. Miesiąc wystawienia, w którym mają być pobierane faktury.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Wiadomość z odpowiedzią na temat: InvoiceService.ListInvoices.

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

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

object (Invoice)

Lista faktur, które pasują do ustawień 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

Faktura. Wszystkie informacje z faktur są tworzone, aby odpowiadały informacjom na fakturze w formacie PDF. W przypadku faktur starszych niż udostępnienie usługi InvoiceService podsumowanie informacji może być niezgodne z fakturą w formacie PDF.

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
}
Pola
resourceName

string

Tylko dane wyjściowe. Nazwa zasobu faktury. Jedna faktura może być przypisana do kilku klientów, dlatego kilka nazw zasobów może wskazywać tę samą fakturę. Nazwy zasobów faktur mają postać:

customers/{customerId}/invoices/{invoice_id}

type

enum (InvoiceType)

Tylko dane wyjściowe. Typ faktury.

serviceDateRange

object (DateRange)

Tylko dane wyjściowe. Zakres dat okresu świadczenia usługi podanego na tej fakturze. Data zakończenia należy do Ciebie.

adjustmentsSubtotalAmountMicros

string (int64 format)

Tylko dane wyjściowe. Suma częściowa przed opodatkowaniem korekt na poziomie faktury (w mikro).

adjustmentsTaxAmountMicros

string (int64 format)

Tylko dane wyjściowe. Suma podatków od korekt 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 przed opodatkowaniem kosztów regulacyjnych na poziomie faktury (w mikro).

regulatoryCostsTaxAmountMicros

string (int64 format)

Tylko dane wyjściowe. Suma podatków od kosztów regulacyjnych na poziomie faktury, w mikro.

regulatoryCostsTotalAmountMicros

string (int64 format)

Tylko dane wyjściowe. Łączna kwota kosztów wynikających z przepisów na poziomie faktury (w mikro).

replacedInvoices[]

string

Tylko dane wyjściowe. Nazwa zasobu oryginalnych faktur, które podlegają ponownemu rozliczeniu lub zastąpiły tę fakturę(w stosownych przypadkach). Z powodu konsolidacji faktur mogło zostać zastąpionych wiele faktur. Zastąpione faktury mogą nie należeć do tego samego konta płatności. Jeśli zasada replacedInvoices jest ustawiona, wartość correctedInvoice nie jest ustawiona. Nazwy zasobów faktur mają postać:

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 powiązanych z tą fakturą.

id

string

Tylko dane wyjściowe. Identyfikator faktury. Na fakturze w formacie PDF znajduje się 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 używany do identyfikacji konta płatności powiązanego z konfiguracją płatności, np. „1234-5678-9012-3456”. Na fakturze PDF jest podany jako „Numer konta rozliczeniowego”.

paymentsProfileId

string

Tylko dane wyjściowe. 12-cyfrowy identyfikator używany do identyfikacji profilu płatności powiązanego z konfiguracją płatności, np. „1234-5678-9012”. Na fakturze PDF jest podana jako „Identyfikator płatności”.

issueDate

string

Tylko dane wyjściowe. Data wystawienia w formacie rrrr-mm-dd. Na fakturze PDF znajdują się pozycje „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 waluty uzyskany ze standardu 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. Suma częściowa przed naliczeniem podatku (w mikro). Jest to suma części sum częściowych kontaBudżetu i sumy kwoty Invoice.Adjustments_subtotal_amount_micros.

taxAmountMicros

string (int64 format)

Tylko dane wyjściowe. Suma wszystkich podatków na fakturze (w mikro). Jest to suma kwot podatków podanych w kolumnie AccountBudżetSummary oraz podatków niepowiązanych z określonym budżetem konta.

totalAmountMicros

string (int64 format)

Tylko dane wyjściowe. Łączna kwota w mikro. Jest to suma wartości Invoice.subtotal_amount_micros, Invoice.tax_amount_micros, Invoice.regulatory_costs_subtotal_amount_micros i Invoice.export_charge_subtotal_amount_micros (jest ona podzielona na osobną pozycję rozpoczynającą się od wersji V14.1).

correctedInvoice

string

Tylko dane wyjściowe. Nazwa zasobu oryginalnej faktury, która została skorygowana, odpisana lub anulowana przez tę fakturę (w stosownych przypadkach). Jeśli zasada correctedInvoice jest ustawiona, wartość replacedInvoices nie jest ustawiona. Nazwy zasobów faktur mają postać:

customers/{customerId}/invoices/{invoice_id}

pdfUrl

string

Tylko dane wyjściowe. Adres URL kopii faktury w formacie PDF. Aby pobrać 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 Służy tylko do zwracania wartości. Reprezentuje wartość nieznaną w tej wersji.
CREDIT_MEMO fakturę z kwotą ujemną. Na konto wpłyną środki.
INVOICE Faktura z kwotą dodatnią. Konto jest zaległe.

AccountBudgetSummary

Reprezentuje podsumowanie kosztów naliczonych z budżetu konta.

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
}
Pola
billableActivityDateRange

object (DateRange)

Tylko dane wyjściowe. Zakres dat aktywności podlegającej rozliczeniu w ramach budżetu konta w zakresie dat świadczenia usługi określonym na tej fakturze. Data zakończenia należy do Ciebie. Nie musi to być godzina rozpoczęcia i zakończenia budżetu konta.

invalidActivitySummaries[]

object (InvalidActivitySummary)

Tylko dane wyjściowe. Lista podsumowanych środków za nieprawidłową aktywność z oryginalnymi połączeniami.

customer

string

Tylko dane wyjściowe. Nazwa zasobu klienta powiązanego z tym budżetem konta. Zawiera on identyfikator klienta, który na fakturze PDF jest widoczny jako „Identyfikator konta”. Nazwy zasobów klienta mają postać:

customers/{customerId}

customerDescriptiveName

string

Tylko dane wyjściowe. Opisowa nazwa klienta powiązanego z budżetem konta. Na fakturze w formacie PDF pojawi się on jako „Konto”.

accountBudget

string

Tylko dane wyjściowe. Nazwa zasobu budżetu konta powiązanego z tym podsumowaniem rozliczonych kosztów. Nazwy zasobów AccountBudżety mają postać:

customers/{customerId}/accountBudgets/{account_budget_id}

accountBudgetName

string

Tylko dane wyjściowe. Nazwa budżetu konta. Na fakturze PDF jest oznaczona jako „Budżet konta”.

purchaseOrderNumber

string

Tylko dane wyjściowe. Numer zamówienia powiązanego z budżetem konta. Na fakturze w formacie PDF pojawi się ona jako „Zamówienie”.

subtotalAmountMicros

string (int64 format)

Tylko dane wyjściowe. Suma częściowa przed naliczeniem podatku 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). Jest to suma części sumy częściowej budżetu konta i kwoty podatku z budżetu konta.

servedAmountMicros

string (int64 format)

Tylko dane wyjściowe. Kwota wyświetleń przed naliczeniem podatku związana z tym budżetem w okresie świadczenia usługi (w mikro). Ta funkcja jest przydatna tylko do uzgadniania danych faktury i dostawy.

billedAmountMicros

string (int64 format)

Tylko dane wyjściowe. Kwota rozliczona przed naliczeniem podatku przypisana do tego budżetu w okresie świadczenia usługi (w mikro). Nie uwzględnia to żadnych korekt.

overdeliveryAmountMicros

string (int64 format)

Tylko dane wyjściowe. Kwota nadmiarowych wyświetleń przed naliczeniem podatku związana z tym budżetem w okresie świadczenia usługi, wyrażona w mikro (wartość ujemna).

invalidActivityAmountMicros

string (int64 format)

Tylko dane wyjściowe. Nieprawidłowa kwota przed naliczeniem podatku przypisana do tego budżetu w poprzednich miesiącach, w mikro (wartość ujemna).

InvalidActivitySummary

Szczegółowe informacje o nieprawidłowej aktywności na fakturze, które zawierają dodatkowe szczegóły dotyczące faktury, na podstawie której wprowadzasz korekty.

Zapis JSON
{
  "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 powiązany z tymi środkami za nieprawidłową aktywność.

originalYearOfService

string

Tylko dane wyjściowe. Pierwotny rok korzystania z usługi powiązany z tym kredytem za nieprawidłową aktywność.

originalInvoiceId

string

Tylko dane wyjściowe. Numer oryginalnej faktury związanej z tymi środkami za nieprawidłową aktywność.

originalAccountBudgetName

string

Tylko dane wyjściowe. Pierwotna nazwa budżetu konta powiązana z tą kredytem za nieprawidłową aktywność.

originalPurchaseOrderNumber

string

Tylko dane wyjściowe. Pierwotny numer zamówienia powiązany z tymi środkami za nieprawidłową aktywność.

amountMicros

string (int64 format)

Tylko dane wyjściowe. Nieprawidłowa aktywność w mikro.

AccountSummary

Reprezentuje 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
}
Pola
customer

string

Tylko dane wyjściowe. Konto powiązane z podsumowaniem konta.

billingCorrectionSubtotalAmountMicros

string (int64 format)

Tylko dane wyjściowe. Suma częściowa korekty płatności przed naliczeniem podatku (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 naliczeniem podatku (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. Przed naliczeniem podatku korygującego nadmiarowego kredytu kwotę częściową w mikro.

excessCreditAdjustmentTaxAmountMicros

string (int64 format)

Tylko dane wyjściowe. Podatek od korekty nadmiarowej kwoty 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 naliczeniem podatku (w mikro).

regulatoryCostsTaxAmountMicros

string (int64 format)

Tylko dane wyjściowe. Podatek od kosztów regulacyjnych w mikro.

regulatoryCostsTotalAmountMicros

string (int64 format)

Tylko dane wyjściowe. Kwota całkowitych kosztów regulacyjnych (w mikro).

exportChargeSubtotalAmountMicros

string (int64 format)

Tylko dane wyjściowe. Łączna kwota częściowa opłaty za eksport przed naliczeniem podatku (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 naliczeniem podatku 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 przypisana do konta w okresie świadczenia usługi (w mikro). Jest to suma wartości subtotalAmountMicros i taxAmountMicros.