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

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

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 は、請求書の PDF に「アカウント ID」として記載されます。顧客リソース名の形式は次のとおりです。

customers/{customerId}

string

出力のみ。アカウントの予算のお客様にわかりやすい名前です。請求書の 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 の合計と等しくなります。