Devuelve todas las facturas emitidas por MongoDB a la organización especificada. Esta lista incluye todas las facturas, independientemente de su estado. Para usar este recurso, la cuenta de servicio o clave API solicitante debe tener el rol de Visor de facturación de la organización, Administrador de facturación de la organización o Propietario de la organización. Si tiene una configuración multiorganización, puede ver las facturas vinculadas si tiene el rol de Administrador de facturación de la organización o Propietario de la organización. Para calcular el importe total adeudado de las facturas, sume el total adeudado de cada factura. Se puede calcular como la suma del importe adeudado de cada pago incluido en la factura. Para calcular el importe adeudado del pago, utilice la fórmula totalBilledCents * unitPrice + salesTax - startingBalanceCents.
Parámetros de ruta
-
Cadena 24hexadecimal única que identifica la organización que contiene sus proyectos. Utilice el
/orgspunto de conexión para recuperar todas las organizaciones a las que el usuario autenticado tiene acceso.El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$.
Parámetros de consulta
-
Indicador que indica si la aplicación encapsula la respuesta en un objeto JSON
envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como encapsulado. La aplicación añade el parámetro de estado al cuerpo de la respuesta.El valor predeterminado es
false. -
Bandera que indica si la respuesta devuelve el número total de elementos (
totalCount) en la respuesta.El valor predeterminado es
true. -
Número de elementos que la respuesta devuelve por página.
El valor mínimo es
1, el valor máximo es500. El valor predeterminado es100. -
Número de la página que muestra el conjunto actual del total de objetos que devuelve la respuesta.
El valor mínimo es
1. El valor por defecto es1. -
Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint.
El valor predeterminado es
false.Impresión bonita -
Bandera que indica si se deben devolver facturas vinculadas en el campo
linkedInvoices.El valor predeterminado es
true. -
Estados de la factura que se recuperarán. Omitir la devolución de facturas de todos los estados.
Los valores son
PENDING,CLOSED,FORGIVEN,FAILED,PAID,FREE,PREPAIDoINVOICED. -
Recupera las facturas cuyos
startDatessean mayores o iguales afromDate. Si se omite, la devolución de facturas se remontará a la más antigua,startDate. -
Recupera las facturas cuyos
endDatessean menores o iguales atoDate. Si se omite, la devolución de facturas irá hasta la últimaendDate. -
Campo utilizado para ordenar las facturas devueltas. Úselo junto con el parámetro
orderBypara controlar el orden del resultado.Los valores son
START_DATEoEND_DATE. El valor predeterminado esEND_DATE. -
Campo utilizado para ordenar las facturas devueltas. Úselo junto con el parámetro
sortBypara controlar el orden del resultado.Los valores son
descoasc. El valor predeterminado esdesc.
atlas api invoices listInvoices --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20230101001/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-01-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-01-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": "2026-05-04T09:42:00Z",
"creditsCents": 42,
"endDate": "2026-05-04T09:42:00Z",
"id": "32b6e34b3d91647abb20e7b8",
"linkedInvoices": [
{}
],
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"salesTaxCents": 42,
"startDate": "2026-05-04T09:42:00Z",
"startingBalanceCents": 42,
"statusName": "PENDING",
"subtotalCents": 42,
"updated": "2026-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"
}