atlas API invoices listInvoices

O suporte do Atlas CLI para executar comandos com o está em pré-visualização. O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para saber mais, consulte Recursos de visualização.

experimental: Retorna todas as faturas que a MongoDB emitiu para a organização especificada.

Esta lista inclui todas as faturas, independentemente do status da fatura. Para usar esse recurso, a chave de API solicitante deve ter a função Visualizador de Faturamento da Organização, Administrador de Cobrança da Organização ou Proprietário da Organização. Se você tiver uma configuração de organização cruzada, você pode visualizar as faturas vinculadas se tiver a função de Administrador de Cobrança da Organização ou Proprietário da Organização. Para calcular o valor total devido das faturas - some o total devido de cada fatura. Pode ser calculado como uma soma do valor devido de cada pagamento incluído na fatura. Para calcular o valor devido do pagamento - use a fórmula totalBilledCents * unitPrice + salesTax - beginBalanceCents. Este comando está invocando o endpoint com OperationID: 'listInvoices'. Para obter mais informações sobre sinalizadores, formato de --file e exemplos, consulte: https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/ Listar faturas

Sintaxe

Sintaxe do comando

atlas api invoices listInvoices [options]

Opções

Nome	Tipo	Obrigatório	Descrição
--envelope		false	sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON de envelope
--fromDate	string	false	recuperar as faturas cujas startDates são maiores ou iguais a fromDate
-h, --help		false	ajuda para listInvoices
--includeCount		false	sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta
--itemsPerPage	int	false	número de itens que a resposta retorna por página
--orderBy	string	false	campo usado para solicitar as faturas devolvidas por
--orgId	string	true	string exclusiva de dígitos hexadecimais 24que identifica a organização que contém seus projetos
--output	string	false	formato de API preferido, pode ser ["JSON", go-template] Este valor padrão é "JSON".
--output-file	string	false	no qual gravar a saída da API. Esse sinalizador é necessário quando a saída de um endpoint é binária (por exemplo: gzip) e o comando não é piped (por exemplo: comando atlas > out.zip)
--pageNum	int	false	número da página que exibe o conjunto atual do total de objetos que a resposta retorna
--pretty		false	sinalizador que indica se o corpo da resposta deve estar no formato de impressão bonita
--sortBy	string	false	campo usado para classificar as faturas devolvidas por
--statusNames	array de strings	false	status da fatura a ser recuperada
--toDate	string	false	recuperar as faturas cujas endDates são menores ou iguais a toDate
--version	string	false	Versão da API a ser usada ao chamar a chamada da API [opções: "2023-01-01"], o padrão é a versão mais recente ou o valor de configuração dos perfis api_version, se definido Este valor é padronizado como "2023-01a01".
--viewLinkedInvoices		false	sinalizador que indica se as faturas vinculadas devem ser devolvidas no campo embeddedInvoices

Opções herdadas

Nome	Tipo	Obrigatório	Descrição
-P, --profile	string	false	Nome do perfil a ser usado no arquivo de configuração. Para saber mais sobre perfis para o Atlas CLI, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

Voltar

Obter Fatura

listar faturas pendentes