Method: customers.invoices.list

string

必須。請求書を取得する顧客の ID。

string

必須。リクエストされた請求書のお支払い情報設定のリソース名。

customers/{customerId}/billingSetups/{billing_setup_id}

string

必須。請求書を取得する発行年（yyyy 形式）。取得できるのは、2019 年以降に発行された請求書のみです。

enum (MonthOfYear)

必須。請求書を取得する発行月。

{
  "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
}

string

出力のみ。請求書のリソース名。請求書は複数のお客様が共有できるため、複数のリソース名が同じ請求書を指す場合があります。請求書のリソースの名前の形式は次のとおりです。

customers/{customerId}/invoices/{invoice_id}

enum (InvoiceType)

出力のみ。請求書のタイプ。

object (DateRange)

出力のみ。この請求書のサービス期間。終了日も指定可能です。

string (int64 format)

出力のみ。請求書レベルの調整の税引前の小計金額（マイクロ単位）。

string (int64 format)

出力のみ。請求書レベルでの調整に対する税金の合計（マイクロ単位）。

string (int64 format)

出力のみ。請求書レベルでの調整の合計額（マイクロ単位）。

string (int64 format)

出力のみ。請求書レベルの規制費用の税引前の小計額（マイクロ秒単位）。

string (int64 format)

出力のみ。請求書レベルの規制費用に対する税金の合計（マイクロ単位）。

string (int64 format)

出力のみ。請求書レベルの規制費用の合計額（マイクロ単位）。

string

出力のみ。再請求される、またはこの請求書によって置き換えられる元の請求書のリソース名（該当する場合）。請求書の統合により、置き換えられる請求書が複数存在する場合があります。差し替え後の請求書は、同じお支払いアカウントに属していない可能性があります。replacedInvoices が設定されている場合、correctedInvoice は設定されません。請求書のリソースの名前の形式は次のとおりです。

customers/{customerId}/invoices/{invoice_id}

object (AccountBudgetSummary)

出力のみ。この請求書に関連付けられているアカウントの予算情報の概要のリスト。

object (AccountSummary)

出力のみ。この請求書に関連付けられているアカウント情報の要約のリスト。

string

出力のみ。請求書の ID。この番号は、請求書の PDF に「請求書番号」として表示されます。

string

出力のみ。この請求書のお支払い情報設定のリソース名。

customers/{customerId}/billingSetups/{billing_setup_id}

string

出力のみ。お支払い情報の設定に関連付けられたお支払いアカウントの識別に使用される 16 桁の ID（例: 1234-5678-9012-3456）。この番号は、請求書の PDF に「請求先アカウント番号」と表示されます。

string

出力のみ。お支払い情報の設定に関連付けられたお支払いプロファイルを識別するために使用される 12 桁の ID（例: 1234-5678-9012）。この番号は、請求書の PDF に「請求 ID」として表示されます。

string

出力のみ。発行日（yyyy-mm-dd 形式）。請求書の PDF には「発行日」または「請求書の日付」で表示されます。

string

出力のみ。期限（yyyy-mm-dd 形式）。

string

出力のみ。通貨コード。すべての費用はこの通貨で返されます。ISO 4217 規格から派生した通貨コードのサブセットがサポートされています。

string (int64 format)

出力のみ。請求書レベルのエクスポート料金の税引前の小計金額（マイクロ秒単位）。

string (int64 format)

出力のみ。請求書レベルの輸出料金の合計額（マイクロ秒単位）。

string (int64 format)

出力のみ。請求書レベルのエクスポート料金の合計額（マイクロ単位）。

string (int64 format)

出力のみ。税抜きの小計額（マイクロ単位）。これは、AccountBudgetSummary の小計金額と Invoice.adjustments_subtotal_amount_micros の合計額です。

string (int64 format)

出力のみ。請求書に記載されているすべての税金の合計（マイクロ単位）。これは、AccountBudgetSummary の税額に、特定のアカウントの予算に関連付けられていない税を加えた金額です。

string (int64 format)

出力のみ。合計金額（マイクロ単位）。これは、Invoice.subtotal_amount_micros、Invoice.tax_amount_micros、Invoice.regulatory_costs_subtotal_amount_micros、Invoice.export_charge_subtotal_amount_micros（V14.1 以降では個別の項目に分割されています）を合計したものです。

string

出力のみ。この請求書によって修正、取り消し、キャンセルが行われた元の請求書のリソース名（該当する場合）。correctedInvoice が設定されている場合、replacedInvoices は設定されません。請求書のリソースの名前の形式は次のとおりです。

customers/{customerId}/invoices/{invoice_id}

string

出力のみ。請求書の PDF コピーの URL。この URL を含む PDF をリクエストするには、OAuth トークンを渡す必要があります。

{
  "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
}

object (DateRange)

出力のみ。この請求書のサービス期間内での、アカウントの予算の請求対象アクティビティ期間。終了日も指定可能です。これは、アカウントの予算の開始時刻と終了時刻とは異なる場合があります。

object (InvalidActivitySummary)

出力のみ。無効なアクティビティのクレジットと元のリンクをまとめたリスト。

string

出力のみ。このアカウントの予算に関連付けられている顧客のリソース名。これにはお客様 ID が含まれます。お客様 ID は、請求書の PDF に「アカウント ID」として記載されます。顧客リソース名の形式は次のとおりです。

customers/{customerId}

string

出力のみ。アカウントの予算の顧客のわかりやすい名前。この ID は請求書の PDF には「アカウント」と表示されます。

string

出力のみ。この請求可能な費用の要約に関連付けられたアカウントの予算のリソース名。AccountBudget リソース名の形式は次のとおりです。

customers/{customerId}/accountBudgets/{account_budget_id}

string

出力のみ。アカウントの予算の名前。PDF の請求書には「アカウントの予算」と表示されます。

string

出力のみ。アカウントの予算の注文書番号。この番号は PDF 請求書には「注文書」と表示されます。

string (int64 format)

出力のみ。サービス期間中のこの予算に起因する税引前の小計の金額（マイクロ単位）。

string (int64 format)

出力のみ。サービス期間中にこの予算に起因する税額（マイクロ単位）。

string (int64 format)

出力のみ。サービス期間中にこの予算に起因する合計額（マイクロ単位）。これは、アカウントの予算の小計額とアカウントの予算の税額を合計した額になります。

string (int64 format)

出力のみ。サービス期間中のこの予算に起因する、税引前の配信額（マイクロ単位）。これは、請求書と配信データを調整する場合にのみ有用です。

string (int64 format)

出力のみ。サービス期間中のこの予算に起因する税引前の請求額（マイクロ単位）。調整は考慮されていません。

string (int64 format)

出力のみ。この予算に起因する、サービス期間中の税引前の超過配信額（マイクロ秒単位）（負の値）。

string (int64 format)

出力のみ。前月のこの予算に起因する、税引前の無効なアクティビティの金額（マイクロ単位）（負の値）。

{
  "originalMonthOfService": enum (MonthOfYear),
  "originalYearOfService": string,
  "originalInvoiceId": string,
  "originalAccountBudgetName": string,
  "originalPurchaseOrderNumber": string,
  "amountMicros": string
}

enum (MonthOfYear)

出力のみ。無効なアクティビティに対するクレジットに関連する元の利用月。

string

出力のみ。この無効なアクティビティに対するクレジットに関連する元のサービス提供年。

string

出力のみ。無効なアクティビティに対するクレジットに関連する元の請求書番号。

string

出力のみ。この無効なアクティビティに対するクレジットに関連する元のアカウントの予算名。

string

出力のみ。無効なアクティビティのクレジットに関連する元の注文番号です。

string (int64 format)

出力のみ。無効なアクティビティ金額（マイクロ単位）。

{
  "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
}

string

出力のみ。アカウントの概要に関連付けられているアカウント。

string (int64 format)

出力のみ。税引前の請求修正の小計金額（マイクロ単位）。

string (int64 format)

出力のみ。請求修正に対する税金（マイクロ単位）。

string (int64 format)

出力のみ。請求修正の合計額（マイクロ単位）。

string (int64 format)

出力のみ。税引前クーポン調整の小計金額（マイクロ単位）。

string (int64 format)

出力のみ。クーポン調整に対する税金（マイクロ単位）。

string (int64 format)

出力のみ。クーポン調整額の合計（マイクロ単位）。

string (int64 format)

出力のみ。税引前の超過クレジット調整の小計額（マイクロ秒単位）。

string (int64 format)

出力のみ。超過クレジット調整に対する税金（マイクロ単位）。

string (int64 format)

出力のみ。超過クレジット調整額の合計（マイクロ単位）。

string (int64 format)

出力のみ。税引前の規制費用の小計額（マイクロ単位）。

string (int64 format)

出力のみ。規制費用に対する税金（マイクロ単位）。

string (int64 format)

出力のみ。規制費用の合計（マイクロ単位）。

string (int64 format)

出力のみ。輸出手数料税抜きの小計金額（マイクロ単位）。

string (int64 format)

出力のみ。輸出料金に対する税（マイクロ単位）。

string (int64 format)

出力のみ。輸出手数料の総額（マイクロ秒単位）。

string (int64 format)

出力のみ。サービス期間中のアカウントに起因する税引前の合計額（マイクロ単位）。

string (int64 format)

出力のみ。サービス期間中にアカウントに帰属する合計税額（マイクロ単位）。

string (int64 format)

出力のみ。サービス期間中にアカウントに帰属する合計金額（マイクロ単位）。これは、subtotalAmountMicros と taxAmountMicros の合計と等しくなります。