この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

InvoiceBatchRun

Subscription Management の一括処理ジョブを表します。請求書バッチ実行では、指定された条件を満たすすべての請求スケジュールが処理され、請求書が作成されます。このオブジェクトは、API バージョン 55.0 以降で使用できます。

請求書バッチ実行はスケジューラーで制御されます。スケジューラーはスケジュールされた日時に実行を開始するようにシステムに指示します。また、スケジューラーには、請求スケジュールの評価に使用される一致条件が含まれています。指定された条件を満たす請求スケジュールは、請求書バッチ実行の処理対象となります。

請求書バッチ実行が開始されると、Subscription Management で次のことが実行されます。
  1. 請求スケジュールが請求書バッチ実行に含まれる条件を満たしているかどうかを評価します。
  2. 待機中状態の請求書レコードを生成します。
  3. 外部の税金プロバイダー対するコールを行います。
  4. 税金を請求書に追加します。
  5. 請求書バッチ実行に含まれていた請求スケジュールに関する情報をまとめ、この情報を請求書バッチ実行レコードに表示します。

サポートされているコール

describeLayout()describeSObjects()getDeleted()getUpdated()query()retrieve()update()

特別なアクセスルール

このオブジェクトは、Subscription Management が有効な場合に使用できます。

項目

項目 詳細
BillingBatchSchedulerId
reference
プロパティ
Filter、Group、Sort
説明
関連する請求バッチスケジューラーの ID。
この項目はリレーション項目です。
リレーション名
BillingBatchScheduler
リレーション種別
Lookup
参照先
BillingBatchScheduler
Comments
textarea
プロパティ
Filter、Nillable、Sort、Update
説明
スケジューラーに関するユーザー定義の情報 (省略可���)。
CompletionTime
dateTime
プロパティ
Filter、Nillable、Sort
説明
請求書バッチ実行が処理を完了したときのタイムスタンプ。
InvoiceBatchRunNumber
string
プロパティ
Autonumber、Defaulted on create、Filter、idLookup、Sort
説明
システムによって生成された連続番号。
LastReferencedDate
dateTime
プロパティ
Filter、Nillable、Sort
説明
請求書バッチ実行が最後に更新されたときのタイムスタンプ。UI 表示ラベルは [最終更新日] です。
LastViewedDate
dateTime
プロパティ
Filter、Nillable、Sort
説明
請求書バッチ実行が最後に参照されたときのタイムスタンプ。
OwnerId
reference
プロパティ
Filter、Group、Sort、Update
説明
システムで生成された項目。BillingBatchScheduler レコードを作成したユーザーの ID。UI 表示ラベルは [所有者] です。
この項目は多態的なリレーション項目です。
リレーション名
Owner
リレーション種別
Lookup
参照先
Group、User
RecoveryStatus
picklist
プロパティ
Filter、Group、Nillable、Restricted picklist、Sort
説明
請求書バッチ実行の復元プロセスの状態を示します。この項目は、API バージョン 56.0 以降で使用できます。
可能な値は次のとおりです。
  • CompletelyRecovered — 復元の実行に含まれるすべての請求スケジュールが [請求準備完了] にリセットされました。このような請求スケジュールは、次回の請求書バッチ実行スケジュールに含まれます。
  • PartiallyRecovered — 復元の実行に含まれる一部 (全部ではない) の課金スケジュールが [請求準備完了] にリセットされました。復元された請求スケジュールは、次回の請求書バッチ実行スケジュールに含まれます。正常に復元されなかった請求スケジュールは、処理できるように手動で [請求準備完了] にリセットする必要があります。
  • RecoveryFailed — 復元ジョブが失敗しました。この値は、API バージョン 57.0 以降で使用できます。
  • RecoveryStarted — 復元ジョブは処理中です。
StartTime
dateTime
プロパティ
Filter、Sort
説明
請求書バッチ実行が処理を開始したときのタイムスタンプ。
Status
picklist
プロパティ
Defaulted on create、Filter、Group、Restricted picklist、Sort
説明
請求書バッチ実行の状態。
可能な値は次のとおりです。
  • Canceled — この値は API バージョン 57.0 以降で使用できます。
  • Completed
  • Failed
  • Started
  • Stopped — この値は API バージョン 57.0 以降で使用できます。
デフォルト値は Started です。
TotalBillSchedRecovered
int
プロパティ
Filter、Group、Nillable、Sort
説明
[請求準備完了] にリセットされた、復元の実行に含まれる一部の課金スケジュールの数。このような請求スケジュールは、次回の請求書バッチ実行スケジュールに含まれます。
この項目は、API バージョン 57.0 以降で使用できます。
TotalBillSchedUnrecovered
int
プロパティ
Filter、Group、Nillable、Sort
説明
[請求準備完了] にリセットされていない復元の実行に含まれる一部の課金スケジュールの数。これらの正常に復元されなかった請求スケジュールは、処理できるように手動で [請求準備完了] にリセットする必要があります。
この項目は、API バージョン 57.0 以降で使用できます。
TotalBillingSchedulesFailed
int
プロパティ
Filter、Group、Nillable、Sort
説明
正常に処理されなかった請求スケジュールの合計数。請求スケジュールが正常に処理されない場合、その請求書は生成されません。エラーの詳細については、収益トランザクションエラーログを確認してください。この項目は、API バージョン 56.0 以降で使用できます。
TotalBsSuccessfullyProcessed
int
プロパティ
Filter、Group、Nillable、Sort
説明
システムで請求書を生成して、処理することができた請求スケジュールの合計数。この項目は、API バージョン 56.0 以降で使用できます。
TotalFilteredBillingSchedules
int
プロパティ
Filter、Group、Nillable、Sort
説明
請求書の実行スケジューラーの一致条件を満たした請求スケジュールの合計数。一致条件によって、請求書バッチ実行に含まれる請求スケジュールが指定されます。項目表示ラベルは、[一致する請求スケジュール総数] です。この項目は、API バージョン 56.0 以降で使用できます。
TotalInvSuccessfullyProcessed
int
プロパティ
Filter、Group、Nillable、Sort
説明
正常に処理された請求書の合計数。この項目は、API バージョン 56.0 以降で使用できます。
TotalInvoicedAmount
currency
プロパティ
Filter、Nillable、Sort
説明
正常に処理された請求書で表される税込み収入の総額。この項目は、API バージョン 56.0 以降で使用できます。
TotalInvoicesCanceled
int
プロパティ
Filter、Group、Nillable、Sort
説明
正常に処理されなかった請求書の合計数。問題を調べるには、収益トランザクションエラーログを確認します。エラーを修正し、次に請求書バッチ実行の復旧プロセスを実行します。
この項目は、API バージョン 57.0 以降で使用できます。
TotalInvoicesFailed
int
プロパティ
Filter、Group、Nillable、Sort
説明
正常に処理されなかった請求書の合計数。問題を調べるには、収益トランザクションエラーログを確認します。その後、エラーを修正し、請求書バッチ実行の復旧プロセスを実行します。この項目は、API バージョン 56.0 以降で使用できます。
TotalInvoicesGenerated
int
プロパティ
Filter、Group、Nillable、Sort
説明
請求書バッチ実行で処理された請求書スケジュールから生成された請求書の合計数。この項目は、API バージョン 56.0 以降で使用できます。

関連付けられたオブジェクト

このオブジェクトには次の関連するオブジェクトがあります。API バージョンが指定されていない場合、これらはこのオブジェクトと同じ API バージョンで使用できます。指定されている場合、指定された API バージョン以降で使用できます。

InvoiceBatchRunChangeEvent
このオブジェクトには変更イベントを利用できます。
InvoiceBatchRunFeed
このオブジェクトにはフィード追跡を利用できます。
InvoiceBatchRunHistory
このオブジェクトの追跡項目には履歴を利用できます。
InvoiceBatchRunOwnerSharingRule
このオブジェクトには共有ルールを利用できます。
InvoiceBatchRunShare
このオブジェクトには共有を利用できます。