Sherweb Platform MCP Server (préversion)
Le serveur Sherweb Cumulus MCP offre aux assistants IA un accès sécurisé à Cumulus via le protocole de contexte du modèle. Les partenaires MSP autorisés peuvent utiliser le langage naturel pour récupérer des organisations, des abonnements, des catalogues, des données de facturation et d’audit, les combiner en réponses utiles et effectuer des opérations prises en charge, telles que le passage de commandes et la modification des abonnements, au sein de leurs autorisations Cumulus.
Ce connecteur est disponible dans les produits et régions suivants :
| Service | Classe | Régions |
|---|---|---|
| Copilot Studio | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Applications logiques | Standard | Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - Régions Azure Chine - Us Department of Defense (DoD) |
| Power Apps | Premium | Toutes les régions Power Apps , à l’exception des suivantes : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Sherweb Support |
| URL | https://www.sherweb.com |
| Courriel | support@sherweb.com |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | IA de Sherweb |
| Website | https://www.sherweb.com |
| Politique de confidentialité | https://www.sherweb.com/legal/privacy-policy/ |
| Categories | Opérations informatiques ; Gestion de l’entreprise |
Sherweb Cumulus
Sherweb est un fournisseur de solutions cloud qui permet aux fournisseurs de services managés (MSPs) de gérer leurs clients, abonnements, facturation et catalogue via la plateforme Cumulus . Le connecteur Cumulus MCP (Model Context Protocol) expose vos données Cumulus directement aux assistants IA, tels que les agents Microsoft Copilot Studio, afin de pouvoir interroger et agir sur votre activité MSP en langage naturel.
Avec ce connecteur, vous pouvez poser vos questions d’assistant IA comme suit :
- « Répertorier tous les abonnements pour le renouvellement au cours des 60 prochains jours. »
- « Laquelle de mes organisations n’a pas de produit de sauvegarde ? »
- « Quelles sont mes 10 principales organisations par revenus récurrents ? »
- « Passer une commande pour l’organisation Contoso ».
Prerequisites
- Un compte Cumulus actif avec le rôle Fournisseur de services .
- Clé API Cumulus spécifique au revendeur avec les étendues et
service-providerlesmcp:toolsétendues. - Environnement Microsoft Power Platform où la solution sherweb Platform connector est installée.
Création d’informations d’identification de revendeur
Chaque revendeur utilise ses propres informations d’identification client OAuth existantes lors de la création d’une connexion de connecteur ; ce flux n’utilise pas l’inscription dynamique du client (DCR) ou un ID client partagé et une clé secrète client.
https://helpdesk.sherweb.com/en-us/knowledge-base/articles/KA-05021
- Connectez-vous à Cumulus.
- Accédez aux paramètres de la plateforme → API.
- Créez une clé API distincte pour le revendeur ou sélectionnez la clé existante de ce revendeur.
- Vérifiez que la clé a les étendues et
service-providerlesmcp:toolsétendues. Copiez son ID client et sa clé secrète client ; le secret est affiché uniquement lors de la création. - Ajoutez l’URI de redirection affiché pour le connecteur Sherweb Platform installé à la clé API.
Points de terminaison OAuth
| Champ | Value |
|---|---|
| URL d’autorisation | https://cumulus.sherweb.com/oidc/connect/authorize |
| URL du jeton | https://cumulus.sherweb.com/oidc/connect/token |
| Actualiser l’URL | https://cumulus.sherweb.com/oidc/connect/token |
| Étendues | mcp:tools service-provider |
Création d’une connexion
https://helpdesk.sherweb.com/en-us/knowledge-base/articles/KA-05021
- Dans Power Platform, sélectionnez le connecteur Sherweb Platform installé et créez une connexion.
- Entrez l’ID client et la clé secrète client du revendeur lorsque vous y êtes invité. Ces informations d’identification sont stockées en toute sécurité par la connexion et sont utilisées pour l’autorisation OAuth et l’actualisation des jetons de ce revendeur.
- Connectez-vous à Cumulus avec un compte d’utilisateur autorisé pour ce revendeur.
- Si la connexion ne peut pas terminer l’autorisation, vérifiez que l’URI de redirection du connecteur est inscrit sur la clé API de ce revendeur et que les deux étendues requises sont activées.
Créez une connexion distincte pour chaque revendeur. L’ID client et la clé secrète client identifient l’application OAuth du revendeur ; la connexion interactive détermine le compte d’utilisateur autorisé à utiliser la connexion.
Le renouvellement du jeton utilise l’octroi de jeton d’actualisation OAuth et les informations d’identification fournies pour cette connexion, au lieu de répéter l’échange de code d’autorisation.
Pour les clients MCP directs (plutôt que le connecteur Power Platform certifié), configurez OAuth sur https://mcp.sherweb.com l’utilisation des points de terminaison et des étendues ci-dessus. La configuration directe de l’authentification du client MCP est distincte des champs d’informations d’identification spécifiques au revendeur dans le connecteur Power Platform.
Opérations prises en charge
outils Read-Only
| Outil | Description |
|---|---|
QueryOrganizations |
Interrogez les organisations gérées par le fournisseur de services à l’aide de GraphQL. |
QuerySubscriptions |
Interroger des abonnements entre les organisations à l’aide de GraphQL. |
QueryOrganizationConsumptions |
Interroger les données de consommation (utilisation et frais) pour les organisations utilisant GraphQL. |
QueryCatalog |
Interrogez le catalogue de produits disponible pour le fournisseur de services à l’aide de GraphQL. |
QueryAuditLogs |
Interrogez le journal d’audit des actions effectuées sur la plateforme à l’aide de GraphQL. |
GetGraphQLSchema |
Récupérez le schéma GraphQL complet pour vous aider à construire des requêtes valides. |
GetCopilotSkus |
Obtenez la liste des références SKU Sherweb pour les offres Microsoft Copilot. |
Outils d’écriture
Remarque : Les opérations d’écriture nécessitent les autorisations appropriées sur le compte Cumulus authentifié.
| Outil | Description |
|---|---|
PlaceOrder |
Placez une commande de produit pour une organisation cliente. |
ValidateQuote |
Validez une commande proposée et obtenez les détails des tarifs sans passer la commande. |
CreateSubscriptionsAmendment |
Modifiez la quantité de sièges ou de licences sur un ou plusieurs abonnements existants. |
CancelSubscriptions |
Annulez un ou plusieurs abonnements pour une organisation cliente. |
ConfigurePlatform |
Configurez une plateforme (par exemple, Microsoft 365 locataire) pour un client. |
Exemples d’invites
Voici des exemples d’invites en langage naturel que vous pouvez utiliser avec un assistant IA connecté à ce serveur MCP :
Renouvellements et facturation
- « Répertorier tous les abonnements pour le renouvellement au cours des 60 prochains jours. »
- « Donnez-moi une répartition de tous les frais pour l’organisation Contoso au cours des 3 derniers mois. »
- « Quels abonnements expirent dans les 30 jours au sein de toutes les organisations ? »
Inventaire et portefeuille
- « Laquelle de mes organisations n’a pas de produit de sauvegarde ? »
- « Quelles sont mes 10 principales organisations par revenus récurrents ? »
- « Afficher tous les abonnements récemment annulés ».
- « Répertorier toutes les offres de produits qui incluent une référence SKU Copilot. »
Actions
- « Passer une commande pour 5 sièges de Microsoft 365 Business Premium pour l’organisation Contoso . »
- « Valider une citation pour 10 sièges de Azure Plan pour l’organisation Fabrikam. »
- « Réduisez la quantité de sièges Exchange Online pour l’organisation Contoso de 20 à 15. »
Problèmes connus et limitations
- Profondeur de requête GraphQL : Les requêtes GraphQL imbriquées très profondément peuvent expirer. Si une requête expire, simplifiez-la en réduisant la profondeur d’imbrication ou le nombre de champs demandés.
-
Pagination requise : les requêtes de liste (
QueryOrganizations,QuerySubscriptionsetc.) nécessitent des arguments de pagination (after/firstou).last/beforeLes requêtes sans pagination retournent une erreur. -
Étendues : assurez-vous que les étendues
mcp:toolsOAuth sont inclusesservice-providerdans les étendues OAuth lors de la création de votre clé API ; l’une ou l’autre étendue entraîne des erreurs d’authentification.
Création d’une connexion
Le connecteur prend en charge les types d’authentification suivants :
| Par défaut | Paramètres de création de connexion. | Toutes les régions | Non partageable |
Faire défaut
Applicable : Toutes les régions
Paramètres de création de connexion.
Cette connexion n’est pas partageable. Si l’application Power est partagée avec un autre utilisateur, un autre utilisateur sera invité à créer explicitement une nouvelle connexion.
| Name | Type | Description | Required |
|---|---|---|---|
| ID client revendeur | string | Entrez l’ID client émis pour ce revendeur. | True |
| Clé secrète client de revendeur | Securestring | Entrez le secret client émis pour ce revendeur. | True |
Actions
| Annuler des abonnements pour une organisation |
Annulez les abonnements pour une organisation. |
| Configurer une plateforme pour un client |
Configurez une plateforme pour un client. |
| Interroger des abonnements à l’aide de GraphQL |
Interroger des abonnements à l’aide de GraphQL. |
| Interroger des journaux d’audit à l’aide de GraphQL |
Interroger des journaux d’audit à l’aide de GraphQL. |
| Interroger des organisations à l’aide de GraphQL |
Interroger des organisations à l’aide de GraphQL. |
| Interroger des éléments de catalogue à l’aide de GraphQL |
Interroger des éléments de catalogue à l’aide de GraphQL. |
| Interroger les consommations de l’organisation à l’aide de GraphQL |
Interroger les consommations de l’organisation à l’aide de GraphQL. |
| Modifier les quantités d’abonnement |
Modifiez les quantités d’abonnement. |
| Obtenir des références SKU Sherweb mappées aux offres Microsoft Copilot |
Obtenez des références SKU Sherweb mappées aux offres Microsoft Copilot. |
| Obtenir le schéma GraphQL au format SDL |
Obtenez le schéma GraphQL au format SDL. |
| Passer une commande pour un client |
Passez une commande pour un client. |
| Valider un devis sans passer la commande |
Validez un devis sans passer la commande. |
Annuler des abonnements pour une organisation
Annulez les abonnements pour une organisation.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
organizationId
|
organizationId | True | uuid | |
|
subscriptionIds
|
subscriptionIds | True | array of uuid |
Retours
Configurer une plateforme pour un client
Configurez une plateforme pour un client.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
customerId
|
customerId | True | uuid | |
|
platformId
|
platformId | True | uuid | |
|
identifiant
|
identifier | True | string | |
|
value
|
value | string |
Retours
- response
- string
Interroger des abonnements à l’aide de GraphQL
Interroger des abonnements à l’aide de GraphQL.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
graphqlQuery
|
graphqlQuery | True | string |
Retours
Type de connexion générique pour la pagination basée sur le curseur, « T » Type d’éléments dans la connexion
Interroger des journaux d’audit à l’aide de GraphQL
Interroger des journaux d’audit à l’aide de GraphQL.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
graphqlQuery
|
graphqlQuery | True | string |
Retours
Type de connexion générique pour la pagination basée sur le curseur, « T » Type d’éléments dans la connexion
Interroger des organisations à l’aide de GraphQL
Interroger des organisations à l’aide de GraphQL.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
graphqlQuery
|
graphqlQuery | True | string |
Retours
Type de connexion générique pour la pagination basée sur le curseur, « T » Type d’éléments dans la connexion
Interroger des éléments de catalogue à l’aide de GraphQL
Interroger des éléments de catalogue à l’aide de GraphQL.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
graphqlQuery
|
graphqlQuery | True | string |
Retours
Type de connexion générique pour la pagination basée sur le curseur, « T » Type d’éléments dans la connexion
Interroger les consommations de l’organisation à l’aide de GraphQL
Interroger les consommations de l’organisation à l’aide de GraphQL.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
graphqlQuery
|
graphqlQuery | True | string |
Retours
Type de connexion générique pour la pagination basée sur le curseur, « T » Type d’éléments dans la connexion
Modifier les quantités d’abonnement
Modifiez les quantités d’abonnement.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
organizationId
|
organizationId | True | uuid | |
|
subscriptionId
|
subscriptionId | True | uuid | |
|
newQuantity
|
newQuantity | integer |
Retours
Obtenir des références SKU Sherweb mappées aux offres Microsoft Copilot
Obtenez des références SKU Sherweb mappées aux offres Microsoft Copilot.
Retours
- response
- array of SkuDetail
Obtenir le schéma GraphQL au format SDL
Passer une commande pour un client
Passez une commande pour un client.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
customerId
|
customerId | True | uuid | |
|
sku
|
sku | True | string | |
|
quantité
|
quantity | integer | ||
|
purchaseOrderNumber
|
purchaseOrderNumber | string | ||
|
orderBy
|
orderedBy | True | string |
Retours
- Body
- PlaceOrderResponse
Valider un devis sans passer la commande
Validez un devis sans passer la commande.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
customerId
|
customerId | True | uuid | |
|
sku
|
sku | True | string | |
|
quantité
|
quantity | integer | ||
|
purchaseOrderNumber
|
purchaseOrderNumber | string | ||
|
orderBy
|
orderedBy | True | string |
Retours
- Body
- ValidateOrderResult
Définitions
Choix
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
parameterChoiceValue
|
parameterChoiceValue | string | |
|
parameterChoiceDisplayName
|
parameterChoiceDisplayName | string |
ConnectionOfProjectedAuditLog
Type de connexion générique pour la pagination basée sur le curseur, « T » Type d’éléments dans la connexion
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Arêtes
|
edges | array of EdgeOfProjectedAuditLog |
Liste des bords de cette page. Chaque bord contient le nœud et son curseur. |
|
nodes
|
nodes | array of ProjectedAuditLog |
Liste aplatir les nœuds de cette page (sans métadonnées de curseur). |
|
nombre total
|
totalCount | integer |
Nombre total d’éléments sur toutes les pages (lorsque demandé) |
|
pageInfo
|
pageInfo | PageInfo |
Métadonnées de pagination pour la navigation basée sur le curseur. |
ConnectionOfProjectedCatalogItem
Type de connexion générique pour la pagination basée sur le curseur, « T » Type d’éléments dans la connexion
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Arêtes
|
edges | array of EdgeOfProjectedCatalogItem |
Liste des bords de cette page. Chaque bord contient le nœud et son curseur. |
|
nodes
|
nodes | array of ProjectedCatalogItem |
Liste aplatir les nœuds de cette page (sans métadonnées de curseur). |
|
nombre total
|
totalCount | integer |
Nombre total d’éléments sur toutes les pages (lorsque demandé) |
|
pageInfo
|
pageInfo | PageInfo |
Métadonnées de pagination pour la navigation basée sur le curseur. |
ConnectionOfProjectedConsumptionItem
Type de connexion générique pour la pagination basée sur le curseur, « T » Type d’éléments dans la connexion
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Arêtes
|
edges | array of EdgeOfProjectedConsumptionItem |
Liste des bords de cette page. Chaque bord contient le nœud et son curseur. |
|
nodes
|
nodes | array of ProjectedConsumptionItem |
Liste aplatir les nœuds de cette page (sans métadonnées de curseur). |
|
nombre total
|
totalCount | integer |
Nombre total d’éléments sur toutes les pages (lorsque demandé) |
|
pageInfo
|
pageInfo | PageInfo |
Métadonnées de pagination pour la navigation basée sur le curseur. |
ConnectionOfProjectedOrganization
Type de connexion générique pour la pagination basée sur le curseur, « T » Type d’éléments dans la connexion
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Arêtes
|
edges | array of EdgeOfProjectedOrganization |
Liste des bords de cette page. Chaque bord contient le nœud et son curseur. |
|
nodes
|
nodes | array of ProjectedOrganization |
Liste aplatir les nœuds de cette page (sans métadonnées de curseur). |
|
nombre total
|
totalCount | integer |
Nombre total d’éléments sur toutes les pages (lorsque demandé) |
|
pageInfo
|
pageInfo | PageInfo |
Métadonnées de pagination pour la navigation basée sur le curseur. |
ConnectionOfProjectedSubscription
Type de connexion générique pour la pagination basée sur le curseur, « T » Type d’éléments dans la connexion
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Arêtes
|
edges | array of EdgeOfProjectedSubscription |
Liste des bords de cette page. Chaque bord contient le nœud et son curseur. |
|
nodes
|
nodes | array of ProjectedSubscription |
Liste aplatir les nœuds de cette page (sans métadonnées de curseur). |
|
nombre total
|
totalCount | integer |
Nombre total d’éléments sur toutes les pages (lorsque demandé) |
|
pageInfo
|
pageInfo | PageInfo |
Métadonnées de pagination pour la navigation basée sur le curseur. |
EdgeOfProjectedAuditLog
Bord d’une connexion paginé basée sur un curseur, contenant le nœud et son curseur.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
node
|
node | ProjectedAuditLog | |
|
curseur
|
cursor | string |
Curseur de ce bord, utilisé pour la pagination basée sur le curseur. |
EdgeOfProjectedCatalogItem
Bord d’une connexion paginé basée sur un curseur, contenant le nœud et son curseur.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
node
|
node | ProjectedCatalogItem | |
|
curseur
|
cursor | string |
Curseur de ce bord, utilisé pour la pagination basée sur le curseur. |
EdgeOfProjectedConsumptionItem
Bord d’une connexion paginé basée sur un curseur, contenant le nœud et son curseur.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
node
|
node | ProjectedConsumptionItem | |
|
curseur
|
cursor | string |
Curseur de ce bord, utilisé pour la pagination basée sur le curseur. |
EdgeOfProjectedOrganization
Bord d’une connexion paginé basée sur un curseur, contenant le nœud et son curseur.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
node
|
node | ProjectedOrganization | |
|
curseur
|
cursor | string |
Curseur de ce bord, utilisé pour la pagination basée sur le curseur. |
EdgeOfProjectedSubscription
Bord d’une connexion paginé basée sur un curseur, contenant le nœud et son curseur.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
node
|
node | ProjectedSubscription | |
|
curseur
|
cursor | string |
Curseur de ce bord, utilisé pour la pagination basée sur le curseur. |
EventSource
InvoiceMetrics
| Nom | Chemin d’accès | Type | 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
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
from
|
from | date |
O(1) |
|
to
|
to | date |
O(1) |
PageInfo
Métadonnées de pagination pour la navigation basée sur le curseur.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
hasNextPage
|
hasNextPage | boolean | |
|
hasPreviousPage
|
hasPreviousPage | boolean | |
|
startCursor
|
startCursor | string | |
|
endCursor
|
endCursor | string |
PlaceOrderResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
requestTrackingId
|
requestTrackingId | uuid | |
|
subscriptionIds
|
subscriptionIds | array of uuid |
PlatformRequiredParameter
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
parameterDescription
|
parameterDescription | string | |
|
parameterIdentifier
|
parameterIdentifier | string | |
|
parameterDefaultValue
|
parameterDefaultValue | string | |
|
parameterFormatType
|
parameterFormatType | string | |
|
parameterFormatPattern
|
parameterFormatPattern | string | |
|
parameterFormatChoices
|
parameterFormatChoices | array of Choice |
ProjectedAuditLog
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
targetName
|
targetName | string | |
|
action
|
action | string | |
|
date
|
date | date-time | |
|
userDisplayName
|
userDisplayName | string | |
|
categoryName
|
categoryName | string | |
|
description
|
description | string | |
|
details
|
details | array of ProjectedAuditLogDetail |
ProjectedAuditLogDetail
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
propertyName
|
propertyName | string | |
|
oldValue
|
oldValue | string | |
|
newValue
|
newValue | string |
ProjectedCatalogItem
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
sku
|
sku | string |
O(1) |
|
name
|
name | string |
O(1) |
|
description
|
description | string |
O(1) |
|
billingCycle
|
billingCycle | string |
O(1) |
|
engagementTerm
|
commitmentTerm | string |
O(1) |
|
pricingInformation
|
pricingInformation | ProjectedPricingInformation | |
|
plateformes de l’appareil
|
platforms | array of ProjectedPlatforms |
Appel supplémentaire O(1) |
ProjectedCommitmentTerm
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
type
|
type | ProjectedCommitmentTermType | |
|
date de fin
|
endDate | date-time | |
|
renewalConfiguration
|
renewalConfiguration | ProjectedRenewalConfiguration |
ProjectedCommitmentTermType
ProjectedConsumptionItem
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
product
|
product | string |
O(1) |
|
vendorName
|
vendorName | string |
O(1) |
|
totalQuantities
|
totalQuantities | integer |
O(1) |
|
consumeQuantities
|
consumedQuantities | integer |
O(1) |
|
availableQuantities
|
availableQuantities | integer |
O(1) |
ProjectedCurrency
ProjectedFeesDto
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
périodiqueFee
|
recurringFee | ProjectedMoney | |
|
setupFee
|
setupFee | ProjectedMoney | |
|
costRecurringFee
|
costRecurringFee | ProjectedMoney | |
|
billingCycle
|
billingCycle | string |
ProjectedMoney
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
value
|
value | double | |
|
currency
|
currency | ProjectedCurrency | |
|
arrondi
|
rounding | integer |
ProjectedOrganization
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
id
|
id | uuid |
O(1) |
|
name
|
name | string |
O(1) |
|
uniqueName
|
uniqueName | string |
O(1) |
|
parentId
|
parentId | uuid |
O(1) |
|
nom_parent
|
parentName | string |
O(1) |
|
suspendedOn
|
suspendedOn | date-time |
O(n) |
|
isSuspended
|
isSuspended | boolean |
O(1) |
|
estSupprimé
|
isDeleted | boolean |
O(1) |
|
estActif
|
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), Agrégation des frais récurrents avec un cycle de facturation autre que mensuel ou annuel |
|
totalOtherCostRecurringFee
|
totalOtherCostRecurringFee | double |
O(n), Agrégation des frais récurrents avec un cycle de facturation autre que mensuel ou annuel |
|
invoiceMetrics
|
invoiceMetrics | InvoiceMetrics |
ProjectedPlatforms
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
platformId
|
platformId | uuid | |
|
requiredParameters
|
requiredParameters | array of PlatformRequiredParameter |
Appel supplémentaire O(1) |
ProjectedPricingInformation
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
périodiqueFee
|
recurringFee | double | |
|
setupFee
|
setupFee | double | |
|
currency
|
currency | ProjectedCurrency | |
|
billingCycle
|
billingCycle | string |
ProjectedRenewalConfiguration
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
isConfigurable
|
isConfigurable | boolean | |
|
renewSettings
|
renewSettings | ProjectedRenewSettings |
ProjectedRenewSettings
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
renewalDate
|
renewalDate | date-time | |
|
scheduledQuantity
|
scheduledQuantity | integer | |
|
coTerminationEndDate
|
coTerminationEndDate | date-time |
ProjectedSubscription
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
subscriptionId
|
subscriptionId | uuid |
O(1) |
|
organizationId
|
organizationId | uuid |
O(1) |
|
cancelledOn
|
cancelledOn | date-time |
O(n) |
|
estActif
|
isActive | boolean |
O(n) |
|
daysSinceCreation
|
daysSinceCreation | integer |
O(n) |
|
createdOn
|
createdOn | date-time |
O(1) |
|
quantité
|
quantity | integer |
O(1) |
|
engagementTerm
|
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) |
|
frais
|
fees | ProjectedFeesDto | |
|
productName
|
productName | string |
O(1) |
|
isCoterminated
|
isCoterminated | boolean |
O(n) |
|
history
|
history | array of SubscriptionHistoryEvent |
O(n) |
RenewedTermEndDateDetail
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
previousDate
|
previousDate | date | |
|
newDate
|
newDate | date |
RenewedTermStartDateDetail
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
previousDate
|
previousDate | date | |
|
newDate
|
newDate | date |
SkuDetail
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
sku
|
sku | string | |
|
skuName
|
skuName | string |
SubscriptionHistoryEvent
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
createdOn
|
createdOn | date-time | |
|
nombreDeLicences
|
licenseCount | integer | |
|
sku
|
sku | string | |
|
offerName
|
offerName | string | |
|
user
|
user | string | |
|
coTerminationDate
|
coTerminationDate | string | |
|
eventSource
|
eventSource | EventSource | |
|
termEndDateDetail
|
termEndDateDetail | RenewedTermEndDateDetail | |
|
termStartDateDetail
|
termStartDateDetail | RenewedTermStartDateDetail |
SubscriptionsAmendment
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
subscriptionsAmendmentId
|
subscriptionsAmendmentId | uuid | |
|
trackingId
|
trackingId | TrackingId |
SubscriptionsCancellation
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
subscriptionsCancellationId
|
subscriptionsCancellationId | uuid | |
|
trackingId
|
trackingId | TrackingId |
TrackingId
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
requestTrackingId
|
requestTrackingId | uuid |
ValidateOrderLineItem
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
numéro de ligne
|
lineNumber | integer | |
|
sku
|
sku | string | |
|
name
|
name | string | |
|
billingCycle
|
billingCycle | string | |
|
engagementTerm
|
commitmentTerm | string | |
|
quantité
|
quantity | integer | |
|
prix unitaire
|
unitPrice | double | |
|
extendedPrice
|
extendedPrice | double | |
|
currency
|
currency | string |
ValidateOrderResult
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
message
|
message | string | |
|
lineItems
|
lineItems | array of ValidateOrderLineItem | |
|
Sous-total
|
subtotal | double | |
|
currency
|
currency | string |
string
Il s’agit du type de données de base « string ».