- Żądanie HTTP
- Parametry ścieżki
- Parametry zapytania
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
- Faktura
- InvoiceType
- AccountBudgetSummary
- InvalidActivitySummary
- AccountSummary
- Wypróbuj
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/v14/customers/{customerId}/invoices
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
Parametry | |
---|---|
customerId |
To pole jest wymagane. Identyfikator klienta, dla którego chcesz pobrać faktury. |
Parametry zapytania
Parametry | |
---|---|
billingSetup |
To pole jest wymagane. Nazwa zasobu konfiguracji płatności na potrzeby faktur.
|
issueYear |
To pole jest wymagane. Rok wystawienia faktury w formacie rrrr. Możesz pobrać tylko faktury wystawione w 2019 roku i później. |
issueMonth |
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 ( |
Pola | |
---|---|
invoices[] |
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 ( |
Pola | |
---|---|
resourceName |
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ć:
|
type |
Tylko dane wyjściowe. Typ faktury. |
serviceDateRange |
Tylko dane wyjściowe. Zakres dat okresu świadczenia usługi podanego na tej fakturze. Data zakończenia należy do Ciebie. |
adjustmentsSubtotalAmountMicros |
Tylko dane wyjściowe. Suma częściowa przed opodatkowaniem korekt na poziomie faktury (w mikro). |
adjustmentsTaxAmountMicros |
Tylko dane wyjściowe. Suma podatków od korekt na poziomie faktury, w mikro. |
adjustmentsTotalAmountMicros |
Tylko dane wyjściowe. Łączna kwota korekt na poziomie faktury (w mikro). |
regulatoryCostsSubtotalAmountMicros |
Tylko dane wyjściowe. Suma częściowa przed opodatkowaniem kosztów regulacyjnych na poziomie faktury (w mikro). |
regulatoryCostsTaxAmountMicros |
Tylko dane wyjściowe. Suma podatków od kosztów regulacyjnych na poziomie faktury, w mikro. |
regulatoryCostsTotalAmountMicros |
Tylko dane wyjściowe. Łączna kwota kosztów wynikających z przepisów na poziomie faktury (w mikro). |
replacedInvoices[] |
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
|
accountBudgetSummaries[] |
Tylko dane wyjściowe. Lista podsumowania informacji o budżecie konta powiązanych z tą fakturą. |
accountSummaries[] |
Tylko dane wyjściowe. Lista podsumowania informacji o koncie powiązanych z tą fakturą. |
id |
Tylko dane wyjściowe. Identyfikator faktury. Na fakturze w formacie PDF znajduje się on jako „Numer faktury”. |
billingSetup |
Tylko dane wyjściowe. Nazwa zasobu konfiguracji płatności na tej fakturze.
|
paymentsAccountId |
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 |
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 |
Tylko dane wyjściowe. Data wystawienia w formacie rrrr-mm-dd. Na fakturze PDF znajdują się pozycje „Data wystawienia” lub „Data faktury”. |
dueDate |
Tylko dane wyjściowe. Termin w formacie rrrr-mm-dd. |
currencyCode |
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 |
Tylko dane wyjściowe. Suma częściowa przed opodatkowaniem opłat eksportowych na poziomie faktury (w mikro). |
exportChargeTaxAmountMicros |
Tylko dane wyjściowe. Suma podatków od opłat eksportowych na poziomie faktury (w mikro). |
exportChargeTotalAmountMicros |
Tylko dane wyjściowe. Łączna kwota opłat eksportowych na poziomie faktury (w mikro). |
subtotalAmountMicros |
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 |
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 |
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 |
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
|
pdfUrl |
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 ( |
Pola | |
---|---|
billableActivityDateRange |
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[] |
Tylko dane wyjściowe. Lista podsumowanych środków za nieprawidłową aktywność z oryginalnymi połączeniami. |
customer |
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ć:
|
customerDescriptiveName |
Tylko dane wyjściowe. Opisowa nazwa klienta powiązanego z budżetem konta. Na fakturze w formacie PDF pojawi się on jako „Konto”. |
accountBudget |
Tylko dane wyjściowe. Nazwa zasobu budżetu konta powiązanego z tym podsumowaniem rozliczonych kosztów. Nazwy zasobów AccountBudżety mają postać:
|
accountBudgetName |
Tylko dane wyjściowe. Nazwa budżetu konta. Na fakturze PDF jest oznaczona jako „Budżet konta”. |
purchaseOrderNumber |
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 |
Tylko dane wyjściowe. Suma częściowa przed naliczeniem podatku do tego budżetu w okresie świadczenia usługi (w mikro). |
taxAmountMicros |
Tylko dane wyjściowe. Kwota podatku przypisana do tego budżetu w okresie świadczenia usługi (w mikro). |
totalAmountMicros |
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 |
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 |
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 |
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 |
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 ( |
Pola | |
---|---|
originalMonthOfService |
Tylko dane wyjściowe. Pierwotny miesiąc korzystania z usługi powiązany z tymi środkami za nieprawidłową aktywność. |
originalYearOfService |
Tylko dane wyjściowe. Pierwotny rok korzystania z usługi powiązany z tym kredytem za nieprawidłową aktywność. |
originalInvoiceId |
Tylko dane wyjściowe. Numer oryginalnej faktury związanej z tymi środkami za nieprawidłową aktywność. |
originalAccountBudgetName |
Tylko dane wyjściowe. Pierwotna nazwa budżetu konta powiązana z tą kredytem za nieprawidłową aktywność. |
originalPurchaseOrderNumber |
Tylko dane wyjściowe. Pierwotny numer zamówienia powiązany z tymi środkami za nieprawidłową aktywność. |
amountMicros |
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 |
Tylko dane wyjściowe. Konto powiązane z podsumowaniem konta. |
billingCorrectionSubtotalAmountMicros |
Tylko dane wyjściowe. Suma częściowa korekty płatności przed naliczeniem podatku (w mikro). |
billingCorrectionTaxAmountMicros |
Tylko dane wyjściowe. Podatek od korekty płatności (w mikro). |
billingCorrectionTotalAmountMicros |
Tylko dane wyjściowe. Łączna kwota korekty płatności w mikro. |
couponAdjustmentSubtotalAmountMicros |
Tylko dane wyjściowe. Suma częściowa korekty kuponu przed naliczeniem podatku (w mikro). |
couponAdjustmentTaxAmountMicros |
Tylko dane wyjściowe. Podatek od korekty kuponu, w mikro. |
couponAdjustmentTotalAmountMicros |
Tylko dane wyjściowe. Łączna kwota korekty kuponu (w mikro). |
excessCreditAdjustmentSubtotalAmountMicros |
Tylko dane wyjściowe. Przed naliczeniem podatku korygującego nadmiarowego kredytu kwotę częściową w mikro. |
excessCreditAdjustmentTaxAmountMicros |
Tylko dane wyjściowe. Podatek od korekty nadmiarowej kwoty kredytu w mikro. |
excessCreditAdjustmentTotalAmountMicros |
Tylko dane wyjściowe. Łączna kwota korekty nadmiarowej kredytu (w mikro). |
regulatoryCostsSubtotalAmountMicros |
Tylko dane wyjściowe. Suma częściowa kosztów regulacyjnych przed naliczeniem podatku (w mikro). |
regulatoryCostsTaxAmountMicros |
Tylko dane wyjściowe. Podatek od kosztów regulacyjnych w mikro. |
regulatoryCostsTotalAmountMicros |
Tylko dane wyjściowe. Kwota całkowitych kosztów regulacyjnych (w mikro). |
exportChargeSubtotalAmountMicros |
Tylko dane wyjściowe. Łączna kwota częściowa opłaty za eksport przed naliczeniem podatku (w mikro). |
exportChargeTaxAmountMicros |
Tylko dane wyjściowe. Podatek od opłaty eksportowej (w mikro). |
exportChargeTotalAmountMicros |
Tylko dane wyjściowe. Łączna kwota opłaty eksportowej (w mikro). |
subtotalAmountMicros |
Tylko dane wyjściowe. Łączna kwota częściowa przed naliczeniem podatku do konta w okresie świadczenia usługi (w mikro). |
taxAmountMicros |
Tylko dane wyjściowe. Łączna kwota podatku przypisana do konta w okresie świadczenia usługi (w mikro). |
totalAmountMicros |
Tylko dane wyjściowe. Łączna kwota przypisana do konta w okresie świadczenia usługi (w mikro). Jest to suma wartości subtotalAmountMicros i taxAmountMicros. |