Retornar todas as faturas de uma organização
Retorna todas as faturas que o MongoDB emitiu para a organização especificada. Esta lista inclui todas as faturas, independentemente do status da fatura. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de visualizador de faturamento da organização, administrador de faturamento da organização ou proprietário da organização. Se houver uma configuração de organização cruzada, é possível visualizar as faturas vinculadas se você tiver a função de Administrador de cobrança da organização ou Proprietário da organização. Para calcular o valor total devido das faturas, some o total devido em cada uma das faturas. Pode ser calculado como uma soma do valor devido de cada pagamento incluído na fatura. Para calcular o valor devido do pagamento, use a fórmula totalBilledCents * unitPrice + salesTax - StartingBalanceCents.
parâmetros de caminho
-
String exclusiva de 24dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint /orgs para recuperar todas as organizações às quais o usuário autenticado tem acesso.
O formato deve corresponder ao seguinte padrão:
^([a-f0-9]{24})$.
parâmetros de query
-
Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON
envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.O valor padrão é
false. -
Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
O valor padrão é
true. -
Número de itens que a resposta retorna por página.
O valor mínimo é
1, o valor máximo é500. O valor padrão é100. -
Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
O valor mínimo é
1. O valor padrão é1. -
Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
O valor padrão é
false.Prettyprint -
Sinalizador que indica se as faturas vinculadas devem ser retornadas no campo linkedInvoices.
O valor padrão é
true. -
Status da fatura a ser recuperada. Omitir para retornar faturas de todos os status.
Os valores são
PENDING,CLOSED,FORGIVEN,FAILED,PAID,FREE,PREPAIDouINVOICED. -
Recupere as faturas cujas startDates sejam maiores ou iguais a fromDate. Se omitido, as faturas geradas retornarão para a startDate mais antiga
-
Recupere as faturas das quais endpoints são menores ou iguais a toDate. Se omitido, as faturas devolvidas irão além do mais recente endDate.
-
Campo usado para classificar as faturas retornadas. Use em combinação com o parâmetro orderBy para controlar a ordem do resultado.
Os valores são
START_DATEouEND_DATE. O valor padrão éEND_DATE. -
Campo usado para ordenar as faturas retornadas. Use em combinação com o parâmetro sortBy para controlar a ordem do resultado.
Os valores são
descouasc. O valor padrão édesc.
atlas api invoices listInvoices --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"
}