Acesse o Relatório de uso e custo doFOCUS

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 oFOCUS

Anteriormente, os dados de faturamento do Atlas são fornecidos em formatos específicos do MongoDB. Os clientes do Atlas , especialmente grandes empresas e parceiros, precisam despender esforço manual para converter Unidades de Crédito do Atlas (ACUs) em moeda de faturamento.

O foco fornece um vocabulário e uma estrutura de faturamento comuns, que o ajudam a entender, reconciliar e integrar seus dados de faturamento do Atlas com o FindCam e as ferramentas de gerenciamento de custos de todos os 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 doFOCUS apresenta o mesmo período de cobrança no formatoFOCUS padronizado. Você pode baixar todos os três na página Invoices no console do Atlas .

Recursos de Data API de foco

A Data API fornece acesso programático aos seus dados de custo e uso formatados emFOCUS.

Com a Data API, você pode:

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

Referência de colunaFOCUS

A tabela a seguir lista as colunas retornadas na resposta da Data API e seus campos de cobrança legado equivalentes:

ID da coluna ID do foco 1.3	Definição	Campo equivalente a CSV atual	Campo equivalente a 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 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 cobrança dessa cobrança.	N/A	N/A
`BillingPeriodEnd`	A data final do período de faturamento. O período de cobrança não inclui a data de término.	N/A	"endDate" (fatura)
`BillingPeriodStart`	A data de início do período de faturamento. O período de cobrança 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, "usamento" 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 cobrança não inclui a data de término.	N/A	"endDate" (lineItems)
`ChargePeriodStart`	O início do período em que a cobrança foi incorrida. O período de cobrança 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 utilizado, com base na unidade consumida.	Quantidade	"quantidade"
`ConsumedUnit`	A unidade usada para medir determinado SKU.	unidade	"unit"
`ContractApplied`	Um conjunto de propriedades que associam uma cobrança a um ou mais compromisso contratual. Identifica o nome do Crédito Atlas utilizado 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ço correspondente. Este campo é denominado na moeda de cobrança.	N/A	N/A
`ContractedUnitPrice`	O preço unitário combinado para uma única unidade de preço do SKU associado, incluindo descontos. Esse preço é denominado na moeda de faturamento.	N/A	N/A
`EffectiveCost`	Representa o custo depreciado de uma cobrança após a aplicação de todas as taxas reduzidas e descontos. Este campo é denominado na moeda de cobrança.	N/A	N/A
`HostProviderName`	O nome da entidade que fornece a infraestrutura subjacente onde o provedor de serviço implementa seus recursos e serviços. Por exemplo, AWS, 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 fazem transações diretamente com o MongoDB ou marketplace para clientes que fazem transações com o Atlas por meio de um marketplace.	N/A	N/A
`ListCost`	Representa o custo calculado multiplicando o preço unitário de lista e a quantidade de preço correspondente. Este campo é denominado na moeda de cobrança.	N/A	N/A
`ListUnitPrice`	O preço unitário publicado pelo fornecedor sugerido para uma unidade de preço única do SKU associado, excluindo quaisquer descontos. Esse preço é denominado na moeda de faturamento.	N/A	N/A
`PricingCurrency`	A moeda de medição para essa cobrança, por exemplo, Atlas Credits.	N/A	N/A
`PricingCurrencyContractedUnitPrice`	O preço unitário combinado 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 depreciado de uma cobrança após a aplicação de todas as taxas reduzidas e descontos. Este campo é denominado na moeda do preço.	Quantia	"totalPriceCents"
`PricingCurrencyListUnitPrice`	Representa o custo calculado multiplicando o preço unitário de lista e a quantidade de preço correspondente. Este campo é denominado na moeda do preço.	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 no preço unitário.	N/A	N/A
`PricingUnit`	Representa uma unidade para determinar os 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 Atlas, este é o nome do agrupamento.	cluster	"clusterName"
`ServiceCategory`	Classificação de nível mais alto, conforme definido porFOCUS. Esta é a seção "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 do 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 cobrada, como pares de valor-chave em JSON. Esta coluna está vazia quando a cobrança não tem ponto de preço ou o ponto de preço não especifica nenhuma dimensão.	N/A	N/A
`SkuPriceId`	Um identificador exclusivo do ponto de preço em que a cobrança foi cobrada.	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`	Marcações atribuídas aos recursos associados.	Etiquetas/ aplicação	"tags"
`x_AtlasSku`	O SKU do Atlas que está sendo cobrado.	SKU	"sku"
`x_BilledDateEnd`	O final do período em que o MongoDB cobrou a cobrança.	Data	"criado" (lineItems)
`x_BilledDateStart`	O início do período em que o MongoDB cobrou a cobrança.	N/A	N/A
`x_PricingCurrencyRate`	O "price" de um Crédito Atlas . Aplique esta taxa para encontrar o custo de um crédito Atlas na moeda de cobrança.	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 Data API do Atlas estende a API de administração do Atlas a três endpoints:

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 endpoints exigem Organization Billing Admin aOrganization Owner Organization Billing Viewer função, ou.

Listar faturas para uma organização

Recupera uma lista de IDs de faturas disponíveis. Para o faturamento entre organizações, esse endpoint identifica faturas de 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 recuperadas. Deve ser >= 2000.	Ano atual
`includeLinkedOrgs`	booleano	Opcional	Sinalizador que indica se 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 no período especificado.
`associatedInvoices[n].invoiceId`	string	Identificador exclusivo de 24dígitos hexadecimais 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órioFOCUS

Solicita a geração de um relatório de faturamento no formato padrãoFOCUS. O Atlas gera o relatório de forma assíncrona e retorna um ID de relatório que você usa para pesquisar 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 única de 24dígitos hexadecimais 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 a 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órioFOCUS

Retorna o status e os detalhes de um relatórioFOCUS que você solicitou. Pesquise esse endpoint até que state seja SUCCEEDED ou FAILED.

Faça pesquisas no máximo uma vez a cada cinco segundos. Se um relatório demorar mais para ser gerado, aumente exponencialmente o intervalo entre as solicitações. 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 única de 24dígitos hexadecimais 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"
}

Estados do relatório

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 este 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álido por 15 minutos. A resposta inclui este parâmetro somente quando `state` está `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 única de 24dígitos hexadecimais 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.

Disponibilidade do relatório

Cada downloadUrl é válido por 15 minutos. Para baixar um relatório depois que seu URL expirar, chame este endpoint novamente com o mesmo reportId. Atlas retorna um novo downloadUrl e um novo expiresAt tempo.

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

Comportamento e desempenho de dados

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

Visibilidade do mês pendente

Você pode executar query de dados para a questão "pendente" mês (atual). Enquanto o Atlas associa o uso a créditos em tempo real para oferecer estimativas de custo, esses valores são not final até o fechamento da fatura. Puxe os dados novamente após o fechamento do mês para confirmar os valores de faturamento finais.

Manuseio de arquivos para grandes volumes de dados

A Data API de foco gera e fornece relatórios de uma forma projetada para lidar com dados de cobrança em grande escala:

Geração assíncrona: a geração de relatórios não bloqueia sua solicitação. O reportId endpoint de solicitação retorna um imediatamente e você pesquisa o endpoint 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 o faturamento entre organizações, solicite um relatório para cada invoiceId retornado pelo endpoint da lista.

Limitações

O endpoint cobre apenas os custos baseados em uso. Atualmente não inclui:
- Cobranças de lacunas (diferenças de compromisso mensal/flexível).
- Itens de linha de imposto.
- Ajustes ou devoluções.

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

Uso e tributação internacional

Explore seus dados