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