listaInvoices de facturas de la API Atlas

Devuelve todas las facturas 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.

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 multiorganizacional, 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 - beginningBalanceCents.

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-listorginvoices.

Para obtener más información y ejemplos, consulte la documentación de la API referenciada en el enlace anterior.

Sintaxis

Sintaxis del comando

atlas api invoices listInvoices [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.
--desdeFecha	string	false	Recupera las facturas cuyas fechas de inicio sean mayores o iguales a la fecha inicial. Si se omite, las facturas retornarán a la fecha de inicio más temprana.
-h, --ayuda		false	Ayuda para listInvoices
--incluirConteo		false	Bandera que indica si la respuesta devuelve el número total de elementos (totalCount) en larespuesta.
--itemsPerPage	Int	false	Número de elementos que la respuesta devuelve por página.
--ordenarPor	string	false	Campo utilizado para ordenar las facturas devueltas. Úselo junto con el parámetro sortBy para controlar el orden del resultado.
--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	false	formato de API preferido, puede ser ["json", go-template] Este valor predeterminado es "json".
--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)
--Número de página	Int	false	Número de la página que muestra el conjunto actual del total de objetos que devuelve la respuesta.
--bonito		false	Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint.
--Ordenar por	string	false	Campo utilizado para ordenar las facturas devueltas. Úselo junto con el parámetro orderBy para controlar el orden del resultado.
--nombresdeestado	matriz de cadenas	false	Estados de la factura que se recuperarán. Omitir la devolución de facturas de todos los estados.
--toDate	string	false	Recupera las facturas cuyas fechas de finalización sean menores o iguales a la fecha de finalización. Si se omite, las facturas retornadas irán hasta la fecha de finalización más reciente.
--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".
--verFacturasEnlazadas		false	Bandera que indica si se deben devolver facturas vinculadas en el campo linkedInvoices.

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 listInvoices --version 2023-01-01 --fromDate 2023-01-01 --orderBy desc --orgId 4888442a3354817a7320eb61 --toDate 2023-01-01

Volver

listaFacturaPendiente

lista de artículos