返回一个组织的所有发票
返回 MongoDB 已向指定组织开具的全部发票。此列表包括所有发票，无论发票状态如何。要使用此资源，请求的服务帐户或 API 密钥必须具有“组织账单查看器”、“组织账单管理员”或“组织所有者”角色。如果您有跨组织设置，只要您具有“组织账单管理员”或“组织所有者”角色，就可以查看链接的发票。计算发票的总欠款要将每张发票的欠款总额相加。它可以计算为包含在发票中的每笔付款的欠款总额。要计算付款的欠款金额，可使用公式 totalBilledCents * unitPrice + salesTax - startingBalanceCents。
路径参数
-
唯一的24 -十六进制数字字符串，用于标识包含项目的组织。使用 /orgs 端点检索身份验证的用户有权访问权限的所有组织。
格式应符合以下模式：
^([a-f0-9]{24})$。
查询参数
-
指示应用程序是否将响应包装在
envelopeJSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。默认值为
false。 -
标志，用于指示响应是否返回响应中的列项总数 (totalCount)。
默认值为
true。 -
响应每页返回的列项数。
最小值为
1，最大值为500。默认值为100。 -
显示响应返回的当前总对象集的页面编号。
最小值为
1。默认值为1。 -
指示响应正文是否应采用 prettyprint 格式的标记。
默认值为
false。Prettyprint -
指示是否在 linkedInvoices 字段中返回链接发票的标志。
默认值为
true。 -
要检索的发票的状态。省略返回所有状态的发票。
取值为
PENDING、CLOSED、FORGIVEN、FAILED、PAID、FREE、PREPAID或INVOICED。 -
检索 startDate 大于或等于 fromDate 的发票。如果省略，发票返回将回溯到最早开始日期。
-
检索 endDates 小于或等于 toDate 的发票。 如果省略，发票返回将进一步到最晚结束日期。
-
用于对返回的发票进行排序的字段。与 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/v20230201001/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.2023-02-01+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.2023-02-01+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"
}