Atlas API請求書 listInvoices

envelope

false

アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

string

false

fromDate が 以上の請求書を取得します。 省略した場合、返される請求書は最も近い startDate に戻りGo 。

false

listInvoices のヘルプ

false

レスポンスがレスポンス内のアイテムの総数（totalCount）を返すかどうかを示すフラグ。

整数

false

レスポンスが返す 1 ページあたりのアイテムの数。

string

false

返された請求書を並べ替えるために使用されるフィールド。 結果の順序を制御するには、 sortBy パラメーターと組み合わせて使用します。

string

true

プロジェクトを含む組織を識別する一意の 24 桁の 16 進数文字列。 [/orgs](#Tag/Organizations/ 操作/listOrganizations) エンドポイントを使用して、認証されたユーザーがアクセスできるすべての組織を取得します。

string

false

優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。

string

false

API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。

整数

false

レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。

false

レスポンス本体を <aクエリを実行するかどうかを示すフラグtarget ` ` Sharding</a>

string

false

返された請求書を並べ替えるために使用されるフィールド。 結果の順序を制御するには、orderBy パラメーターと組み合わせて使用します。

stringArray

false

検索する請求書のステータス。 省略すると、すべてのステータスの請求書が返されます。

string

false

endDate が toDate 以下の請求書を取得します。 省略した場合、返される請求書は最新のGoよりも超過します。

string

false

API 呼び出し [options: "2023-01-01"] を呼び出すときに使用する API バージョンは、最新バージョンにデフォルト設定されているか、設定されている場合は api_version 構成値 をプロファイルします。この値のデフォルトは "2023-01-01"

false

linkedInvoices フィールドにリンクされた請求書を返すかどうかを示すフラグ。