1개의 조직에 대해 1개의 청구서를 CSV 로 반환

얻다 /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv

MongoDB가 지정된 조직에 발행한 청구서 하나를 CSV 형식으로 반환합니다. 고유한 24자리 16진수 문자열로 청구서를 식별합니다. 이 리소스를 사용하려면, 요청하는 서비스 계정 또는 API 키에 최소한 조직 청구 뷰어, 조직 청구 관리자 또는 조직 소유자 역할이 있어야 합니다. 조직 간 설정이 있는 경우, 조직 청구 관리자 또는 조직 소유자 역할이 있으면 연결된 청구서를 쿼리할 수 있습니다. 청구서의 총 미지급 금액을 계산하려면 청구서에 포함된 각 결제의 총 미지급 금액을 합산합니다. 결제의 미지급 금액을 계산하려면 totalBilledCents * unitPrice + salesTax - startingBalanceCents 수식을 사용하세요.

경로 매개변수

orgId 문자열 필수 사항

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

형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.
invoiceId 문자열 필수 사항

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

형식은 [0-9a-f]+ 패턴 과 일치해야 합니다.

쿼리 매개변수

envelope 부울

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

기본값은 false 입니다.
pretty 부울

응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

기본값은 false 입니다.

Prettyprint

응답

200 application/vnd.atlas.2023-01-01+csv

확인
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}/csv

atlas api invoices getOrgInvoiceCsv --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20240530001/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.GetOrgInvoiceCsvApiParams{}
	sdkResp, httpResp, err := client.InvoicesApi.
		GetOrgInvoiceCsvWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2024-05-30+csv" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2024-05-30+csv" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true"

응답 예시(200)

Invoice Number,666acb8787ba43606905dcae,
Billing Period,"June 1, 2024 - July 1, 2024",
Organization Name,Test 2,
Organization ID,666acb8787ba43606905dcac,

Date,Usage Date,Description,Note,Organization Name,Organization ID,Project,Project ID,SKU,Region,Cluster,Replica Set,Config Server,Application,Unit,Unit Price,Quantity,Discount Percent,Amount

응답 예시(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"
}