実験的な : 指定された組織にMongoDBが発行した請求書を 1 つ返します。
一意な 24 桁の 16 進数文字列によって請求書が識別されます。 この請求書はJSONまたは CSV形式で受信することを選択できます。このリソースを使用するには、リクエスト元のAPIキーに組織請求閲覧者、組織請求管理者、または組織オーナーのロールが必要です。組織をまたいだ設定をしている場合、組織請求管理者または組織オーナーのロールがあれば、リンクされた請求書をクエリできます。請求書の未払い金額の合計を計算するには、請求書に含まれる各支払いの未払い金額の総額を合計します。支払いの未払い金額を計算するには、 totalBilledCents * unitPrice + salesTax - startingBalanceCents という式を使用します。このコマンドは、OpsID: 'getInvoice' を使用してエンドポイントを呼び出します。フラグ、--ファイルの形式、および例の詳細については、 https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /#Tag/Invoices/操作/ getInvoice
構文
atlas api invoices getInvoice [options]
オプション
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
-- envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ | |
-h, --help | false | getInvoice のヘルプ | |
--invoiceId | string | true | 指定された組織に提出された請求書を識別する一意な 24 桁の 16 進数文字列 |
--orgId | string | true | プロジェクトを含む組織を識別する一意の 24 桁の 16 進数文字列 |
--出力 | string | true | 優先API形式 は、 ["CSV", "JSON", go-template] にすることができます |
-- output-file | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ(例: gzip)で、コマンドがパイプライン化されていない場合(例: Atlas コマンド >out.zip)に必要です。 |
--pretty | false | レスポンス本体を pretty-print形式にするかどうかを示すフラグ | |
--version | string | false | API 呼び出し [options: "2023-01-01"] を呼び出すときに使用する API バージョンは、最新バージョンにデフォルト設定されているか、設定されている場合は api_version 構成値 をプロファイルします。この値のデフォルトは "2023-01-01" |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |