atlas API invoices listInvoices

O suporte do Atlas CLI para executar comandos com a API de administração do Atlas está em 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.

Visualização pública: forneça feedback: retorna todas as faturas que o MongoDB emitiu para a organização especificada.

Visualização pública: o subcomando da API atlas, gerado automaticamente a partir da API de administração do MongoDB Atlas, oferece cobertura completa da API de administração e está atualmente em visualização pública (forneça comentários em https://feedback.mongodb.com/forums/930808-atlas-cli). Os recursos da API de administração têm seu próprio ciclo de vida de versão, que você pode verificar por meio do link de documentação do endpoint da API fornecido.

Esta lista inclui todas as faturas, independentemente do status da fatura. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de visualizador de faturamento da organização, administrador de faturamento da organização ou proprietário da organização. Se houver uma configuração de organização cruzada, é possível visualizar as faturas vinculadas se você 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 em cada uma das faturas. 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 - StartingBalanceCents.

Este comando é gerado automaticamente e corresponde 1:1 ao ponto de extremidade da API do Atlas https://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/operation/operation-listinvoices.

Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.

Sintaxe

Sintaxe do comando

atlas api invoices listInvoices [options]

Opções

Nome	Tipo	Obrigatório	Descrição
--envelope	envelope	false	Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON de envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.
--fromDate	string	false	Recupere as faturas cujas startDates sejam maiores ou iguais a fromDate. Se omitido, as faturas geradas retornarão para a startDate mais antiga
-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 ordenar as faturas retornadas. Use em combinação com o parâmetro sortBy para controlar a ordem do resultado.
--orgId	string	true	String exclusiva de 24dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint [/orgs](#tag/Organizations/operation/listOrganizations) para recuperar todas as organizações às quais o usuário autenticado tem acesso.
-o, --output	string	false	formato de API preferido, pode ser ["JSON", go-template] Este valor padrão é "JSON".
--outputFile	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 dos objetos totais que a resposta retorna.
--pretty		false	Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
--sortBy	string	false	Campo usado para classificar as faturas retornadas. Use em combinação com o parâmetro orderBy para controlar a ordem do resultado.
--statusNames	array de strings	false	Status da fatura a ser recuperada. Omitir para retornar faturas de todos os status.
--toDate	string	false	Recupere as faturas das quais endpoints são menores ou iguais a toDate. Se omitido, as faturas devolvidas irão além do mais recente endDate.
--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 retornadas no campo linkedInvoices.

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.

Exemplos

atlas api invoices listInvoices --version 2023-01-01 --fromDate 2023-01-01 --orderBy desc --orgId 4888442a3354817a7320eb61 --toDate 2023-01-01