- Żą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 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 | |
---|---|
customerId |
Wymagane. Identyfikator klienta, dla którego chcesz pobrać faktury. |
Parametry zapytania
Parametry | |
---|---|
billingSetup |
Wymagane. Nazwa zasobu konfiguracji płatności na fakturach, o które prosisz.
|
issueYear |
Wymagane. Rok wystawienia faktur w formacie rrrr. Możesz pobrać tylko faktury wystawione w 2019 roku lub później. |
issueMonth |
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 ( |
Pola | |
---|---|
invoices[] |
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 |
---|
{ "resourceName": string, "type": enum ( |
Pola | |
---|---|
resourceName |
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:
|
type |
Tylko dane wyjściowe. Typ faktury. |
serviceDateRange |
Tylko dane wyjściowe. Zakres dat świadczenia usługi na tej fakturze. Data zakończenia jest włącznie. |
adjustmentsSubtotalAmountMicros |
Tylko dane wyjściowe. Kwota sumy częściowej (przed opodatkowaniem) korekt na poziomie faktury (w mikro). |
adjustmentsTaxAmountMicros |
Tylko dane wyjściowe. Suma podatków na korektach 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 kosztów regulacyjnych na poziomie faktury przed naliczeniem podatku (w częściach mikro). |
regulatoryCostsTaxAmountMicros |
Tylko dane wyjściowe. Suma podatków od kosztów ustawowych na poziomie faktury w mikro. |
regulatoryCostsTotalAmountMicros |
Tylko dane wyjściowe. Łączna kwota kosztów regulacyjnych na poziomie faktury w mikro. |
replacedInvoices[] |
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
|
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 związanych z tą fakturą. |
id |
Tylko dane wyjściowe. Identyfikator faktury. Na fakturze w formacie PDF występuje 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 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 |
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 |
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 |
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 walut zgodnie ze standardem 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. 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 |
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 |
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 |
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
|
pdfUrl |
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 |
---|
{ "billableActivityDateRange": { object ( |
Pola | |
---|---|
billableActivityDateRange |
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[] |
Tylko dane wyjściowe. Lista podsumowanych środków za nieprawidłową aktywność z pierwotnymi połączeniami. |
customer |
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:
|
customerDescriptiveName |
Tylko dane wyjściowe. Opisowa nazwa klienta budżetu konta. Na fakturze w formacie PDF widnieje jako „Konto”. |
accountBudget |
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:
|
accountBudgetName |
Tylko dane wyjściowe. Nazwa budżetu konta. Na fakturze w formacie PDF widnieje jako „Budżet konta”. |
purchaseOrderNumber |
Tylko dane wyjściowe. Numer zamówienia powiązany z budżetem konta. Na fakturze w formacie PDF widnieje jako „Zamówienie”. |
subtotalAmountMicros |
Tylko dane wyjściowe. Suma częściowa przed naliczeniem podatku przypisana 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). To suma sumy częściowej budżetu konta i kwoty podatku budżetu konta. |
servedAmountMicros |
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 |
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 |
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 |
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 |
---|
{
"originalMonthOfService": enum ( |
Pola | |
---|---|
originalMonthOfService |
Tylko dane wyjściowe. Pierwotny miesiąc korzystania z usługi związany z tą kwotą środków za nieprawidłową aktywność. |
originalYearOfService |
Tylko dane wyjściowe. Pierwotny rok świadczenia usługi związany z kredytem za nieprawidłową aktywność. |
originalInvoiceId |
Tylko dane wyjściowe. Oryginalny numer faktury za nieprawidłową aktywność. |
originalAccountBudgetName |
Tylko dane wyjściowe. Pierwotna nazwa budżetu konta powiązana z kwotami za nieprawidłową aktywność. |
originalPurchaseOrderNumber |
Tylko dane wyjściowe. Oryginalny numer zamówienia powiązany z tymi środkami za nieprawidłową aktywność. |
amountMicros |
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 } |
Pola | |
---|---|
customer |
Tylko dane wyjściowe. Konto powiązane z podsumowaniem konta. |
billingCorrectionSubtotalAmountMicros |
Tylko dane wyjściowe. Kwota częściowa korekty płatności przed opodatkowaniem (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 opodatkowaniem (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. Kwota częściowa korekty nadmiarowej kwoty przed naliczeniem podatku (w mikro). |
excessCreditAdjustmentTaxAmountMicros |
Tylko dane wyjściowe. Podatek od korekty nadmiarowej 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 opodatkowaniem (w częściach mikro). |
regulatoryCostsTaxAmountMicros |
Tylko dane wyjściowe. Podatek od kosztów regulacyjnych w milionowych częściach jednostki |
regulatoryCostsTotalAmountMicros |
Tylko dane wyjściowe. Całkowita kwota kosztów regulacyjnych w milionowych częściach jednostki. |
exportChargeSubtotalAmountMicros |
Tylko dane wyjściowe. Suma częściowa opłaty za eksport przed opodatkowaniem (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 opodatkowaniem, którą można przypisać 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 przypisywana kontu w okresie obsługi klienta (w mikro). Jest to suma wartości częściowa sumaAmountMicros i taxAmountMicros. |