Devolver todas las facturas de una organización

OBTENER /api/atlas/v1.0/orgs/{orgId}/invoices

Devuelve todas las facturas que MongoDB emitió a la organización especificada. Esta lista incluye todas las facturas sin importar el estado de la factura. Para utilizar este recurso, la cuenta de servicio o clave API solicitante debe tener los roles de Visualizador de facturación de la organización, Administrador de facturación de la organización o Propietario de la organización. Si tienes una configuración entre organizaciones, puedes ver las facturas vinculadas si tienes el rol de Administrador de Facturación de la Organización o Propietario de la Organización. Para calcular el total adeudado de las facturas, suma el total adeudado de cada factura. Se podría calcular como una suma del importe adeudado de cada pago incluido en la factura. Para calcular el monto adeudado del pago: use la fórmula totalBilledCents * unitPrice + salesTax - startingBalanceCents.

Parámetros de path

  • orgId string Requerido

    string única de 24dígitos hexadecimales que identifica la organización que contiene su proyectos. Utilice el /orgs endpoint 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 query

  • envelope booleano

    Bandera que indica si la aplicación envuelve 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 remediar esto, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como un sobre. La aplicación agrega el parámetro de estado al cuerpo de la respuesta.

    El valor por defecto es false.

  • includeCount booleano

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

    El valor por defecto es true.

  • elementosPorPágina entero

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

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

  • Num. de pág. 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.

  • bonito booleano

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

    El valor por defecto es false.

    Impresión bonita
  • ver facturas vinculadas booleano

    Indicador que señala si se deben devolver facturas vinculadas en el campo linkedInvoices.

    El valor por defecto es true.

  • nombres de estado array[string]

    Estados de la factura a recuperar. Omitir para devolver facturas de todos los estados.

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

  • fromDate string(date)

    Recupere las facturas cuyo startDates sea mayor o igual a fromDate. Si se omite, las facturas devueltas se retrotraerán a la startDate más antigua.

  • toDate string(date)

    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 que se utiliza para ordenar las facturas devueltas. Usar en combinación con el parámetro orderBy para controlar el orden del resultado.

    Los valores son START_DATE o END_DATE. El valor por defecto es END_DATE.

  • ordenarPor string

    Campo utilizado para organizar las facturas devueltas. Utiliza en combinación el parámetro sortBy para controlar el orden del resultado.

    Los valores son desc o asc. El valor por defecto es desc.

Respuestas

  • 200 aplicación/json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Resultados arreglo[objeto] Requerido

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

      Ocultar atributos de resultados Mostrar atributos de resultados Objeto
      • amountBilledCents 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ó hacia esta factura. Este parámetro expresa su valor en centavos (100avos de un dólar estadounidense).

      • creado string(date-time)

        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éditosCéntimos integer(int64)

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

      • endDate string(date-time)

        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 24 dígitos hexadecimales que 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 arreglo[objeto]

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

      • orgId string

        string única de dígitos hexadecimales 24que identifica a la organización a la que se le cobran los servicios consumidos de MongoDB nube.

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

      • salesTaxCents integer(int64)

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

      • fecha de inicio string(date-time)

        Fecha y hora en que MongoDB Cloud comenzó 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)

        Suma que la organización especificada debía 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 ha cobrado al cliente.
        • FAILEDMongoDB intentó cargar la tarjeta de crédito proporcionada, pero el cargo por esa cantidad falló.
        • FORGIVENPago iniciado por el cliente que MongoDB perdonó posteriormente.
        • FREE:Todos los cargos totalizan cero por lo que no se le cobrará al cliente.
        • INVOICEDMongoDB gestionó estos cargos utilizando 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 prepagado, por lo que no se le cobrará.

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

      • subtotalCents integer(int64)

        Suma de todos los conceptos de factura positivos incluidos en esta factura. Este parámetro expresa su valor en centavos (100a parte de un dólar estadounidense).

      • actualizado string(date-time)

        Fecha y hora en la que MongoDB Cloud actualizó por última vez el 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 está configurado 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 incorrecta.

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

        Describe todas las infracciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de la 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 arreglo[objeto]

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

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 403 aplicación/json

    Forbidden.

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

      Detalle de solicitud incorrecta.

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

        Describe todas las infracciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de la 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 arreglo[objeto]

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

    • motivo string

      El mensaje de error de la aplicación se devuelve 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 incorrecta.

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

        Describe todas las infracciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de la 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 arreglo[objeto]

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

    • motivo string

      El mensaje de error de la aplicación se devuelve 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 incorrecta.

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

        Describe todas las infracciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de la 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 arreglo[objeto]

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

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

GET /api/atlas/v1.0/orgs/{orgId}/invoices
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/orgs/4888442a3354817a7320eb61/invoices' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
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"
}