experimental: Retorna uma fatura que o MongoDB emitiu para a organização especificada.
Uma string exclusiva de 24dí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 Cobrança 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 de Administrador de Cobrança 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 - beginBalanceCents. Este comando está invocando o endpoint com OperationID: 'getInvoice'. 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/Obter Fatura
Sintaxe
atlas api invoices getInvoice [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 | |
-h, --help | false | ajuda para getInvoice | |
--invoiceId | string | true | string exclusiva de dígitos hexadecimais 24que identifica a fatura enviada à organização especificada |
--orgId | string | true | string exclusiva de dígitos hexadecimais 24que identifica a organização que contém seus projetos |
--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 formato de impressão bonita | |
--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. |