1개의 조직에 대해 모든 청구서 반환
MongoDB가 지정된 조직에 발행한 모든 청구서를 반환합니다. 이 목록에는 청구서 상태와 관계없이 모든 청구서가 포함됩니다. 이 리소스를 사용하려면, 요청하는 서비스 계정 또는 API 키에 조직 청구 뷰어, 조직 청구 관리자 또는 조직 소유자 역할이 있어야 합니다. 조직 간 설정이 있는 경우, 조직 청구 관리자 또는 조직 소유자 역할이 있으면 연결된 청구서를 볼 수 있습니다. 청구서의 총 미지급 금액을 계산하려면 각 청구서의 총 미지급 금액을 합산합니다. 청구서에 포함된 각 결제의 미지급 금액의 합계로 계산할 수 있습니다. 결제의 미지급 금액을 계산하려면 totalBilledCents * unitPrice + salesTax - startingBalanceCents 수식을 사용하세요.
경로 매개변수
-
24프로젝트가 포함된 조직 식별하는 고유한 -16진수 문자열입니다. 인증된 사용자가 액세스 할 수 있는 모든 조직을 조회 하려면 /orgs 엔드포인트를 사용합니다.
형식은
^([a-f0-9]{24})$패턴 과 일치해야 합니다.
쿼리 매개변수
-
애플리케이션이 응답을
envelopeJSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.기본값은
false입니다. -
응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.
기본값은
true입니다. -
페이지당 응답이 반환하는 항목 수입니다.
최소값은
1, 최대값은500입니다. 기본값은100입니다. -
응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.
최소값은
1입니다. 기본값은1입니다. -
응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.
기본값은
false입니다.Prettyprint -
LinkedInvoices 필드에 연결된 청구서를 반환할지 여부를 나타내는 플래그입니다.
기본값은
true입니다. -
조회할 청구서의 상태입니다. 생략하면 모든 상태의 청구서를 반환합니다.
값은
PENDING,CLOSED,FORGIVEN,FAILED,PAID,FREE,PREPAID또는INVOICED입니다. -
startDates가 fromDate보다 크거나 같은 청구서를 조회합니다. 생략하면 청구서 반환이 가장 이른 startDate로 돌아갑니다.
-
endDates가 toDate보다 작거나 같은 인보이스를 검색합니다. 생략하면 반환되는 인보이스는 최신 endDate까지 확장됩니다.
-
반환된 인보이스를 정렬하는 데 사용되는 필드입니다. orderBy 매개변수와 함께 사용하면 결과의 순서를 제어할 수 있습니다.
값은
START_DATE또는END_DATE입니다. 기본값은END_DATE입니다. -
반환된 인보이스를 주문하는 데 사용되는 필드입니다. sortBy 매개변수와 함께 사용하여 결과의 순서를 제어할 수 있습니다.
값은
desc또는asc입니다. 기본값은desc입니다.
atlas api invoices listOrgInvoices --helpimport (
"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.ListOrgInvoicesApiParams{}
sdkResp, httpResp, err := client.InvoicesApi.
ListOrgInvoicesWithParams(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?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?pretty=true"{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [
{
"amountBilledCents": 42,
"amountPaidCents": 42,
"created": "2025-05-04T09:42:00Z",
"creditsCents": 42,
"endDate": "2025-05-04T09:42:00Z",
"id": "32b6e34b3d91647abb20e7b8",
"linkedInvoices": [
{}
],
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"salesTaxCents": 42,
"startDate": "2025-05-04T09:42:00Z",
"startingBalanceCents": 42,
"statusName": "PENDING",
"subtotalCents": 42,
"updated": "2025-05-04T09:42:00Z"
}
],
"totalCount": 42
}{
"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"
}