Devuelve una factura que MongoDB emitió a la organización especificada.
El subcomando atlas api se genera automáticamente desde la API de administración de MongoDB Atlas y ofrece cobertura completa de dicha API. Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puede consultar a través del enlace de documentación del punto final de la API.
Una unique 24-hexadecimal digit string identifica la factura. Puedes elegir recibir esta factura en formato JSON o CSV. 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 query una factura enlazada si tienes el rol de Administrador de facturación de organización o Propietario de organización. Para calcular el monto total adeudado de la factura, suma el monto total adeudado de cada pago incluido en la factura. Para calcular el importe adeudado del pago, utiliza la fórmula totalBilledCents * unitPrice + salesTax - startingBalanceCents.
Este comando se genera automáticamente y corresponde 1:1 con el endpoint de la API de Atlas https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operation/operation-getorginvoice.
Para obtener más información y ejemplos, consulta la documentación de la API referenciada que se encuentra en el enlace anterior.
Sintaxis
atlas api invoices getInvoice [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--envelope | envelope | false | Indicador que indica si la aplicación envuelve la respuesta en un objeto JSON tipo sobre. 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 sobre. La aplicación añade el parámetro de estado al cuerpo de la respuesta. |
-h, --help | false | Ayuda para getInvoice | |
--invoiceId | string | true | 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. |
--orgId | string | true | Cadena única de dígitos hexadecimales 24que identifica la organización que contiene sus proyectos. Utilice el punto de conexión [/orgs](#tag/Organizations/operation/listOrganizations) para recuperar todas las organizaciones a las que el usuario autenticado tiene acceso. |
-o, --output | string | true | formato preferido de la API, puede ser ["csv", "json", go-template] |
--outputFile | string | false | archivo para guardar la salida de la api. Este flag es necesario cuando la salida de un endpoint es binaria (ej.: gzip) y el comando no se redirige (ej.: comando atlas > out.zip) |
--bonito | false | Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint. | |
--versión | string | false | versión de la API que se utilizará al llamar a la llamada de API [opciones: "2023-01-01"], por defecto se usa la versión más reciente o el valor de configuración api_version de perfiles si se establece Este valor por defecto es "2023-01-01". |
Opciones heredadas
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil que se utilizará en tu archivo de configuración. Para aprender sobre los perfiles para el Atlas CLI, consulta https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Ejemplos
atlas api invoices getInvoice --version 2023-01-01 --invoiceId [invoiceId] --orgId 4888442a3354817a7320eb61