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 del estado de la factura. Para utilizar este recurso, la cuenta de servicio o la 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 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 monto total adeudado de las facturas, sumar el total adeudado de cada factura. Se podría calcular como la suma del importe 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/operación/operación-listorginvoices.

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

Sintaxis

Sintaxis del comando

atlas api invoices listInvoices [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.
--fromDate	string	false	Recupera las facturas cuyas fechas de inicio son mayores o iguales a la fromDate. Si se omite, la devolución de las facturas se retrotraerá a la fecha de inicio más temprana.
-h, --help		false	ayuda para listInvoices
--includeCount		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 retorna por página.
--ordenarPor	string	false	Campo utilizado para ordenar las facturas devueltas. Utiliza junto al parámetro sortBy para controlar el orden de los resultados.
--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".
--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)
--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 el formato prettyprint.
--ordenarPor	string	false	Campo que se utiliza para ordenar las facturas devueltas. Úsalo en combinación con el parámetro orderBy para controlar el orden del resultado.
--statusNames	stringArray	false	Estados de la factura a recuperar. Omitir para devolver facturas de todos los estados.
--toDate	string	false	Recupera las facturas cuyos endDates son menores o iguales que el toDate. Si se omite, el retorno de las facturas irá más allá de la última fecha de finalización.
--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".
--viewLinkedInvoices		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 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 listInvoices --version 2023-01-01 --fromDate 2023-01-01 --orderBy desc --orgId 4888442a3354817a7320eb61 --toDate 2023-01-01

Volver

listInvoicePending

buscarLíneasDeFactura