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 cadena única de dígitos hexadecimales 24identifica la factura. Puede optar por recibir esta factura en formato JSON o CSV. 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 consultar una factura vinculada 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 la factura, sume el importe total adeudado de cada pago incluido en la factura. Para calcular el importe adeudado del pago, utilice la fórmula totalBilledCents * unitPrice + salesTax - StartingBalanceCents.
Este comando se genera automáticamente y corresponde 1:1 con el punto final 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, consulte la documentación de la API referenciada en el enlace anterior.
Sintaxis
atlas api invoices getInvoice [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--sobre | envolvente | 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, --ayuda | false | Ayuda para getInvoice | |
--facturaId | string | true | Cadena única de dígitos hexadecimales 24que 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 de API preferido: ["csv", "json", go-template] |
--archivo de salida | 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 formato prettyprint. | |
--versión | string | false | Versión de API a utilizar al llamar a la llamada de API [opciones: "2023-01-01"], el valor predeterminado es la última versión o el valor de configuración api_version de los perfiles si está configurado. Este valor predeterminado es "2023-01-01". |
Opciones heredadas
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil que se usará en el archivo de configuración. Para obtener más información sobre los perfiles de la CLI de Atlas, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Ejemplos
atlas api invoices getInvoice --version 2023-01-01 --invoiceId [invoiceId] --orgId 4888442a3354817a7320eb61