Sherweb Platform MCP Server (preview)
Sherweb Cumulus MCP-server biedt AI-assistenten beveiligde toegang tot Cumulus via het Model Context Protocol. Geautoriseerde MSP-partners kunnen natuurlijke taal gebruiken om organisaties, abonnementen, catalogus, facturerings- en controlegegevens op te halen, deze te combineren tot nuttige antwoorden en ondersteunde bewerkingen uit te voeren, zoals het plaatsen van orders en het wijzigen van abonnementen, binnen hun Cumulus-machtigingen.
Deze connector is beschikbaar in de volgende producten en regio's:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate regio's behalve: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Logische apps | Standard | Alle Logic Apps-regio's , met uitzondering van het volgende: - Azure Government regio's - Azure China-regio's - Us Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps regio's behalve: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate regio's behalve: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Ondersteuning voor Sherweb |
| URL | https://www.sherweb.com |
| E-mailadres | support@sherweb.com |
| Connectormetagegevens | |
|---|---|
| Publisher | AI van Sherweb |
| Website | https://www.sherweb.com |
| Privacybeleid | https://www.sherweb.com/legal/privacy-policy/ |
| Categories | IT-bewerkingen; Bedrijfsbeheer |
Sherweb Cumulus
Sherweb is een cloudoplossingsprovider waarmee Managed Service Providers (MSP's) hun klanten, abonnementen, facturering en catalogus kunnen beheren via het Cumulus-platform . De Cumulus MCP-connector (Model Context Protocol) toont uw Cumulus-gegevens rechtstreeks aan AI-assistenten, zoals Microsoft Copilot Studio agents, zodat u in natuurlijke taal query's kunt uitvoeren op uw MSP-bedrijf en erop kunt reageren.
Met deze connector kunt u vragen stellen voor uw AI-assistent, zoals:
- "Vermeld alle abonnementen voor verlenging in de komende 60 dagen."
- "Welke van mijn organisaties hebben geen back-upproduct?"
- "Wat zijn mijn tien belangrijkste organisaties door terugkerende omzet?"
- "Plaats een bestelling voor organisatie Contoso."
Prerequisites
- Een actief Cumulus-account met de rol Serviceprovider .
- Een resellerspecifieke Cumulus-API-sleutel met de
mcp:toolsenservice-providerbereiken. - Een Microsoft Power Platform omgeving waarin de Sherweb Platform-connectoroplossing is geïnstalleerd.
Resellerreferenties maken
Elke reseller gebruikt zijn eigen bestaande OAuth-clientreferenties bij het maken van een connectorverbinding; deze stroom maakt geen gebruik van Dynamic Client Registration (DCR) of een gedeelde client-id en clientgeheim.
https://helpdesk.sherweb.com/en-us/knowledge-base/articles/KA-05021
- Meld u aan bij Cumulus.
- Navigeer naar Platforminstellingen → API's.
- Maak een afzonderlijke API-sleutel voor de reseller of selecteer de bestaande sleutel van die reseller.
- Zorg ervoor dat de sleutel de
mcp:toolsenservice-providerbereiken heeft. Kopieer de client-id en het clientgeheim; het geheim wordt alleen weergegeven wanneer het is gemaakt. - Voeg de omleidings-URI toe die wordt weergegeven voor de geïnstalleerde Sherweb Platform-connector aan de API-sleutel.
OAuth-eindpunten
| Veld | Value |
|---|---|
| Autorisatie-URL | https://cumulus.sherweb.com/oidc/connect/authorize |
| Token-URL | https://cumulus.sherweb.com/oidc/connect/token |
| URL vernieuwen | https://cumulus.sherweb.com/oidc/connect/token |
| Scopes | mcp:tools service-provider |
Een verbinding maken
https://helpdesk.sherweb.com/en-us/knowledge-base/articles/KA-05021
- Selecteer in Power Platform de geïnstalleerde Sherweb Platform-connector en maak een verbinding.
- Voer de client-id en het clientgeheim van de reseller in wanneer u hierom wordt gevraagd. Deze referenties worden veilig opgeslagen door de verbinding en worden gebruikt voor OAuth-autorisatie en tokenvernieuwing van die reseller.
- Meld u aan bij Cumulus met een gebruikersaccount dat is geautoriseerd voor die reseller.
- Als de verbinding de autorisatie niet kan voltooien, controleert u of de omleidings-URI van de connector is geregistreerd op de API-sleutel van die reseller en of beide vereiste bereiken zijn ingeschakeld.
Maak een afzonderlijke verbinding voor elke reseller. De client-id en het clientgeheim identificeren de OAuth-toepassing van de reseller; de interactieve aanmelding bepaalt het gebruikersaccount dat is gemachtigd om de verbinding te gebruiken.
Tokenvernieuwing maakt gebruik van de OAuth-vernieuwingstokentoekentoeken en de referenties die voor die verbinding zijn opgegeven, in plaats van de autorisatiecode-uitwisseling te herhalen.
Configureer OAuth voor directe MCP-clients (in plaats van de gecertificeerde Power Platform-connector) met https://mcp.sherweb.com behulp van de bovenstaande eindpunten en bereiken. De directe installatie van MCP-clientverificatie is gescheiden van de velden voor resellerspecifieke referenties in de Power Platform-connector.
Ondersteunde bewerkingen
hulpprogramma's voor Read-Only
| Tool | Description |
|---|---|
QueryOrganizations |
Query's uitvoeren op organisaties die worden beheerd door de serviceprovider met Behulp van GraphQL. |
QuerySubscriptions |
Query's uitvoeren op abonnementen in organisaties met Behulp van GraphQL. |
QueryOrganizationConsumptions |
Query's uitvoeren op verbruiksgegevens (gebruik en kosten) voor organisaties die GraphQL gebruiken. |
QueryCatalog |
Voer een query uit voor de productcatalogus die beschikbaar is voor de serviceprovider met behulp van GraphQL. |
QueryAuditLogs |
Voer een query uit in het auditlogboek van acties die op het platform worden uitgevoerd met Behulp van GraphQL. |
GetGraphQLSchema |
Haal het volledige GraphQL-schema op om geldige query's te maken. |
GetCopilotSkus |
Haal de lijst met Sherweb-SKU's op voor Microsoft Copilot aanbiedingen. |
Hulpmiddelen voor schrijven
Opmerking: Schrijfbewerkingen vereisen de juiste machtigingen voor het geverifieerde Cumulus-account.
| Tool | Description |
|---|---|
PlaceOrder |
Plaats een productorder voor een klantorganisatie. |
ValidateQuote |
Valideer een voorgestelde bestelling en ontvang prijsgegevens zonder de bestelling te plaatsen. |
CreateSubscriptionsAmendment |
Wijzig de hoeveelheid seats of licenties voor een of meer bestaande abonnementen. |
CancelSubscriptions |
Annuleer een of meer abonnementen voor een klantorganisatie. |
ConfigurePlatform |
Configureer een platform (bijvoorbeeld Microsoft 365 tenant) voor een klant. |
Voorbeeldprompts
Hieronder vindt u voorbeelden van prompts in natuurlijke taal die u kunt gebruiken met een AI-assistent die is verbonden met deze MCP-server:
Verlengingen en facturering
- "Vermeld alle abonnementen voor verlenging in de komende 60 dagen."
- "Geef me een uitsplitsing van alle kosten voor organisatie Contoso in de afgelopen 3 maanden."
- "Welke abonnementen verlopen binnen 30 dagen binnen alle organisaties?"
Voorraad en portfolio
- "Welke van mijn organisaties hebben geen back-upproduct?"
- "Wat zijn mijn tien belangrijkste organisaties door terugkerende omzet?"
- "Toon alle onlangs geannuleerde abonnementen."
- "Vermeld alle productaanbiedingen die een Copilot SKU bevatten."
Actions
- "Plaats een bestelling voor 5 seats van Microsoft 365 Business Premium voor organisatie Contoso."
- "Valideer een offerte voor 10 seats van Azure Plan for organization Fabrikam."
- "Verminder de hoeveelheid Exchange Online seats voor organisatie Contoso van 20 tot 15."
Bekende problemen en beperkingen
- GraphQL-querydiepte: Zeer diep geneste GraphQL-query's kunnen een time-out hebben. Als er een time-out optreedt voor een query, vereenvoudigt u deze door de nestdiepte of het aantal aangevraagde velden te verminderen.
-
Paginering vereist: voor lijstquery's (,
QuerySubscriptionsenzovoort) zijn pagineringsargumenten (/firstQueryOrganizationsafteroflast/before) vereist. Query's zonder paginering retourneren een fout. -
Bereiken: Zorg ervoor dat beide
mcp:toolsbereiken enservice-providerworden opgenomen in de OAuth-bereiken bij het maken van uw API-sleutel. Als een van beide bereiken ontbreekt, worden verificatiefouten veroorzaakt.
Een verbinding maken
De connector ondersteunt de volgende verificatietypen:
| Default | Parameters voor het maken van verbinding. | Alle regio's | Niet deelbaar |
Verstek
Van toepassing: Alle regio's
Parameters voor het maken van verbinding.
Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.
| Name | Type | Description | Required |
|---|---|---|---|
| Client-id van reseller | string | Voer de client-id in die is uitgegeven voor deze reseller. | True |
| Clientgeheim reseller | beveiligde string | Voer het clientgeheim in dat is uitgegeven voor deze reseller. | True |
Acties
| Abonnementen voor een organisatie annuleren |
Annuleer abonnementen voor een organisatie. |
| Abonnementshoeveelheden wijzigen |
Abonnementshoeveelheden wijzigen. |
| Een bestelling voor een klant plaatsen |
Plaats een bestelling voor een klant. |
| Een offerte valideren zonder de bestelling te plaatsen |
Valideer een offerte zonder de bestelling te plaatsen. |
| Een platform configureren voor een klant |
Configureer een platform voor een klant. |
| Het GraphQL-schema ophalen in SDL-indeling |
Haal het GraphQL-schema op in SDL-indeling. |
| Query's uitvoeren op abonnementen met GraphQL |
Query's uitvoeren op abonnementen met GraphQL. |
| Query's uitvoeren op auditlogboeken met GraphQL |
Query's uitvoeren op auditlogboeken met GraphQL. |
| Query's uitvoeren op catalogusitems met GraphQL |
Query's uitvoeren op catalogusitems met GraphQL. |
| Query's uitvoeren op organisaties met GraphQL |
Query's uitvoeren op organisaties met GraphQL. |
| Sherweb-SKU's toewijzen aan Microsoft Copilot aanbiedingen |
Get Sherweb-SKU's die zijn toegewezen aan Microsoft Copilot aanbiedingen. |
| Verbruik van organisaties opvragen met GraphQL |
Query's uitvoeren op het verbruik van organisaties met Behulp van GraphQL. |
Abonnementen voor een organisatie annuleren
Annuleer abonnementen voor een organisatie.
Parameters
| Naam | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
organisatie-ID
|
organizationId | True | uuid | |
|
subscriptionIds
|
subscriptionIds | True | array of uuid |
Retouren
Abonnementshoeveelheden wijzigen
Abonnementshoeveelheden wijzigen.
Parameters
| Naam | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
organisatie-ID
|
organizationId | True | uuid | |
|
subscriptionId
|
subscriptionId | True | uuid | |
|
newQuantity
|
newQuantity | integer |
Retouren
Een bestelling voor een klant plaatsen
Plaats een bestelling voor een klant.
Parameters
| Naam | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
klant-ID
|
customerId | True | uuid | |
|
sku
|
sku | True | string | |
|
hoeveelheid
|
quantity | integer | ||
|
purchaseOrderNumber
|
purchaseOrderNumber | string | ||
|
orderedBy
|
orderedBy | True | string |
Retouren
- Body
- PlaceOrderResponse
Een offerte valideren zonder de bestelling te plaatsen
Valideer een offerte zonder de bestelling te plaatsen.
Parameters
| Naam | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
klant-ID
|
customerId | True | uuid | |
|
sku
|
sku | True | string | |
|
hoeveelheid
|
quantity | integer | ||
|
purchaseOrderNumber
|
purchaseOrderNumber | string | ||
|
orderedBy
|
orderedBy | True | string |
Retouren
- Body
- ValidateOrderResult
Een platform configureren voor een klant
Configureer een platform voor een klant.
Parameters
| Naam | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
klant-ID
|
customerId | True | uuid | |
|
platformId
|
platformId | True | uuid | |
|
identifier
|
identifier | True | string | |
|
value
|
value | string |
Retouren
- response
- string
Het GraphQL-schema ophalen in SDL-indeling
Query's uitvoeren op abonnementen met GraphQL
Query's uitvoeren op abonnementen met GraphQL.
Parameters
| Naam | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
graphqlQuery
|
graphqlQuery | True | string |
Retouren
Algemeen verbindingstype voor op cursor gebaseerde paginering, 'T'Het type items in de verbinding
Query's uitvoeren op auditlogboeken met GraphQL
Query's uitvoeren op auditlogboeken met GraphQL.
Parameters
| Naam | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
graphqlQuery
|
graphqlQuery | True | string |
Retouren
Algemeen verbindingstype voor op cursor gebaseerde paginering, 'T'Het type items in de verbinding
Query's uitvoeren op catalogusitems met GraphQL
Query's uitvoeren op catalogusitems met GraphQL.
Parameters
| Naam | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
graphqlQuery
|
graphqlQuery | True | string |
Retouren
Algemeen verbindingstype voor op cursor gebaseerde paginering, 'T'Het type items in de verbinding
Query's uitvoeren op organisaties met GraphQL
Query's uitvoeren op organisaties met GraphQL.
Parameters
| Naam | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
graphqlQuery
|
graphqlQuery | True | string |
Retouren
Algemeen verbindingstype voor op cursor gebaseerde paginering, 'T'Het type items in de verbinding
Sherweb-SKU's toewijzen aan Microsoft Copilot aanbiedingen
Get Sherweb-SKU's die zijn toegewezen aan Microsoft Copilot aanbiedingen.
Retouren
- response
- array of SkuDetail
Verbruik van organisaties opvragen met GraphQL
Query's uitvoeren op het verbruik van organisaties met Behulp van GraphQL.
Parameters
| Naam | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
graphqlQuery
|
graphqlQuery | True | string |
Retouren
Algemeen verbindingstype voor op cursor gebaseerde paginering, 'T'Het type items in de verbinding
Definities
Keuze
| Naam | Pad | Type | Description |
|---|---|---|---|
|
parameterChoiceValue
|
parameterChoiceValue | string | |
|
parameterChoiceDisplayName
|
parameterChoiceDisplayName | string |
ConnectionOfProjectedAuditLog
Algemeen verbindingstype voor op cursor gebaseerde paginering, 'T'Het type items in de verbinding
| Naam | Pad | Type | Description |
|---|---|---|---|
|
Randen
|
edges | array of EdgeOfProjectedAuditLog |
De lijst met randen op deze pagina. Elke rand bevat het knooppunt en de bijbehorende cursor. |
|
nodes
|
nodes | array of ProjectedAuditLog |
Een afgeplatte lijst met de knooppunten op deze pagina (zonder metagegevens van de cursor). |
|
totaal aantal
|
totalCount | integer |
Totaal aantal items op alle pagina's (indien aangevraagd) |
|
pageInfo
|
pageInfo | PageInfo |
Pagineringsmetagegevens voor navigatie op basis van cursors. |
ConnectionOfProjectedCatalogItem
Algemeen verbindingstype voor op cursor gebaseerde paginering, 'T'Het type items in de verbinding
| Naam | Pad | Type | Description |
|---|---|---|---|
|
Randen
|
edges | array of EdgeOfProjectedCatalogItem |
De lijst met randen op deze pagina. Elke rand bevat het knooppunt en de bijbehorende cursor. |
|
nodes
|
nodes | array of ProjectedCatalogItem |
Een afgeplatte lijst met de knooppunten op deze pagina (zonder metagegevens van de cursor). |
|
totaal aantal
|
totalCount | integer |
Totaal aantal items op alle pagina's (indien aangevraagd) |
|
pageInfo
|
pageInfo | PageInfo |
Pagineringsmetagegevens voor navigatie op basis van cursors. |
ConnectionOfProjectedConsumptionItem
Algemeen verbindingstype voor op cursor gebaseerde paginering, 'T'Het type items in de verbinding
| Naam | Pad | Type | Description |
|---|---|---|---|
|
Randen
|
edges | array of EdgeOfProjectedConsumptionItem |
De lijst met randen op deze pagina. Elke rand bevat het knooppunt en de bijbehorende cursor. |
|
nodes
|
nodes | array of ProjectedConsumptionItem |
Een afgeplatte lijst met de knooppunten op deze pagina (zonder metagegevens van de cursor). |
|
totaal aantal
|
totalCount | integer |
Totaal aantal items op alle pagina's (indien aangevraagd) |
|
pageInfo
|
pageInfo | PageInfo |
Pagineringsmetagegevens voor navigatie op basis van cursors. |
ConnectionOfProjectedOrganization
Algemeen verbindingstype voor op cursor gebaseerde paginering, 'T'Het type items in de verbinding
| Naam | Pad | Type | Description |
|---|---|---|---|
|
Randen
|
edges | array of EdgeOfProjectedOrganization |
De lijst met randen op deze pagina. Elke rand bevat het knooppunt en de bijbehorende cursor. |
|
nodes
|
nodes | array of ProjectedOrganization |
Een afgeplatte lijst met de knooppunten op deze pagina (zonder metagegevens van de cursor). |
|
totaal aantal
|
totalCount | integer |
Totaal aantal items op alle pagina's (indien aangevraagd) |
|
pageInfo
|
pageInfo | PageInfo |
Pagineringsmetagegevens voor navigatie op basis van cursors. |
ConnectionOfProjectedSubscription
Algemeen verbindingstype voor op cursor gebaseerde paginering, 'T'Het type items in de verbinding
| Naam | Pad | Type | Description |
|---|---|---|---|
|
Randen
|
edges | array of EdgeOfProjectedSubscription |
De lijst met randen op deze pagina. Elke rand bevat het knooppunt en de bijbehorende cursor. |
|
nodes
|
nodes | array of ProjectedSubscription |
Een afgeplatte lijst met de knooppunten op deze pagina (zonder metagegevens van de cursor). |
|
totaal aantal
|
totalCount | integer |
Totaal aantal items op alle pagina's (indien aangevraagd) |
|
pageInfo
|
pageInfo | PageInfo |
Pagineringsmetagegevens voor navigatie op basis van cursors. |
EdgeOfProjectedAuditLog
Een rand in een gepagineerde verbinding op basis van cursor, die het knooppunt en de cursor bevat.
| Naam | Pad | Type | Description |
|---|---|---|---|
|
node
|
node | ProjectedAuditLog | |
|
cursor
|
cursor | string |
De cursor voor deze rand, die wordt gebruikt voor paginering op basis van cursor. |
EdgeOfProjectedCatalogItem
Een rand in een gepagineerde verbinding op basis van cursor, die het knooppunt en de cursor bevat.
| Naam | Pad | Type | Description |
|---|---|---|---|
|
node
|
node | ProjectedCatalogItem | |
|
cursor
|
cursor | string |
De cursor voor deze rand, die wordt gebruikt voor paginering op basis van cursor. |
EdgeOfProjectedConsumptionItem
Een rand in een gepagineerde verbinding op basis van cursor, die het knooppunt en de cursor bevat.
| Naam | Pad | Type | Description |
|---|---|---|---|
|
node
|
node | ProjectedConsumptionItem | |
|
cursor
|
cursor | string |
De cursor voor deze rand, die wordt gebruikt voor paginering op basis van cursor. |
EdgeOfProjectedOrganization
Een rand in een gepagineerde verbinding op basis van cursor, die het knooppunt en de cursor bevat.
| Naam | Pad | Type | Description |
|---|---|---|---|
|
node
|
node | ProjectedOrganization | |
|
cursor
|
cursor | string |
De cursor voor deze rand, die wordt gebruikt voor paginering op basis van cursor. |
EdgeOfProjectedSubscription
Een rand in een gepagineerde verbinding op basis van cursor, die het knooppunt en de cursor bevat.
| Naam | Pad | Type | Description |
|---|---|---|---|
|
node
|
node | ProjectedSubscription | |
|
cursor
|
cursor | string |
De cursor voor deze rand, die wordt gebruikt voor paginering op basis van cursor. |
EventSource
InvoiceMetrics
| Naam | Pad | 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
| Naam | Pad | Type | Description |
|---|---|---|---|
|
from
|
from | date |
O(1) |
|
to
|
to | date |
O(1) |
PageInfo
Pagineringsmetagegevens voor navigatie op basis van cursors.
| Naam | Pad | Type | Description |
|---|---|---|---|
|
hasNextPage
|
hasNextPage | boolean | |
|
hasPreviousPage
|
hasPreviousPage | boolean | |
|
startCursor
|
startCursor | string | |
|
endCursor
|
endCursor | string |
PlaceOrderResponse
| Naam | Pad | Type | Description |
|---|---|---|---|
|
requestTrackingId
|
requestTrackingId | uuid | |
|
subscriptionIds
|
subscriptionIds | array of uuid |
PlatformRequiredParameter
| Naam | Pad | Type | Description |
|---|---|---|---|
|
parameterDescription
|
parameterDescription | string | |
|
parameterIdentifier
|
parameterIdentifier | string | |
|
parameterDefaultValue
|
parameterDefaultValue | string | |
|
parameterFormatType
|
parameterFormatType | string | |
|
parameterFormatPattern
|
parameterFormatPattern | string | |
|
parameterFormatChoices
|
parameterFormatChoices | array of Choice |
ProjectedAuditLog
| Naam | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
targetName
|
targetName | string | |
|
action
|
action | string | |
|
date
|
date | date-time | |
|
gebruikersweergavenaam
|
userDisplayName | string | |
|
categoryName
|
categoryName | string | |
|
description
|
description | string | |
|
details
|
details | array of ProjectedAuditLogDetail |
ProjectedAuditLogDetail
| Naam | Pad | Type | Description |
|---|---|---|---|
|
propertyName
|
propertyName | string | |
|
oudeWaarde
|
oldValue | string | |
|
newValue
|
newValue | string |
ProjectedCatalogItem
| Naam | Pad | Type | Description |
|---|---|---|---|
|
sku
|
sku | string |
O(1) |
|
name
|
name | string |
O(1) |
|
description
|
description | string |
O(1) |
|
billingCycle
|
billingCycle | string |
O(1) |
|
commitmentTerm
|
commitmentTerm | string |
O(1) |
|
pricingInformation
|
pricingInformation | ProjectedPricingInformation | |
|
platformen
|
platforms | array of ProjectedPlatforms |
O(1) extra oproep |
ProjectedCommitmentTerm
| Naam | Pad | Type | Description |
|---|---|---|---|
|
type
|
type | ProjectedCommitmentTermType | |
|
einddatum
|
endDate | date-time | |
|
renewalConfiguration
|
renewalConfiguration | ProjectedRenewalConfiguration |
ProjectedCommitmentTermType
ProjectedConsumptionItem
| Naam | Pad | Type | Description |
|---|---|---|---|
|
product
|
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
| Naam | Pad | Type | Description |
|---|---|---|---|
|
recurringFee
|
recurringFee | ProjectedMoney | |
|
setupFee
|
setupFee | ProjectedMoney | |
|
costRecurringFee
|
costRecurringFee | ProjectedMoney | |
|
billingCycle
|
billingCycle | string |
ProjectedMoney
| Naam | Pad | Type | Description |
|---|---|---|---|
|
value
|
value | double | |
|
currency
|
currency | ProjectedCurrency | |
|
afronding
|
rounding | integer |
ProjectedOrganization
| Naam | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid |
O(1) |
|
name
|
name | string |
O(1) |
|
uniekeNaam
|
uniqueName | string |
O(1) |
|
ouder-ID
|
parentId | uuid |
O(1) |
|
oudernaam
|
parentName | string |
O(1) |
|
suspendedOn
|
suspendedOn | date-time |
O(n) |
|
isSuspended
|
isSuspended | boolean |
O(1) |
|
isVerwijderd
|
isDeleted | boolean |
O(1) |
|
isActive
|
isActive | boolean |
O(n) |
|
daysSinceSus gegroepeerd
|
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), Aggregatie van terugkerende kosten met een andere factureringscyclus dan maandelijks of jaarlijks |
|
totalOtherCostRecurringFee
|
totalOtherCostRecurringFee | double |
O(n), Aggregatie van terugkerende kostenkosten met een andere billingCycle dan maandelijks of jaarlijks |
|
invoiceMetrics
|
invoiceMetrics | InvoiceMetrics |
ProjectedPlatforms
| Naam | Pad | Type | Description |
|---|---|---|---|
|
platformId
|
platformId | uuid | |
|
requiredParameters
|
requiredParameters | array of PlatformRequiredParameter |
O(1) extra oproep |
ProjectedPricingInformation
| Naam | Pad | Type | Description |
|---|---|---|---|
|
recurringFee
|
recurringFee | double | |
|
setupFee
|
setupFee | double | |
|
currency
|
currency | ProjectedCurrency | |
|
billingCycle
|
billingCycle | string |
ProjectedRenewalConfiguration
| Naam | Pad | Type | Description |
|---|---|---|---|
|
isConfigurable
|
isConfigurable | boolean | |
|
renewSettings
|
renewSettings | ProjectedRenewSettings |
ProjectedRenewSettings
| Naam | Pad | Type | Description |
|---|---|---|---|
|
renewalDate
|
renewalDate | date-time | |
|
scheduledQuantity
|
scheduledQuantity | integer | |
|
coTerminationEndDate
|
coTerminationEndDate | date-time |
ProjectedSubscription
| Naam | Pad | Type | Description |
|---|---|---|---|
|
subscriptionId
|
subscriptionId | uuid |
O(1) |
|
organisatie-ID
|
organizationId | uuid |
O(1) |
|
canceledOn
|
cancelledOn | date-time |
O(n) |
|
isActive
|
isActive | boolean |
O(n) |
|
daysSinceCreation
|
daysSinceCreation | integer |
O(n) |
|
gemaaktOp
|
createdOn | date-time |
O(1) |
|
hoeveelheid
|
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) |
|
kosten
|
fees | ProjectedFeesDto | |
|
productName
|
productName | string |
O(1) |
|
isCoterminated
|
isCoterminated | boolean |
O(n) |
|
history
|
history | array of SubscriptionHistoryEvent |
O(n) |
RenewedTermEndDateDetail
| Naam | Pad | Type | Description |
|---|---|---|---|
|
previousDate
|
previousDate | date | |
|
newDate
|
newDate | date |
RenewedTermStartDateDetail
| Naam | Pad | Type | Description |
|---|---|---|---|
|
previousDate
|
previousDate | date | |
|
newDate
|
newDate | date |
SkuDetail
| Naam | Pad | Type | Description |
|---|---|---|---|
|
sku
|
sku | string | |
|
skuName
|
skuName | string |
SubscriptionHistoryEvent
| Naam | Pad | Type | Description |
|---|---|---|---|
|
gemaaktOp
|
createdOn | date-time | |
|
aantal licenties
|
licenseCount | integer | |
|
sku
|
sku | string | |
|
offerName
|
offerName | string | |
|
user
|
user | string | |
|
coTerminationDate
|
coTerminationDate | string | |
|
gebeurtenisbron
|
eventSource | EventSource | |
|
termEndDateDetail
|
termEndDateDetail | RenewedTermEndDateDetail | |
|
termStartDateDetail
|
termStartDateDetail | RenewedTermStartDateDetail |
SubscriptionsAmendment
| Naam | Pad | Type | Description |
|---|---|---|---|
|
subscriptionsAmendmentId
|
subscriptionsAmendmentId | uuid | |
|
trackingId
|
trackingId | TrackingId |
SubscriptionsCancellation
| Naam | Pad | Type | Description |
|---|---|---|---|
|
subscriptionsCancellationId
|
subscriptionsCancellationId | uuid | |
|
trackingId
|
trackingId | TrackingId |
TrackingId
| Naam | Pad | Type | Description |
|---|---|---|---|
|
requestTrackingId
|
requestTrackingId | uuid |
ValidateOrderLineItem
| Naam | Pad | Type | Description |
|---|---|---|---|
|
lineNumber
|
lineNumber | integer | |
|
sku
|
sku | string | |
|
name
|
name | string | |
|
billingCycle
|
billingCycle | string | |
|
commitmentTerm
|
commitmentTerm | string | |
|
hoeveelheid
|
quantity | integer | |
|
eenheidsprijs
|
unitPrice | double | |
|
uitgebreide prijs
|
extendedPrice | double | |
|
currency
|
currency | string |
ValidateOrderResult
| Naam | Pad | Type | Description |
|---|---|---|---|
|
message
|
message | string | |
|
lineItems
|
lineItems | array of ValidateOrderLineItem | |
|
Subtotaal
|
subtotal | double | |
|
currency
|
currency | string |
string
Dit is het basisgegevenstype 'tekenreeks'.