atlas API de faturas getInvoice

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 em: retorna uma fatura que o MongoDB emitiu para a organização especificada .

Uma string única de 24 dígitos hexadecimais que identifica a fatura. Você pode optar por receber esta fatura em formato JSON ou CSV. Para usar esse recurso, a chave de API solicitante deve ter a função Visualizador de faturamento da organização, Administrador de faturamento da organização ou Proprietário da organização. Se você tiver uma configuração de organização cruzada, você pode consultar uma fatura vinculada se tiver a função Administrador de faturamento da organização ou Proprietário da organização. Para calcular o valor total devido da fatura, some o valor total 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 endpoint da API do Atlas https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getInvoice.

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

Sintaxe

Sintaxe do comando

atlas api invoices getInvoice [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.
-h, --help		false	ajuda para getInvoice
--invoiceId	string	true	String única de 24 dígitos hexadecimais que identifica a fatura enviada à organização especificada. Normalmente, as cobranças são publicadas no dia seguinte.
--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.
--output	string	true	formato de API preferido, pode ser ["CSV", "JSON", go-template]
--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)
--pretty		false	Sinalizador que indica se o corpo da resposta deve estar no <a URL =https://en.wikipede.org/wiki/Prettyprint" formato target="_blank" rel="noopener noreferrer">pretty-print</a>.
--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".

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

Execute o comando abaixo.

atlas api invoices getInvoice --version 2023-01-01 --envelope false --invoiceId [invoiceId] --orgId 4888442a3354817a7320eb61 --pretty false