Sherweb Platform MCP Server (Pré-visualização)
O servidor MCP Sherweb Cumulus oferece aos assistentes de IA acesso seguro ao Cumulus através do Protocolo de Contexto do Modelo. Os parceiros MSP autorizados podem usar linguagem natural para recuperar organizações, subscrições, catalogar, faturação e dados de auditoria, combiná-los em respostas úteis e realizar operações suportadas, como fazer encomendas e alterar subscrições, dentro das suas permissões Cumulus.
Este conector está disponível nos seguintes produtos e regiões:
| Service | Classe | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões Power Automate exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões Power Apps exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões Power Automate exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contact | |
|---|---|
| Name | Suporte Sherweb |
| URL | https://www.sherweb.com |
| support@sherweb.com |
| Metadados do conector | |
|---|---|
| Publisher | A IA do Sherweb |
| Website | https://www.sherweb.com |
| Política de privacidade | https://www.sherweb.com/legal/privacy-policy/ |
| Categories | Operações de TI; Gestão Empresarial |
Sherweb Cumulus
A Sherweb é um fornecedor de soluções cloud que capacita os Provedores de Serviços Geridos (MSPs) para gerir os seus clientes, subscrições, faturação e catálogo através da plataforma Cumulus . O conector Cumulus MCP (Model Context Protocol) expõe os seus dados Cumulus diretamente a assistentes de IA — como agentes do Microsoft Copilot Studio — para que possa consultar e agir sobre o seu negócio MSP em linguagem natural.
Com este conector, pode fazer perguntas ao seu assistente de IA como:
- "Liste todas as subscrições para renovação nos próximos 60 dias."
- "Qual das minhas organizações não tem um produto de reserva?"
- "Quais são as minhas 10 principais organizações em termos de receita recorrente?"
- "Faça uma encomenda para a organização Contoso."
Prerequisites
- Uma conta Cumulus ativa com o papel de Prestador de Serviços .
- Uma chave API Cumulus específica para revendedor com
mcp:toolsos escopos e.service-provider - Um ambiente Microsoft Power Platform onde está instalada a solução de conector Sherweb Platform.
Criação de Credenciais de Revendedor
Cada revendedor utiliza as suas próprias credenciais de cliente OAuth existentes ao criar uma ligação de conector; este fluxo não utiliza Registo Dinâmico de Cliente (DCR) nem um ID de Cliente partilhado e Segredo do Cliente.
https://helpdesk.sherweb.com/en-us/knowledge-base/articles/KA-05021
- Inicia sessão no Cumulus.
- Navegue até às Definições da Plataforma → APIs.
- Crie uma chave API separada para o revendedor, ou selecione a chave existente desse revendedor.
- Assegura-te de que a chave tem os
mcp:toolsescopos eservice-providerescopos. Copie o seu ID do Cliente e o Segredo do Cliente; o segredo só é mostrado quando criado. - Adicione o URI de redirecionamento exibido para o conector Sherweb Platform instalado à chave API.
OAuth Endpoints
| Field | Value |
|---|---|
| URL de Autorização | https://cumulus.sherweb.com/oidc/connect/authorize |
| URL de Token | https://cumulus.sherweb.com/oidc/connect/token |
| Atualizar URL | https://cumulus.sherweb.com/oidc/connect/token |
| Scopes | mcp:tools service-provider |
Criar uma Ligação
https://helpdesk.sherweb.com/en-us/knowledge-base/articles/KA-05021
- No Power Platform, selecione o conector Sherweb Platform instalado e crie uma ligação.
- Introduza o ID do Cliente e o Segredo do Cliente do revendedor quando solicitado. Estas credenciais são armazenadas de forma segura pela ligação e são usadas para a autorização OAuth e atualização do token desse revendedor.
- Inicie sessão no Cumulus com uma conta de utilizador autorizada para esse revendedor.
- Se a ligação não conseguir completar a autorização, verifique se o URI de redirecionamento do conector está registado na chave API desse revendedor e se ambos os escopos necessários estão ativados.
Crie uma ligação separada para cada revendedor. O ID do Cliente e o Segredo do Cliente identificam a aplicação OAuth do revendedor; o login interativo determina a conta de utilizador autorizada a usar a ligação.
A renovação de tokens utiliza a concessão de token de atualização OAuth e as credenciais fornecidas para essa ligação, em vez de repetir a troca de códigos de autorização.
Para clientes MCP diretos (em vez do conector certificado da Power Platform), configure o OAuth usando https://mcp.sherweb.com os endpoints e scopes acima. A configuração direta de autenticação do cliente MCP é separada dos campos de credenciais específicos do revendedor no conector Power Platform.
Operações suportadas
Read-Only Ferramentas
| Tool | Description |
|---|---|
QueryOrganizations |
Organizações de consulta geridas pelo fornecedor de serviços usando GraphQL. |
QuerySubscriptions |
Consultar subscrições entre organizações usando GraphQL. |
QueryOrganizationConsumptions |
Consultar dados de consumo (utilização e encargos) para organizações que utilizam GraphQL. |
QueryCatalog |
Consulte o catálogo de produtos disponível para o fornecedor de serviços usando o GraphQL. |
QueryAuditLogs |
Consulte o registo de auditoria das ações realizadas na plataforma usando o GraphQL. |
GetGraphQLSchema |
Recupere o esquema completo do GraphQL para ajudar a construir consultas válidas. |
GetCopilotSkus |
Obtenha a lista de SKUs Sherweb para ofertas do Microsoft Copilot. |
Ferramentas de Escrita
Nota: As operações de escrita requerem as permissões apropriadas na conta Cumulus autenticada.
| Tool | Description |
|---|---|
PlaceOrder |
Faça uma encomenda de produto para uma organização cliente. |
ValidateQuote |
Valide uma encomenda proposta e obtenha detalhes de preços sem a fazer. |
CreateSubscriptionsAmendment |
Alterar o número de lugares ou licenças numa ou mais subscrições existentes. |
CancelSubscriptions |
Cancele uma ou mais subscrições para uma organização cliente. |
ConfigurePlatform |
Configure uma plataforma (por exemplo, um tenant Microsoft 365) para um cliente. |
Prompts de exemplo
Abaixo estão exemplos de prompts em linguagem natural que pode usar com um assistente de IA ligado a este servidor MCP:
Renovações e Faturação
- "Liste todas as subscrições para renovação nos próximos 60 dias."
- "Dá-me um resumo de todas as despesas da organização Contoso nos últimos 3 meses."
- "Que subscrições expiram em 30 dias em todas as organizações?"
Inventário e Portefólio
- "Qual das minhas organizações não tem um produto de reserva?"
- "Quais são as minhas 10 principais organizações em termos de receita recorrente?"
- "Mostra-me todas as subscrições recentemente canceladas."
- "Liste todas as ofertas de produtos que incluam um SKU Copilot."
Actions
- "Faça uma encomenda de 5 lugares do Microsoft 365 Empresas Premium para a organização Contoso."
- "Validar um orçamento para 10 lugares do Azure Plan para a organização Fabrikam."
- "Reduzir o número de lugares no Exchange Online para a empresa Contoso de 20 para 15."
Problemas conhecidos e limitações
- Profundidade de consulta GraphQL: Consultas GraphQL muito profundamente aninhadas podem expirar. Se uma consulta expirar, simplifique-a reduzindo a profundidade de aninhamento ou o número de campos solicitados.
-
Paginação necessária: Consultas de lista (
QueryOrganizations,QuerySubscriptions, etc.) requerem argumentos de paginação (first/afteroulast/before). Consultas sem paginação devolvem um erro. -
Escopos: Certifique-se de que ambos
mcp:toolseservice-providerestão incluídos nos escopos OAuth ao criar a sua chave API; a ausência de qualquer um deles resultará em erros de autenticação.
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: Todas as regiões
Parâmetros para criar conexão.
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Name | Tipo | Description | Required |
|---|---|---|---|
| ID do Cliente do Revendedor | cadeia (de caracteres) | Insira o ID do Cliente emitido para este revendedor. | True |
| Segredo do Cliente Revendedor | securestring | Entra o Cliente Secret emitido para este revendedor. | True |
Ações
| Alterar os valores das subscrições |
Alterar os valores de subscrição. |
| Cancelar subscrições de uma organização |
Cancelar subscrições de uma organização. |
| Configurar uma plataforma para um cliente |
Configura uma plataforma para um cliente. |
| Consultar itens de catálogo usando GraphQL |
Consulta os itens do catálogo usando GraphQL. |
| Consultar registos de auditoria usando GraphQL |
Consultar registos de auditoria usando GraphQL. |
| Consumos de organização de consultas usando GraphQL |
Consulta aos consumos de organização usando GraphQL. |
| Faça mapear os SKUs Sherweb para as ofertas do Microsoft Copilot |
Faça os SKUs Sherweb mapeados para as ofertas do Microsoft Copilot. |
| Faça uma encomenda para um cliente |
Faça uma encomenda para um cliente. |
| Obtenha o esquema GraphQL em formato SDL |
Obtenha o esquema GraphQL em formato SDL. |
| Organizações de consulta usando GraphQL |
Consultar organizações usando GraphQL. |
| Subscrições de consulta usando GraphQL |
Consultar subscrições usando GraphQL. |
| Valide um orçamento sem fazer a encomenda |
Valide um orçamento sem fazer a encomenda. |
Alterar os valores das subscrições
Alterar os valores de subscrição.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
organizationId
|
organizationId | True | uuid | |
|
subscriptionId
|
subscriptionId | True | uuid | |
|
newQuantity
|
newQuantity | integer |
Devoluções
Cancelar subscrições de uma organização
Cancelar subscrições de uma organização.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
organizationId
|
organizationId | True | uuid | |
|
subscriptionIds
|
subscriptionIds | True | array of uuid |
Devoluções
Configurar uma plataforma para um cliente
Configura uma plataforma para um cliente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
ID do cliente
|
customerId | True | uuid | |
|
platformId
|
platformId | True | uuid | |
|
identificador
|
identifier | True | string | |
|
valor
|
value | string |
Devoluções
- response
- string
Consultar itens de catálogo usando GraphQL
Consulta os itens do catálogo usando GraphQL.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
graphqlQuery
|
graphqlQuery | True | string |
Devoluções
Tipo genérico de ligação para paginação baseada em cursor, "T" O tipo de itens na ligação
Consultar registos de auditoria usando GraphQL
Consultar registos de auditoria usando GraphQL.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
graphqlQuery
|
graphqlQuery | True | string |
Devoluções
Tipo genérico de ligação para paginação baseada em cursor, "T" O tipo de itens na ligação
Consumos de organização de consultas usando GraphQL
Consulta aos consumos de organização usando GraphQL.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
graphqlQuery
|
graphqlQuery | True | string |
Devoluções
Tipo genérico de ligação para paginação baseada em cursor, "T" O tipo de itens na ligação
Faça mapear os SKUs Sherweb para as ofertas do Microsoft Copilot
Faça os SKUs Sherweb mapeados para as ofertas do Microsoft Copilot.
Devoluções
- response
- array of SkuDetail
Faça uma encomenda para um cliente
Faça uma encomenda para um cliente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
ID do cliente
|
customerId | True | uuid | |
|
sku
|
sku | True | string | |
|
quantidade
|
quantity | integer | ||
|
compraNúmero de Encomenda
|
purchaseOrderNumber | string | ||
|
ordenadoPor
|
orderedBy | True | string |
Devoluções
- Body
- PlaceOrderResponse
Obtenha o esquema GraphQL em formato SDL
Organizações de consulta usando GraphQL
Consultar organizações usando GraphQL.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
graphqlQuery
|
graphqlQuery | True | string |
Devoluções
Tipo genérico de ligação para paginação baseada em cursor, "T" O tipo de itens na ligação
Subscrições de consulta usando GraphQL
Consultar subscrições usando GraphQL.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
graphqlQuery
|
graphqlQuery | True | string |
Devoluções
Tipo genérico de ligação para paginação baseada em cursor, "T" O tipo de itens na ligação
Valide um orçamento sem fazer a encomenda
Valide um orçamento sem fazer a encomenda.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
ID do cliente
|
customerId | True | uuid | |
|
sku
|
sku | True | string | |
|
quantidade
|
quantity | integer | ||
|
compraNúmero de Encomenda
|
purchaseOrderNumber | string | ||
|
ordenadoPor
|
orderedBy | True | string |
Devoluções
- Body
- ValidateOrderResult
Definições
Opção
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
ParameterChoiceValue
|
parameterChoiceValue | string | |
|
parameterChoiceDisplayName
|
parameterChoiceDisplayName | string |
ConexãoDeRegistoDe AuditoriaProjetada
Tipo genérico de ligação para paginação baseada em cursor, "T" O tipo de itens na ligação
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
bordas
|
edges | array of EdgeOfProjectedAuditLog |
A lista de arestas nesta página. Cada aresta contém o nó e o seu cursor. |
|
nodes
|
nodes | array of ProjectedAuditLog |
Uma lista achatada dos nós nesta página (sem metadados do cursor). |
|
contagemTotal
|
totalCount | integer |
Contagem total de itens em todas as páginas (quando solicitado) |
|
pageInfo
|
pageInfo | PageInfo |
Metadados de paginação para navegação baseada em cursor. |
ConexãoDeItemDeCatálogoProjetadoProjeto
Tipo genérico de ligação para paginação baseada em cursor, "T" O tipo de itens na ligação
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
bordas
|
edges | array of EdgeOfProjectedCatalogItem |
A lista de arestas nesta página. Cada aresta contém o nó e o seu cursor. |
|
nodes
|
nodes | array of ProjectedCatalogItem |
Uma lista achatada dos nós nesta página (sem metadados do cursor). |
|
contagemTotal
|
totalCount | integer |
Contagem total de itens em todas as páginas (quando solicitado) |
|
pageInfo
|
pageInfo | PageInfo |
Metadados de paginação para navegação baseada em cursor. |
ItemLigaçãoDeConsumoProjeçãoProjetado
Tipo genérico de ligação para paginação baseada em cursor, "T" O tipo de itens na ligação
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
bordas
|
edges | array of EdgeOfProjectedConsumptionItem |
A lista de arestas nesta página. Cada aresta contém o nó e o seu cursor. |
|
nodes
|
nodes | array of ProjectedConsumptionItem |
Uma lista achatada dos nós nesta página (sem metadados do cursor). |
|
contagemTotal
|
totalCount | integer |
Contagem total de itens em todas as páginas (quando solicitado) |
|
pageInfo
|
pageInfo | PageInfo |
Metadados de paginação para navegação baseada em cursor. |
ConexãoDeOrganização Projetada
Tipo genérico de ligação para paginação baseada em cursor, "T" O tipo de itens na ligação
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
bordas
|
edges | array of EdgeOfProjectedOrganization |
A lista de arestas nesta página. Cada aresta contém o nó e o seu cursor. |
|
nodes
|
nodes | array of ProjectedOrganization |
Uma lista achatada dos nós nesta página (sem metadados do cursor). |
|
contagemTotal
|
totalCount | integer |
Contagem total de itens em todas as páginas (quando solicitado) |
|
pageInfo
|
pageInfo | PageInfo |
Metadados de paginação para navegação baseada em cursor. |
ConexãoDeSubscriçãoProjetada
Tipo genérico de ligação para paginação baseada em cursor, "T" O tipo de itens na ligação
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
bordas
|
edges | array of EdgeOfProjectedSubscription |
A lista de arestas nesta página. Cada aresta contém o nó e o seu cursor. |
|
nodes
|
nodes | array of ProjectedSubscription |
Uma lista achatada dos nós nesta página (sem metadados do cursor). |
|
contagemTotal
|
totalCount | integer |
Contagem total de itens em todas as páginas (quando solicitado) |
|
pageInfo
|
pageInfo | PageInfo |
Metadados de paginação para navegação baseada em cursor. |
EdgeOfProjectedAuditLog
Uma aresta numa ligação paginada baseada em cursor, contendo o nó e o seu cursor.
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
nó
|
node | ProjectedAuditLog | |
|
cursor
|
cursor | string |
O cursor desta aresta, usado para paginação baseada em cursor. |
ArmaOItemDeCatálogoProjetado
Uma aresta numa ligação paginada baseada em cursor, contendo o nó e o seu cursor.
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
nó
|
node | ProjectedCatalogItem | |
|
cursor
|
cursor | string |
O cursor desta aresta, usado para paginação baseada em cursor. |
ItemLimiteDeConsumoProjeçãoProjetado
Uma aresta numa ligação paginada baseada em cursor, contendo o nó e o seu cursor.
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
nó
|
node | ProjectedConsumptionItem | |
|
cursor
|
cursor | string |
O cursor desta aresta, usado para paginação baseada em cursor. |
EdgeOfProjectedOrganization
Uma aresta numa ligação paginada baseada em cursor, contendo o nó e o seu cursor.
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
nó
|
node | ProjectedOrganization | |
|
cursor
|
cursor | string |
O cursor desta aresta, usado para paginação baseada em cursor. |
EdgeOfProjectedSubscription
Uma aresta numa ligação paginada baseada em cursor, contendo o nó e o seu cursor.
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
nó
|
node | ProjectedSubscription | |
|
cursor
|
cursor | string |
O cursor desta aresta, usado para paginação baseada em cursor. |
EventSource
InvoiceMetrics
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
período Distribuição
|
periodRange | InvoicePeriodRange | |
|
acumuladoCusto Recorrente
|
accumulatedRecurringCost | double |
O(1) |
|
Contagem de faturas
|
invoiceCount | integer |
O(1) |
|
CompostoMensalCustoTaxa de CrescimentoT
|
compoundMonthlyCostGrowthRate | double |
O(1) |
|
CustoRazãoConcentraçãoT
|
costConcentrationRatio | double |
O(1) |
|
custoVolatilidade
|
costVolatility | double |
O(1) |
PeríodoDeFaturaIntervalo
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
from
|
from | date |
O(1) |
|
a
|
to | date |
O(1) |
PageInfo
Metadados de paginação para navegação baseada em cursor.
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
hasNextPage
|
hasNextPage | boolean | |
|
hasPreviousPage
|
hasPreviousPage | boolean | |
|
startCursor
|
startCursor | string | |
|
endCursor
|
endCursor | string |
PlaceOrderResponse
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
requestTrackingId
|
requestTrackingId | uuid | |
|
subscriptionIds
|
subscriptionIds | array of uuid |
Parâmetro NecessárioDePlataforma
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
Descrição do parâmetro
|
parameterDescription | string | |
|
ParameterIdentifier
|
parameterIdentifier | string | |
|
parameterDefaultValue
|
parameterDefaultValue | string | |
|
parameterFormatType
|
parameterFormatType | string | |
|
parameterFormatPattern
|
parameterFormatPattern | string | |
|
ParameterFormatChoices
|
parameterFormatChoices | array of Choice |
ProjectedAuditLog
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
id
|
id | integer | |
|
targetName
|
targetName | string | |
|
ação
|
action | string | |
|
date
|
date | date-time | |
|
Nome de Exibição do Utilizador
|
userDisplayName | string | |
|
categoryName
|
categoryName | string | |
|
description
|
description | string | |
|
details
|
details | array of ProjectedAuditLogDetail |
ProjectedAuditLogDetail
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
propertyName
|
propertyName | string | |
|
oldValue
|
oldValue | string | |
|
novoValor
|
newValue | string |
ItemCatálogoDeProjetado
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
sku
|
sku | string |
O(1) |
|
name
|
name | string |
O(1) |
|
description
|
description | string |
O(1) |
|
billingCycle
|
billingCycle | string |
O(1) |
|
CompromissoPrazo
|
commitmentTerm | string |
O(1) |
|
Informação de preços
|
pricingInformation | ProjectedPricingInformation | |
|
plataformas
|
platforms | array of ProjectedPlatforms |
O(1) chamada extra |
Prazo de CompromissoProjetado
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
tipo
|
type | ProjectedCommitmentTermType | |
|
data de término
|
endDate | date-time | |
|
renewalConfiguração
|
renewalConfiguration | ProjectedRenewalConfiguration |
ProjetoCompromissoTermoTipo
ItemConsumoProjetado
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
product
|
product | string |
O(1) |
|
vendorName
|
vendorName | string |
O(1) |
|
totalQuantidades
|
totalQuantities | integer |
O(1) |
|
consumidQuantidades consumidas
|
consumedQuantities | integer |
O(1) |
|
Quantidades disponíveis
|
availableQuantities | integer |
O(1) |
Moeda projetada
TaxasProjetadasDto
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
Taxa recorrente
|
recurringFee | ProjectedMoney | |
|
setupFee
|
setupFee | ProjectedMoney | |
|
custoTaxa Recorrente
|
costRecurringFee | ProjectedMoney | |
|
billingCycle
|
billingCycle | string |
ProjectedMoney
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
valor
|
value | double | |
|
moeda
|
currency | ProjectedCurrency | |
|
arredondar
|
rounding | integer |
Organização Projetada
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
id
|
id | uuid |
O(1) |
|
name
|
name | string |
O(1) |
|
uniqueName
|
uniqueName | string |
O(1) |
|
parentId
|
parentId | uuid |
O(1) |
|
nome-pai
|
parentName | string |
O(1) |
|
suspensoLigado
|
suspendedOn | date-time |
O(n) |
|
éSuspenso
|
isSuspended | boolean |
O(1) |
|
estáEliminado
|
isDeleted | boolean |
O(1) |
|
estáAtivo
|
isActive | boolean |
O(n) |
|
diasDesde Suspensão
|
daysSinceSuspension | integer |
O(n) |
|
totalSubscriptionCount
|
totalSubscriptionCount | integer |
O(n) |
|
uniqueSkus
|
uniqueSkus | array of string |
O(n) |
|
totalMensalTaxa Recorrente
|
totalMonthlyRecurringFee | double |
O(n) |
|
totalCustoMensalTaxa Recorrente
|
totalMonthlyCostRecurringFee | double |
O(n) |
|
totalAnualTaxa Recorrente
|
totalYearlyRecurringFee | double |
O(n) |
|
totalCustoAnualTaxa Recorrente
|
totalYearlyCostRecurringFee | double |
O(n) |
|
totalOutrosTaxa Recorrente
|
totalOtherRecurringFee | double |
O(n), Agregação de taxas recorrentes com um ciclo de faturação diferente de mensal ou anual |
|
totalOutrosCustoTaxa Recorrente
|
totalOtherCostRecurringFee | double |
O(n), Agregação de taxas de custos recorrentes com um ciclo de faturação diferente do mensal ou anual |
|
invoiceMetrics
|
invoiceMetrics | InvoiceMetrics |
Plataformas Projetadas
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
platformId
|
platformId | uuid | |
|
requiredParameters
|
requiredParameters | array of PlatformRequiredParameter |
O(1) chamada extra |
Informação de Preços ProjetadosT
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
Taxa recorrente
|
recurringFee | double | |
|
setupFee
|
setupFee | double | |
|
moeda
|
currency | ProjectedCurrency | |
|
billingCycle
|
billingCycle | string |
Configuração Renovada Projetada
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
isConfigurable
|
isConfigurable | boolean | |
|
renewDefinições
|
renewSettings | ProjectedRenewSettings |
ProjectedRenewSettings
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
Renovação Data
|
renewalDate | date-time | |
|
Quantidade programada
|
scheduledQuantity | integer | |
|
CoTerminaçãoData de Fim
|
coTerminationEndDate | date-time |
SubscriçãoDeProjetada
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
subscriptionId
|
subscriptionId | uuid |
O(1) |
|
organizationId
|
organizationId | uuid |
O(1) |
|
canceladoLigado
|
cancelledOn | date-time |
O(n) |
|
estáAtivo
|
isActive | boolean |
O(n) |
|
diasdesdeCriação
|
daysSinceCreation | integer |
O(n) |
|
criadoEm
|
createdOn | date-time |
O(1) |
|
quantidade
|
quantity | integer |
O(1) |
|
CompromissoPrazo
|
commitmentTerm | ProjectedCommitmentTerm | |
|
diasAté à Renovação
|
daysUntilRenewal | integer |
O(n) |
|
sherwebSku
|
sherwebSku | string |
O(1) |
|
microsoftSkus
|
microsoftSkus | array of string |
O(n) |
|
description
|
description | string |
O(1) |
|
expirationDate
|
expirationDate | date-time |
O(1) |
|
ÚltimaData de Renovação
|
lastRenewalDate | date-time |
O(n) |
|
Taxas
|
fees | ProjectedFeesDto | |
|
productName
|
productName | string |
O(1) |
|
éCoterminado
|
isCoterminated | boolean |
O(n) |
|
histórico
|
history | array of SubscriptionHistoryEvent |
O(n) |
RenovadoTermoDataDataDataDataRenovado
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
Data anterior
|
previousDate | date | |
|
NewDate
|
newDate | date |
RenovadoTermoInícioDataDetalhe
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
Data anterior
|
previousDate | date | |
|
NewDate
|
newDate | date |
SkuDetalhe
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
sku
|
sku | string | |
|
skuName
|
skuName | string |
SubscriçãoHistóriaEvento
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
criadoEm
|
createdOn | date-time | |
|
contagem de licenças
|
licenseCount | integer | |
|
sku
|
sku | string | |
|
offerName
|
offerName | string | |
|
utilizador
|
user | string | |
|
coTerminationDate
|
coTerminationDate | string | |
|
fonteDeEventos
|
eventSource | EventSource | |
|
termoFimDataDetalhe
|
termEndDateDetail | RenewedTermEndDateDetail | |
|
termoInícioDataDetalhe
|
termStartDateDetail | RenewedTermStartDateDetail |
SubscriçõesEmenda
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
subscriçõesAmendmentId
|
subscriptionsAmendmentId | uuid | |
|
trackingId
|
trackingId | TrackingId |
SubscriçõesCancelamento
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
subscriçõesCancellationId
|
subscriptionsCancellationId | uuid | |
|
trackingId
|
trackingId | TrackingId |
TrackingId
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
requestTrackingId
|
requestTrackingId | uuid |
ValidateOrderLineItem
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
número da linha
|
lineNumber | integer | |
|
sku
|
sku | string | |
|
name
|
name | string | |
|
billingCycle
|
billingCycle | string | |
|
CompromissoPrazo
|
commitmentTerm | string | |
|
quantidade
|
quantity | integer | |
|
preço unitário
|
unitPrice | double | |
|
preço estendido
|
extendedPrice | double | |
|
moeda
|
currency | string |
ValidateOrderResult
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
mensagem
|
message | string | |
|
lineItems
|
lineItems | array of ValidateOrderLineItem | |
|
Subtotal
|
subtotal | double | |
|
moeda
|
currency | string |
cadeia (de caracteres)
Este é o tipo de dados básico 'string'.