Acesse o relatório de custos e uso do FOCUS

A Especificação de Uso e Custo Aberto do Find Ops (FOCUS) estabelece requisitos uniformes para conjuntos de dados de faturamento de tecnologia. O MongoDB Atlas fornece dados de uso e custo de faturamento no formatoFOCUS..1 3 Você pode gerar um relatórioFOCUS a partir da Invoices página no console do Atlas ou com a Data API.

Sobre o FOCUS

Historicamente, os dados de faturamento do Atlas foram fornecidos em formatos específicos do MongoDB. Os clientes do Atlas, particularmente grandes empresas e parceiros, precisam fazer um esforço manual para converter as Unidades de Crédito do Atlas (ACUs) em moeda de faturamento.

O FOCUS fornece um vocabulário comum e uma estrutura de faturamento, o que ajuda você a entender, reconciliar e integrar seus dados de faturamento do Atlas com FinOps e ferramentas de gerenciamento de custos entre fornecedores.

Os resumos de uso em PDF e CSV apresentam sua fatura em formatos específicos do MongoDB. O relatório de custo e uso do FOCUS apresenta o mesmo período de faturamento no formato FOCUS padronizado. Você pode baixar todos os três na página Invoices no console do Atlas.

Baixar um relatórioFOCUS a partir do Console do Atlas

Você pode baixar o relatório de uso e custo doFOCUS para uma fatura na página Invoices no console do Atlas . Selecione CSV FOCUS Cost & Usage Report ao escolher o formato da fatura.

Para baixar o relatório para o período de faturamento atual, consulte Baixar sua fatura atual. Para baixar o relatório de um período de faturamento anterior, consulte Baixar faturas anteriores.

Observação

Para visualizar e baixar dados de faturamento, você deve ter a função,Organization Billing Admin Organization Owner Organization Billing Viewer ou.

Funcionalidades do FOCUS Data API

A API de dados FOCUS fornece acesso programático aos seus dados de custo e uso no formato FOCUS.

Com a FOCUS Data API, você pode:

Visualizar custos na moeda de faturamento: Acesse BilledCost e EffectiveCost diretamente na moeda de faturamento, sem conversão manual.
Identifique os tipos de crédito: veja se um crédito é pré-pago, promocional ou elástico por meio do campo Contract Applied.
Analise os custos com contexto completo: use campos como Region, UsageDate e ServiceCategory para análise granular de custos.
Trabalhe com termos padrões do setor: use SubAccountName e outros termos FOCUS intuitivos em vez de termos de API internos, como groupName.

Referência de coluna FOCUS

A tabela a seguir lista as colunas retornadas na resposta da Data API do FOCUS e seus campos de faturamento legados equivalentes:

FOCO 1.3 ID da coluna	Definição	Campo equivalente CSV atual	Campo equivalente de JSON atual
`BilledCost`	O custo, na moeda de faturamento, cobrado durante o período de faturamento atual.	N/A	N/A
`BillingAccountId`	O ID da organização do Atlas para esta fatura.	ID da organização	N/A
`BillingAccountName`	O nome da organização Atlas para esta fatura.	Nome da organização	N/A
`BillingCurrency`	A moeda de faturamento para esta cobrança.	N/A	N/A
`BillingPeriodEnd`	A data final do período de faturamento. O período de faturamento é exclusivo da data final.	N/A	"endDate" (fatura)
`BillingPeriodStart`	A data de início do período de faturamento. O período de faturamento inclui a data de início.	N/A	"criado" (fatura)
`ChargeCategory`	Classificação de uma cobrança com base na natureza de como ela é cobrada. Por exemplo, "uso" denota uma cobrança com base na quantidade do serviço ou recurso consumido.	N/A	N/A
`ChargeDescription`	Contexto de alto nível sobre a cobrança.	Descrição	N/A
`ChargePeriodEnd`	O final do período em que a cobrança foi incorrida. O período de faturamento é exclusivo da data final.	N/A	"endDate" (lineItems)
`ChargePeriodStart`	O início do período em que a cobrança foi incorrida. O período de faturamento inclui a data de início.	Uso de data	"startDate" (lineItems)
`ConsumedQuantity`	O volume de um determinado SKU associado a um recurso ou serviço usado, com base na unidade consumida.	Quantidade	"quantidade"
`ConsumedUnit`	A unidade usada para medir um determinado SKU.	unidade	"unit"
`ContractApplied`	Um conjunto de propriedades que associam uma cobrança a um ou mais compromissos contratuais. Identifica o nome do crédito Atlas usado para cobrir o uso consumido.	N/A	N/A
`ContractedCost`	Representa o custo calculado multiplicando o preço unitário contratado e a quantidade de preços correspondente. Este campo é denominado em moeda de faturamento.	N/A	N/A
`ContractedUnitPrice`	O preço unitário acordado para uma única unidade de preço do SKU associado, incluindo descontos. Este preço é denominado em moeda de faturamento.	N/A	N/A
`EffectiveCost`	Representa o custo amortizado de uma cobrança após aplicar todas as taxas e descontos reduzidos. Este campo é denominado em moeda de faturamento.	N/A	N/A
`HostProviderName`	O nome da entidade que fornece a infraestrutura subjacente onde o provedor de serviços implanta seus recursos e serviços. Por exemplo, Amazon Web Services, Azure, GCP.	N/A	N/A
`InvoiceIssuer`	A entidade responsável pela fatura dos recursos ou serviços consumidos. Por exemplo, MongoDB para clientes que transacionam diretamente com o MongoDB, ou marketplace para clientes que transacionam com o Atlas por meio de um marketplace.	N/A	N/A
`ListCost`	Representa o custo calculado multiplicando o preço unitário da lista e a quantidade de preços correspondente. Este campo é denominado em moeda de faturamento.	N/A	N/A
`ListUnitPrice`	O preço unitário sugerido publicado pelo provedor para uma única unidade de preço do SKU associado, excluindo quaisquer descontos. Este preço é denominado em moeda de faturamento.	N/A	N/A
`PricingCurrency`	A moeda de medição para esta cobrança, por exemplo, Atlas Credits.	N/A	N/A
`PricingCurrencyContractedUnitPrice`	O preço unitário acordado para uma única unidade de preço do SKU associado, incluindo descontos. Este preço é denominado na moeda de preços.	N/A	N/A
`PricingCurrencyEffectiveCost`	Representa o custo amortizado de uma cobrança após aplicar todas as taxas e descontos reduzidos. Este campo é denominado em moeda de preços.	Quantia	"totalPriceCents"
`PricingCurrencyListUnitPrice`	Representa o custo calculado multiplicando o preço unitário da lista e a quantidade de preços correspondente. Este campo é denominado em moeda de preços.	Preço unitário	"unitPriceDollars"
`PricingQuantity`	Representa o volume de um determinado SKU associado a um recurso ou serviço usado ou comprado, com base na unidade de preço.	N/A	N/A
`PricingUnit`	Representa uma unidade para determinar preços unitários, por exemplo, GB-Horas.	N/A	N/A
`RegionId`	Um identificador para uma área geográfica isolada onde um recurso é provisionado ou um serviço é fornecido. Por exemplo, `us-east-1`.	N/A	N/A
`RegionName`	Um nome para uma área geográfica isolada onde um recurso é provisionado ou um serviço é fornecido. Por exemplo, `N. Virginia`.	Região	N/A
`ResourceName`	Para o Atlas, este é o nome do cluster.	cluster	"clusterName"
`ServiceCategory`	Classificação de nível mais alto conforme definido pelo FOCUS. Isso é "Bancos de dados" para MongoDB Atlas.	N/A	N/A
`ServiceName`	Representa uma oferta que pode ser comprada de um provedor de serviços, por exemplo, MongoDB Atlas.	N/A	N/A
`ServiceProviderName`	Nome da entidade que fornece os recursos ou serviços disponíveis para uso ou compra. Por exemplo, MongoDB.	N/A	N/A
`SkuId`	Um identificador exclusivo para uma Unidade de Manutenção de Estoque (SKU), representando uma configuração faturável distinta.	N/A	N/A
`SkuMeter`	A unidade de medida para o SKU associado, indicando o que está sendo medido, por exemplo, `GB`, tempo de computação ou solicitações.	N/A	N/A
`SkuPriceDetails`	As dimensões de preço do ponto de preço em que a cobrança foi faturada, como pares chave-valor em JSON. Esta coluna está vazia quando a cobrança não tem um ponto de preço ou o ponto de preço não especifica dimensões.	N/A	N/A
`SkuPriceId`	Um identificador exclusivo para o ponto de preço em que a cobrança foi faturada.	N/A	N/A
`SubAccountId`	Um identificador atribuído a uma subconta, que é um agrupamento baseado em construções organizacionais. Isso equivale a um projeto no MongoDB Atlas.	ID do Projeto	"groupId"
`SubAccountName`	O nome de exibição da subconta. Isso equivale a um projeto no MongoDB Atlas.	Projeto	"groupName"
`Tags`	Tags atribuídas aos recursos associados.	Tags/aplicativo	"tags"
`x_AtlasSku`	O Atlas SKU que está sendo cobrado.	SKU	"sku"
`x_BilledDateEnd`	O fim do período em que o MongoDB cobrou a taxa.	Data	"criado" (lineItems)
`x_BilledDateStart`	O início do período em que o MongoDB cobrou a taxa.	N/A	N/A
`x_PricingCurrencyRate`	O "preço" de um crédito do Atlas. Aplique essa taxa para encontrar o custo de um crédito do Atlas na moeda de faturamento.	N/A	N/A
`x_SkuCategory`	Classificação de nível mais alto para o Atlas SKU associado. Por exemplo, `Clusters` ou `Backup`.	N/A	N/A

Endpoints

A FOCUS Data API estende a Atlas Administration API com três pontos de extremidade:

Listar faturas de uma organização lista as faturas disponíveis de uma organização.
Solicitar um relatórioFOCUS solicita a geração de um relatório de cobrança formatado emFOCUS.
Recuperar um relatórioFOCUS retorna o status desse relatório e, quando o relatório estiver pronto, o URL para baixá-lo.

Observação

Todos os pontos de extremidade exigem a função Organization Billing Admin, Organization Owner ou Organization Billing Viewer.

Listar faturas de uma organização

Recupera uma lista de IDs de fatura disponíveis. Para faturamento entre organizações, este ponto de extremidade identifica faturas para todas as organizações vinculadas.

URL base: /api/atlas/v2/orgs/{orgId}/associatedInvoices

GET /api/atlas/v2/orgs/{orgId}/associatedInvoices

Parâmetros do caminho da solicitação

Nome	Tipo	necessidade	Descrição
`orgId`	string	Obrigatório	String única de 24 dígitos hexadecimais que identifica a organização.

Solicitar parâmetros de query

Os seguintes parâmetros de query são opcionais:

Nome	Tipo	necessidade	Descrição	Default
`month`	inteiro	Opcional	O mês das faturas a serem recuperadas (1-12).	Mês atual
`year`	inteiro	Opcional	O ano das faturas a serem recuperar. Deve ser >= 2000.	Ano atual
`includeLinkedOrgs`	booleano	Opcional	Sinalizador que indica se as faturas de organizações vinculadas devem ser incluídas.	`false`

Exemplo de solicitação

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --request GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/associatedInvoices"

Resposta

{
  "associatedInvoices": [
    {
      "invoiceId": "string",
      "orgId": "string"
    }
  ],
  "month": "06",
  "year": "2026"
}

Elementos de resposta

Nome	Tipo	Descrição
`associatedInvoices`	array	Lista de faturas associadas à organização para o período especificado.
`associatedInvoices[n].invoiceId`	string	Identificador de dígitos hexadecimais 24exclusivo para uma fatura.
`associatedInvoices[n].orgId`	string	Identificador exclusivo de 24dígitos hexadecimais para uma organização.
`month`	string	Número de dois dígitos que representa o mês das faturas associadas, por exemplo, `06`.
`year`	string	Número de quatro dígitos que representa o ano das faturas associadas, por exemplo, `2026`.

Solicitar um relatório FOCUS

Solicita a geração de um relatório de faturamento no formato padrão FOCUS. O Atlas gera o relatório assincronamente e retorna um ID do relatório que você usa para consultar o status do relatório.

URL base: /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/reports

POST /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/reports

Parâmetros do caminho da solicitação

Nome	Tipo	necessidade	Descrição
`orgId`	string	Obrigatório	String única de 24 dígitos hexadecimais que identifica a organização.
`invoiceId`	string	Obrigatório	String de 24dígitos hexadecimais exclusiva que identifica a fatura.

Parâmetros do corpo da solicitação

Nome	Tipo	necessidade	Descrição
`reportType`	string	Obrigatório	Tipo de relatório a ser gerado. Deve ser definido como `FOCUS`.
`reportFormat`	string	Obrigatório	Formato do relatório. Valores permitidos: `CSV`.
`formatSpecVersion`	string	Opcional	Versão da especificação do formato do relatório, por exemplo, `1.3`.

Exemplo de solicitação

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  --request POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/reports" \
  --data '{
    "reportType": "FOCUS",
    "reportFormat": "CSV",
    "formatSpecVersion": "1.3"
  }'

Resposta

Em caso de sucesso, retorna 201 Created com o ID do relatório e o estado inicial do relatório:

{
  "invoiceId": "32b6e34b3d91647abb20e7b8",
  "reportFormat": "CSV",
  "reportId": "5f5f4c9e2b8f4b3a1c2d3e4f",
  "reportType": "FOCUS",
  "state": "PENDING"
}

Para baixar o relatório, passe reportId o retornado para o endpoint de recuperação.

Recuperar um relatório FOCUS

Retorna o status e os detalhes de um relatório FOCUS que você solicitou. Pesquise este ponto de extremidade até que state seja SUCCEEDED ou FAILED.

Pesquise não mais de uma vez a cada cinco segundos. Se um relatório demorar mais para ser gerado, aumente o intervalo entre as solicitações exponencialmente. A maioria dos relatórios é concluída em segundos, mas os relatórios de faturas grandes podem levar alguns minutos.

URL base: /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/reports/{reportId}

GET /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/reports/{reportId}

Parâmetros do caminho da solicitação

Nome	Tipo	necessidade	Descrição
`orgId`	string	Obrigatório	String única de 24 dígitos hexadecimais que identifica a organização.
`invoiceId`	string	Obrigatório	String de 24dígitos hexadecimais exclusiva que identifica a fatura.
`reportId`	string	Obrigatório	String única de 24dígitos hexadecimais que identifica o relatório.

Exemplo de solicitação

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --request GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/reports/{reportId}"

Resposta

Em caso de sucesso, retorna 200 OK com o estado atual do relatório. Quando state é SUCCEEDED, a resposta também inclui a URL de download e seu tempo de expiração:

{
  "downloadUrl": "https://<presigned-url>",
  "expiresAt": "2026-08-17T18:30:00Z",
  "formatSpecVersion": "1.3",
  "invoiceId": "32b6e34b3d91647abb20e7b8",
  "reportFormat": "CSV",
  "reportId": "5f5f4c9e2b8f4b3a1c2d3e4f",
  "reportType": "FOCUS",
  "state": "SUCCEEDED"
}

Relatar estados

Estado	Descrição
`PENDING`	O Atlas aceitou a solicitação, mas não começou a gerar o relatório.
`RUNNING`	O Atlas está gerando o relatório.
`SUCCEEDED`	O relatório está pronto. A resposta inclui `downloadUrl` e `expiresAt`.
`FAILED`	O Atlas não conseguiu gerar o relatório. A resposta inclui `failureReason`.

Elementos de resposta

Nome	Tipo	Descrição
`downloadUrl`	string	URL para baixar o relatório. A resposta inclui esse parâmetro somente quando `state` é `SUCCEEDED`.
`expiresAt`	string	Data e hora em que `downloadUrl` expira, no formato ISO 8601 em UTC. Cada URL de download é válida por 15 minutos. A resposta inclui este parâmetro somente quando `state` for `SUCCEEDED`.
`failureReason`	string	Motivo da falha do relatório. A resposta inclui este parâmetro somente quando `state` é `FAILED`.
`formatSpecVersion`	string	Versão da especificação do formato do relatório.
`invoiceId`	string	String de 24dígitos hexadecimais exclusiva que identifica a fatura.
`reportFormat`	string	Formato do relatório gerado.
`reportId`	string	String única de 24dígitos hexadecimais que identifica o relatório.
`reportType`	string	Tipo do relatório gerado.
`state`	string	Estado atual da geração de relatórios.

Relatório de disponibilidade

Cada downloadUrl é válido por 15 minutos. Para baixar um relatório depois que sua URL expirar, chame este ponto de extremidade novamente com o mesmo reportId. O Atlas retorna um novo downloadUrl e um novo horário expiresAt.

Um relatório permanece disponível por sete dias após a solicitação. Após sete dias, solicite um novo relatório para baixar os mesmos dados da fatura.

Comportamento e desempenho dos dados

As seções a seguir descrevem como a FOCUS Data API lida com dados pendentes e a geração de relatórios em larga escala.

Visibilidade do mês pendente

Você pode consultar dados para o mês "Pendente" (atual). Embora o Atlas associe o uso a créditos em tempo real para oferecer estimativas de custo, esses valores são not final até que a fatura seja fechada. Re-puxe os dados após o fechamento do mês para confirmar os valores finais de faturamento.

Manipulação de arquivos para grandes volumes de dados

A API de dados FOCUS gera e entrega relatórios de uma forma projetada para lidar com dados de faturamento em larga escala:

Geração assíncrona: a geração de relatórios não bloqueia sua solicitação. O ponto de extremidade da solicitação retorna um reportId imediatamente, e você pesquisa o ponto de extremidade de recuperação para o estado do relatório.
Formato CSV: os relatórios são gerados como arquivos CSV.
URL de download por tempo limitado : quando uma informação downloadUrl é bem-sucedida, o endpoint de recuperação retorna um válido por 15 minutos. Os relatórios permanecem disponíveis por sete dias. Para saber como atualizar um URL expirado, consulte Disponibilidade do relatório.
Escopo de organização única: cada solicitação retorna dados para uma organização. Se você usar faturamento entre organizações, solicite um relatório para cada invoiceId retornado pelo ponto de extremidade da lista.

Limitações

O ponto de extremidade cobre apenas os custos baseados no uso. Atualmente, não inclui:
- Encargos de déficit (Diferenças de compromisso mensal/flexível).
- Itens de linha de imposto.
- Ajustes ou reembolsos.

Para visualizar sua fatura completa no console do Atlas, consulte Gerenciar faturas.

Suporte e feedback

Em caso de dúvidas sobre a Data API , entre em contato com a equipe de contas do MongoDB . Para fazer perguntas e participar de discussões com outros desenvolvedores, consulte as comunidades MongoDB no Stack Overflow ou Reddit.

Voltar

Detalhamento da Fatura

Assinaturas