Method: customers.invoices.list

Возвращает все счета, связанные с настройкой выставления счетов, за определенный месяц.

Список выброшенных ошибок: AuthenticationError AuthorizationError FieldError HeaderError InternalError InvoiceError QuotaError RequestError

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
customerId

string

Необходимый. Идентификатор клиента, для которого нужно получить счета.

Параметры запроса

Параметры
billingSetup

string

Необходимый. Имя ресурса настройки выставления счетов для запрошенных счетов.

customers/{customerId}/billingSetups/{billing_setup_id}

issueYear

string

Необходимый. Год выдачи для получения счетов-фактур в формате гггг. Можно получить только счета, выставленные в 2019 году или позже.

issueMonth

enum ( MonthOfYear )

Необходимый. Месяц выдачи для получения счетов.

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

Ответное сообщение для InvoiceService.ListInvoices .

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление
{
  "invoices": [
    {
      object (Invoice)
    }
  ]
}
Поля
invoices[]

object ( Invoice )

Список счетов, соответствующих настройкам выставления счетов и периоду времени.

Области авторизации

Требуется следующая область действия OAuth:

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

Дополнительную информацию см. в обзоре OAuth 2.0 .

Счет

Счет-фактура. Вся информация о счете сохраняется в виде моментального снимка, чтобы соответствовать счету в формате PDF. Для счетов старше, чем запуск InvoiceService, информация в моментальном снимке может не соответствовать счету в формате PDF.

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

Только вывод. Имя ресурса счета. Несколько клиентов могут использовать один и тот же счет, поэтому несколько имен ресурсов могут указывать на один и тот же счет. Имена ресурсов счетов имеют вид:

customers/{customerId}/invoices/{invoice_id}

type

enum ( InvoiceType )

Только вывод. Тип счета-фактуры.

serviceDateRange

object ( DateRange )

Только вывод. Диапазон дат периода обслуживания этого счета. Дата окончания указана включительно.

adjustmentsSubtotalAmountMicros

string ( int64 format)

Только вывод. Промежуточная сумма корректировок на уровне счета до уплаты налогов, в микронах.

adjustmentsTaxAmountMicros

string ( int64 format)

Только вывод. Сумма налогов по корректировкам на уровне счета-фактуры, в микронах.

adjustmentsTotalAmountMicros

string ( int64 format)

Только вывод. Общая сумма корректировок на уровне счета в микронах.

regulatoryCostsSubtotalAmountMicros

string ( int64 format)

Только вывод. Промежуточная сумма нормативных затрат на уровне счета-фактуры до уплаты налогов, в микронах.

regulatoryCostsTaxAmountMicros

string ( int64 format)

Только вывод. Сумма налогов на нормативные расходы на уровне счета-фактуры, в микро.

regulatoryCostsTotalAmountMicros

string ( int64 format)

Только вывод. Общая сумма нормативных затрат на уровне счета-фактуры, в микро.

replacedInvoices[]

string

Только вывод. Имя ресурса исходного счета-фактуры, которому выставляется новый счет или который заменяется этим счетом, если применимо. В результате консолидации счетов может быть несколько замененных счетов. Замененные счета не могут принадлежать одному и тому же платежному счету. Если replacedInvoices установлен, correctedInvoice не будет установлен. Имена ресурсов счетов имеют вид:

customers/{customerId}/invoices/{invoice_id}

accountBudgetSummaries[]

object ( AccountBudgetSummary )

Только вывод. Список сводной информации о бюджете аккаунта, связанной с этим счетом.

accountSummaries[]

object ( AccountSummary )

Только вывод. Список сводной информации об учетной записи, связанной с этим счетом.

id

string

Только вывод. Идентификатор счета. В PDF-фактуре он отображается как «Номер счета».

billingSetup

string

Только вывод. Имя ресурса настройки выставления счетов для этого счета.

customers/{customerId}/billingSetups/{billing_setup_id}

paymentsAccountId

string

Только вывод. 16-значный идентификатор, используемый для идентификации платежного аккаунта, связанного с настройками выставления счетов, например «1234-5678-9012-3456». В PDF-файле счета он отображается как «Номер платежного счета».

paymentsProfileId

string

Только вывод. 12-значный идентификатор, используемый для идентификации платежного профиля, связанного с настройкой выставления счетов, например «1234-5678-9012». В PDF-файле счета он отображается как «Идентификатор платежа».

issueDate

string

Только вывод. Дата выпуска в формате гггг-мм-дд. В PDF-файле счета-фактуры оно отображается как «Дата выдачи» или «Дата выставления счета».

dueDate

string

Только вывод. Срок сдачи в формате гггг-мм-дд.

currencyCode

string

Только вывод. Код валюты. Все затраты возвращаются в этой валюте. Поддерживается подмножество кодов валют, полученных из стандарта ISO 4217.

exportChargeSubtotalAmountMicros

string ( int64 format)

Только вывод. Промежуточная сумма экспортных сборов на уровне счета-фактуры до уплаты налогов, в микро.

exportChargeTaxAmountMicros

string ( int64 format)

Только вывод. Сумма налогов на экспортные сборы на уровне счета-фактуры, в микро.

exportChargeTotalAmountMicros

string ( int64 format)

Только вывод. Общая сумма экспортных сборов на уровне счета-фактуры в микро.

subtotalAmountMicros

string ( int64 format)

Только вывод. Итоговая сумма до уплаты налогов, в микрон. Это равно сумме промежуточных сумм AccountBudgetSummary и Invoice.adjustments_subtotal_amount_micros.

taxAmountMicros

string ( int64 format)

Только вывод. Сумма всех налогов в счете-фактуре в микронах. Это равняется сумме сумм налогов AccountBudgetSummary плюс налоги, не связанные с конкретным бюджетом аккаунта.

totalAmountMicros

string ( int64 format)

Только вывод. Общая сумма в микрон. Это соответствует сумме Invoice.subtotal_amount_micros, Invoice.tax_amount_micros, Invoice.regulatory_costs_subtotal_amount_micros и Invoice.export_charge_subtotal_amount_micros (которая, начиная с версии 14.1, выделена в отдельную позицию).

correctedInvoice

string

Только вывод. Имя ресурса исходного счета, исправленного, списанного или аннулированного этим счетом, если применимо. Если установлен correctedInvoice , replacedInvoices не будет установлен. Имена ресурсов счетов имеют вид:

customers/{customerId}/invoices/{invoice_id}

pdfUrl

string

Только вывод. URL-адрес PDF-копии счета. Пользователям необходимо передать свой токен OAuth, чтобы запросить PDF-файл с этим URL-адресом.

Тип счета

Возможный тип счетов.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
CREDIT_MEMO Счет-фактура с отрицательной суммой. На счет поступает кредит.
INVOICE Счет-фактура с положительной суммой. На счету есть задолженность.

СчетБюджетСводка

Представляет собой суммарную сумму к оплате бюджета аккаунта.

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

Только вывод. Имя ресурса клиента, связанного с этим бюджетом аккаунта. Он содержит идентификатор клиента, который отображается в PDF-файле счета как «Идентификатор счета». Имена ресурсов клиента имеют вид:

customers/{customerId}

customerDescriptiveName

string

Только вывод. Описательное имя клиента бюджета аккаунта. В PDF-фактуре он отображается как «Счет».

accountBudget

string

Только вывод. Имя ресурса бюджета аккаунта, связанного с этой суммированной стоимостью к оплате. Имена ресурсов AccountBudget имеют вид:

customers/{customerId}/accountBudgets/{account_budget_id}

accountBudgetName

string

Только вывод. Название бюджета аккаунта. В PDF-файле счета он отображается как «Бюджет счета».

purchaseOrderNumber

string

Только вывод. Номер заказа на покупку бюджета аккаунта. В PDF-фактуре он отображается как «Заказ на поставку».

subtotalAmountMicros

string ( int64 format)

Только вывод. Промежуточная сумма до уплаты налогов, относящаяся к этому бюджету в течение периода обслуживания, в микронах.

taxAmountMicros

string ( int64 format)

Только вывод. Сумма налога, зачисляемая в этот бюджет за период обслуживания, в микрон.

totalAmountMicros

string ( int64 format)

Только вывод. Общая сумма, относящаяся к этому бюджету в течение периода обслуживания, в микронах. Это равняется сумме промежуточной суммы бюджета аккаунта и суммы налога на бюджет аккаунта.

servedAmountMicros

string ( int64 format)

Только вывод. Сумма обслуживания до уплаты налогов, относящаяся к этому бюджету в течение периода обслуживания, в микронах. Это полезно только для сверки данных счета и доставки.

billedAmountMicros

string ( int64 format)

Только вывод. Сумма счета до уплаты налогов, относящаяся к этому бюджету в течение периода обслуживания, в микро. Это не учитывает никаких корректировок.

overdeliveryAmountMicros

string ( int64 format)

Только вывод. Сумма перепоставки до уплаты налогов, относящаяся к этому бюджету в течение периода обслуживания, в микронах (отрицательное значение).

invalidActivityAmountMicros

string ( int64 format)

Только вывод. Сумма недействительной активности до уплаты налогов, относящаяся к этому бюджету в предыдущие месяцы, в микронах (отрицательное значение).

Инвалидактивитисводка

Сведения о недействительной активности для счета, содержащие дополнительные сведения о счете, в отношении которого вносятся исправления.

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 ( int64 format)

Только вывод. Недопустимая сумма активности в микро.

Краткий отчет

Представляет сводное представление на уровне аккаунта.

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
}
Поля
customer

string

Только вывод. Учетная запись, связанная со сводкой учетной записи.

billingCorrectionSubtotalAmountMicros

string ( int64 format)

Только вывод. Итоговая сумма корректировки счета до уплаты налогов, в микронах.

billingCorrectionTaxAmountMicros

string ( int64 format)

Только вывод. Налог на корректировку счета, в микрон.

billingCorrectionTotalAmountMicros

string ( int64 format)

Только вывод. Общая сумма корректировки счета, в микронах.

couponAdjustmentSubtotalAmountMicros

string ( int64 format)

Только вывод. Общая сумма корректировки купона до уплаты налогов, в микронах.

couponAdjustmentTaxAmountMicros

string ( int64 format)

Только вывод. Налог на корректировку купона, в микронах.

couponAdjustmentTotalAmountMicros

string ( int64 format)

Только вывод. Общая сумма корректировки купона, в микро.

excessCreditAdjustmentSubtotalAmountMicros

string ( int64 format)

Только вывод. Промежуточная сумма корректировки превышения кредита до уплаты налогов, в микронах.

excessCreditAdjustmentTaxAmountMicros

string ( int64 format)

Только вывод. Налог на корректировку избыточного кредита, в микронах.

excessCreditAdjustmentTotalAmountMicros

string ( int64 format)

Только вывод. Общая сумма корректировки превышения кредита, в микронах.

regulatoryCostsSubtotalAmountMicros

string ( int64 format)

Только вывод. Общая сумма регуляторных расходов до уплаты налогов, в микронах.

regulatoryCostsTaxAmountMicros

string ( int64 format)

Только вывод. Налог на расходы на регулирование, в микронах.

regulatoryCostsTotalAmountMicros

string ( int64 format)

Только вывод. Общая сумма расходов на регулирование, в микронах.

exportChargeSubtotalAmountMicros

string ( int64 format)

Только вывод. Общая сумма экспортных сборов до уплаты налогов, в микронах.

exportChargeTaxAmountMicros

string ( int64 format)

Только вывод. Налог на экспортный сбор, в микро.

exportChargeTotalAmountMicros

string ( int64 format)

Только вывод. Общая сумма экспортных сборов, в микро.

subtotalAmountMicros

string ( int64 format)

Только вывод. Общая промежуточная сумма до уплаты налогов, относящаяся к счету в течение периода обслуживания, в микронах.

taxAmountMicros

string ( int64 format)

Только вывод. Общая сумма налога, причитающаяся к счету за период обслуживания, в микронах.

totalAmountMicros

string ( int64 format)

Только вывод. Общая сумма, приходящаяся на счет в течение периода обслуживания, в микронах. Это равно сумме промежуточных сумм AmountMicros и TaxAmountMicros.