- Żądanie HTTP
- Parametry ścieżki
- Parametry zapytania
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
- Faktura
- InvoiceType
- AccountBudgetSummary
- InvalidActivitySummary
- AccountSummary
- Wypróbuj
Zwraca wszystkie faktury z danego miesiąca powiązane z konfiguracją płatności.
Lista zgłoszonych błędów: AuthenticationError AuthorizationError FieldError HeaderError InternalError InvoiceError QuotaError RequestError
Żądanie HTTP
GET https://googleads.googleapis.com/v16/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 wydania faktury w formacie rrrr. Możesz pobierać tylko faktury wystawione w 2019 roku lub później. |
issueMonth |
To pole jest wymagane. Miesiąc wystawienia, w którym mają zostać pobrane faktury. |
Treść żądania
Treść żądania musi być pusta.
Treść odpowiedzi
Odpowiedź na pytanie: 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 omówieniu protokołu OAuth 2.0.
Faktura
Faktura. Wszystkie informacje z faktur są zapisywane pod postacią kopii w formacie PDF. W przypadku faktur starszych niż wprowadzone w ramach 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ć współdzielona przez kilku klientów, dlatego kilka nazw zasobów może wskazywać na 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 podany na tej fakturze. Data zakończenia należy do Ciebie. |
adjustmentsSubtotalAmountMicros |
Tylko dane wyjściowe. Suma częściowa korekt na poziomie faktury przed naliczeniem podatku (w częściach milionowych). |
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. Łączna kwota częściowa kosztów prawnych na poziomie faktury przed naliczeniem podatku (w częściach milionowych). |
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 regulacyjnych na poziomie faktury w mikro. |
replacedInvoices[] |
Tylko dane wyjściowe. Nazwa zasobu oryginalnych faktur, które są ponownie rozliczane lub zastąpione tą fakturą(w stosownych przypadkach). Z powodu konsolidacji faktur może pojawić się wiele zastąpionych faktur. Zastąpione faktury mogą nie należeć do tego samego konta płatności. Jeśli skonfigurowana jest 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 pliku PDF widnieje nazwa „Numer faktury”. |
billingSetup |
Tylko dane wyjściowe. Nazwa zasobu konfiguracji płatności na potrzeby tej faktury.
|
paymentsAccountId |
Tylko dane wyjściowe. 16-cyfrowy identyfikator używany do identyfikowania konta płatności powiązanego z konfiguracją płatności, np. „1234-5678-9012-3456”. Jest on widoczny na fakturze w formacie PDF jako „Numer konta rozliczeniowego”. |
paymentsProfileId |
Tylko dane wyjściowe. 12-cyfrowy identyfikator służący do identyfikacji profilu płatności powiązanego z konfiguracją płatności, np. „1234-5678-9012”. Jest on widoczny na fakturze w pliku PDF jako „Identyfikator płatności”. |
issueDate |
Tylko dane wyjściowe. Data wydania w formacie rrrr-mm-dd. Na fakturze w pliku PDF podana jest informacja „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 pochodzący ze standardu ISO 4217. |
exportChargeSubtotalAmountMicros |
Tylko dane wyjściowe. Łączna kwota częściowa opłat eksportowych na poziomie faktury przed naliczeniem podatku (w częściach milionowych). |
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 ona równa sumie kwot częściowych AccountBudgetSummary oraz Invoice.Adjustments_subtotal_amount_micros. |
taxAmountMicros |
Tylko dane wyjściowe. Suma wszystkich podatków na fakturze (w mikro). Są one sumą kwot podatków z kolumny AccountBudgetSummary powiększoną o podatki niepowiązane z określonym budżetem konta. |
totalAmountMicros |
Tylko dane wyjściowe. Łączna kwota podana 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 oddzielny wiersz zaczynający się od wersji 14.1). |
correctedInvoice |
Tylko dane wyjściowe. Nazwa zasobu oryginalnej faktury, skorygowana, odpisana lub anulowana przez tę fakturę (w stosownych przypadkach). Jeśli skonfigurowana jest zasada
|
pdfUrl |
Tylko dane wyjściowe. Adres URL kopii faktury w formacie PDF. Aby wysłać żądanie pliku 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żywana tylko w przypadku wartości zwracanej. Reprezentuje wartość nieznaną w tej wersji. |
CREDIT_MEMO |
faktury z ujemną kwotą, Na koncie przyznawane są środki. |
INVOICE |
Faktura z dodatnią kwotą. Konto ma zaległości w płatnościach. |
AccountBudgetSummary
Reprezentuje podsumowanie kosztów podlegających rozliczeniu w ramach 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 usługi podanym na tej fakturze. Data zakończenia należy do Ciebie. Może być inny niż czas rozpoczęcia i zakończenia budżetu konta. |
invalidActivitySummaries[] |
Tylko dane wyjściowe. Lista ś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, który na fakturze w formie pliku PDF to „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 pliku PDF widnieje informacja „Konto”. |
accountBudget |
Tylko dane wyjściowe. Nazwa zasobu budżetu konta powiązanego z tym podsumowaniem rozliczanego kosztu. Nazwy zasobów AccountBudget mają postać:
|
accountBudgetName |
Tylko dane wyjściowe. Nazwa budżetu konta. Na fakturze w pliku PDF widnieje nazwa „Budżet konta”. |
purchaseOrderNumber |
Tylko dane wyjściowe. Numer zamówienia powiązanego z budżetem konta. Na fakturze w pliku PDF pojawi się informacja „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). Jest to suma kwoty sumy częściowej budżetu konta i kwoty podatku z budżetu konta. |
servedAmountMicros |
Tylko dane wyjściowe. Kwota przed opodatkowaniem przypisana do tego budżetu w okresie korzystania z usługi (w mikro). Jest to przydatne tylko do uzgadniania faktur i danych dostawy. |
billedAmountMicros |
Tylko dane wyjściowe. Kwota rozliczenia przed naliczeniem podatku przypisana do tego budżetu w okresie świadczenia usługi (w mikro). Nie uwzględnia ono żadnych korekt. |
overdeliveryAmountMicros |
Tylko dane wyjściowe. Kwota nadmiernej liczby wyświetleń przed naliczeniem podatku przypisana do tego budżetu w okresie świadczenia usługi, w mikro (wartość ujemna). |
invalidActivityAmountMicros |
Tylko dane wyjściowe. Kwotę nieprawidłowej aktywności przed naliczeniem podatku, którą można przypisać 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 na temat faktury, na podstawie której wprowadzono 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 związany z tymi środkami na nieprawidłową aktywność. |
originalInvoiceId |
Tylko dane wyjściowe. Oryginalny numer faktury związanej z tymi środkami na 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 związany z tymi środkami na 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. Kwota 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. Łączna kwota 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 opodatkowaniem kwota częściowa korekty nadmiarowej kwoty promocyjnej (w mikro). |
excessCreditAdjustmentTaxAmountMicros |
Tylko dane wyjściowe. Podatek od korekty nadwyżki kredytu w milionowych częściach. |
excessCreditAdjustmentTotalAmountMicros |
Tylko dane wyjściowe. Łączna kwota korekty nadwyżki kredytu w milionowych częściach. |
regulatoryCostsSubtotalAmountMicros |
Tylko dane wyjściowe. Kwota częściowa kosztów regulacyjnych przed naliczeniem podatku w mikro. |
regulatoryCostsTaxAmountMicros |
Tylko dane wyjściowe. Podatek od kosztów ustawowych (w części mikro). |
regulatoryCostsTotalAmountMicros |
Tylko dane wyjściowe. Kwota całkowitych kosztów regulacyjnych (w mikro). |
exportChargeSubtotalAmountMicros |
Tylko dane wyjściowe. Kwota częściowa opłaty eksportowej 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 naliczeniem podatku przypisana 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. |