Servidor MCP da Plataforma Sherweb (versão prévia)
O servidor MCP do Sherweb Cumulus fornece aos assistentes de IA acesso seguro ao Cumulus por meio do Protocolo de Contexto de Modelo. Parceiros msp autorizados podem usar linguagem natural para recuperar organizações, assinaturas, catálogo, dados de cobrança e auditoria, combiná-los em respostas úteis e executar operações com suporte, como fazer pedidos e alterar assinaturas, dentro de suas permissões cumulus.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Classe | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões Power Automate exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Azure Governamental regiões - 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 (GCC) – 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 (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Name | Suporte à Sherweb |
| URL | https://www.sherweb.com |
| support@sherweb.com |
| Metadados do conector | |
|---|---|
| Publicador | IA da Sherweb |
| Website | https://www.sherweb.com |
| Política de privacidade | https://www.sherweb.com/legal/privacy-policy/ |
| Categories | Operações de TI; Gestão de empresas |
Sherweb Cumulus
O Sherweb é um provedor de soluções de nuvem que capacita os MSPs (Provedores de Serviços Gerenciados) a gerenciar seus clientes, assinaturas, cobrança e catálogo por meio da plataforma Cumulus . O conector cumulus MCP (Protocolo de Contexto de Modelo) expõe seus dados cumulus diretamente aos assistentes de IA, como Microsoft Copilot Studio agentes, para que você possa consultar e agir sobre seus negócios msp em linguagem natural.
Com esse conector, você pode fazer perguntas ao assistente de IA como:
- "Liste todas as assinaturas para renovação nos próximos 60 dias."
- "Qual das minhas organizações não tem um produto de backup?"
- "Quais são minhas 10 principais organizações por receita recorrente?"
- "Faça um pedido para a organização Contoso."
Prerequisites
- Uma conta cumulus ativa com a função provedor de serviços .
- Uma chave de API Cumulus específica do revendedor com escopos e
service-providerescoposmcp:tools. - Um ambiente Microsoft Power Platform em que a solução de conector da Plataforma Sherweb está instalada.
Criando credenciais de revendedor
Cada revendedor usa suas próprias credenciais de cliente OAuth existentes ao criar uma conexão de conector; esse fluxo não usa o DCR (Registro dinâmico do cliente) ou uma ID do cliente compartilhada e um segredo do cliente.
https://helpdesk.sherweb.com/en-us/knowledge-base/articles/KA-05021
- Faça logon no Cumulus.
- Navegue até as Configurações de Plataforma → APIs.
- Crie uma chave de API separada para o revendedor ou selecione a chave existente do revendedor.
- Verifique se a chave tem os escopos e
service-providerosmcp:toolsescopos. Copiar sua ID do cliente e o segredo do cliente; o segredo é mostrado somente quando criado. - Adicione o URI de redirecionamento exibido para o conector da Plataforma Sherweb instalado à chave de API.
Pontos de extremidade OAuth
| Field | Value |
|---|---|
| URL de Autorização | https://cumulus.sherweb.com/oidc/connect/authorize |
| Token URL | https://cumulus.sherweb.com/oidc/connect/token |
| Atualizar URL | https://cumulus.sherweb.com/oidc/connect/token |
| Escopos | mcp:tools service-provider |
Criando uma conexão
https://helpdesk.sherweb.com/en-us/knowledge-base/articles/KA-05021
- No Power Platform, selecione o conector da Plataforma Sherweb instalado e crie uma conexão.
- Insira a ID do cliente e o segredo do cliente do revendedor quando solicitado. Essas credenciais são armazenadas com segurança pela conexão e são usadas para a autorização do OAuth do revendedor e a atualização de token.
- Entre no Cumulus com uma conta de usuário autorizada para esse revendedor.
- Se a conexão não puder concluir a autorização, verifique se o URI de redirecionamento do conector está registrado na chave de API do revendedor e se ambos os escopos necessários estão habilitados.
Crie uma conexão separada para cada revendedor. A ID do cliente e o segredo do cliente identificam o aplicativo OAuth do revendedor; a entrada interativa determina a conta de usuário autorizada a usar a conexão.
A renovação de token usa a concessão de token de atualização OAuth e as credenciais fornecidas para essa conexão, em vez de repetir a troca de código de autorização.
Para clientes MCP diretos (em vez do conector certificado do Power Platform), configure o OAuth em relação https://mcp.sherweb.com ao uso dos pontos de extremidade e escopos acima. A configuração direta de autenticação do cliente MCP é separada dos campos de credencial específicos do revendedor no conector do Power Platform.
Operações com suporte
Ferramentas de Read-Only
| Tool | Description |
|---|---|
QueryOrganizations |
Consultar organizações gerenciadas pelo provedor de serviços usando o GraphQL. |
QuerySubscriptions |
Consultar assinaturas entre organizações usando o GraphQL. |
QueryOrganizationConsumptions |
Consultar dados de consumo (uso e encargos) para organizações que usam o GraphQL. |
QueryCatalog |
Consulte o catálogo de produtos disponível para o provedor de serviços usando o GraphQL. |
QueryAuditLogs |
Consulte o log de auditoria de ações executadas 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 de Microsoft Copilot. |
Ferramentas de Gravação
Observação: As operações de gravação exigem as permissões apropriadas na conta cumulus autenticada.
| Tool | Description |
|---|---|
PlaceOrder |
Faça um pedido de produto para uma organização do cliente. |
ValidateQuote |
Valide um pedido proposto e obtenha detalhes de preços sem fazer o pedido. |
CreateSubscriptionsAmendment |
Altere a quantidade de estações ou licenças em uma ou mais assinaturas existentes. |
CancelSubscriptions |
Cancele uma ou mais assinaturas para uma organização do cliente. |
ConfigurePlatform |
Configure uma plataforma (por exemplo, Microsoft 365 locatário) para um cliente. |
Exemplo de Prompts
Abaixo estão exemplos de prompts de linguagem natural que você pode usar com um assistente de IA conectado a este servidor MCP:
Renovações e cobrança
- "Liste todas as assinaturas para renovação nos próximos 60 dias."
- "Dê-me um detalhamento de todas as cobranças para a organização Contoso nos últimos 3 meses."
- "Quais assinaturas estão expirando dentro de 30 dias em todas as organizações?"
Inventário e portfólio
- "Qual das minhas organizações não tem um produto de backup?"
- "Quais são minhas 10 principais organizações por receita recorrente?"
- "Mostre-me todas as assinaturas canceladas recentemente."
- "Listar todas as ofertas de produtos que incluem um SKU Copilot."
Actions
- "Faça um pedido para 5 lugares de Microsoft 365 Business Premium para a organização Contoso."
- "Valide uma cotação para 10 lugares de Azure Plano para a organização Fabrikam."
- "Reduza a quantidade de assentos Exchange Online para a organização Contoso de 20 para 15."
Problemas e limitações conhecidos
- Profundidade da consulta GraphQL: consultas GraphQL muito profundamente aninhadas podem ter um tempo limite. Se uma consulta atingir o tempo limite, simplifique-a reduzindo a profundidade de aninhamento ou o número de campos solicitados.
-
Paginação necessária: listar consultas (
QueryOrganizations,QuerySubscriptionsetc.) exige argumentos de paginação (after/firstou).last/beforeConsultas sem paginação retornarão um erro. -
Escopos: verifique se ambos
mcp:toolseservice-providerestão incluídos nos escopos do OAuth ao criar sua chave de API; a falta de qualquer escopo resultará em erros de autenticação.
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | 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.
Essa não é uma conexão compartilhável. Se o aplicativo de energia 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 | Insira a ID do cliente emitida para este revendedor. | True |
| Segredo do cliente do revendedor | secureString | Insira o Segredo do Cliente emitido para este revendedor. | True |
Ações
| Alterar quantidades de assinatura |
Altere as quantidades de assinatura. |
| Cancelar assinaturas de uma organização |
Cancelar assinaturas de uma organização. |
| Configurar uma plataforma para um cliente |
Configure uma plataforma para um cliente. |
| Consultar assinaturas usando o GraphQL |
Consultar assinaturas usando o GraphQL. |
| Consultar consumos da organização usando o GraphQL |
Consultar os consumos da organização usando o GraphQL. |
| Consultar itens do catálogo usando o GraphQL |
Consultar itens do catálogo usando o GraphQL. |
| Consultar logs de auditoria usando o GraphQL |
Consultar logs de auditoria usando o GraphQL. |
| Consultar organizações usando o GraphQL |
Consultar organizações usando o GraphQL. |
| Fazer um pedido para um cliente |
Faça um pedido para um cliente. |
| Obter o esquema GraphQL no formato SDL |
Obtenha o esquema GraphQL no formato SDL. |
| Obter SKUs sherweb mapeados para ofertas de Microsoft Copilot |
Faça com que as SKUs do Sherweb são mapeadas para Microsoft Copilot ofertas. |
| Validar uma cotação sem fazer a ordem |
Valide uma aspa sem fazer a ordem. |
Alterar quantidades de assinatura
Altere as quantidades de assinatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da organização
|
organizationId | True | uuid | |
|
subscriptionId
|
subscriptionId | True | uuid | |
|
newQuantity
|
newQuantity | integer |
Retornos
- Corpo
- SubscriptionsAmendment
Cancelar assinaturas de uma organização
Cancelar assinaturas de uma organização.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da organização
|
organizationId | True | uuid | |
|
subscriptionIds
|
subscriptionIds | True | array of uuid |
Retornos
Configurar uma plataforma para um cliente
Configure uma plataforma para um cliente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
customerId
|
customerId | True | uuid | |
|
platformId
|
platformId | True | uuid | |
|
identificador
|
identifier | True | string | |
|
value
|
value | string |
Retornos
- response
- string
Consultar assinaturas usando o GraphQL
Consultar assinaturas usando o GraphQL.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
graphqlQuery
|
graphqlQuery | True | string |
Retornos
Tipo de conexão genérica para paginação baseada em cursor, "T"O tipo de itens na conexão
Consultar consumos da organização usando o GraphQL
Consultar os consumos da organização usando o GraphQL.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
graphqlQuery
|
graphqlQuery | True | string |
Retornos
Tipo de conexão genérica para paginação baseada em cursor, "T"O tipo de itens na conexão
Consultar itens do catálogo usando o GraphQL
Consultar itens do catálogo usando o GraphQL.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
graphqlQuery
|
graphqlQuery | True | string |
Retornos
Tipo de conexão genérica para paginação baseada em cursor, "T"O tipo de itens na conexão
Consultar logs de auditoria usando o GraphQL
Consultar logs de auditoria usando o GraphQL.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
graphqlQuery
|
graphqlQuery | True | string |
Retornos
Tipo de conexão genérica para paginação baseada em cursor, "T"O tipo de itens na conexão
Consultar organizações usando o GraphQL
Consultar organizações usando o GraphQL.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
graphqlQuery
|
graphqlQuery | True | string |
Retornos
Tipo de conexão genérica para paginação baseada em cursor, "T"O tipo de itens na conexão
Fazer um pedido para um cliente
Faça um pedido para um cliente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
customerId
|
customerId | True | uuid | |
|
sku
|
sku | True | string | |
|
quantidade
|
quantity | integer | ||
|
purchaseOrderNumber
|
purchaseOrderNumber | string | ||
|
orderedBy
|
orderedBy | True | string |
Retornos
- Corpo
- PlaceOrderResponse
Obter o esquema GraphQL no formato SDL
Obter SKUs sherweb mapeados para ofertas de Microsoft Copilot
Faça com que as SKUs do Sherweb são mapeadas para Microsoft Copilot ofertas.
Retornos
- response
- array of SkuDetail
Validar uma cotação sem fazer a ordem
Valide uma aspa sem fazer a ordem.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
customerId
|
customerId | True | uuid | |
|
sku
|
sku | True | string | |
|
quantidade
|
quantity | integer | ||
|
purchaseOrderNumber
|
purchaseOrderNumber | string | ||
|
orderedBy
|
orderedBy | True | string |
Retornos
- Corpo
- ValidateOrderResult
Definições
Opção
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
parameterChoiceValue
|
parameterChoiceValue | string | |
|
parameterChoiceDisplayName
|
parameterChoiceDisplayName | string |
ConnectionOfProjectedAuditLog
Tipo de conexão genérica para paginação baseada em cursor, "T"O tipo de itens na conexão
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Bordas
|
edges | array of EdgeOfProjectedAuditLog |
A lista de bordas nesta página. Cada borda contém o nó e seu cursor. |
|
nodes
|
nodes | array of ProjectedAuditLog |
Uma lista nivelada dos nós nesta página (sem metadados do cursor). |
|
contagem total
|
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. |
ConnectionOfProjectedCatalogItem
Tipo de conexão genérica para paginação baseada em cursor, "T"O tipo de itens na conexão
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Bordas
|
edges | array of EdgeOfProjectedCatalogItem |
A lista de bordas nesta página. Cada borda contém o nó e seu cursor. |
|
nodes
|
nodes | array of ProjectedCatalogItem |
Uma lista nivelada dos nós nesta página (sem metadados do cursor). |
|
contagem total
|
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. |
ConnectionOfProjectedConsumptionItem
Tipo de conexão genérica para paginação baseada em cursor, "T"O tipo de itens na conexão
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Bordas
|
edges | array of EdgeOfProjectedConsumptionItem |
A lista de bordas nesta página. Cada borda contém o nó e seu cursor. |
|
nodes
|
nodes | array of ProjectedConsumptionItem |
Uma lista nivelada dos nós nesta página (sem metadados do cursor). |
|
contagem total
|
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. |
ConnectionOfProjectedOrganization
Tipo de conexão genérica para paginação baseada em cursor, "T"O tipo de itens na conexão
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Bordas
|
edges | array of EdgeOfProjectedOrganization |
A lista de bordas nesta página. Cada borda contém o nó e seu cursor. |
|
nodes
|
nodes | array of ProjectedOrganization |
Uma lista nivelada dos nós nesta página (sem metadados do cursor). |
|
contagem total
|
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. |
ConnectionOfProjectedSubscription
Tipo de conexão genérica para paginação baseada em cursor, "T"O tipo de itens na conexão
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Bordas
|
edges | array of EdgeOfProjectedSubscription |
A lista de bordas nesta página. Cada borda contém o nó e seu cursor. |
|
nodes
|
nodes | array of ProjectedSubscription |
Uma lista nivelada dos nós nesta página (sem metadados do cursor). |
|
contagem total
|
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 borda em uma conexão paginada baseada em cursor, contendo o nó e seu cursor.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nó
|
node | ProjectedAuditLog | |
|
cursor
|
cursor | string |
O cursor para essa borda, usado para paginação baseada em cursor. |
EdgeOfProjectedCatalogItem
Uma borda em uma conexão paginada baseada em cursor, contendo o nó e seu cursor.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nó
|
node | ProjectedCatalogItem | |
|
cursor
|
cursor | string |
O cursor para essa borda, usado para paginação baseada em cursor. |
EdgeOfProjectedConsumptionItem
Uma borda em uma conexão paginada baseada em cursor, contendo o nó e seu cursor.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nó
|
node | ProjectedConsumptionItem | |
|
cursor
|
cursor | string |
O cursor para essa borda, usado para paginação baseada em cursor. |
EdgeOfProjectedOrganization
Uma borda em uma conexão paginada baseada em cursor, contendo o nó e seu cursor.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nó
|
node | ProjectedOrganization | |
|
cursor
|
cursor | string |
O cursor para essa borda, usado para paginação baseada em cursor. |
EdgeOfProjectedSubscription
Uma borda em uma conexão paginada baseada em cursor, contendo o nó e seu cursor.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nó
|
node | ProjectedSubscription | |
|
cursor
|
cursor | string |
O cursor para essa borda, usado para paginação baseada em cursor. |
EventSource
InvoiceMetrics
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
periodRange
|
periodRange | InvoicePeriodRange | |
|
accumulatedRecurringCost
|
accumulatedRecurringCost | double |
O(1) |
|
invoiceCount
|
invoiceCount | integer |
O(1) |
|
compoundMonthlyCostGrowthRate
|
compoundMonthlyCostGrowthRate | double |
O(1) |
|
costConcentrationRatio
|
costConcentrationRatio | double |
O(1) |
|
costVolatility
|
costVolatility | double |
O(1) |
InvoicePeriodRange
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
from
|
from | date |
O(1) |
|
para
|
to | date |
O(1) |
PageInfo
Metadados de paginação para navegação baseada em cursor.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
hasNextPage
|
hasNextPage | boolean | |
|
hasPreviousPage
|
hasPreviousPage | boolean | |
|
startCursor
|
startCursor | string | |
|
endCursor
|
endCursor | string |
PlaceOrderResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
requestTrackingId
|
requestTrackingId | uuid | |
|
subscriptionIds
|
subscriptionIds | array of uuid |
PlatformRequiredParameter
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
parameterDescription
|
parameterDescription | string | |
|
parameterIdentifier
|
parameterIdentifier | string | |
|
parameterDefaultValue
|
parameterDefaultValue | string | |
|
parameterFormatType
|
parameterFormatType | string | |
|
parameterFormatPattern
|
parameterFormatPattern | string | |
|
parameterFormatChoices
|
parameterFormatChoices | array of Choice |
ProjectedAuditLog
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer | |
|
targetName
|
targetName | string | |
|
ação
|
action | string | |
|
date
|
date | date-time | |
|
userDisplayName
|
userDisplayName | string | |
|
categoryName
|
categoryName | string | |
|
description
|
description | string | |
|
details
|
details | array of ProjectedAuditLogDetail |
ProjectedAuditLogDetail
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
propertyName
|
propertyName | string | |
|
oldValue
|
oldValue | string | |
|
newValue
|
newValue | string |
ProjectedCatalogItem
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
sku
|
sku | string |
O(1) |
|
name
|
name | string |
O(1) |
|
description
|
description | string |
O(1) |
|
ciclo de faturamento
|
billingCycle | string |
O(1) |
|
commitmentTerm
|
commitmentTerm | string |
O(1) |
|
pricingInformation
|
pricingInformation | ProjectedPricingInformation | |
|
do Azure
|
platforms | array of ProjectedPlatforms |
Chamada extra de O(1) |
ProjectedCommitmentTerm
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
type | ProjectedCommitmentTermType | |
|
data de término
|
endDate | date-time | |
|
renewalConfiguration
|
renewalConfiguration | ProjectedRenewalConfiguration |
ProjectedCommitmentTermType
ProjectedConsumptionItem
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
produto
|
product | string |
O(1) |
|
vendorName
|
vendorName | string |
O(1) |
|
totalQuantities
|
totalQuantities | integer |
O(1) |
|
consumedQuantities
|
consumedQuantities | integer |
O(1) |
|
availableQuantities
|
availableQuantities | integer |
O(1) |
ProjectedCurrency
ProjectedFeesDto
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
recurringFee
|
recurringFee | ProjectedMoney | |
|
setupFee
|
setupFee | ProjectedMoney | |
|
costRecurringFee
|
costRecurringFee | ProjectedMoney | |
|
ciclo de faturamento
|
billingCycle | string |
ProjectedMoney
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
value
|
value | double | |
|
moeda
|
currency | ProjectedCurrency | |
|
arredondamento
|
rounding | integer |
ProjectedOrganization
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | uuid |
O(1) |
|
name
|
name | string |
O(1) |
|
Nome único
|
uniqueName | string |
O(1) |
|
ID do pai
|
parentId | uuid |
O(1) |
|
nome_pai
|
parentName | string |
O(1) |
|
suspendedOn
|
suspendedOn | date-time |
O(n) |
|
isSuspended
|
isSuspended | boolean |
O(1) |
|
está excluído
|
isDeleted | boolean |
O(1) |
|
estáAtivo
|
isActive | boolean |
O(n) |
|
daysSinceSuspension
|
daysSinceSuspension | integer |
O(n) |
|
totalSubscriptionCount
|
totalSubscriptionCount | integer |
O(n) |
|
uniqueSkus
|
uniqueSkus | array of string |
O(n) |
|
totalMonthlyRecurringFee
|
totalMonthlyRecurringFee | double |
O(n) |
|
totalMonthlyCostRecurringFee
|
totalMonthlyCostRecurringFee | double |
O(n) |
|
totalYearlyRecurringFee
|
totalYearlyRecurringFee | double |
O(n) |
|
totalYearlyCostRecurringFee
|
totalYearlyCostRecurringFee | double |
O(n) |
|
totalOtherRecurringFee
|
totalOtherRecurringFee | double |
O(n), agregação de taxas recorrentes com um Ciclo de cobrança diferente de mensal ou anual |
|
totalOtherCostRecurringFee
|
totalOtherCostRecurringFee | double |
O(n), agregação de taxas de custo recorrentes com um Ciclo de cobrança diferente de mensal ou anual |
|
invoiceMetrics
|
invoiceMetrics | InvoiceMetrics |
ProjectedPlatforms
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
platformId
|
platformId | uuid | |
|
requiredParameters
|
requiredParameters | array of PlatformRequiredParameter |
Chamada extra de O(1) |
ProjectedPricingInformation
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
recurringFee
|
recurringFee | double | |
|
setupFee
|
setupFee | double | |
|
moeda
|
currency | ProjectedCurrency | |
|
ciclo de faturamento
|
billingCycle | string |
ProjectedRenewalConfiguration
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
isConfigurable
|
isConfigurable | boolean | |
|
renewSettings
|
renewSettings | ProjectedRenewSettings |
ProjectedRenewSettings
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
renewalDate
|
renewalDate | date-time | |
|
scheduledQuantity
|
scheduledQuantity | integer | |
|
coTerminationEndDate
|
coTerminationEndDate | date-time |
ProjectedSubscription
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
subscriptionId
|
subscriptionId | uuid |
O(1) |
|
ID da organização
|
organizationId | uuid |
O(1) |
|
cancelledOn
|
cancelledOn | date-time |
O(n) |
|
estáAtivo
|
isActive | boolean |
O(n) |
|
daysSinceCreation
|
daysSinceCreation | integer |
O(n) |
|
createdOn
|
createdOn | date-time |
O(1) |
|
quantidade
|
quantity | integer |
O(1) |
|
commitmentTerm
|
commitmentTerm | ProjectedCommitmentTerm | |
|
daysUntilRenewal
|
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) |
|
lastRenewalDate
|
lastRenewalDate | date-time |
O(n) |
|
taxas
|
fees | ProjectedFeesDto | |
|
productName
|
productName | string |
O(1) |
|
isCoterminated
|
isCoterminated | boolean |
O(n) |
|
histórico
|
history | array of SubscriptionHistoryEvent |
O(n) |
RenewedTermEndDateDetail
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
previousDate
|
previousDate | date | |
|
newDate
|
newDate | date |
RenewedTermStartDateDetail
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
previousDate
|
previousDate | date | |
|
newDate
|
newDate | date |
SkuDetail
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
sku
|
sku | string | |
|
skuName
|
skuName | string |
SubscriptionHistoryEvent
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
createdOn
|
createdOn | date-time | |
|
númeroDeLicenças
|
licenseCount | integer | |
|
sku
|
sku | string | |
|
nome da oferta
|
offerName | string | |
|
usuário
|
user | string | |
|
coTerminationDate
|
coTerminationDate | string | |
|
eventSource
|
eventSource | EventSource | |
|
termEndDateDetail
|
termEndDateDetail | RenewedTermEndDateDetail | |
|
termStartDateDetail
|
termStartDateDetail | RenewedTermStartDateDetail |
SubscriptionsAmendment
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
subscriptionsAmendmentId
|
subscriptionsAmendmentId | uuid | |
|
trackingId
|
trackingId | TrackingId |
SubscriptionsCancellation
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
subscriptionsCancellationId
|
subscriptionsCancellationId | uuid | |
|
trackingId
|
trackingId | TrackingId |
TrackingId
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
requestTrackingId
|
requestTrackingId | uuid |
ValidateOrderLineItem
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Número da linha
|
lineNumber | integer | |
|
sku
|
sku | string | |
|
name
|
name | string | |
|
ciclo de faturamento
|
billingCycle | string | |
|
commitmentTerm
|
commitmentTerm | string | |
|
quantidade
|
quantity | integer | |
|
preço unitário
|
unitPrice | double | |
|
preço estendido
|
extendedPrice | double | |
|
moeda
|
currency | string |
ValidateOrderResult
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
mensagem
|
message | string | |
|
lineItems
|
lineItems | array of ValidateOrderLineItem | |
|
Subtotal
|
subtotal | double | |
|
moeda
|
currency | string |
cadeia
Esse é o tipo de dados básico 'string'.