청구서 ID 별로 하나의 청구서에 대해 모든 항목 반환

얻다 /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search

지정된 청구서의 lineItems를 쿼리하고 결과 JSON을 반환합니다. 고유한 24자리 16진수 문자열로 청구서를 식별합니다.

경로 매개변수

  • orgId 문자열 필수 사항

    24프로젝트가 포함된 조직 식별하는 고유한 -16진수 문자열입니다. 인증된 사용자가 액세스 할 수 있는 모든 조직을 조회 하려면 /orgs 엔드포인트를 사용합니다.

    형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

  • invoiceId 문자열 필수 사항

    지정된 조직에 제출된 청구서를 식별하는 고유한 24자리 16진수 문자열입니다. 요금은 일반적으로 다음 날 청구됩니다.

    형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

쿼리 매개변수

  • envelope 부울

    애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

    기본값은 false 입니다.

  • itemsPerPage integer

    페이지당 응답이 반환하는 항목 수입니다.

    최소값은 1, 최대값은 500입니다. 기본값은 100입니다.

  • pageNum integer

    응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.

    최소값은 1입니다. 기본값은 1입니다.

application/vnd.atlas.2024-08-05+json

body 필수 사항

lineItems 쿼리에 대한 필터 매개변수입니다. 필터를 적용하지 않고 주어진 invoiceID에 대한 모든 품목을 조회하기 위해 빈 JSON 본문이 있는 요청을 보냅니다.

  • 필터 객체

    특정 인보이스 사용 세부 정보 쿼리의 일부로 항목 필터링을 위한 다양한 필드가 포함된 요청 본문입니다.

    필터 속성 숨기기 필터 속성 표시 객체
    • billEndDate 문자열(날짜)

      사용량 세부 정보 필터하다 의 포함 청구 시작일입니다.

    • BillStartDate 문자열(날짜)

      사용량 세부 정보 필터하다 의 포함 청구 시작일입니다.

    • clusterIds array[string]

      사용량 세부 정보 필터하다 에 포함할 고유 클러스터 ID의 목록입니다.

      각 형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

    • groupIds array[string]

      사용량 세부 정보 필터하다 에 포함할 그룹 목록입니다.

      각 형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

    • includeZroCentLineItems 부울

      0센트 광고 항목을 포함할지 여부입니다.

    • skuServices array[string]

      Cost Explorer 쿼리에 포함할 프로젝트 목록입니다.

      값은 Atlas, Clusters, Storage, Serverless Instances, Backup, Data Transfer, BI Connector, Premium Features, Atlas Data Federation, Atlas Stream Processing, App Services, Charts, Cloud Manager, Cloud Manager Standard/Premium, Legacy Backup, Flex Consulting, Support 또는 Credits.

    • usageEndDate 문자열(날짜)

      사용량 세부 정보 필터하다 의 포함 청구 시작일입니다.

    • UsageStartDate 문자열(날짜)

      사용 세부 정보 필터하다 의 포괄적 사용 시작 날짜입니다.

  • sortField 문자열

    쿼리 결과를 정렬하는 방법을 지정하는 데 사용되는 필드를 지정합니다. 기본적으로 청구 날짜로 설정됩니다.

    값은 USAGE_DATES, BILL_DATES 또는 TOTAL_PRICE_CENTS입니다.

  • sortOrder 문자열

    쿼리 결과를 정렬하는 방법을 지정하는 데 사용되는 정렬 순서(오름차순/내림차순)를 지정합니다. 기본값은 내림차순입니다.

    값은 ASCENDING 또는 DESCENDING입니다.

응답

  • 200 application/vnd.atlas.2024-08-05+json

    확인

    응답 속성 숨기기 응답 속성 표시 객체
    • 결과 배열[객체]

      이 요청 을 완료할 때 MongoDB 클라우드가 제공하는 반환된 문서 목록입니다.

      결과 속성 숨기기 결과 속성 표시 객체
      • BillDate 문자열(날짜-시간)

        항목의 청구 날짜입니다. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다.

      • clusterName 문자열

        라인 항목과 연결된 클러스터입니다.

      • description 문자열

        항목에 대한 설명으로, SKU 이름 및 기타 식별 정보를 포함할 수 있습니다.

      • groupId 문자열

        광고 항목과 연결된 그룹 ID입니다.

        형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

      • 수량 number(double)

        SKU와 연결된 단위로 표시된 품목의 수량입니다.

      • totalPriceCents integer(int64)

        가격 * 해당 단위의 수량으로, 정수 센트로 표시됩니다.

      • unitPriceDollars number(double)

        품목의 SKU와 연결된 단위 단위의 가격입니다.

      • UsageDate 문자열(날짜-시간)

        항목의 사용 날짜입니다. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다.

    • 총 개수 integer(int32)

      사용 가능한 총 문서 수입니다. MongoDB Cloud는 includeCountfalse로 설정하다 경우 이 값을 생략합니다. 총 숫자는 추정치이며 정확하지 않을 수 있습니다.

      최소값은 0입니다.

  • 400 application/json

    잘못된 요청입니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

  • 401 application/json

    승인되지 않았습니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

  • 403 application/json

    Forbidden.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

  • 404 application/json

    찾을 수 없습니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

  • 500 application/json

    내부 서버 오류입니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

GET /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems: 검색
atlas api invoices searchOrgInvoiceLineItems --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/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-03-12+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-03-12+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"
}
응답 예시(200)
{
  "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
}
응답 예시(400)
{
  "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"
}
응답 예시(401)
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
응답 예시(403)
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
응답 예시(404)
{
  "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"
}
응답 예시(500)
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}