Devolver todas las facturas de una organización

Obtener /api/atlas/v2/orgs/{orgId}/facturas

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

  • orgId string Requerido

    Cadena 24hexadecimal única que identifica la organización que contiene sus proyectos. Utilice el /orgs punto 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

  • envolvente booleano

    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.

  • incluirConteo booleano

    Bandera que indica si la respuesta devuelve el número total de elementos (totalCount) en la respuesta.

    El valor predeterminado es true.

  • artículos por página entero

    Número de elementos que la respuesta devuelve por página.

    El valor mínimo es 1, el valor máximo es 500. El valor predeterminado es 100.

  • número de página entero

    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 es 1.

  • bonita booleano

    Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint.

    El valor predeterminado es false.

    Impresión bonita
  • ver facturas vinculadas booleano

    Bandera que indica si se deben devolver facturas vinculadas en el campo linkedInvoices.

    El valor predeterminado es true.

  • nombres de estado array[string]

    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, PREPAID o INVOICED.

  • desdeFecha cadena(fecha)

    Recupera las facturas cuyos startDates sean mayores o iguales a fromDate. Si se omite, la devolución de facturas se remontará a la más antigua, startDate.

  • toDate cadena(fecha)

    Recupera las facturas cuyos endDates sean menores o iguales a toDate. Si se omite, la devolución de facturas irá hasta la última endDate.

  • sortBy string

    Campo utilizado para ordenar las facturas devueltas. Úselo junto con el parámetro orderBy para controlar el orden del resultado.

    Los valores son START_DATE o END_DATE. El valor predeterminado es END_DATE.

  • orderBy string

    Campo utilizado para ordenar las facturas devueltas. Úselo junto con el parámetro sortBy para controlar el orden del resultado.

    Los valores son desc o asc. El valor predeterminado es desc.

Respuestas

  • 200 application/vnd.atlas.2023-01-01+json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • resultados matriz[objeto]

      Lista de documentos devueltos que MongoDB nube proporciona al completar esta solicitud.

      Ocultar atributos de resultados Mostrar atributos de resultados Objeto
      • cantidadfacturadacentavos integer(int64)

        Suma de los servicios que la organización especificada consumió durante el período cubierto por esta factura. Este parámetro expresa su valor en centavos (100avos de dólar estadounidense).

      • amountPaidCents integer(int64)

        Suma que la organización especificada pagó por esta factura. Este parámetro expresa su valor en centavos (100avos de dólar estadounidense).

      • creado cadena(fecha-hora)

        Fecha y hora en que MongoDB Cloud creó esta factura. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

      • créditosCentavos integer(int64)

        Suma que MongoDB abonó a la organización especificada en esta factura. Este parámetro expresa su valor en centavos (100avos de dólar estadounidense).

      • fecha de finalización cadena(fecha-hora)

        Fecha y hora en que MongoDB Cloud finalizó el período de facturación que cubre esta factura. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

      • ID. string

        Cadena única de dígitos hexadecimales 24que identifica la factura enviada a la organización especificada. Los cargos suelen contabilizarse al día siguiente.

        El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

      • Facturas vinculadas matriz[objeto]

        Listado que contiene las facturas de organizaciones vinculadas a la organización pagadora.

      • orgId string

        Cadena de dígitos hexadecimales 24única que identifica la organización a la que se le cobra por los servicios consumidos de MongoDB Cloud.

        El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

      • centavos de impuesto sobre las ventas integer(int64)

        Suma del impuesto sobre las ventas aplicado a esta factura. Este parámetro expresa su valor en centavos (100avos de dólar estadounidense).

      • fecha de inicio cadena(fecha-hora)

        Fecha y hora en que MongoDB Cloud inició el período de facturación que cubre esta factura. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

      • saldo inicialCents integer(int64)

        Importe que la organización especificada adeudaba a MongoDB cuando MongoDB emitió esta factura. Este parámetro expresa su valor en dólares estadounidenses.

      • nombreDeEstado string

        Fase del procesamiento de pagos en la que se encuentra esta factura cuando realizaste esta solicitud. Las fases aceptadas incluyen:

        • CLOSED:MongoDB finalizó todos los cargos en el ciclo de facturación, pero aún no le ha cobrado al cliente.
        • FAILED:MongoDB intentó cargar la tarjeta de crédito proporcionada, pero el cargo por ese monto falló.
        • FORGIVEN:El cliente inició el pago que MongoDB luego perdonó.
        • FREE:Todos los cargos totalizan cero por lo que no se le cobrará al cliente.
        • INVOICED:MongoDB gestionó estos cargos mediante facturación elástica.
        • PAID:MongoDB logró cargar la tarjeta de crédito proporcionada.
        • PENDING:La factura incluye los cargos del ciclo de facturación actual.
        • PREPAID:El cliente tiene un plan prepago por lo que no se le cobrará nada.

        Los valores son PENDING, CLOSED, FORGIVEN, FAILED, PAID, FREE, PREPAID o INVOICED.

      • subtotalCents integer(int64)

        Suma de todas las partidas de factura positivas contenidas en esta factura. Este parámetro expresa su valor en centavos (100avos de dólar estadounidense).

      • actualizado cadena(fecha-hora)

        Fecha y hora de la última actualización de MongoDB Cloud del valor de este pago. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

    • recuento total integer(int32)

      Número total de documentos disponibles. MongoDB Cloud omite este valor si includeCount se establece en false. El número total es una estimación y puede no ser exacto.

      El valor mínimo es 0.

  • 401 aplicación/json

    No autorizado.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 403 aplicación/json

    Forbidden.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 404 aplicación/json

    No se encontró.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 500 aplicación/json

    Error Interno del Servidor.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

OBTENER /api/atlas/v2/orgs/{orgId}/facturas
atlas api invoices listInvoices --help
import (
	"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"
Ejemplos de respuestas (200)
{
  "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
}
Ejemplos de respuestas (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"
}
Ejemplos de respuestas (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"
}
Ejemplos de respuestas (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"
}
Ejemplos de respuestas (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"
}