請求書IDを使用して 1 つの請求書のすべての明細項目を返す
指定された請求書の LineItems をクエリし、結果 JSON を返します。 一意な 24 桁の 16 進数stringによって請求書が識別されます。
path パラメータ
-
24プロジェクトを含む組織を識別する一意の 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべての組織を取得するには、 /orgs エンドポイントを使用します。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。 -
指定された組織に提出された請求書を識別するユニークな 24 桁の 16 進数文字列。料金は通常翌日に書き込みされます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelopeJSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
falseです。 -
レスポンスが返す 1 ページあたりのアイテムの数。
最小値は
1、最大値は500です。デフォルト値は100です。 -
レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。
の最小値は
1です。デフォルト値は1です。
body
必須
LineItems クエリのフィルタリング パラメータ。 フィルターを適用せずに、指定された請求書 ID のすべての行項目を検索するには、空の JSON ボディで リクエストを送信します。
-
特定の 請求書使用状況の詳細 クエリの一部として行項目をフィルタリングするためのさまざまなフィールドを含むリクエスト本文。
-
クエリ結果のソート方法を指定するために使用されるフィールドを指定します。 デフォルトは請求日です。
値は
USAGE_DATES、BILL_DATES、またはTOTAL_PRICE_CENTSです。 -
クエリ結果を並べ替える方法を指定するために使用される並べ替え順序（昇順または降順）を指定します。 デフォルトは降順です。
値は
ASCENDINGまたはDESCENDINGです。
atlas api invoices searchOrgInvoiceLineItems --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20250219001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.SearchOrgInvoiceLineItemsApiParams{}
sdkResp, httpResp, err := client.InvoicesApi.
SearchOrgInvoiceLineItemsWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2025-02-19+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search?pretty=true"curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2025-02-19+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search?pretty=true"{
"filters": {
"billEndDate": "2025-05-04",
"billStartDate": "2025-05-04",
"clusterIds": [
"32b6e34b3d91647abb20e7b8"
],
"groupIds": [
"32b6e34b3d91647abb20e7b8"
],
"includeZeroCentLineItems": true,
"skuServices": [
"Atlas"
],
"usageEndDate": "2025-05-04",
"usageStartDate": "2025-05-04"
},
"sortField": "USAGE_DATES",
"sortOrder": "ASCENDING"
}{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [
{
"billDate": "2025-05-04T09:42:00Z",
"clusterName": "string",
"description": "string",
"groupId": "32b6e34b3d91647abb20e7b8",
"quantity": 42.0,
"totalPriceCents": 42,
"unitPriceDollars": 42.0,
"usageDate": "2025-05-04T09:42:00Z"
}
],
"totalCount": 42
}{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}