Hybr® - Integrations APIs

Response Class (Status 200)

OK

integer
Enum:	0, 10, 20, 30

[
  {
    "SubscriptionId": "string",
    "BillingAccount": {
      "Id": 0,
      "Name": "string",
      "UserId": "string",
      "IsInvoiceManual": true,
      "BillingFirstName": "string",
      "BillingLastName": "string",
      "BillingCompany": "string",
      "BillingAddress1": "string",
      "BillingAddress2": "string",
      "BillingCity": "string",
      "BillingState": "string",
      "BillingPostalCode": "string",
      "BillingCountryId": 0,
      "BillingPhoneNumber": "string",
      "BillingFaxNumber": "string",
      "BillingEmailAddress": "string",
      "CurrencyCode": "string",
      "ShippingFirstName": "string",
      "ShippingLastName": "string",
      "ShippingCompany": "string",
      "ShippingAddress1": "string",
      "ShippingAddress2": "string",
      "ShippingCity": "string",
      "ShippingState": "string",
      "ShippingPostalCode": "string",
      "ShippingCountryId": 0,
      "ShippingPhoneNumber": "string",
      "ShippingEmailAddress": "string",
      "ReferredBy": "string",
      "ReferenceId": "string",
      "IsDeleted": true,
      "SignupStateString": "string",
      "SignupState": 0,
      "CreatedBy": "string",
      "LastUpdatedBy": "string",
      "Created": "2024-02-06T12:47:39.191Z",
      "SignupDate": "2024-02-06T12:47:39.191Z",
      "AdditionalInvoiceNotificationEmailIds": "string",
      "SendEmailNotificationForInvoice": true,
      "InvoiceEmailNotificationEffectiveStartMonth": "2024-02-06T12:47:39.191Z",
      "QRNumber": "string",
      "Properties": {},
      "SignupDateString": "string",
      "LastUpdated": "2024-02-06T12:47:39.191Z",
      "BillingCountry": {
        "States": [
          {
            "Code": "string",
            "Name": "string"
          }
        ],
        "Id": 0,
        "Code": "string",
        "Name": "string"
      },
      "ShippingCountry": {
        "States": [
          {
            "Code": "string",
            "Name": "string"
          }
        ],
        "Id": 0,
        "Code": "string",
        "Name": "string"
      },
      "CurrencyCodeId": 0,
      "CultureInfoId": 0,
      "CurrencyCodeData": {
        "Id": 0,
        "Code": "string",
        "Region": "string",
        "DisplayName": "string",
        "Symbol": "string"
      },
      "CultureInfo": {
        "Id": 0,
        "Code": "string",
        "DisplayName": "string"
      }
    }
  }
]

<?xml version="1.0"?>
<Inline Model>
  <SubscriptionId>string</SubscriptionId>
  <BillingAccount>
    <Id>1</Id>
    <Name>string</Name>
    <UserId>string</UserId>
    <IsInvoiceManual>true</IsInvoiceManual>
    <BillingFirstName>string</BillingFirstName>
    <BillingLastName>string</BillingLastName>
    <BillingCompany>string</BillingCompany>
    <BillingAddress1>string</BillingAddress1>
    <BillingAddress2>string</BillingAddress2>
    <BillingCity>string</BillingCity>
    <BillingState>string</BillingState>
    <BillingPostalCode>string</BillingPostalCode>
    <BillingCountryId>1</BillingCountryId>
    <BillingPhoneNumber>string</BillingPhoneNumber>
    <BillingFaxNumber>string</BillingFaxNumber>
    <BillingEmailAddress>string</BillingEmailAddress>
    <CurrencyCode>string</CurrencyCode>
    <ShippingFirstName>string</ShippingFirstName>
    <ShippingLastName>string</ShippingLastName>
    <ShippingCompany>string</ShippingCompany>
    <ShippingAddress1>string</ShippingAddress1>
    <ShippingAddress2>string</ShippingAddress2>
    <ShippingCity>string</ShippingCity>
    <ShippingState>string</ShippingState>
    <ShippingPostalCode>string</ShippingPostalCode>
    <ShippingCountryId>1</ShippingCountryId>
    <ShippingPhoneNumber>string</ShippingPhoneNumber>
    <ShippingEmailAddress>string</ShippingEmailAddress>
    <ReferredBy>string</ReferredBy>
    <ReferenceId>string</ReferenceId>
    <IsDeleted>true</IsDeleted>
    <SignupStateString>string</SignupStateString>
    <SignupState>0</SignupState>
    <CreatedBy>string</CreatedBy>
    <LastUpdatedBy>string</LastUpdatedBy>
    <Created>1970-01-01T00:00:00.001Z</Created>
    <SignupDate>1970-01-01T00:00:00.001Z</SignupDate>
    <AdditionalInvoiceNotificationEmailIds>string</AdditionalInvoiceNotificationEmailIds>
    <SendEmailNotificationForInvoice>true</SendEmailNotificationForInvoice>
    <InvoiceEmailNotificationEffectiveStartMonth>1970-01-01T00:00:00.001Z</InvoiceEmailNotificationEffectiveStartMonth>
    <QRNumber>string</QRNumber>
    <Properties>
      <!-- additional elements allowed -->
    </Properties>
    <SignupDateString>string</SignupDateString>
    <LastUpdated>1970-01-01T00:00:00.001Z</LastUpdated>
    <BillingCountry>
      <States>
        <Code>string</Code>
        <Name>string</Name>
      </States>
      <Id>1</Id>
      <Code>string</Code>
      <Name>string</Name>
    </BillingCountry>
    <ShippingCountry>
      <States>
        <Code>string</Code>
        <Name>string</Name>
      </States>
      <Id>1</Id>
      <Code>string</Code>
      <Name>string</Name>
    </ShippingCountry>
    <CurrencyCodeId>1</CurrencyCodeId>
    <CultureInfoId>1</CultureInfoId>
    <CurrencyCodeData>
      <Id>1</Id>
      <Code>string</Code>
      <Region>string</Region>
      <DisplayName>string</DisplayName>
      <Symbol>string</Symbol>
    </CurrencyCodeData>
    <CultureInfo>
      <Id>1</Id>
      <Code>string</Code>
      <DisplayName>string</DisplayName>
    </CultureInfo>
  </BillingAccount>
</Inline Model>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
subscriptionIds	query	string
appId	path	string
paginationParameters.page	query	integer
paginationParameters.page_Size	query	integer

AdminBillingCostEstimate

post /api/integrations/{appId}/admin/service/billing/costEstimate/pricingProfile/{pricingProfileId}/granularity/{granularity}

Get cost estimate based on the given pricing profile id, granularity and quantity input.

Response Class (Status 200)

OK

{}

<?xml version="1.0"?>
<inline_model_20>
  <!-- additional elements allowed -->
</inline_model_20>

Response Content Type

Parameters

Parameter	Value	Parameter Type	Data Type
pricingProfileId		path	integer
granularity		path	string
quantityInput	Parameter content type:	body	Model Example Value Array[CloudAssert.WAP.Billing.Common.DataContracts.UsageQuantityInput { Id (integer, optional), UsageQuantity (number, optional), ProviderName (string, optional), ServiceType (string, optional), MeteredResourceName (string, optional), FilterProperties (Array[CloudAssert.WAP.Billing.Common.DataContracts.UsageInputFilterProperty], optional) } CloudAssert.WAP.Billing.Common.DataContracts.UsageInputFilterProperty { FilterPropertyKey (string, optional), FilterPropertyValue (string, optional) }] `[ { "Id": 0, "UsageQuantity": 0, "ProviderName": "string", "ServiceType": "string", "MeteredResourceName": "string", "FilterProperties": [ { "FilterPropertyKey": "string", "FilterPropertyValue": "string" } ] } ]` `<?xml version="1.0"?> <CloudAssert.WAP.Billing.Common.DataContracts.UsageQuantityInput> <Id>1</Id> <UsageQuantity>1.1</UsageQuantity> <ProviderName>string</ProviderName> <ServiceType>string</ServiceType> <MeteredResourceName>string</MeteredResourceName> <FilterProperties> <FilterPropertyKey>string</FilterPropertyKey> <FilterPropertyValue>string</FilterPropertyValue> </FilterProperties> </CloudAssert.WAP.Billing.Common.DataContracts.UsageQuantityInput>`
appId		path	string

post /api/integrations/{appId}/admin/service/billing/costEstimate

Get the cost estimate based on the given usage records. Pricing Profile will be determined based on the susbscription id in the usage record. So the subscription id in the usage record should be valid and should be associated with a plan that has pricing profile set.

Response Class (Status 200)

OK

{}

<?xml version="1.0"?>
<inline_model_21>
  <!-- additional elements allowed -->
</inline_model_21>

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

Parameter	Value	Description	Parameter Type	Data Type
usageRecords	Parameter content type:		body	Model Example Value Array[CloudAssert.WAP.Billing.Common.DataContracts.UsageRecordIn { UsageSourceString (string, optional), EventId (integer, optional), ExternalRecordId (string, optional), ResourceId (string, optional), StartTime (string, optional), EndTime (string, optional), ProviderName (string, optional), ServiceType (string, optional), SubscriptionId (string, optional), Properties (inline_model_0, optional), Resources (inline_model_1, optional), Id (integer, optional), CreatedTime (string, optional), ProcessedTime (string, optional), IsProcessed (boolean, optional), PropertiesJson (string, optional), ResourcesJson (string, optional) } inline_model_0 {} inline_model_1 {}] `[ { "UsageSourceString": "string", "EventId": 0, "ExternalRecordId": "string", "ResourceId": "string", "StartTime": "2024-02-06T12:47:39.215Z", "EndTime": "2024-02-06T12:47:39.215Z", "ProviderName": "string", "ServiceType": "string", "SubscriptionId": "string", "Properties": {}, "Resources": {}, "Id": 0, "CreatedTime": "2024-02-06T12:47:39.215Z", "ProcessedTime": "2024-02-06T12:47:39.215Z", "IsProcessed": true, "PropertiesJson": "string", "ResourcesJson": "string" } ]` <?xml version="1.0"?> <CloudAssert.WAP.Billing.Common.DataContracts.UsageRecordIn> <UsageSourceString>string</UsageSourceString> <EventId>1</EventId> <ExternalRecordId>string</ExternalRecordId> <ResourceId>string</ResourceId> <StartTime>1970-01-01T00:00:00.001Z</StartTime> <EndTime>1970-01-01T00:00:00.001Z</EndTime> <ProviderName>string</ProviderName> <ServiceType>string</ServiceType> <SubscriptionId>string</SubscriptionId> <Properties> <!-- additional elements allowed --> </Properties> <Resources> <!-- additional elements allowed --> </Resources> <Id>1</Id> <CreatedTime>1970-01-01T00:00:00.001Z</CreatedTime> <ProcessedTime>1970-01-01T00:00:00.001Z</ProcessedTime> <IsProcessed>true</IsProcessed> <PropertiesJson>string</PropertiesJson> <ResourcesJson>string</ResourcesJson> </CloudAssert.WAP.Billing.Common.DataContracts.UsageRecordIn>
appId			path	string

usageRecords

Parameter content type:

body

[
  {
    "UsageSourceString": "string",
    "EventId": 0,
    "ExternalRecordId": "string",
    "ResourceId": "string",
    "StartTime": "2024-02-06T12:47:39.215Z",
    "EndTime": "2024-02-06T12:47:39.215Z",
    "ProviderName": "string",
    "ServiceType": "string",
    "SubscriptionId": "string",
    "Properties": {},
    "Resources": {},
    "Id": 0,
    "CreatedTime": "2024-02-06T12:47:39.215Z",
    "ProcessedTime": "2024-02-06T12:47:39.215Z",
    "IsProcessed": true,
    "PropertiesJson": "string",
    "ResourcesJson": "string"
  }
]

<?xml version="1.0"?>
<CloudAssert.WAP.Billing.Common.DataContracts.UsageRecordIn>
  <UsageSourceString>string</UsageSourceString>
  <EventId>1</EventId>
  <ExternalRecordId>string</ExternalRecordId>
  <ResourceId>string</ResourceId>
  <StartTime>1970-01-01T00:00:00.001Z</StartTime>
  <EndTime>1970-01-01T00:00:00.001Z</EndTime>
  <ProviderName>string</ProviderName>
  <ServiceType>string</ServiceType>
  <SubscriptionId>string</SubscriptionId>
  <Properties>
    <!-- additional elements allowed -->
  </Properties>
  <Resources>
    <!-- additional elements allowed -->
  </Resources>
  <Id>1</Id>
  <CreatedTime>1970-01-01T00:00:00.001Z</CreatedTime>
  <ProcessedTime>1970-01-01T00:00:00.001Z</ProcessedTime>
  <IsProcessed>true</IsProcessed>
  <PropertiesJson>string</PropertiesJson>
  <ResourcesJson>string</ResourcesJson>
</CloudAssert.WAP.Billing.Common.DataContracts.UsageRecordIn>

appId path string

AdminBillingCosts

get /api/integrations/{appId}/admin/service/billing/costs/subscriptions/{subscriptionId}/costsAndCredits

Get subscription costs along with any available credits and balances from billing service.

Response Class (Status 200)

OK

[
  {
    "SubscriptionId": "string",
    "PropertyType": "string",
    "PropertyValue": "string",
    "Cost": 0,
    "RemainingCredits": 0,
    "CurrencySymbol": "string"
  }
]

<?xml version="1.0"?>
<Inline Model>
  <SubscriptionId>string</SubscriptionId>
  <PropertyType>string</PropertyType>
  <PropertyValue>string</PropertyValue>
  <Cost>1.1</Cost>
  <RemainingCredits>1.1</RemainingCredits>
  <CurrencySymbol>string</CurrencySymbol>
</Inline Model>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
subscriptionId	path	string
startTime	query	date-time
endTime	query	date-time
provider	query	string
service	query	string
appId	path	string

get /api/integrations/{appId}/admin/service/billing/costs/subscriptions/{subscriptionId}/monthlyRecords

Get subscription monthly cost records from billing service.

Response Class (Status 200)

OK

[
  {
    "SubscriptionId": "string",
    "ProviderName": "string",
    "PlanName": "string",
    "SubscriptionName": "string",
    "StampName": "string",
    "ServiceType": "string",
    "MeteredResourceName": "string",
    "MeteredResourceDisplayName": "string",
    "MeteredResourcePricingDataId": 0,
    "ResourceId": "string",
    "PropertiesJson": "string",
    "Properties": {},
    "Units": 0,
    "Cost": 0,
    "MonthlyUnitPrice": 0,
    "BillableUnits": 0,
    "BillableCost": 0,
    "ISOCurrencySymbol": "string",
    "CurrencySymbol": "string",
    "AdminId": "string",
    "ResourceName": "string",
    "UnitDisplayName": "string",
    "ResourceGroup": "string",
    "Credit": 0,
    "CreditInPercentage": true,
    "PricingProfileHierarchy": "string",
    "Tags": "string",
    "IncludedUnits": 0,
    "IncludedCost": 0,
    "StartTime": "2024-02-06T12:47:39.227Z",
    "EndTime": "2024-02-06T12:47:39.227Z",
    "CurrencyCode": "string"
  }
]

<?xml version="1.0"?>
<Inline Model>
  <SubscriptionId>string</SubscriptionId>
  <ProviderName>string</ProviderName>
  <PlanName>string</PlanName>
  <SubscriptionName>string</SubscriptionName>
  <StampName>string</StampName>
  <ServiceType>string</ServiceType>
  <MeteredResourceName>string</MeteredResourceName>
  <MeteredResourceDisplayName>string</MeteredResourceDisplayName>
  <MeteredResourcePricingDataId>1</MeteredResourcePricingDataId>
  <ResourceId>string</ResourceId>
  <PropertiesJson>string</PropertiesJson>
  <Properties>
    <!-- additional elements allowed -->
  </Properties>
  <Units>1.1</Units>
  <Cost>1.1</Cost>
  <MonthlyUnitPrice>1.1</MonthlyUnitPrice>
  <BillableUnits>1.1</BillableUnits>
  <BillableCost>1.1</BillableCost>
  <ISOCurrencySymbol>string</ISOCurrencySymbol>
  <CurrencySymbol>string</CurrencySymbol>
  <AdminId>string</AdminId>
  <ResourceName>string</ResourceName>
  <UnitDisplayName>string</UnitDisplayName>
  <ResourceGroup>string</ResourceGroup>
  <Credit>1.1</Credit>
  <CreditInPercentage>true</CreditInPercentage>
  <PricingProfileHierarchy>string</PricingProfileHierarchy>
  <Tags>string</Tags>
  <IncludedUnits>1.1</IncludedUnits>
  <IncludedCost>1.1</IncludedCost>
  <StartTime>1970-01-01T00:00:00.001Z</StartTime>
  <EndTime>1970-01-01T00:00:00.001Z</EndTime>
  <CurrencyCode>string</CurrencyCode>
</Inline Model>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
subscriptionId	path	string
startTime	query	date-time
endTime	query	date-time
isOverallDetailedUsage	query	boolean
currencySymbol	query	string
appId	path	string

get /api/integrations/{appId}/admin/service/billing/costs/subscriptions/{subscriptionId}/downloadDailyUsage

Download daily cost data records as CSV file from billing service.

Response Class (Status 200)

OK

{
  "FileName": "string",
  "Data": "string"
}

<?xml version="1.0"?>
<CloudAssert.WAP.Billing.Common.DataContracts.CsvDataOut>
  <FileName>string</FileName>
  <Data>string</Data>
</CloudAssert.WAP.Billing.Common.DataContracts.CsvDataOut>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
subscriptionId	path	string
year	query	integer
month	query	integer
isOverallUsage	query	boolean
isOverallDetailedUsage	query	boolean
currencySymbol	query	string
appId	path	string

get /api/integrations/{appId}/admin/service/billing/costs/subscriptions/{subscriptionId}/downloadMonthUsage

Download monthly cost data records as CSV file from billing service.

Response Class (Status 200)

OK

{
  "FileName": "string",
  "Data": "string"
}

<?xml version="1.0"?>
<CloudAssert.WAP.Billing.Common.DataContracts.CsvDataOut>
  <FileName>string</FileName>
  <Data>string</Data>
</CloudAssert.WAP.Billing.Common.DataContracts.CsvDataOut>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
subscriptionId	path	string
year	query	integer
month	query	integer
isOverallUsage	query	boolean
isOverallDetailedUsage	query	boolean
currencySymbol	query	string
appId	path	string

AdminBillingCostSummary

get /api/integrations/{appId}/admin/service/billing/costSummary/daily

Response Class (Status 200)

OK

[
  {
    "MonthStartTime": "2024-02-06T12:47:39.244Z",
    "MonthEndTime": "2024-02-06T12:47:39.244Z",
    "DailyCostSummaryDetails": [
      {
        "CostPerDay": [
          0
        ],
        "CurrencySymbol": "string",
        "ISOCurrencySymbol": "string"
      }
    ]
  }
]

<?xml version="1.0"?>
<Inline Model>
  <MonthStartTime>1970-01-01T00:00:00.001Z</MonthStartTime>
  <MonthEndTime>1970-01-01T00:00:00.001Z</MonthEndTime>
  <DailyCostSummaryDetails>
    <CostPerDay>1.1</CostPerDay>
    <CurrencySymbol>string</CurrencySymbol>
    <ISOCurrencySymbol>string</ISOCurrencySymbol>
  </DailyCostSummaryDetails>
</Inline Model>

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
subscriptionId			query	string
appId			path	string

get /api/integrations/{appId}/admin/service/billing/costSummary

Response Class (Status 200)

OK

[
  {
    "UserId": "string",
    "SubscriptionId": "string",
    "SubscriptionName": "string",
    "BillingCycleStartTime": "2024-02-06T12:47:39.247Z",
    "BillingCycleEndTime": "2024-02-06T12:47:39.247Z",
    "TotalCost": 0,
    "TotalIncludedOfferCredits": 0,
    "IncludedCostCredits": 0,
    "TaxAmount": 0,
    "MonthlyFee": 0,
    "OneTimeFee": 0,
    "CurrencyCode": "string",
    "CurrencySymbol": "string",
    "StampName": "string",
    "BillableCost": 0,
    "UserCredits": 0,
    "AddOnMonthlyFee": 0,
    "SubscriptionProvisionedDate": "2024-02-06T12:47:39.247Z"
  }
]

<?xml version="1.0"?>
<Inline Model>
  <UserId>string</UserId>
  <SubscriptionId>string</SubscriptionId>
  <SubscriptionName>string</SubscriptionName>
  <BillingCycleStartTime>1970-01-01T00:00:00.001Z</BillingCycleStartTime>
  <BillingCycleEndTime>1970-01-01T00:00:00.001Z</BillingCycleEndTime>
  <TotalCost>1.1</TotalCost>
  <TotalIncludedOfferCredits>1.1</TotalIncludedOfferCredits>
  <IncludedCostCredits>1.1</IncludedCostCredits>
  <TaxAmount>1.1</TaxAmount>
  <MonthlyFee>1.1</MonthlyFee>
  <OneTimeFee>1.1</OneTimeFee>
  <CurrencyCode>string</CurrencyCode>
  <CurrencySymbol>string</CurrencySymbol>
  <StampName>string</StampName>
  <BillableCost>1.1</BillableCost>
  <UserCredits>1.1</UserCredits>
  <AddOnMonthlyFee>1.1</AddOnMonthlyFee>
  <SubscriptionProvisionedDate>1970-01-01T00:00:00.001Z</SubscriptionProvisionedDate>
</Inline Model>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
month	query	integer
year	query	integer
appId	path	string
paginationParameters.page	query	integer
paginationParameters.page_Size	query	integer

get /api/integrations/{appId}/admin/service/billing/costSummary/subscriptions/{subscriptionId}/costDetails

Response Class (Status 200)

OK

[
  {
    "SubscriptionId": "string",
    "ProviderName": "string",
    "PlanName": "string",
    "SubscriptionName": "string",
    "StampName": "string",
    "ServiceType": "string",
    "MeteredResourceName": "string",
    "MeteredResourceDisplayName": "string",
    "ResourceId": "string",
    "BillableUnits": 0,
    "BillableCost": 0,
    "TotalCost": 0,
    "CurrencyCode": "string",
    "CurrencySymbol": "string",
    "AdminId": "string",
    "ResourceName": "string",
    "ResourceGroup": "string",
    "StartTime": "2024-02-06T12:47:39.252Z",
    "EndTime": "2024-02-06T12:47:39.252Z",
    "MonthlyUnitPrice": 0,
    "Credit": 0,
    "CreditInPercentage": true,
    "UnitDisplayName": "string",
    "SourceSubscriptionId": "string"
  }
]

<?xml version="1.0"?>
<Inline Model>
  <SubscriptionId>string</SubscriptionId>
  <ProviderName>string</ProviderName>
  <PlanName>string</PlanName>
  <SubscriptionName>string</SubscriptionName>
  <StampName>string</StampName>
  <ServiceType>string</ServiceType>
  <MeteredResourceName>string</MeteredResourceName>
  <MeteredResourceDisplayName>string</MeteredResourceDisplayName>
  <ResourceId>string</ResourceId>
  <BillableUnits>1.1</BillableUnits>
  <BillableCost>1.1</BillableCost>
  <TotalCost>1.1</TotalCost>
  <CurrencyCode>string</CurrencyCode>
  <CurrencySymbol>string</CurrencySymbol>
  <AdminId>string</AdminId>
  <ResourceName>string</ResourceName>
  <ResourceGroup>string</ResourceGroup>
  <StartTime>1970-01-01T00:00:00.001Z</StartTime>
  <EndTime>1970-01-01T00:00:00.001Z</EndTime>
  <MonthlyUnitPrice>1.1</MonthlyUnitPrice>
  <Credit>1.1</Credit>
  <CreditInPercentage>true</CreditInPercentage>
  <UnitDisplayName>string</UnitDisplayName>
  <SourceSubscriptionId>string</SourceSubscriptionId>
</Inline Model>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
subscriptionId	path	string
startDate	query	date-time
endDate	query	date-time
sourceType	query	string
granularity	query	integer
appId	path	string
paginationParameters.page	query	integer
paginationParameters.page_Size	query	integer

AdminBillingCredits

get /api/integrations/{appId}/admin/service/billing/credits/userCredits

Response Class (Status 200)

OK

[
  {
    "UserId": "string",
    "UserIdDisplayName": "string",
    "CreditBalance": 0,
    "RemainingCredits": 0,
    "IsLowCreditsCheckerEnabled": true,
    "ISOCurrencySymbol": "string",
    "Comments": "string",
    "AddedBy": "string",
    "IsNegativeCreditAllowed": true
  }
]

<?xml version="1.0"?>
<Inline Model>
  <UserId>string</UserId>
  <UserIdDisplayName>string</UserIdDisplayName>
  <CreditBalance>1.1</CreditBalance>
  <RemainingCredits>1.1</RemainingCredits>
  <IsLowCreditsCheckerEnabled>true</IsLowCreditsCheckerEnabled>
  <ISOCurrencySymbol>string</ISOCurrencySymbol>
  <Comments>string</Comments>
  <AddedBy>string</AddedBy>
  <IsNegativeCreditAllowed>true</IsNegativeCreditAllowed>
</Inline Model>

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
appId			path	string

post /api/integrations/{appId}/admin/service/billing/credits/userCredits

Response Class (Status 200)

OK

{
  "Result": {},
  "IsSuccess": true,
  "Message": "string",
  "Exception": "string"
}

<?xml version="1.0"?>
<CloudAssert.WAP.Billing.Common.Contracts.API.UserCreditsAPIResponse>
  <!-- invalid XML -->
  <IsSuccess>true</IsSuccess>
  <Message>string</Message>
  <Exception>string</Exception>
</CloudAssert.WAP.Billing.Common.Contracts.API.UserCreditsAPIResponse>

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

Parameter	Value	Description	Parameter Type	Data Type
credit	Parameter content type:		body	Model Example Value CloudAssert.WAP.Billing.Common.Contracts.UserCreditsInfo { UserId (string, optional), UserIdDisplayName (string, optional), CreditBalance (number, optional), RemainingCredits (number, optional), IsLowCreditsCheckerEnabled (boolean, optional), ISOCurrencySymbol (string, optional), Comments (string, optional), AddedBy (string, optional), IsNegativeCreditAllowed (boolean, optional) } `{ "UserId": "string", "UserIdDisplayName": "string", "CreditBalance": 0, "RemainingCredits": 0, "IsLowCreditsCheckerEnabled": true, "ISOCurrencySymbol": "string", "Comments": "string", "AddedBy": "string", "IsNegativeCreditAllowed": true }` <?xml version="1.0"?> <CloudAssert.WAP.Billing.Common.Contracts.UserCreditsInfo> <UserId>string</UserId> <UserIdDisplayName>string</UserIdDisplayName> <CreditBalance>1.1</CreditBalance> <RemainingCredits>1.1</RemainingCredits> <IsLowCreditsCheckerEnabled>true</IsLowCreditsCheckerEnabled> <ISOCurrencySymbol>string</ISOCurrencySymbol> <Comments>string</Comments> <AddedBy>string</AddedBy> <IsNegativeCreditAllowed>true</IsNegativeCreditAllowed> </CloudAssert.WAP.Billing.Common.Contracts.UserCreditsInfo>
appId			path	string

credit

Parameter content type:

body

{
  "UserId": "string",
  "UserIdDisplayName": "string",
  "CreditBalance": 0,
  "RemainingCredits": 0,
  "IsLowCreditsCheckerEnabled": true,
  "ISOCurrencySymbol": "string",
  "Comments": "string",
  "AddedBy": "string",
  "IsNegativeCreditAllowed": true
}

<?xml version="1.0"?>
<CloudAssert.WAP.Billing.Common.Contracts.UserCreditsInfo>
  <UserId>string</UserId>
  <UserIdDisplayName>string</UserIdDisplayName>
  <CreditBalance>1.1</CreditBalance>
  <RemainingCredits>1.1</RemainingCredits>
  <IsLowCreditsCheckerEnabled>true</IsLowCreditsCheckerEnabled>
  <ISOCurrencySymbol>string</ISOCurrencySymbol>
  <Comments>string</Comments>
  <AddedBy>string</AddedBy>
  <IsNegativeCreditAllowed>true</IsNegativeCreditAllowed>
</CloudAssert.WAP.Billing.Common.Contracts.UserCreditsInfo>

appId path string

put /api/integrations/{appId}/admin/service/billing/credits/userCredits

Response Class (Status 200)

OK

{
  "Result": {},
  "IsSuccess": true,
  "Message": "string",
  "Exception": "string"
}

<?xml version="1.0"?>
<CloudAssert.WAP.Billing.Common.Contracts.API.UserCreditsAPIResponse>
  <!-- invalid XML -->
  <IsSuccess>true</IsSuccess>
  <Message>string</Message>
  <Exception>string</Exception>
</CloudAssert.WAP.Billing.Common.Contracts.API.UserCreditsAPIResponse>

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

Parameter	Value	Description	Parameter Type	Data Type
credit	Parameter content type:		body	Model Example Value CloudAssert.WAP.Billing.Common.Contracts.UserCreditsInfo { UserId (string, optional), UserIdDisplayName (string, optional), CreditBalance (number, optional), RemainingCredits (number, optional), IsLowCreditsCheckerEnabled (boolean, optional), ISOCurrencySymbol (string, optional), Comments (string, optional), AddedBy (string, optional), IsNegativeCreditAllowed (boolean, optional) } `{ "UserId": "string", "UserIdDisplayName": "string", "CreditBalance": 0, "RemainingCredits": 0, "IsLowCreditsCheckerEnabled": true, "ISOCurrencySymbol": "string", "Comments": "string", "AddedBy": "string", "IsNegativeCreditAllowed": true }` <?xml version="1.0"?> <CloudAssert.WAP.Billing.Common.Contracts.UserCreditsInfo> <UserId>string</UserId> <UserIdDisplayName>string</UserIdDisplayName> <CreditBalance>1.1</CreditBalance> <RemainingCredits>1.1</RemainingCredits> <IsLowCreditsCheckerEnabled>true</IsLowCreditsCheckerEnabled> <ISOCurrencySymbol>string</ISOCurrencySymbol> <Comments>string</Comments> <AddedBy>string</AddedBy> <IsNegativeCreditAllowed>true</IsNegativeCreditAllowed> </CloudAssert.WAP.Billing.Common.Contracts.UserCreditsInfo>
appId			path	string

credit

Parameter content type:

body

{
  "UserId": "string",
  "UserIdDisplayName": "string",
  "CreditBalance": 0,
  "RemainingCredits": 0,
  "IsLowCreditsCheckerEnabled": true,
  "ISOCurrencySymbol": "string",
  "Comments": "string",
  "AddedBy": "string",
  "IsNegativeCreditAllowed": true
}

<?xml version="1.0"?>
<CloudAssert.WAP.Billing.Common.Contracts.UserCreditsInfo>
  <UserId>string</UserId>
  <UserIdDisplayName>string</UserIdDisplayName>
  <CreditBalance>1.1</CreditBalance>
  <RemainingCredits>1.1</RemainingCredits>
  <IsLowCreditsCheckerEnabled>true</IsLowCreditsCheckerEnabled>
  <ISOCurrencySymbol>string</ISOCurrencySymbol>
  <Comments>string</Comments>
  <AddedBy>string</AddedBy>
  <IsNegativeCreditAllowed>true</IsNegativeCreditAllowed>
</CloudAssert.WAP.Billing.Common.Contracts.UserCreditsInfo>

appId path string

get /api/integrations/{appId}/admin/service/billing/credits/users/{userId}/currentBalance

Response Class (Status 200)

OK

{
  "Result": {},
  "IsSuccess": true,
  "Message": "string",
  "Exception": "string"
}

<?xml version="1.0"?>
<CloudAssert.WAP.Billing.Common.Contracts.API.UserCreditsAPIResponse>
  <!-- invalid XML -->
  <IsSuccess>true</IsSuccess>
  <Message>string</Message>
  <Exception>string</Exception>
</CloudAssert.WAP.Billing.Common.Contracts.API.UserCreditsAPIResponse>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
userId	path	string
isoCurrencySymbol	query	string
appId	path	string

get /api/integrations/{appId}/admin/service/billing/credits/userCredits/eligibleUsersForAddingCredits

Response Class (Status 200)

OK

{}

<?xml version="1.0"?>
<inline_model_22>
  <!-- additional elements allowed -->
</inline_model_22>

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
appId			path	string

AdminBillingCspAzure

post /api/integrations/{appId}/admin/service/billing/csp/azure/azureplan/{subscriptionId}

Response Class (Status 200)

OK

{
  "id": "string",
  "DeploymentId": 0,
  "Name": "string",
  "ResourceType": "string",
  "ResourceId": "string",
  "ResourceName": "string",
  "OwnerId": "string",
  "OwnerEmailId": "string",
  "OperationTemplateJson": "string",
  "Type": "string",
  "DisplayName": "string",
  "StatusString": "string",
  "Status": "string",
  "Message": "string",
  "Exception": "string",
  "CreatedOn": "2024-02-06T12:47:39.280Z",
  "StartTime": "2024-02-06T12:47:39.280Z",
  "CompletedTime": "2024-02-06T12:47:39.280Z",
  "AgentId": "string"
}

<?xml version="1.0"?>
<CloudAssert.WAP.Billing.ApiClient.OperationsData.DeploymentInfoOut>
  <id>string</id>
  <DeploymentId>1</DeploymentId>
  <Name>string</Name>
  <ResourceType>string</ResourceType>
  <ResourceId>string</ResourceId>
  <ResourceName>string</ResourceName>
  <OwnerId>string</OwnerId>
  <OwnerEmailId>string</OwnerEmailId>
  <OperationTemplateJson>string</OperationTemplateJson>
  <Type>string</Type>
  <DisplayName>string</DisplayName>
  <StatusString>string</StatusString>
  <Status>string</Status>
  <Message>string</Message>
  <Exception>string</Exception>
  <CreatedOn>1970-01-01T00:00:00.001Z</CreatedOn>
  <StartTime>1970-01-01T00:00:00.001Z</StartTime>
  <CompletedTime>1970-01-01T00:00:00.001Z</CompletedTime>
  <AgentId>string</AgentId>
</CloudAssert.WAP.Billing.ApiClient.OperationsData.DeploymentInfoOut>

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

subscriptionId path string

subscriptionAddOnOrderIn

Parameter content type:

body

[
  {
    "ReferenceCustomerId": "string",
    "LineItems": [
      {
        "LineItemNumber": 0,
        "FriendlyName": "string",
        "OfferId": "string",
        "PartnerIdOnRecord": "string",
        "Quantity": 0,
        "TermDuration": "string",
        "ProductId": "string",
        "SkuId": "string",
        "AvailabilityId": "string",
        "AzureSubscription": "string",
        "ProductType": "string",
        "CustomTermEndDate": "2024-02-06T12:47:39.283Z"
      }
    ],
    "ParentSubscriptionId": "string",
    "IsAddOn": true,
    "WapUserId": "string",
    "BillingCycle": 0
  }
]

<?xml version="1.0"?>
<CloudAssert.Csp.Common.Models.CspOrderIn>
  <ReferenceCustomerId>string</ReferenceCustomerId>
  <LineItems>
    <LineItemNumber>1</LineItemNumber>
    <FriendlyName>string</FriendlyName>
    <OfferId>string</OfferId>
    <PartnerIdOnRecord>string</PartnerIdOnRecord>
    <Quantity>1</Quantity>
    <TermDuration>string</TermDuration>
    <ProductId>string</ProductId>
    <SkuId>string</SkuId>
    <AvailabilityId>string</AvailabilityId>
    <AzureSubscription>string</AzureSubscription>
    <ProductType>string</ProductType>
    <CustomTermEndDate>1970-01-01T00:00:00.001Z</CustomTermEndDate>
  </LineItems>
  <ParentSubscriptionId>string</ParentSubscriptionId>
  <IsAddOn>true</IsAddOn>
  <WapUserId>string</WapUserId>
  <BillingCycle>0</BillingCycle>
</CloudAssert.Csp.Common.Models.CspOrderIn>

appId path string

post /api/integrations/{appId}/admin/service/billing/csp/azure/azureentitlement/{subscriptionId}

Response Class (Status 200)

OK

{
  "id": "string",
  "DeploymentId": 0,
  "Name": "string",
  "ResourceType": "string",
  "ResourceId": "string",
  "ResourceName": "string",
  "OwnerId": "string",
  "OwnerEmailId": "string",
  "OperationTemplateJson": "string",
  "Type": "string",
  "DisplayName": "string",
  "StatusString": "string",
  "Status": "string",
  "Message": "string",
  "Exception": "string",
  "CreatedOn": "2024-02-06T12:47:39.288Z",
  "StartTime": "2024-02-06T12:47:39.288Z",
  "CompletedTime": "2024-02-06T12:47:39.288Z",
  "AgentId": "string"
}

<?xml version="1.0"?>
<CloudAssert.WAP.Billing.ApiClient.OperationsData.DeploymentInfoOut>
  <id>string</id>
  <DeploymentId>1</DeploymentId>
  <Name>string</Name>
  <ResourceType>string</ResourceType>
  <ResourceId>string</ResourceId>
  <ResourceName>string</ResourceName>
  <OwnerId>string</OwnerId>
  <OwnerEmailId>string</OwnerEmailId>
  <OperationTemplateJson>string</OperationTemplateJson>
  <Type>string</Type>
  <DisplayName>string</DisplayName>
  <StatusString>string</StatusString>
  <Status>string</Status>
  <Message>string</Message>
  <Exception>string</Exception>
  <CreatedOn>1970-01-01T00:00:00.001Z</CreatedOn>
  <StartTime>1970-01-01T00:00:00.001Z</StartTime>
  <CompletedTime>1970-01-01T00:00:00.001Z</CompletedTime>
  <AgentId>string</AgentId>
</CloudAssert.WAP.Billing.ApiClient.OperationsData.DeploymentInfoOut>

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

subscriptionId path string

azureSubscriptionCreateRequestIn

Parameter content type:

body

{
  "CustomerId": "string",
  "AzurePlanSubscriptionId": "string",
  "SubscriptionDisplayName": "string",
  "BillingAccountId": "string",
  "SubscriptionOwnerPrincipalId": "string",
  "Tags": {}
}

<?xml version="1.0"?>
<CloudAssert.Csp.Common.Models.AzureSubscriptionCreateRequestIn>
  <CustomerId>string</CustomerId>
  <AzurePlanSubscriptionId>string</AzurePlanSubscriptionId>
  <SubscriptionDisplayName>string</SubscriptionDisplayName>
  <BillingAccountId>string</BillingAccountId>
  <SubscriptionOwnerPrincipalId>string</SubscriptionOwnerPrincipalId>
  <Tags>
    <!-- additional elements allowed -->
  </Tags>
</CloudAssert.Csp.Common.Models.AzureSubscriptionCreateRequestIn>

appId path string

post /api/integrations/{appId}/admin/service/billing/csp/azure/azureuserrole/{subscriptionId}

Response Class (Status 200)

OK

{
  "id": "string",
  "DeploymentId": 0,
  "Name": "string",
  "ResourceType": "string",
  "ResourceId": "string",
  "ResourceName": "string",
  "OwnerId": "string",
  "OwnerEmailId": "string",
  "OperationTemplateJson": "string",
  "Type": "string",
  "DisplayName": "string",
  "StatusString": "string",
  "Status": "string",
  "Message": "string",
  "Exception": "string",
  "CreatedOn": "2024-02-06T12:47:39.297Z",
  "StartTime": "2024-02-06T12:47:39.297Z",
  "CompletedTime": "2024-02-06T12:47:39.297Z",
  "AgentId": "string"
}

<?xml version="1.0"?>
<CloudAssert.WAP.Billing.ApiClient.OperationsData.DeploymentInfoOut>
  <id>string</id>
  <DeploymentId>1</DeploymentId>
  <Name>string</Name>
  <ResourceType>string</ResourceType>
  <ResourceId>string</ResourceId>
  <ResourceName>string</ResourceName>
  <OwnerId>string</OwnerId>
  <OwnerEmailId>string</OwnerEmailId>
  <OperationTemplateJson>string</OperationTemplateJson>
  <Type>string</Type>
  <DisplayName>string</DisplayName>
  <StatusString>string</StatusString>
  <Status>string</Status>
  <Message>string</Message>
  <Exception>string</Exception>
  <CreatedOn>1970-01-01T00:00:00.001Z</CreatedOn>
  <StartTime>1970-01-01T00:00:00.001Z</StartTime>
  <CompletedTime>1970-01-01T00:00:00.001Z</CompletedTime>
  <AgentId>string</AgentId>
</CloudAssert.WAP.Billing.ApiClient.OperationsData.DeploymentInfoOut>

Response Content Type

Parameters

Parameter	Value	Parameter Type	Data Type
subscriptionId		path	string
principalName		query	string
roleDefinitionId		query	string
azureSubscriptionOpIn	Parameter content type:	body	Model Example Value CloudAssert.Csp.Common.Models.AzureSubscriptionOpIn { AzureSubscriptionId (string, optional), AzurePlanSubscriptionId (string, optional), CustomerId (string, optional), AzureSubscriptionName (string, optional), CustomerCompany (string, optional), IsReactivateSubscription (boolean, optional) } `{ "AzureSubscriptionId": "string", "AzurePlanSubscriptionId": "string", "CustomerId": "string", "AzureSubscriptionName": "string", "CustomerCompany": "string", "IsReactivateSubscription": true }` `<?xml version="1.0"?> <CloudAssert.Csp.Common.Models.AzureSubscriptionOpIn> <AzureSubscriptionId>string</AzureSubscriptionId> <AzurePlanSubscriptionId>string</AzurePlanSubscriptionId> <CustomerId>string</CustomerId> <AzureSubscriptionName>string</AzureSubscriptionName> <CustomerCompany>string</CustomerCompany> <IsReactivateSubscription>true</IsReactivateSubscription> </CloudAssert.Csp.Common.Models.AzureSubscriptionOpIn>`
appId		path	string

AdminBillingCspCompanies

get /api/integrations/{appId}/admin/service/billing/csp/companies

Response Class (Status 200)

OK

integer
Enum:	0, 100, 200, 300, 400, 500

{
  "draw": 0,
  "recordsFiltered": 0,
  "recordsTotal": 0,
  "data": [
    {
      "MicrosoftTenantId": "string",
      "HybrMappingStatus": 0,
      "HybrTenantId": "00000000-0000-0000-0000-000000000000"
    }
  ]
}

<?xml version="1.0"?>
<Trisul.Org.Api.Web.Areas.Admin.Models.DataTable[Trisul.Org.Business.Models.Responses.CspCompanyInfo]>
  <draw>1</draw>
  <recordsFiltered>1</recordsFiltered>
  <recordsTotal>1</recordsTotal>
  <data>
    <MicrosoftTenantId>string</MicrosoftTenantId>
    <HybrMappingStatus>0</HybrMappingStatus>
    <HybrTenantId>00000000-0000-0000-0000-000000000000</HybrTenantId>
  </data>
</Trisul.Org.Api.Web.Areas.Admin.Models.DataTable[Trisul.Org.Business.Models.Responses.CspCompanyInfo]>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
appId	path	string
paginationParameters.page	query	integer
paginationParameters.page_Size	query	integer

get /api/integrations/{appId}/admin/service/billing/csp/companies/{companyId}

Response Class (Status 200)

OK

integer
Enum:	0, 100, 200, 300, 400, 500

{
  "MicrosoftTenantId": "string",
  "HybrMappingStatus": 0,
  "HybrTenantId": "00000000-0000-0000-0000-000000000000"
}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
companyId			path	string
appId			path	string

AdminBillingCspCostDetails

get /api/integrations/{appId}/admin/service/billing/csp/costDetails/azureusagecostdetails

Response Class (Status 200)

OK

{
  "MetaData": {
    "Page_Size": 0,
    "Page": 0,
    "TotalPages": 0,
    "TotalRecords": 0
  },
  "Data": [
    {
      "CustomerId": "string",
      "SubscriptionId": "string",
      "EntitlementId": "string",
      "MeterId": "string",
      "ResourceLocation": "string",
      "Cost": 0,
      "Currency": "string"
    }
  ]
}

<?xml version="1.0"?>
<CloudAssert.WAP.Billing.Common.DataContracts.Common.PagedResponse[CloudAssert.WAP.Billing.Common.DataContracts.Csp.CspUsageMeterCostData]>
  <MetaData>
    <Page_Size>1</Page_Size>
    <Page>1</Page>
    <TotalPages>1</TotalPages>
    <TotalRecords>1</TotalRecords>
  </MetaData>
  <Data>
    <CustomerId>string</CustomerId>
    <SubscriptionId>string</SubscriptionId>
    <EntitlementId>string</EntitlementId>
    <MeterId>string</MeterId>
    <ResourceLocation>string</ResourceLocation>
    <Cost>1.1</Cost>
    <Currency>string</Currency>
  </Data>
</CloudAssert.WAP.Billing.Common.DataContracts.Common.PagedResponse[CloudAssert.WAP.Billing.Common.DataContracts.Csp.CspUsageMeterCostData]>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
month	query	string
appId	path	string
paginationParameters.page	query	integer
paginationParameters.page_Size	query	integer

AdminBillingCspCustomers

post /api/integrations/{appId}/admin/service/billing/csp/customers/customerwithexisitingtenant/{subscriptionId}

Response Class (Status 200)

OK

{
  "id": "string",
  "DeploymentId": 0,
  "Name": "string",
  "ResourceType": "string",
  "ResourceId": "string",
  "ResourceName": "string",
  "OwnerId": "string",
  "OwnerEmailId": "string",
  "OperationTemplateJson": "string",
  "Type": "string",
  "DisplayName": "string",
  "StatusString": "string",
  "Status": "string",
  "Message": "string",
  "Exception": "string",
  "CreatedOn": "2024-02-06T12:47:39.315Z",
  "StartTime": "2024-02-06T12:47:39.315Z",
  "CompletedTime": "2024-02-06T12:47:39.315Z",
  "AgentId": "string"
}

<?xml version="1.0"?>
<CloudAssert.WAP.Billing.ApiClient.OperationsData.DeploymentInfoOut>
  <id>string</id>
  <DeploymentId>1</DeploymentId>
  <Name>string</Name>
  <ResourceType>string</ResourceType>
  <ResourceId>string</ResourceId>
  <ResourceName>string</ResourceName>
  <OwnerId>string</OwnerId>
  <OwnerEmailId>string</OwnerEmailId>
  <OperationTemplateJson>string</OperationTemplateJson>
  <Type>string</Type>
  <DisplayName>string</DisplayName>
  <StatusString>string</StatusString>
  <Status>string</Status>
  <Message>string</Message>
  <Exception>string</Exception>
  <CreatedOn>1970-01-01T00:00:00.001Z</CreatedOn>
  <StartTime>1970-01-01T00:00:00.001Z</StartTime>
  <CompletedTime>1970-01-01T00:00:00.001Z</CompletedTime>
  <AgentId>string</AgentId>
</CloudAssert.WAP.Billing.ApiClient.OperationsData.DeploymentInfoOut>

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

subscriptionId path string

customerIn

Parameter content type:

body

{
  "WapUserId": "string",
  "FirstName": "string",
  "LastName": "string",
  "CompanyName": "string",
  "Email": "string",
  "AddressLine1": "string",
  "AddressLine2": "string",
  "City": "string",
  "State": "string",
  "PostalCode": "string",
  "Country": "string",
  "PhoneNumber": "string",
  "Language": "string",
  "Culture": "string",
  "Domain": "string",
  "IsAgreementAccepted": true,
  "DateAgreed": "2024-02-06T12:47:39.317Z"
}

<?xml version="1.0"?>
<CloudAssert.Csp.Common.Models.ExternalCspCustomerIn>
  <WapUserId>string</WapUserId>
  <FirstName>string</FirstName>
  <LastName>string</LastName>
  <CompanyName>string</CompanyName>
  <Email>string</Email>
  <AddressLine1>string</AddressLine1>
  <AddressLine2>string</AddressLine2>
  <City>string</City>
  <State>string</State>
  <PostalCode>string</PostalCode>
  <Country>string</Country>
  <PhoneNumber>string</PhoneNumber>
  <Language>string</Language>
  <Culture>string</Culture>
  <Domain>string</Domain>
  <IsAgreementAccepted>true</IsAgreementAccepted>
  <DateAgreed>1970-01-01T00:00:00.001Z</DateAgreed>
</CloudAssert.Csp.Common.Models.ExternalCspCustomerIn>

appId path string

post /api/integrations/{appId}/admin/service/billing/csp/customers/customerwithnewtenant/{subscriptionId}

Response Class (Status 200)

OK

{
  "id": "string",
  "DeploymentId": 0,
  "Name": "string",
  "ResourceType": "string",
  "ResourceId": "string",
  "ResourceName": "string",
  "OwnerId": "string",
  "OwnerEmailId": "string",
  "OperationTemplateJson": "string",
  "Type": "string",
  "DisplayName": "string",
  "StatusString": "string",
  "Status": "string",
  "Message": "string",
  "Exception": "string",
  "CreatedOn": "2024-02-06T12:47:39.321Z",
  "StartTime": "2024-02-06T12:47:39.321Z",
  "CompletedTime": "2024-02-06T12:47:39.321Z",
  "AgentId": "string"
}

<?xml version="1.0"?>
<CloudAssert.WAP.Billing.ApiClient.OperationsData.DeploymentInfoOut>
  <id>string</id>
  <DeploymentId>1</DeploymentId>
  <Name>string</Name>
  <ResourceType>string</ResourceType>
  <ResourceId>string</ResourceId>
  <ResourceName>string</ResourceName>
  <OwnerId>string</OwnerId>
  <OwnerEmailId>string</OwnerEmailId>
  <OperationTemplateJson>string</OperationTemplateJson>
  <Type>string</Type>
  <DisplayName>string</DisplayName>
  <StatusString>string</StatusString>
  <Status>string</Status>
  <Message>string</Message>
  <Exception>string</Exception>
  <CreatedOn>1970-01-01T00:00:00.001Z</CreatedOn>
  <StartTime>1970-01-01T00:00:00.001Z</StartTime>
  <CompletedTime>1970-01-01T00:00:00.001Z</CompletedTime>
  <AgentId>string</AgentId>
</CloudAssert.WAP.Billing.ApiClient.OperationsData.DeploymentInfoOut>

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

subscriptionId path string

customerIn

Parameter content type:

body

{
  "OrgId": "string",
  "OfferId": "string",
  "IsCloneOfferEnabled": true,
  "IsResellerEnable": true,
  "ResellerCompanyId": "00000000-0000-0000-0000-000000000000",
  "ResellerSubscriptionId": "string",
  "IdentityProviderType": "string",
  "PartnerCenterCustomerIds": [
    "string"
  ],
  "CreatedByUserId": "string",
  "HybrCompanyName": "string",
  "HybrCompanyEmail": "string",
  "HybrCompanyAddressLine1": "string",
  "HybrCompanyAddressLine2": "string",
  "HybrCompanyCity": "string",
  "HybrCompanyState": "string",
  "HybrCompanyCountry": "string",
  "HybrCompanyPostalCode": "string",
  "HybrCompanyPhoneNumber": "string",
  "SubscriptionName": "string",
  "CloneOfferName": "string",
  "ClonePlanName": "string",
  "ClonePricingProfileName": "string",
  "SubscriptionId": "string",
  "WapUserId": "string",
  "ExistingCustomerId": "string",
  "FirstName": "string",
  "LastName": "string",
  "CompanyName": "string",
  "Email": "string",
  "TenantId": "string",
  "AddressLine1": "string",
  "AddressLine2": "string",
  "City": "string",
  "Region": "string",
  "State": "string",
  "PostalCode": "string",
  "Country": "string",
  "PhoneNumber": "string",
  "Language": "string",
  "Culture": "string",
  "Domain": "string",
  "IsAgreementAccepted": true,
  "DateAgreed": "2024-02-06T12:47:39.323Z",
  "UserCredentials": {
    "Password": "string",
    "UserName": "string"
  },
  "Qualification": "string",
  "OrganizationRegistrationNumber": "string"
}

<?xml version="1.0"?>
<CloudAssert.Csp.Common.Models.OnboardNewCspCustomerIn>
  <OrgId>string</OrgId>
  <OfferId>string</OfferId>
  <IsCloneOfferEnabled>true</IsCloneOfferEnabled>
  <IsResellerEnable>true</IsResellerEnable>
  <ResellerCompanyId>00000000-0000-0000-0000-000000000000</ResellerCompanyId>
  <ResellerSubscriptionId>string</ResellerSubscriptionId>
  <IdentityProviderType>string</IdentityProviderType>
  <PartnerCenterCustomerIds>string</PartnerCenterCustomerIds>
  <CreatedByUserId>string</CreatedByUserId>
  <HybrCompanyName>string</HybrCompanyName>
  <HybrCompanyEmail>string</HybrCompanyEmail>
  <HybrCompanyAddressLine1>string</HybrCompanyAddressLine1>
  <HybrCompanyAddressLine2>string</HybrCompanyAddressLine2>
  <HybrCompanyCity>string</HybrCompanyCity>
  <HybrCompanyState>string</HybrCompanyState>
  <HybrCompanyCountry>string</HybrCompanyCountry>
  <HybrCompanyPostalCode>string</HybrCompanyPostalCode>
  <HybrCompanyPhoneNumber>string</HybrCompanyPhoneNumber>
  <SubscriptionName>string</SubscriptionName>
  <CloneOfferName>string</CloneOfferName>
  <ClonePlanName>string</ClonePlanName>
  <ClonePricingProfileName>string</ClonePricingProfileName>
  <SubscriptionId>string</SubscriptionId>
  <WapUserId>string</WapUserId>
  <ExistingCustomerId>string</ExistingCustomerId>
  <FirstName>string</FirstName>
  <LastName>string</LastName>
  <CompanyName>string</CompanyName>
  <Email>string</Email>
  <TenantId>string</TenantId>
  <AddressLine1>string</AddressLine1>
  <AddressLine2>string</AddressLine2>
  <City>string</City>
  <Region>string</Region>
  <State>string</State>
  <PostalCode>string</PostalCode>
  <Country>string</Country>
  <PhoneNumber>string</PhoneNumber>
  <Language>string</Language>
  <Culture>string</Culture>
  <Domain>string</Domain>
  <IsAgreementAccepted>true</IsAgreementAccepted>
  <DateAgreed>1970-01-01T00:00:00.001Z</DateAgreed>
  <UserCredentials>
    <Password>string</Password>
    <UserName>string</UserName>
  </UserCredentials>
  <Qualification>string</Qualification>
  <OrganizationRegistrationNumber>string</OrganizationRegistrationNumber>
</CloudAssert.Csp.Common.Models.OnboardNewCspCustomerIn>

appId path string

AdminBillingCspLicenses

get /api/integrations/{appId}/admin/service/billing/csp/licenses

Response Class (Status 200)

OK

{
  "CustomerId": "string",
  "BillingSubscriptionId": "string",
  "CustomerProfileId": 0,
  "Licenses": [
    {
      "LicenseId": "string",
      "LicenseGroupId": "string",
      "LicenseName": "string",
      "SkuPartNumber": "string",
      "TargetType": "string",
      "ActiveUnits": 0,
      "AvailableUnits": 0,
      "CapabilityStatus": "string",
      "ConsumedUnits": 0,
      "SuspendedUnits": 0,
      "TotalUnits": 0,
      "WarningUnits": 0,
      "AssignedUsers": [
        "string"
      ]
    }
  ]
}

<?xml version="1.0"?>
<CloudAssert.Csp.Common.Models.CspLicenseSummaryOut>
  <CustomerId>string</CustomerId>
  <BillingSubscriptionId>string</BillingSubscriptionId>
  <CustomerProfileId>1</CustomerProfileId>
  <Licenses>
    <LicenseId>string</LicenseId>
    <LicenseGroupId>string</LicenseGroupId>
    <LicenseName>string</LicenseName>
    <SkuPartNumber>string</SkuPartNumber>
    <TargetType>string</TargetType>
    <ActiveUnits>1</ActiveUnits>
    <AvailableUnits>1</AvailableUnits>
    <CapabilityStatus>string</CapabilityStatus>
    <ConsumedUnits>1</ConsumedUnits>
    <SuspendedUnits>1</SuspendedUnits>
    <TotalUnits>1</TotalUnits>
    <WarningUnits>1</WarningUnits>
    <AssignedUsers>string</AssignedUsers>
  </Licenses>
</CloudAssert.Csp.Common.Models.CspLicenseSummaryOut>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
customerId	query	string
appId	path	string
paginationParameters.page	query	integer
paginationParameters.page_Size	query	integer

AdminBillingDeployments

get /api/integrations/{appId}/admin/service/billing/deployments/deploymentstatus/{deploymentId}

Get deployment status from the billing service.

Response Class (Status 200)

OK

{
  "DeploymentId": 0,
  "DeploymentName": "string",
  "StatusString": "string"
}

<?xml version="1.0"?>
<CloudAssert.WAP.Billing.Common.DataContracts.DeploymentStatusInfoOut>
  <DeploymentId>1</DeploymentId>
  <DeploymentName>string</DeploymentName>
  <StatusString>string</StatusString>
</CloudAssert.WAP.Billing.Common.DataContracts.DeploymentStatusInfoOut>

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
deploymentId			path	long
appId			path	string

AdminBillingInvoices

get /api/integrations/{appId}/admin/service/billing/invoices

Response Class (Status 200)

OK

[
  {
    "InvoiceId": 0,
    "CompanyName": "string",
    "SubscriptionId": "string",
    "BillingStartTime": "2024-02-06T12:47:39.337Z",
    "BillingEndTime": "2024-02-06T12:47:39.337Z",
    "InvoiceStatus": "string",
    "PaymentStatus": "string",
    "TotalAmount": "string"
  }
]

<?xml version="1.0"?>
<Inline Model>
  <InvoiceId>1</InvoiceId>
  <CompanyName>string</CompanyName>
  <SubscriptionId>string</SubscriptionId>
  <BillingStartTime>1970-01-01T00:00:00.001Z</BillingStartTime>
  <BillingEndTime>1970-01-01T00:00:00.001Z</BillingEndTime>
  <InvoiceStatus>string</InvoiceStatus>
  <PaymentStatus>string</PaymentStatus>
  <TotalAmount>string</TotalAmount>
</Inline Model>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
month	query	string
appId	path	string
paginationParameters.page	query	integer
paginationParameters.page_Size	query	integer

get /api/integrations/{appId}/admin/service/billing/invoices/{invoiceId}

Response Class (Status 200)

OK

{
  "CompanyName": "string",
  "TotalLineItemsCount": 0,
  "InvoiceDate": "string",
  "BillingPeriod": "string",
  "LineItems": [
    {
      "Id": 0,
      "BillingCycle": "string",
      "ItemName": "string",
      "ServiceType": "string",
      "TermDuration": "string",
      "Quantity": 0,
      "Units": "string",
      "UnitPrice": 0,
      "Amount": 0,
      "ResellerCost": 0
    }
  ],
  "SubTotal": [
    {
      "ServiceType": "string",
      "Total": 0
    }
  ],
  "TotalCost": 0,
  "Margin": 0,
  "MarginPercentage": 0,
  "Currency": "string"
}

<?xml version="1.0"?>
<CloudAssert.WAP.Billing.Common.DataContracts.InvoiceExternalData.InvoiceDataOut>
  <CompanyName>string</CompanyName>
  <TotalLineItemsCount>1</TotalLineItemsCount>
  <InvoiceDate>string</InvoiceDate>
  <BillingPeriod>string</BillingPeriod>
  <LineItems>
    <Id>1</Id>
    <BillingCycle>string</BillingCycle>
    <ItemName>string</ItemName>
    <ServiceType>string</ServiceType>
    <TermDuration>string</TermDuration>
    <Quantity>1.1</Quantity>
    <Units>string</Units>
    <UnitPrice>1.1</UnitPrice>
    <Amount>1.1</Amount>
    <ResellerCost>1.1</ResellerCost>
  </LineItems>
  <SubTotal>
    <ServiceType>string</ServiceType>
    <Total>1.1</Total>
  </SubTotal>
  <TotalCost>1.1</TotalCost>
  <Margin>1.1</Margin>
  <MarginPercentage>1.1</MarginPercentage>
  <Currency>string</Currency>
</CloudAssert.WAP.Billing.Common.DataContracts.InvoiceExternalData.InvoiceDataOut>

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
invoiceId			path	long
appId			path	string

AdminBillingPricing

get /api/integrations/{appId}/admin/service/billing/pricing/exchangeRates

Response Class (Status 200)

OK

[
  {
    "Id": 0,
    "SourceCurrencyCodeId": 0,
    "SourceCurrencyCodeData": {
      "Id": 0,
      "Code": "string",
      "Region": "string",
      "DisplayName": "string",
      "Symbol": "string"
    },
    "TargetCurrencyCodeId": 0,
    "TargetCurrencyCodeData": {
      "Id": 0,
      "Code": "string",
      "Region": "string",
      "DisplayName": "string",
      "Symbol": "string"
    },
    "EffectiveStartDate": "2024-02-06T12:47:39.345Z",
    "EffectiveEndDate": "2024-02-06T12:47:39.345Z",
    "ExchangeRate": 0,
    "CreatedTime": "2024-02-06T12:47:39.345Z",
    "CreatedBy": "string",
    "LastModifiedTime": "2024-02-06T12:47:39.345Z",
    "LastModifiedBy": "string"
  }
]

<?xml version="1.0"?>
<Inline Model>
  <Id>1</Id>
  <SourceCurrencyCodeId>1</SourceCurrencyCodeId>
  <SourceCurrencyCodeData>
    <Id>1</Id>
    <Code>string</Code>
    <Region>string</Region>
    <DisplayName>string</DisplayName>
    <Symbol>string</Symbol>
  </SourceCurrencyCodeData>
  <TargetCurrencyCodeId>1</TargetCurrencyCodeId>
  <TargetCurrencyCodeData>
    <Id>1</Id>
    <Code>string</Code>
    <Region>string</Region>
    <DisplayName>string</DisplayName>
    <Symbol>string</Symbol>
  </TargetCurrencyCodeData>
  <EffectiveStartDate>1970-01-01T00:00:00.001Z</EffectiveStartDate>
  <EffectiveEndDate>1970-01-01T00:00:00.001Z</EffectiveEndDate>
  <ExchangeRate>1.1</ExchangeRate>
  <CreatedTime>1970-01-01T00:00:00.001Z</CreatedTime>
  <CreatedBy>string</CreatedBy>
  <LastModifiedTime>1970-01-01T00:00:00.001Z</LastModifiedTime>
  <LastModifiedBy>string</LastModifiedBy>
</Inline Model>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
sourcecurrency	query	string
billingcycle	query	date-time
appId	path	string
paginationParameters.page	query	integer
paginationParameters.page_Size	query	integer

AdminBillingPricingProfiles

get /api/integrations/{appId}/admin/service/billing/pricingProfiles

Get all pricing profiles.

Response Class (Status 200)

OK

integer
Enum:	0, 10, 20, 30, 40, 50, 60

integer
Enum:	0, 100, 500

integer
Enum:	0, 100

[
  {
    "id": "string",
    "Id": 0,
    "name": "string",
    "displayName": "string",
    "ProfileName": "string",
    "BasePricingProfileIds": [
      0
    ],
    "CatalogName": "string",
    "CatalogSequenceNumber": 0,
    "CatalogAmount": "string",
    "Advertisement": "string",
    "Type": "string",
    "Region": "string",
    "MonthlyFee": 0,
    "OneTimeFee": 0,
    "IncludedMonthlyCreditAmount": 0,
    "PromoCredit": 0,
    "PromoPercent": 0,
    "PromoPeriod": 0,
    "MinimumCommitmentDuration": 0,
    "IsMonthlyPromoPeriod": true,
    "OwnerSubscriptionId": "string",
    "PromotionType": 0,
    "PromotionTypeString": "string",
    "PaymentFrequency": 0,
    "PaymentFrequencyString": "string",
    "ISOCurrencySymbol": "string",
    "CurrencySymbol": "string",
    "Terms": "string",
    "IsShowOnlyTerms": true,
    "IsDeleted": true,
    "IsStandardTaxRateApplicable": true,
    "IsMinimumMonthlyFeeApplicable": true,
    "MarkupPercent": 0,
    "ApplyMarkupOnlyToBasePP": true,
    "IsAggregateBaseMarkups": true,
    "ProviderNames": [
      "string"
    ],
    "PricingProfileType": 0,
    "PricingProfileTypeString": "string",
    "PromoCreditInPercentage": true,
    "UpdatedTime": "2024-02-06T12:47:39.349Z",
    "AggregateBaseCredits": true,
    "ApplyMicrosoftCSPPromotionOnTopOfMRPDiscount": true
  }
]

<?xml version="1.0"?>
<Inline Model>
  <id>string</id>
  <Id>1</Id>
  <name>string</name>
  <displayName>string</displayName>
  <ProfileName>string</ProfileName>
  <BasePricingProfileIds>1</BasePricingProfileIds>
  <CatalogName>string</CatalogName>
  <CatalogSequenceNumber>1.1</CatalogSequenceNumber>
  <CatalogAmount>string</CatalogAmount>
  <Advertisement>string</Advertisement>
  <Type>string</Type>
  <Region>string</Region>
  <MonthlyFee>1.1</MonthlyFee>
  <OneTimeFee>1.1</OneTimeFee>
  <IncludedMonthlyCreditAmount>1.1</IncludedMonthlyCreditAmount>
  <PromoCredit>1.1</PromoCredit>
  <PromoPercent>1.1</PromoPercent>
  <PromoPeriod>1.1</PromoPeriod>
  <MinimumCommitmentDuration>1.1</MinimumCommitmentDuration>
  <IsMonthlyPromoPeriod>true</IsMonthlyPromoPeriod>
  <OwnerSubscriptionId>string</OwnerSubscriptionId>
  <PromotionType>0</PromotionType>
  <PromotionTypeString>string</PromotionTypeString>
  <PaymentFrequency>0</PaymentFrequency>
  <PaymentFrequencyString>string</PaymentFrequencyString>
  <ISOCurrencySymbol>string</ISOCurrencySymbol>
  <CurrencySymbol>string</CurrencySymbol>
  <Terms>string</Terms>
  <IsShowOnlyTerms>true</IsShowOnlyTerms>
  <IsDeleted>true</IsDeleted>
  <IsStandardTaxRateApplicable>true</IsStandardTaxRateApplicable>
  <IsMinimumMonthlyFeeApplicable>true</IsMinimumMonthlyFeeApplicable>
  <MarkupPercent>1.1</MarkupPercent>
  <ApplyMarkupOnlyToBasePP>true</ApplyMarkupOnlyToBasePP>
  <IsAggregateBaseMarkups>true</IsAggregateBaseMarkups>
  <ProviderNames>string</ProviderNames>
  <PricingProfileType>0</PricingProfileType>
  <PricingProfileTypeString>string</PricingProfileTypeString>
  <PromoCreditInPercentage>true</PromoCreditInPercentage>
  <UpdatedTime>1970-01-01T00:00:00.001Z</UpdatedTime>
  <AggregateBaseCredits>true</AggregateBaseCredits>
  <ApplyMicrosoftCSPPromotionOnTopOfMRPDiscount>true</ApplyMicrosoftCSPPromotionOnTopOfMRPDiscount>
</Inline Model>

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
appId			path	string

post /api/integrations/{appId}/admin/service/billing/pricingProfiles

WARNING: NOT IMPLEMENTED YET. DO NOT USE. Get pricing profile detail.

Response Class (Status 200)

OK

integer
Enum:	0, 10, 20, 30, 40, 50, 60

integer
Enum:	0, 100, 500

integer
Enum:	0, 100

{
  "id": "string",
  "Id": 0,
  "name": "string",
  "displayName": "string",
  "ProfileName": "string",
  "BasePricingProfileIds": [
    0
  ],
  "CatalogName": "string",
  "CatalogSequenceNumber": 0,
  "CatalogAmount": "string",
  "Advertisement": "string",
  "Type": "string",
  "Region": "string",
  "MonthlyFee": 0,
  "OneTimeFee": 0,
  "IncludedMonthlyCreditAmount": 0,
  "PromoCredit": 0,
  "PromoPercent": 0,
  "PromoPeriod": 0,
  "MinimumCommitmentDuration": 0,
  "IsMonthlyPromoPeriod": true,
  "OwnerSubscriptionId": "string",
  "PromotionType": 0,
  "PromotionTypeString": "string",
  "PaymentFrequency": 0,
  "PaymentFrequencyString": "string",
  "ISOCurrencySymbol": "string",
  "CurrencySymbol": "string",
  "Terms": "string",
  "IsShowOnlyTerms": true,
  "IsDeleted": true,
  "IsStandardTaxRateApplicable": true,
  "IsMinimumMonthlyFeeApplicable": true,
  "MarkupPercent": 0,
  "ApplyMarkupOnlyToBasePP": true,
  "IsAggregateBaseMarkups": true,
  "ProviderNames": [
    "string"
  ],
  "PricingProfileType": 0,
  "PricingProfileTypeString": "string",
  "PromoCreditInPercentage": true,
  "UpdatedTime": "2024-02-06T12:47:39.354Z",
  "AggregateBaseCredits": true,
  "ApplyMicrosoftCSPPromotionOnTopOfMRPDiscount": true
}

<?xml version="1.0"?>
<CloudAssert.WAP.Billing.Common.DataContracts.PricingProfile>
  <id>string</id>
  <Id>1</Id>
  <name>string</name>
  <displayName>string</displayName>
  <ProfileName>string</ProfileName>
  <BasePricingProfileIds>1</BasePricingProfileIds>
  <CatalogName>string</CatalogName>
  <CatalogSequenceNumber>1.1</CatalogSequenceNumber>
  <CatalogAmount>string</CatalogAmount>
  <Advertisement>string</Advertisement>
  <Type>string</Type>
  <Region>string</Region>
  <MonthlyFee>1.1</MonthlyFee>
  <OneTimeFee>1.1</OneTimeFee>
  <IncludedMonthlyCreditAmount>1.1</IncludedMonthlyCreditAmount>
  <PromoCredit>1.1</PromoCredit>
  <PromoPercent>1.1</PromoPercent>
  <PromoPeriod>1.1</PromoPeriod>
  <MinimumCommitmentDuration>1.1</MinimumCommitmentDuration>
  <IsMonthlyPromoPeriod>true</IsMonthlyPromoPeriod>
  <OwnerSubscriptionId>string</OwnerSubscriptionId>
  <PromotionType>0</PromotionType>
  <PromotionTypeString>string</PromotionTypeString>
  <PaymentFrequency>0</PaymentFrequency>
  <PaymentFrequencyString>string</PaymentFrequencyString>
  <ISOCurrencySymbol>string</ISOCurrencySymbol>
  <CurrencySymbol>string</CurrencySymbol>
  <Terms>string</Terms>
  <IsShowOnlyTerms>true</IsShowOnlyTerms>
  <IsDeleted>true</IsDeleted>
  <IsStandardTaxRateApplicable>true</IsStandardTaxRateApplicable>
  <IsMinimumMonthlyFeeApplicable>true</IsMinimumMonthlyFeeApplicable>
  <MarkupPercent>1.1</MarkupPercent>
  <ApplyMarkupOnlyToBasePP>true</ApplyMarkupOnlyToBasePP>
  <IsAggregateBaseMarkups>true</IsAggregateBaseMarkups>
  <ProviderNames>string</ProviderNames>
  <PricingProfileType>0</PricingProfileType>
  <PricingProfileTypeString>string</PricingProfileTypeString>
  <PromoCreditInPercentage>true</PromoCreditInPercentage>
  <UpdatedTime>1970-01-01T00:00:00.001Z</UpdatedTime>
  <AggregateBaseCredits>true</AggregateBaseCredits>
  <ApplyMicrosoftCSPPromotionOnTopOfMRPDiscount>true</ApplyMicrosoftCSPPromotionOnTopOfMRPDiscount>
</CloudAssert.WAP.Billing.Common.DataContracts.PricingProfile>

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

pricingData

Parameter content type:

body

{
  "Id": 0,
  "ProfileName": "string",
  "BasePricingProfileIds": [
    0
  ],
  "CatalogName": "string",
  "CatalogSequenceNumber": 0,
  "CatalogAmount": "string",
  "Advertisement": "string",
  "Region": "string",
  "MonthlyFee": 0,
  "OneTimeFee": 0,
  "IncludedMonthlyCreditAmount": 0,
  "OwnerSubscriptionId": "string",
  "PromoCredit": 0,
  "PromoPercent": 0,
  "PromoPeriod": 0,
  "IsMonthlyPromoPeriod": true,
  "PromotionType": 0,
  "PromotionTypeString": "string",
  "PaymentFrequency": 0,
  "PaymentFrequencyString": "string",
  "ISOCurrencySymbol": "string",
  "CurrencySymbol": "string",
  "Terms": "string",
  "IsShowOnlyTerms": true,
  "IsDeleted": true,
  "IsStandardTaxRateApplicable": true,
  "IsMinimumMonthlyFeeApplicable": true,
  "UpdateExistingSubscriptions": true,
  "MinimumCommitmentDuration": 0,
  "MarkupPercent": 0,
  "ApplyMarkupOnlyToBasePP": true,
  "IsAggregateBaseMarkups": true,
  "PricingProfileType": 0,
  "PricingProfileTypeString": "string",
  "AddOneTimeFeeForExistingSubscriptions": true,
  "PromoCreditInPercentage": true,
  "UpdatedTime": "2024-02-06T12:47:39.358Z",
  "AggregateBaseCredits": true,
  "ApplyMicrosoftCSPPromotionOnTopOfMRPDiscount": true
}

<?xml version="1.0"?>
<CloudAssert.WAP.Billing.Common.DataContracts.PricingProfileIn>
  <Id>1</Id>
  <ProfileName>string</ProfileName>
  <BasePricingProfileIds>1</BasePricingProfileIds>
  <CatalogName>string</CatalogName>
  <CatalogSequenceNumber>1.1</CatalogSequenceNumber>
  <CatalogAmount>string</CatalogAmount>
  <Advertisement>string</Advertisement>
  <Region>string</Region>
  <MonthlyFee>1.1</MonthlyFee>
  <OneTimeFee>1.1</OneTimeFee>
  <IncludedMonthlyCreditAmount>1.1</IncludedMonthlyCreditAmount>
  <OwnerSubscriptionId>string</OwnerSubscriptionId>
  <PromoCredit>1.1</PromoCredit>
  <PromoPercent>1.1</PromoPercent>
  <PromoPeriod>1.1</PromoPeriod>
  <IsMonthlyPromoPeriod>true</IsMonthlyPromoPeriod>
  <PromotionType>0</PromotionType>
  <PromotionTypeString>string</PromotionTypeString>
  <PaymentFrequency>0</PaymentFrequency>
  <PaymentFrequencyString>string</PaymentFrequencyString>
  <ISOCurrencySymbol>string</ISOCurrencySymbol>
  <CurrencySymbol>string</CurrencySymbol>
  <Terms>string</Terms>
  <IsShowOnlyTerms>true</IsShowOnlyTerms>
  <IsDeleted>true</IsDeleted>
  <IsStandardTaxRateApplicable>true</IsStandardTaxRateApplicable>
  <IsMinimumMonthlyFeeApplicable>true</IsMinimumMonthlyFeeApplicable>
  <UpdateExistingSubscriptions>true</UpdateExistingSubscriptions>
  <MinimumCommitmentDuration>1.1</MinimumCommitmentDuration>
  <MarkupPercent>1.1</MarkupPercent>
  <ApplyMarkupOnlyToBasePP>true</ApplyMarkupOnlyToBasePP>
  <IsAggregateBaseMarkups>true</IsAggregateBaseMarkups>
  <PricingProfileType>0</PricingProfileType>
  <PricingProfileTypeString>string</PricingProfileTypeString>
  <AddOneTimeFeeForExistingSubscriptions>true</AddOneTimeFeeForExistingSubscriptions>
  <PromoCreditInPercentage>true</PromoCreditInPercentage>
  <UpdatedTime>1970-01-01T00:00:00.001Z</UpdatedTime>
  <AggregateBaseCredits>true</AggregateBaseCredits>
  <ApplyMicrosoftCSPPromotionOnTopOfMRPDiscount>true</ApplyMicrosoftCSPPromotionOnTopOfMRPDiscount>
</CloudAssert.WAP.Billing.Common.DataContracts.PricingProfileIn>

appId path string

get /api/integrations/{appId}/admin/service/billing/pricingProfiles/{pricingProfileId}

WARNING: NOT IMPLEMENTED YET. DO NOT USE. Get pricing profile detail.

Response Class (Status 200)

OK

integer
Enum:	0, 10, 20, 30, 40, 50, 60

integer
Enum:	0, 100, 500

integer
Enum:	0, 100

{
  "id": "string",
  "Id": 0,
  "name": "string",
  "displayName": "string",
  "ProfileName": "string",
  "BasePricingProfileIds": [
    0
  ],
  "CatalogName": "string",
  "CatalogSequenceNumber": 0,
  "CatalogAmount": "string",
  "Advertisement": "string",
  "Type": "string",
  "Region": "string",
  "MonthlyFee": 0,
  "OneTimeFee": 0,
  "IncludedMonthlyCreditAmount": 0,
  "PromoCredit": 0,
  "PromoPercent": 0,
  "PromoPeriod": 0,
  "MinimumCommitmentDuration": 0,
  "IsMonthlyPromoPeriod": true,
  "OwnerSubscriptionId": "string",
  "PromotionType": 0,
  "PromotionTypeString": "string",
  "PaymentFrequency": 0,
  "PaymentFrequencyString": "string",
  "ISOCurrencySymbol": "string",
  "CurrencySymbol": "string",
  "Terms": "string",
  "IsShowOnlyTerms": true,
  "IsDeleted": true,
  "IsStandardTaxRateApplicable": true,
  "IsMinimumMonthlyFeeApplicable": true,
  "MarkupPercent": 0,
  "ApplyMarkupOnlyToBasePP": true,
  "IsAggregateBaseMarkups": true,
  "ProviderNames": [
    "string"
  ],
  "PricingProfileType": 0,
  "PricingProfileTypeString": "string",
  "PromoCreditInPercentage": true,
  "UpdatedTime": "2024-02-06T12:47:39.363Z",
  "AggregateBaseCredits": true,
  "ApplyMicrosoftCSPPromotionOnTopOfMRPDiscount": true
}

<?xml version="1.0"?>
<CloudAssert.WAP.Billing.Common.DataContracts.PricingProfile>
  <id>string</id>
  <Id>1</Id>
  <name>string</name>
  <displayName>string</displayName>
  <ProfileName>string</ProfileName>
  <BasePricingProfileIds>1</BasePricingProfileIds>
  <CatalogName>string</CatalogName>
  <CatalogSequenceNumber>1.1</CatalogSequenceNumber>
  <CatalogAmount>string</CatalogAmount>
  <Advertisement>string</Advertisement>
  <Type>string</Type>
  <Region>string</Region>
  <MonthlyFee>1.1</MonthlyFee>
  <OneTimeFee>1.1</OneTimeFee>
  <IncludedMonthlyCreditAmount>1.1</IncludedMonthlyCreditAmount>
  <PromoCredit>1.1</PromoCredit>
  <PromoPercent>1.1</PromoPercent>
  <PromoPeriod>1.1</PromoPeriod>
  <MinimumCommitmentDuration>1.1</MinimumCommitmentDuration>
  <IsMonthlyPromoPeriod>true</IsMonthlyPromoPeriod>
  <OwnerSubscriptionId>string</OwnerSubscriptionId>
  <PromotionType>0</PromotionType>
  <PromotionTypeString>string</PromotionTypeString>
  <PaymentFrequency>0</PaymentFrequency>
  <PaymentFrequencyString>string</PaymentFrequencyString>
  <ISOCurrencySymbol>string</ISOCurrencySymbol>
  <CurrencySymbol>string</CurrencySymbol>
  <Terms>string</Terms>
  <IsShowOnlyTerms>true</IsShowOnlyTerms>
  <IsDeleted>true</IsDeleted>
  <IsStandardTaxRateApplicable>true</IsStandardTaxRateApplicable>
  <IsMinimumMonthlyFeeApplicable>true</IsMinimumMonthlyFeeApplicable>
  <MarkupPercent>1.1</MarkupPercent>
  <ApplyMarkupOnlyToBasePP>true</ApplyMarkupOnlyToBasePP>
  <IsAggregateBaseMarkups>true</IsAggregateBaseMarkups>
  <ProviderNames>string</ProviderNames>
  <PricingProfileType>0</PricingProfileType>
  <PricingProfileTypeString>string</PricingProfileTypeString>
  <PromoCreditInPercentage>true</PromoCreditInPercentage>
  <UpdatedTime>1970-01-01T00:00:00.001Z</UpdatedTime>
  <AggregateBaseCredits>true</AggregateBaseCredits>
  <ApplyMicrosoftCSPPromotionOnTopOfMRPDiscount>true</ApplyMicrosoftCSPPromotionOnTopOfMRPDiscount>
</CloudAssert.WAP.Billing.Common.DataContracts.PricingProfile>

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
pricingProfileId			path	integer
appId			path	string

get /api/integrations/{appId}/admin/service/billing/pricingProfiles/{pricingProfileId}/basePricingProfiles

Get Base (parent) Pricing Profiles for a pricing profile.

Response Class (Status 200)

OK

[
  {
    "BaseProfileId": 0,
    "BaseProfileName": "string"
  }
]

<?xml version="1.0"?>
<Inline Model>
  <BaseProfileId>1</BaseProfileId>
  <BaseProfileName>string</BaseProfileName>
</Inline Model>

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
pricingProfileId			path	integer
appId			path	string

get /api/integrations/{appId}/admin/service/billing/pricingProfiles/{pricingProfileId}/mrp

Get Metered Resource Pricing for a pricing profile.

Response Class (Status 200)

OK

integer
Enum:	0, 1, 2

integer
Enum:	0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100, 110, 120, 130, 140, 150, 160, 170, 180, 190, 200

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "displayName": "string",
      "Type": "string",
      "ProviderServiceType": "string",
      "Id": 0,
      "PricingProfileId": 0,
      "ProviderName": "string",
      "ServiceType": "string",
      "MeteredResourceName": "string",
      "MeteredResourceDisplayName": "string",
      "MonthlyUnitPrice": 0,
      "MonthlyResellerPrice": 0,
      "MinimumMonthlyFee": 0,
      "UnitDisplayName": "string",
      "UnitMultiplier": 0,
      "UnitMultiplierFormula": "string",
      "CustomFormula": "string",
      "MonthlyUnitCredits": 0,
      "PromoUnitCredits": 0,
      "PromoPeriod": 0,
      "FilterProperties": {},
      "FilterPropertiesJson": "string",
      "ConditionsExpression": "string",
      "ConditionsExpressionParsed": {
        "Value": 0,
        "Tokens": [
          {}
        ],
        "Variables": [
          "string"
        ],
        "ParsedExpression": "string",
        "IsConstantExpression": true,
        "ErrorMessage": "string"
      },
      "IsUnitMultiplierFormulaParsed": true,
      "IsCustomFormulaParsed": true,
      "IsConditionsExpressionParsed": true,
      "Region": "string",
      "TierDiscountJson": "string",
      "TierDiscount": {
        "IsTierBasedOnUnits": true,
        "BaseLine": 0,
        "TierDiscountRate": [
          {
            "Start": 0,
            "DiscountPercent": 0
          }
        ]
      },
      "EffectiveStartDate": "2024-02-06T12:47:39.372Z",
      "EffectiveEndDate": "2024-02-06T12:47:39.372Z",
      "IsCollectionEnabled": true,
      "RecordType": 0,
      "RecordTypeString": "string",
      "UpdatedTime": "2024-02-06T12:47:39.372Z",
      "MarkupOrMarkdownOnBaseCost": 0,
      "MarkupOrMarkdownOnBaseCostInPercentage": true,
      "PriceListImportId": 0,
      "PriceListImport": {
        "PriceListImportId": 0,
        "PriceListImportSettingsId": 0,
        "PriceListDate": "2024-02-06T12:47:39.372Z",
        "PriceListStatus": 0,
        "ApiPricingSheetDownloadRetryCount": 0,
        "ImportSource": 10,
        "LastUpdatedDateTime": "2024-02-06T12:47:39.372Z",
        "PricingMetersSyncedBy": "string",
        "PricingMetersSyncDate": "2024-02-06T12:47:39.372Z",
        "Country": "string",
        "ImportSetting": {
          "Id": 0,
          "ServiceType": "string",
          "ImportToPricingProfileId": 0,
          "IsEnabled": true,
          "IsAutoImportEnabled": true,
          "UseFromDate": "2024-02-06T12:47:39.372Z",
          "Country": "string"
        }
      }
    }
  ],
  "filteredTotalCount": 0,
  "totalCount": 0
}

<?xml version="1.0"?>
<Microsoft.WindowsAzure.Management.Models.QueryResult[CloudAssert.WAP.Billing.Common.DataContracts.MeteredResourcePricingOut]>
  <items>
    <id>string</id>
    <name>string</name>
    <displayName>string</displayName>
    <Type>string</Type>
    <ProviderServiceType>string</ProviderServiceType>
    <Id>1</Id>
    <PricingProfileId>1</PricingProfileId>
    <ProviderName>string</ProviderName>
    <ServiceType>string</ServiceType>
    <MeteredResourceName>string</MeteredResourceName>
    <MeteredResourceDisplayName>string</MeteredResourceDisplayName>
    <MonthlyUnitPrice>1.1</MonthlyUnitPrice>
    <MonthlyResellerPrice>1.1</MonthlyResellerPrice>
    <MinimumMonthlyFee>1.1</MinimumMonthlyFee>
    <UnitDisplayName>string</UnitDisplayName>
    <UnitMultiplier>1.1</UnitMultiplier>
    <UnitMultiplierFormula>string</UnitMultiplierFormula>
    <CustomFormula>string</CustomFormula>
    <MonthlyUnitCredits>1.1</MonthlyUnitCredits>
    <PromoUnitCredits>1.1</PromoUnitCredits>
    <PromoPeriod>1.1</PromoPeriod>
    <FilterProperties>
      <!-- additional elements allowed -->
    </FilterProperties>
    <FilterPropertiesJson>string</FilterPropertiesJson>
    <ConditionsExpression>string</ConditionsExpression>
    <ConditionsExpressionParsed>
      <Value>1.1</Value>
      <!-- invalid XML -->
      <Variables>string</Variables>
      <ParsedExpression>string</ParsedExpression>
      <IsConstantExpression>true</IsConstantExpression>
      <ErrorMessage>string</ErrorMessage>
    </ConditionsExpressionParsed>
    <IsUnitMultiplierFormulaParsed>true</IsUnitMultiplierFormulaParsed>
    <IsCustomFormulaParsed>true</IsCustomFormulaParsed>
    <IsConditionsExpressionParsed>true</IsConditionsExpressionParsed>
    <Region>string</Region>
    <TierDiscountJson>string</TierDiscountJson>
    <TierDiscount>
      <IsTierBasedOnUnits>true</IsTierBasedOnUnits>
      <BaseLine>1.1</BaseLine>
      <TierDiscountRate>
        <Start>1.1</Start>
        <DiscountPercent>1.1</DiscountPercent>
      </TierDiscountRate>
    </TierDiscount>
    <EffectiveStartDate>1970-01-01T00:00:00.001Z</EffectiveStartDate>
    <EffectiveEndDate>1970-01-01T00:00:00.001Z</EffectiveEndDate>
    <IsCollectionEnabled>true</IsCollectionEnabled>
    <RecordType>0</RecordType>
    <RecordTypeString>string</RecordTypeString>
    <UpdatedTime>1970-01-01T00:00:00.001Z</UpdatedTime>
    <MarkupOrMarkdownOnBaseCost>1.1</MarkupOrMarkdownOnBaseCost>
    <MarkupOrMarkdownOnBaseCostInPercentage>true</MarkupOrMarkdownOnBaseCostInPercentage>
    <PriceListImportId>1</PriceListImportId>
    <PriceListImport>
      <PriceListImportId>1</PriceListImportId>
      <PriceListImportSettingsId>1</PriceListImportSettingsId>
      <PriceListDate>1970-01-01T00:00:00.001Z</PriceListDate>
      <PriceListStatus>0</PriceListStatus>
      <ApiPricingSheetDownloadRetryCount>1</ApiPricingSheetDownloadRetryCount>
      <ImportSource>10</ImportSource>
      <LastUpdatedDateTime>1970-01-01T00:00:00.001Z</LastUpdatedDateTime>
      <PricingMetersSyncedBy>string</PricingMetersSyncedBy>
      <PricingMetersSyncDate>1970-01-01T00:00:00.001Z</PricingMetersSyncDate>
      <Country>string</Country>
      <ImportSetting>
        <Id>1</Id>
        <ServiceType>string</ServiceType>
        <ImportToPricingProfileId>1</ImportToPricingProfileId>
        <IsEnabled>true</IsEnabled>
        <IsAutoImportEnabled>true</IsAutoImportEnabled>
        <UseFromDate>1970-01-01T00:00:00.001Z</UseFromDate>
        <Country>string</Country>
      </ImportSetting>
    </PriceListImport>
  </items>
  <filteredTotalCount>1</filteredTotalCount>
  <totalCount>1</totalCount>
</Microsoft.WindowsAzure.Management.Models.QueryResult[CloudAssert.WAP.Billing.Common.DataContracts.MeteredResourcePricingOut]>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
pricingProfileId	path	integer
providerName	query	string
isOnlyEnabled	query	boolean
skip	query	integer
take	query	integer
sortProperty	query	string
sortDirection	query	string
filter	query	string
onlyOverriddenMrps	query	boolean
appId	path	string

post /api/integrations/{appId}/admin/service/billing/pricingProfiles/{pricingProfileId}/mrp

Add a new Metered Resource Pricing for a pricing profile.

Response Class (Status 200)

OK

{
  "IsSuccess": true,
  "Message": "string"
}

<?xml version="1.0"?>
<Trisul.Org.Api.Web.Api.Controllers.Integrations.IntegrationActionResponse>
  <IsSuccess>true</IsSuccess>
  <Message>string</Message>
</Trisul.Org.Api.Web.Api.Controllers.Integrations.IntegrationActionResponse>

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

pricingProfileId path integer

meteredResourcePricing

Parameter content type:

body

{
  "Id": 0,
  "PricingProfileId": 0,
  "ProviderName": "string",
  "ServiceType": "string",
  "MeteredResourceName": "string",
  "MeteredResourceDisplayName": "string",
  "MonthlyUnitPrice": 0,
  "MonthlyResellerPrice": 0,
  "MinimumMonthlyFee": 0,
  "UnitDisplayName": "string",
  "UnitMultiplier": 0,
  "UnitMultiplierFormula": "string",
  "CustomFormula": "string",
  "MonthlyUnitCredits": 0,
  "PromoUnitCredits": 0,
  "PromoPeriod": 0,
  "FilterProperties": {},
  "FilterPropertiesJson": "string",
  "ConditionsExpression": "string",
  "ConditionsExpressionParsed": {
    "Value": 0,
    "Tokens": [
      {}
    ],
    "Variables": [
      "string"
    ],
    "ParsedExpression": "string",
    "IsConstantExpression": true,
    "ErrorMessage": "string"
  },
  "IsUnitMultiplierFormulaParsed": true,
  "IsCustomFormulaParsed": true,
  "IsConditionsExpressionParsed": true,
  "Region": "string",
  "TierDiscountJson": "string",
  "TierDiscount": {
    "IsTierBasedOnUnits": true,
    "BaseLine": 0,
    "TierDiscountRate": [
      {
        "Start": 0,
        "DiscountPercent": 0
      }
    ]
  },
  "EffectiveStartDate": "2024-02-06T12:47:39.382Z",
  "EffectiveEndDate": "2024-02-06T12:47:39.382Z",
  "IsCollectionEnabled": true,
  "RecordType": 0,
  "RecordTypeString": "string",
  "UpdatedTime": "2024-02-06T12:47:39.382Z",
  "MarkupOrMarkdownOnBaseCost": 0,
  "MarkupOrMarkdownOnBaseCostInPercentage": true,
  "PriceListImportId": 0,
  "PriceListImport": {
    "PriceListImportId": 0,
    "PriceListImportSettingsId": 0,
    "PriceListDate": "2024-02-06T12:47:39.383Z",
    "PriceListStatus": 0,
    "ApiPricingSheetDownloadRetryCount": 0,
    "ImportSource": 10,
    "LastUpdatedDateTime": "2024-02-06T12:47:39.383Z",
    "PricingMetersSyncedBy": "string",
    "PricingMetersSyncDate": "2024-02-06T12:47:39.383Z",
    "Country": "string",
    "ImportSetting": {
      "Id": 0,
      "ServiceType": "string",
      "ImportToPricingProfileId": 0,
      "IsEnabled": true,
      "IsAutoImportEnabled": true,
      "UseFromDate": "2024-02-06T12:47:39.383Z",
      "Country": "string"
    }
  }
}

<?xml version="1.0"?>
<CloudAssert.WAP.Billing.Common.DataContracts.MeteredResourcePricing>
  <Id>1</Id>
  <PricingProfileId>1</PricingProfileId>
  <ProviderName>string</ProviderName>
  <ServiceType>string</ServiceType>
  <MeteredResourceName>string</MeteredResourceName>
  <MeteredResourceDisplayName>string</MeteredResourceDisplayName>
  <MonthlyUnitPrice>1.1</MonthlyUnitPrice>
  <MonthlyResellerPrice>1.1</MonthlyResellerPrice>
  <MinimumMonthlyFee>1.1</MinimumMonthlyFee>
  <UnitDisplayName>string</UnitDisplayName>
  <UnitMultiplier>1.1</UnitMultiplier>
  <UnitMultiplierFormula>string</UnitMultiplierFormula>
  <CustomFormula>string</CustomFormula>
  <MonthlyUnitCredits>1.1</MonthlyUnitCredits>
  <PromoUnitCredits>1.1</PromoUnitCredits>
  <PromoPeriod>1.1</PromoPeriod>
  <FilterProperties>
    <!-- additional elements allowed -->
  </FilterProperties>
  <FilterPropertiesJson>string</FilterPropertiesJson>
  <ConditionsExpression>string</ConditionsExpression>
  <ConditionsExpressionParsed>
    <Value>1.1</Value>
    <!-- invalid XML -->
    <Variables>string</Variables>
    <ParsedExpression>string</ParsedExpression>
    <IsConstantExpression>true</IsConstantExpression>
    <ErrorMessage>string</ErrorMessage>
  </ConditionsExpressionParsed>
  <IsUnitMultiplierFormulaParsed>true</IsUnitMultiplierFormulaParsed>
  <IsCustomFormulaParsed>true</IsCustomFormulaParsed>
  <IsConditionsExpressionParsed>true</IsConditionsExpressionParsed>
  <Region>string</Region>
  <TierDiscountJson>string</TierDiscountJson>
  <TierDiscount>
    <IsTierBasedOnUnits>true</IsTierBasedOnUnits>
    <BaseLine>1.1</BaseLine>
    <TierDiscountRate>
      <Start>1.1</Start>
      <DiscountPercent>1.1</DiscountPercent>
    </TierDiscountRate>
  </TierDiscount>
  <EffectiveStartDate>1970-01-01T00:00:00.001Z</EffectiveStartDate>
  <EffectiveEndDate>1970-01-01T00:00:00.001Z</EffectiveEndDate>
  <IsCollectionEnabled>true</IsCollectionEnabled>
  <RecordType>0</RecordType>
  <RecordTypeString>string</RecordTypeString>
  <UpdatedTime>1970-01-01T00:00:00.001Z</UpdatedTime>
  <MarkupOrMarkdownOnBaseCost>1.1</MarkupOrMarkdownOnBaseCost>
  <MarkupOrMarkdownOnBaseCostInPercentage>true</MarkupOrMarkdownOnBaseCostInPercentage>
  <PriceListImportId>1</PriceListImportId>
  <PriceListImport>
    <PriceListImportId>1</PriceListImportId>
    <PriceListImportSettingsId>1</PriceListImportSettingsId>
    <PriceListDate>1970-01-01T00:00:00.001Z</PriceListDate>
    <PriceListStatus>0</PriceListStatus>
    <ApiPricingSheetDownloadRetryCount>1</ApiPricingSheetDownloadRetryCount>
    <ImportSource>10</ImportSource>
    <LastUpdatedDateTime>1970-01-01T00:00:00.001Z</LastUpdatedDateTime>
    <PricingMetersSyncedBy>string</PricingMetersSyncedBy>
    <PricingMetersSyncDate>1970-01-01T00:00:00.001Z</PricingMetersSyncDate>
    <Country>string</Country>
    <ImportSetting>
      <Id>1</Id>
      <ServiceType>string</ServiceType>
      <ImportToPricingProfileId>1</ImportToPricingProfileId>
      <IsEnabled>true</IsEnabled>
      <IsAutoImportEnabled>true</IsAutoImportEnabled>
      <UseFromDate>1970-01-01T00:00:00.001Z</UseFromDate>
      <Country>string</Country>
    </ImportSetting>
  </PriceListImport>
</CloudAssert.WAP.Billing.Common.DataContracts.MeteredResourcePricing>

appId path string

delete /api/integrations/{appId}/admin/service/billing/pricingProfiles/{pricingProfileId}/mrp/{meteredResourcePricingId}

Delete Metered Resource Pricing for a pricing profile.

Response Class (Status 200)

OK

{
  "IsSuccess": true,
  "Message": "string"
}

<?xml version="1.0"?>
<Trisul.Org.Api.Web.Api.Controllers.Integrations.IntegrationActionResponse>
  <IsSuccess>true</IsSuccess>
  <Message>string</Message>
</Trisul.Org.Api.Web.Api.Controllers.Integrations.IntegrationActionResponse>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
pricingProfileId	path	integer
meteredResourcePricingId	path	long
appId	path	string

get /api/integrations/{appId}/admin/service/billing/pricingProfiles/{pricingProfileId}/mrp/{meteredResourcePricingId}

Get Metered Resource Pricing detail for a pricing profile.

Response Class (Status 200)

OK

{
  "id": "string",
  "name": "string",
  "displayName": "string",
  "Type": "string",
  "ProviderServiceType": "string",
  "Id": 0,
  "PricingProfileId": 0,
  "ProviderName": "string",
  "ServiceType": "string",
  "MeteredResourceName": "string",
  "MeteredResourceDisplayName": "string",
  "MonthlyUnitPrice": 0,
  "MonthlyResellerPrice": 0,
  "MinimumMonthlyFee": 0,
  "UnitDisplayName": "string",
  "UnitMultiplier": 0,
  "UnitMultiplierFormula": "string",
  "CustomFormula": "string",
  "MonthlyUnitCredits": 0,
  "PromoUnitCredits": 0,
  "PromoPeriod": 0,
  "FilterProperties": {},
  "FilterPropertiesJson": "string",
  "ConditionsExpression": "string",
  "ConditionsExpressionParsed": {
    "Value": 0,
    "Tokens": [
      {}
    ],
    "Variables": [
      "string"
    ],
    "ParsedExpression": "string",
    "IsConstantExpression": true,
    "ErrorMessage": "string"
  },
  "IsUnitMultiplierFormulaParsed": true,
  "IsCustomFormulaParsed": true,
  "IsConditionsExpressionParsed": true,
  "Region": "string",
  "TierDiscountJson": "string",
  "TierDiscount": {
    "IsTierBasedOnUnits": true,
    "BaseLine": 0,
    "TierDiscountRate": [
      {
        "Start": 0,
        "DiscountPercent": 0
      }
    ]
  },
  "EffectiveStartDate": "2024-02-06T12:47:39.391Z",
  "EffectiveEndDate": "2024-02-06T12:47:39.391Z",
  "IsCollectionEnabled": true,
  "RecordType": 0,
  "RecordTypeString": "string",
  "UpdatedTime": "2024-02-06T12:47:39.391Z",
  "MarkupOrMarkdownOnBaseCost": 0,
  "MarkupOrMarkdownOnBaseCostInPercentage": true,
  "PriceListImportId": 0,
  "PriceListImport": {
    "PriceListImportId": 0,
    "PriceListImportSettingsId": 0,
    "PriceListDate": "2024-02-06T12:47:39.391Z",
    "PriceListStatus": 0,
    "ApiPricingSheetDownloadRetryCount": 0,
    "ImportSource": 10,
    "LastUpdatedDateTime": "2024-02-06T12:47:39.391Z",
    "PricingMetersSyncedBy": "string",
    "PricingMetersSyncDate": "2024-02-06T12:47:39.391Z",
    "Country": "string",
    "ImportSetting": {
      "Id": 0,
      "ServiceType": "string",
      "ImportToPricingProfileId": 0,
      "IsEnabled": true,
      "IsAutoImportEnabled": true,
      "UseFromDate": "2024-02-06T12:47:39.391Z",
      "Country": "string"
    }
  }
}

<?xml version="1.0"?>
<CloudAssert.WAP.Billing.Common.DataContracts.MeteredResourcePricingOut>
  <id>string</id>
  <name>string</name>
  <displayName>string</displayName>
  <Type>string</Type>
  <ProviderServiceType>string</ProviderServiceType>
  <Id>1</Id>
  <PricingProfileId>1</PricingProfileId>
  <ProviderName>string</ProviderName>
  <ServiceType>string</ServiceType>
  <MeteredResourceName>string</MeteredResourceName>
  <MeteredResourceDisplayName>string</MeteredResourceDisplayName>
  <MonthlyUnitPrice>1.1</MonthlyUnitPrice>
  <MonthlyResellerPrice>1.1</MonthlyResellerPrice>
  <MinimumMonthlyFee>1.1</MinimumMonthlyFee>
  <UnitDisplayName>string</UnitDisplayName>
  <UnitMultiplier>1.1</UnitMultiplier>
  <UnitMultiplierFormula>string</UnitMultiplierFormula>
  <CustomFormula>string</CustomFormula>
  <MonthlyUnitCredits>1.1</MonthlyUnitCredits>
  <PromoUnitCredits>1.1</PromoUnitCredits>
  <PromoPeriod>1.1</PromoPeriod>
  <FilterProperties>
    <!-- additional elements allowed -->
  </FilterProperties>
  <FilterPropertiesJson>string</FilterPropertiesJson>
  <ConditionsExpression>string</ConditionsExpression>
  <ConditionsExpressionParsed>
    <Value>1.1</Value>
    <!-- invalid XML -->
    <Variables>string</Variables>
    <ParsedExpression>string</ParsedExpression>
    <IsConstantExpression>true</IsConstantExpression>
    <ErrorMessage>string</ErrorMessage>
  </ConditionsExpressionParsed>
  <IsUnitMultiplierFormulaParsed>true</IsUnitMultiplierFormulaParsed>
  <IsCustomFormulaParsed>true</IsCustomFormulaParsed>
  <IsConditionsExpressionParsed>true</IsConditionsExpressionParsed>
  <Region>string</Region>
  <TierDiscountJson>string</TierDiscountJson>
  <TierDiscount>
    <IsTierBasedOnUnits>true</IsTierBasedOnUnits>
    <BaseLine>1.1</BaseLine>
    <TierDiscountRate>
      <Start>1.1</Start>
      <DiscountPercent>1.1</DiscountPercent>
    </TierDiscountRate>
  </TierDiscount>
  <EffectiveStartDate>1970-01-01T00:00:00.001Z</EffectiveStartDate>
  <EffectiveEndDate>1970-01-01T00:00:00.001Z</EffectiveEndDate>
  <IsCollectionEnabled>true</IsCollectionEnabled>
  <RecordType>0</RecordType>
  <RecordTypeString>string</RecordTypeString>
  <UpdatedTime>1970-01-01T00:00:00.001Z</UpdatedTime>
  <MarkupOrMarkdownOnBaseCost>1.1</MarkupOrMarkdownOnBaseCost>
  <MarkupOrMarkdownOnBaseCostInPercentage>true</MarkupOrMarkdownOnBaseCostInPercentage>
  <PriceListImportId>1</PriceListImportId>
  <PriceListImport>
    <PriceListImportId>1</PriceListImportId>
    <PriceListImportSettingsId>1</PriceListImportSettingsId>
    <PriceListDate>1970-01-01T00:00:00.001Z</PriceListDate>
    <PriceListStatus>0</PriceListStatus>
    <ApiPricingSheetDownloadRetryCount>1</ApiPricingSheetDownloadRetryCount>
    <ImportSource>10</ImportSource>
    <LastUpdatedDateTime>1970-01-01T00:00:00.001Z</LastUpdatedDateTime>
    <PricingMetersSyncedBy>string</PricingMetersSyncedBy>
    <PricingMetersSyncDate>1970-01-01T00:00:00.001Z</PricingMetersSyncDate>
    <Country>string</Country>
    <ImportSetting>
      <Id>1</Id>
      <ServiceType>string</ServiceType>
      <ImportToPricingProfileId>1</ImportToPricingProfileId>
      <IsEnabled>true</IsEnabled>
      <IsAutoImportEnabled>true</IsAutoImportEnabled>
      <UseFromDate>1970-01-01T00:00:00.001Z</UseFromDate>
      <Country>string</Country>
    </ImportSetting>
  </PriceListImport>
</CloudAssert.WAP.Billing.Common.DataContracts.MeteredResourcePricingOut>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
pricingProfileId	path	integer
meteredResourcePricingId	path	long
appId	path	string

put /api/integrations/{appId}/admin/service/billing/pricingProfiles/{pricingProfileId}/mrp/{meteredResourcePricingId}

Update Metered Resource Pricing for a pricing profile.

Response Class (Status 200)

OK

{
  "IsSuccess": true,
  "Message": "string"
}

<?xml version="1.0"?>
<Trisul.Org.Api.Web.Api.Controllers.Integrations.IntegrationActionResponse>
  <IsSuccess>true</IsSuccess>
  <Message>string</Message>
</Trisul.Org.Api.Web.Api.Controllers.Integrations.IntegrationActionResponse>

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

pricingProfileId path integer

meteredResourcePricingId path long

meteredResourcePricing

Parameter content type:

body

{
  "Id": 0,
  "PricingProfileId": 0,
  "ProviderName": "string",
  "ServiceType": "string",
  "MeteredResourceName": "string",
  "MeteredResourceDisplayName": "string",
  "MonthlyUnitPrice": 0,
  "MonthlyResellerPrice": 0,
  "MinimumMonthlyFee": 0,
  "UnitDisplayName": "string",
  "UnitMultiplier": 0,
  "UnitMultiplierFormula": "string",
  "CustomFormula": "string",
  "MonthlyUnitCredits": 0,
  "PromoUnitCredits": 0,
  "PromoPeriod": 0,
  "FilterProperties": {},
  "FilterPropertiesJson": "string",
  "ConditionsExpression": "string",
  "ConditionsExpressionParsed": {
    "Value": 0,
    "Tokens": [
      {}
    ],
    "Variables": [
      "string"
    ],
    "ParsedExpression": "string",
    "IsConstantExpression": true,
    "ErrorMessage": "string"
  },
  "IsUnitMultiplierFormulaParsed": true,
  "IsCustomFormulaParsed": true,
  "IsConditionsExpressionParsed": true,
  "Region": "string",
  "TierDiscountJson": "string",
  "TierDiscount": {
    "IsTierBasedOnUnits": true,
    "BaseLine": 0,
    "TierDiscountRate": [
      {
        "Start": 0,
        "DiscountPercent": 0
      }
    ]
  },
  "EffectiveStartDate": "2024-02-06T12:47:39.399Z",
  "EffectiveEndDate": "2024-02-06T12:47:39.399Z",
  "IsCollectionEnabled": true,
  "RecordType": 0,
  "RecordTypeString": "string",
  "UpdatedTime": "2024-02-06T12:47:39.399Z",
  "MarkupOrMarkdownOnBaseCost": 0,
  "MarkupOrMarkdownOnBaseCostInPercentage": true,
  "PriceListImportId": 0,
  "PriceListImport": {
    "PriceListImportId": 0,
    "PriceListImportSettingsId": 0,
    "PriceListDate": "2024-02-06T12:47:39.399Z",
    "PriceListStatus": 0,
    "ApiPricingSheetDownloadRetryCount": 0,
    "ImportSource": 10,
    "LastUpdatedDateTime": "2024-02-06T12:47:39.399Z",
    "PricingMetersSyncedBy": "string",
    "PricingMetersSyncDate": "2024-02-06T12:47:39.399Z",
    "Country": "string",
    "ImportSetting": {
      "Id": 0,
      "ServiceType": "string",
      "ImportToPricingProfileId": 0,
      "IsEnabled": true,
      "IsAutoImportEnabled": true,
      "UseFromDate": "2024-02-06T12:47:39.399Z",
      "Country": "string"
    }
  }
}

<?xml version="1.0"?>
<CloudAssert.WAP.Billing.Common.DataContracts.MeteredResourcePricing>
  <Id>1</Id>
  <PricingProfileId>1</PricingProfileId>
  <ProviderName>string</ProviderName>
  <ServiceType>string</ServiceType>
  <MeteredResourceName>string</MeteredResourceName>
  <MeteredResourceDisplayName>string</MeteredResourceDisplayName>
  <MonthlyUnitPrice>1.1</MonthlyUnitPrice>
  <MonthlyResellerPrice>1.1</MonthlyResellerPrice>
  <MinimumMonthlyFee>1.1</MinimumMonthlyFee>
  <UnitDisplayName>string</UnitDisplayName>
  <UnitMultiplier>1.1</UnitMultiplier>
  <UnitMultiplierFormula>string</UnitMultiplierFormula>
  <CustomFormula>string</CustomFormula>
  <MonthlyUnitCredits>1.1</MonthlyUnitCredits>
  <PromoUnitCredits>1.1</PromoUnitCredits>
  <PromoPeriod>1.1</PromoPeriod>
  <FilterProperties>
    <!-- additional elements allowed -->
  </FilterProperties>
  <FilterPropertiesJson>string</FilterPropertiesJson>
  <ConditionsExpression>string</ConditionsExpression>
  <ConditionsExpressionParsed>
    <Value>1.1</Value>
    <!-- invalid XML -->
    <Variables>string</Variables>
    <ParsedExpression>string</ParsedExpression>
    <IsConstantExpression>true</IsConstantExpression>
    <ErrorMessage>string</ErrorMessage>
  </ConditionsExpressionParsed>
  <IsUnitMultiplierFormulaParsed>true</IsUnitMultiplierFormulaParsed>
  <IsCustomFormulaParsed>true</IsCustomFormulaParsed>
  <IsConditionsExpressionParsed>true</IsConditionsExpressionParsed>
  <Region>string</Region>
  <TierDiscountJson>string</TierDiscountJson>
  <TierDiscount>
    <IsTierBasedOnUnits>true</IsTierBasedOnUnits>
    <BaseLine>1.1</BaseLine>
    <TierDiscountRate>
      <Start>1.1</Start>
      <DiscountPercent>1.1</DiscountPercent>
    </TierDiscountRate>
  </TierDiscount>
  <EffectiveStartDate>1970-01-01T00:00:00.001Z</EffectiveStartDate>
  <EffectiveEndDate>1970-01-01T00:00:00.001Z</EffectiveEndDate>
  <IsCollectionEnabled>true</IsCollectionEnabled>
  <RecordType>0</RecordType>
  <RecordTypeString>string</RecordTypeString>
  <UpdatedTime>1970-01-01T00:00:00.001Z</UpdatedTime>
  <MarkupOrMarkdownOnBaseCost>1.1</MarkupOrMarkdownOnBaseCost>
  <MarkupOrMarkdownOnBaseCostInPercentage>true</MarkupOrMarkdownOnBaseCostInPercentage>
  <PriceListImportId>1</PriceListImportId>
  <PriceListImport>
    <PriceListImportId>1</PriceListImportId>
    <PriceListImportSettingsId>1</PriceListImportSettingsId>
    <PriceListDate>1970-01-01T00:00:00.001Z</PriceListDate>
    <PriceListStatus>0</PriceListStatus>
    <ApiPricingSheetDownloadRetryCount>1</ApiPricingSheetDownloadRetryCount>
    <ImportSource>10</ImportSource>
    <LastUpdatedDateTime>1970-01-01T00:00:00.001Z</LastUpdatedDateTime>
    <PricingMetersSyncedBy>string</PricingMetersSyncedBy>
    <PricingMetersSyncDate>1970-01-01T00:00:00.001Z</PricingMetersSyncDate>
    <Country>string</Country>
    <ImportSetting>
      <Id>1</Id>
      <ServiceType>string</ServiceType>
      <ImportToPricingProfileId>1</ImportToPricingProfileId>
      <IsEnabled>true</IsEnabled>
      <IsAutoImportEnabled>true</IsAutoImportEnabled>
      <UseFromDate>1970-01-01T00:00:00.001Z</UseFromDate>
      <Country>string</Country>
    </ImportSetting>
  </PriceListImport>
</CloudAssert.WAP.Billing.Common.DataContracts.MeteredResourcePricing>

appId path string

get /api/integrations/{appId}/admin/service/billing/pricingProfiles/mrp/meteredResourceNames/{providerName}/{serviceName}

Get Metered Resource Names found in pricing profiles for the given provider and service.

Response Class (Status 200)

OK

[
  "string"
]

<?xml version="1.0"?>
  <Inline Model>string</Inline Model>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
providerName	path	string
serviceName	path	string
appId	path	string

get /api/integrations/{appId}/admin/service/billing/pricingProfiles/mrp/{providerName}/{serviceName}

Get Metered Resource Pricing found in pricing profiles for the given provider and service.

Response Class (Status 200)

OK

[
  {
    "id": "string",
    "name": "string",
    "displayName": "string",
    "Type": "string",
    "ProviderServiceType": "string",
    "Id": 0,
    "PricingProfileId": 0,
    "ProviderName": "string",
    "ServiceType": "string",
    "MeteredResourceName": "string",
    "MeteredResourceDisplayName": "string",
    "MonthlyUnitPrice": 0,
    "MonthlyResellerPrice": 0,
    "MinimumMonthlyFee": 0,
    "UnitDisplayName": "string",
    "UnitMultiplier": 0,
    "UnitMultiplierFormula": "string",
    "CustomFormula": "string",
    "MonthlyUnitCredits": 0,
    "PromoUnitCredits": 0,
    "PromoPeriod": 0,
    "FilterProperties": {},
    "FilterPropertiesJson": "string",
    "ConditionsExpression": "string",
    "ConditionsExpressionParsed": {
      "Value": 0,
      "Tokens": [
        {}
      ],
      "Variables": [
        "string"
      ],
      "ParsedExpression": "string",
      "IsConstantExpression": true,
      "ErrorMessage": "string"
    },
    "IsUnitMultiplierFormulaParsed": true,
    "IsCustomFormulaParsed": true,
    "IsConditionsExpressionParsed": true,
    "Region": "string",
    "TierDiscountJson": "string",
    "TierDiscount": {
      "IsTierBasedOnUnits": true,
      "BaseLine": 0,
      "TierDiscountRate": [
        {
          "Start": 0,
          "DiscountPercent": 0
        }
      ]
    },
    "EffectiveStartDate": "2024-02-06T12:47:39.407Z",
    "EffectiveEndDate": "2024-02-06T12:47:39.407Z",
    "IsCollectionEnabled": true,
    "RecordType": 0,
    "RecordTypeString": "string",
    "UpdatedTime": "2024-02-06T12:47:39.407Z",
    "MarkupOrMarkdownOnBaseCost": 0,
    "MarkupOrMarkdownOnBaseCostInPercentage": true,
    "PriceListImportId": 0,
    "PriceListImport": {
      "PriceListImportId": 0,
      "PriceListImportSettingsId": 0,
      "PriceListDate": "2024-02-06T12:47:39.407Z",
      "PriceListStatus": 0,
      "ApiPricingSheetDownloadRetryCount": 0,
      "ImportSource": 10,
      "LastUpdatedDateTime": "2024-02-06T12:47:39.407Z",
      "PricingMetersSyncedBy": "string",
      "PricingMetersSyncDate": "2024-02-06T12:47:39.407Z",
      "Country": "string",
      "ImportSetting": {
        "Id": 0,
        "ServiceType": "string",
        "ImportToPricingProfileId": 0,
        "IsEnabled": true,
        "IsAutoImportEnabled": true,
        "UseFromDate": "2024-02-06T12:47:39.407Z",
        "Country": "string"
      }
    }
  }
]

<?xml version="1.0"?>
<Inline Model>
  <id>string</id>
  <name>string</name>
  <displayName>string</displayName>
  <Type>string</Type>
  <ProviderServiceType>string</ProviderServiceType>
  <Id>1</Id>
  <PricingProfileId>1</PricingProfileId>
  <ProviderName>string</ProviderName>
  <ServiceType>string</ServiceType>
  <MeteredResourceName>string</MeteredResourceName>
  <MeteredResourceDisplayName>string</MeteredResourceDisplayName>
  <MonthlyUnitPrice>1.1</MonthlyUnitPrice>
  <MonthlyResellerPrice>1.1</MonthlyResellerPrice>
  <MinimumMonthlyFee>1.1</MinimumMonthlyFee>
  <UnitDisplayName>string</UnitDisplayName>
  <UnitMultiplier>1.1</UnitMultiplier>
  <UnitMultiplierFormula>string</UnitMultiplierFormula>
  <CustomFormula>string</CustomFormula>
  <MonthlyUnitCredits>1.1</MonthlyUnitCredits>
  <PromoUnitCredits>1.1</PromoUnitCredits>
  <PromoPeriod>1.1</PromoPeriod>
  <FilterProperties>
    <!-- additional elements allowed -->
  </FilterProperties>
  <FilterPropertiesJson>string</FilterPropertiesJson>
  <ConditionsExpression>string</ConditionsExpression>
  <ConditionsExpressionParsed>
    <Value>1.1</Value>
    <!-- invalid XML -->
    <Variables>string</Variables>
    <ParsedExpression>string</ParsedExpression>
    <IsConstantExpression>true</IsConstantExpression>
    <ErrorMessage>string</ErrorMessage>
  </ConditionsExpressionParsed>
  <IsUnitMultiplierFormulaParsed>true</IsUnitMultiplierFormulaParsed>
  <IsCustomFormulaParsed>true</IsCustomFormulaParsed>
  <IsConditionsExpressionParsed>true</IsConditionsExpressionParsed>
  <Region>string</Region>
  <TierDiscountJson>string</TierDiscountJson>
  <TierDiscount>
    <IsTierBasedOnUnits>true</IsTierBasedOnUnits>
    <BaseLine>1.1</BaseLine>
    <TierDiscountRate>
      <Start>1.1</Start>
      <DiscountPercent>1.1</DiscountPercent>
    </TierDiscountRate>
  </TierDiscount>
  <EffectiveStartDate>1970-01-01T00:00:00.001Z</EffectiveStartDate>
  <EffectiveEndDate>1970-01-01T00:00:00.001Z</EffectiveEndDate>
  <IsCollectionEnabled>true</IsCollectionEnabled>
  <RecordType>0</RecordType>
  <RecordTypeString>string</RecordTypeString>
  <UpdatedTime>1970-01-01T00:00:00.001Z</UpdatedTime>
  <MarkupOrMarkdownOnBaseCost>1.1</MarkupOrMarkdownOnBaseCost>
  <MarkupOrMarkdownOnBaseCostInPercentage>true</MarkupOrMarkdownOnBaseCostInPercentage>
  <PriceListImportId>1</PriceListImportId>
  <PriceListImport>
    <PriceListImportId>1</PriceListImportId>
    <PriceListImportSettingsId>1</PriceListImportSettingsId>
    <PriceListDate>1970-01-01T00:00:00.001Z</PriceListDate>
    <PriceListStatus>0</PriceListStatus>
    <ApiPricingSheetDownloadRetryCount>1</ApiPricingSheetDownloadRetryCount>
    <ImportSource>10</ImportSource>
    <LastUpdatedDateTime>1970-01-01T00:00:00.001Z</LastUpdatedDateTime>
    <PricingMetersSyncedBy>string</PricingMetersSyncedBy>
    <PricingMetersSyncDate>1970-01-01T00:00:00.001Z</PricingMetersSyncDate>
    <Country>string</Country>
    <ImportSetting>
      <Id>1</Id>
      <ServiceType>string</ServiceType>
      <ImportToPricingProfileId>1</ImportToPricingProfileId>
      <IsEnabled>true</IsEnabled>
      <IsAutoImportEnabled>true</IsAutoImportEnabled>
      <UseFromDate>1970-01-01T00:00:00.001Z</UseFromDate>
      <Country>string</Country>
    </ImportSetting>
  </PriceListImport>
</Inline Model>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
providerName	path	string
serviceName	path	string
appId	path	string

get /api/integrations/{appId}/admin/service/billing/pricingProfiles/mrp/{providerName}/{serviceName}/{meteredResourceName}

Get Metered Resource Pricing found in pricing profiles for the given provider, service and metered resource. Multiple records may be returned based on effective time period, filter properties and so on.

Response Class (Status 200)

OK

[
  {
    "id": "string",
    "name": "string",
    "displayName": "string",
    "Type": "string",
    "ProviderServiceType": "string",
    "Id": 0,
    "PricingProfileId": 0,
    "ProviderName": "string",
    "ServiceType": "string",
    "MeteredResourceName": "string",
    "MeteredResourceDisplayName": "string",
    "MonthlyUnitPrice": 0,
    "MonthlyResellerPrice": 0,
    "MinimumMonthlyFee": 0,
    "UnitDisplayName": "string",
    "UnitMultiplier": 0,
    "UnitMultiplierFormula": "string",
    "CustomFormula": "string",
    "MonthlyUnitCredits": 0,
    "PromoUnitCredits": 0,
    "PromoPeriod": 0,
    "FilterProperties": {},
    "FilterPropertiesJson": "string",
    "ConditionsExpression": "string",
    "ConditionsExpressionParsed": {
      "Value": 0,
      "Tokens": [
        {}
      ],
      "Variables": [
        "string"
      ],
      "ParsedExpression": "string",
      "IsConstantExpression": true,
      "ErrorMessage": "string"
    },
    "IsUnitMultiplierFormulaParsed": true,
    "IsCustomFormulaParsed": true,
    "IsConditionsExpressionParsed": true,
    "Region": "string",
    "TierDiscountJson": "string",
    "TierDiscount": {
      "IsTierBasedOnUnits": true,
      "BaseLine": 0,
      "TierDiscountRate": [
        {
          "Start": 0,
          "DiscountPercent": 0
        }
      ]
    },
    "EffectiveStartDate": "2024-02-06T12:47:39.414Z",
    "EffectiveEndDate": "2024-02-06T12:47:39.414Z",
    "IsCollectionEnabled": true,
    "RecordType": 0,
    "RecordTypeString": "string",
    "UpdatedTime": "2024-02-06T12:47:39.414Z",
    "MarkupOrMarkdownOnBaseCost": 0,
    "MarkupOrMarkdownOnBaseCostInPercentage": true,
    "PriceListImportId": 0,
    "PriceListImport": {
      "PriceListImportId": 0,
      "PriceListImportSettingsId": 0,
      "PriceListDate": "2024-02-06T12:47:39.414Z",
      "PriceListStatus": 0,
      "ApiPricingSheetDownloadRetryCount": 0,
      "ImportSource": 10,
      "LastUpdatedDateTime": "2024-02-06T12:47:39.414Z",
      "PricingMetersSyncedBy": "string",
      "PricingMetersSyncDate": "2024-02-06T12:47:39.414Z",
      "Country": "string",
      "ImportSetting": {
        "Id": 0,
        "ServiceType": "string",
        "ImportToPricingProfileId": 0,
        "IsEnabled": true,
        "IsAutoImportEnabled": true,
        "UseFromDate": "2024-02-06T12:47:39.414Z",
        "Country": "string"
      }
    }
  }
]

<?xml version="1.0"?>
<Inline Model>
  <id>string</id>
  <name>string</name>
  <displayName>string</displayName>
  <Type>string</Type>
  <ProviderServiceType>string</ProviderServiceType>
  <Id>1</Id>
  <PricingProfileId>1</PricingProfileId>
  <ProviderName>string</ProviderName>
  <ServiceType>string</ServiceType>
  <MeteredResourceName>string</MeteredResourceName>
  <MeteredResourceDisplayName>string</MeteredResourceDisplayName>
  <MonthlyUnitPrice>1.1</MonthlyUnitPrice>
  <MonthlyResellerPrice>1.1</MonthlyResellerPrice>
  <MinimumMonthlyFee>1.1</MinimumMonthlyFee>
  <UnitDisplayName>string</UnitDisplayName>
  <UnitMultiplier>1.1</UnitMultiplier>
  <UnitMultiplierFormula>string</UnitMultiplierFormula>
  <CustomFormula>string</CustomFormula>
  <MonthlyUnitCredits>1.1</MonthlyUnitCredits>
  <PromoUnitCredits>1.1</PromoUnitCredits>
  <PromoPeriod>1.1</PromoPeriod>
  <FilterProperties>
    <!-- additional elements allowed -->
  </FilterProperties>
  <FilterPropertiesJson>string</FilterPropertiesJson>
  <ConditionsExpression>string</ConditionsExpression>
  <ConditionsExpressionParsed>
    <Value>1.1</Value>
    <!-- invalid XML -->
    <Variables>string</Variables>
    <ParsedExpression>string</ParsedExpression>
    <IsConstantExpression>true</IsConstantExpression>
    <ErrorMessage>string</ErrorMessage>
  </ConditionsExpressionParsed>
  <IsUnitMultiplierFormulaParsed>true</IsUnitMultiplierFormulaParsed>
  <IsCustomFormulaParsed>true</IsCustomFormulaParsed>
  <IsConditionsExpressionParsed>true</IsConditionsExpressionParsed>
  <Region>string</Region>
  <TierDiscountJson>string</TierDiscountJson>
  <TierDiscount>
    <IsTierBasedOnUnits>true</IsTierBasedOnUnits>
    <BaseLine>1.1</BaseLine>
    <TierDiscountRate>
      <Start>1.1</Start>
      <DiscountPercent>1.1</DiscountPercent>
    </TierDiscountRate>
  </TierDiscount>
  <EffectiveStartDate>1970-01-01T00:00:00.001Z</EffectiveStartDate>
  <EffectiveEndDate>1970-01-01T00:00:00.001Z</EffectiveEndDate>
  <IsCollectionEnabled>true</IsCollectionEnabled>
  <RecordType>0</RecordType>
  <RecordTypeString>string</RecordTypeString>
  <UpdatedTime>1970-01-01T00:00:00.001Z</UpdatedTime>
  <MarkupOrMarkdownOnBaseCost>1.1</MarkupOrMarkdownOnBaseCost>
  <MarkupOrMarkdownOnBaseCostInPercentage>true</MarkupOrMarkdownOnBaseCostInPercentage>
  <PriceListImportId>1</PriceListImportId>
  <PriceListImport>
    <PriceListImportId>1</PriceListImportId>
    <PriceListImportSettingsId>1</PriceListImportSettingsId>
    <PriceListDate>1970-01-01T00:00:00.001Z</PriceListDate>
    <PriceListStatus>0</PriceListStatus>
    <ApiPricingSheetDownloadRetryCount>1</ApiPricingSheetDownloadRetryCount>
    <ImportSource>10</ImportSource>
    <LastUpdatedDateTime>1970-01-01T00:00:00.001Z</LastUpdatedDateTime>
    <PricingMetersSyncedBy>string</PricingMetersSyncedBy>
    <PricingMetersSyncDate>1970-01-01T00:00:00.001Z</PricingMetersSyncDate>
    <Country>string</Country>
    <ImportSetting>
      <Id>1</Id>
      <ServiceType>string</ServiceType>
      <ImportToPricingProfileId>1</ImportToPricingProfileId>
      <IsEnabled>true</IsEnabled>
      <IsAutoImportEnabled>true</IsAutoImportEnabled>
      <UseFromDate>1970-01-01T00:00:00.001Z</UseFromDate>
      <Country>string</Country>
    </ImportSetting>
  </PriceListImport>
</Inline Model>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
providerName	path	string
serviceName	path	string
meteredResourceName	path	string
appId	path	string

get /api/integrations/{appId}/admin/service/billing/pricingProfiles/mapping

Get base pricing profiles for each of the active pricing profiles.

Response Class (Status 200)

OK

[
  {
    "MaxBaseProfileLinkCount": 0,
    "ProfileId": 0,
    "ProfileName": "string",
    "MarkupPercent": 0,
    "BaseProfiles": [
      {
        "BaseProfileId": 0,
        "BaseProfileName": "string"
      }
    ],
    "LinkedProfiles": "string"
  }
]

<?xml version="1.0"?>
<Inline Model>
  <MaxBaseProfileLinkCount>1</MaxBaseProfileLinkCount>
  <ProfileId>1</ProfileId>
  <ProfileName>string</ProfileName>
  <MarkupPercent>1.1</MarkupPercent>
  <BaseProfiles>
    <BaseProfileId>1</BaseProfileId>
    <BaseProfileName>string</BaseProfileName>
  </BaseProfiles>
  <LinkedProfiles>string</LinkedProfiles>
</Inline Model>

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
appId			path	string

AdminBillingSubscriptions

get /api/integrations/{appId}/admin/service/billing/subscriptions

Get subscriptions from the billing service. This should be the subset of all subscriptions in Hybr and match subscriptions with billing service enabled. There might be some delay in getting the latest data from billing service, as the subscriptions are synched between hybr in billing in a background event processing system.

Response Class (Status 200)

OK

[
  {
    "SubscriptionId": "string",
    "SubscriptionName": "string",
    "AdminId": "string",
    "IsDeleted": true,
    "CreatedTime": "2024-02-06T12:47:39.428Z",
    "CurrencySymbol": "string",
    "CurrencyCode": "string",
    "BillingAccountId": 0,
    "BillingAccountName": "string"
  }
]

<?xml version="1.0"?>
<Inline Model>
  <SubscriptionId>string</SubscriptionId>
  <SubscriptionName>string</SubscriptionName>
  <AdminId>string</AdminId>
  <IsDeleted>true</IsDeleted>
  <CreatedTime>1970-01-01T00:00:00.001Z</CreatedTime>
  <CurrencySymbol>string</CurrencySymbol>
  <CurrencyCode>string</CurrencyCode>
  <BillingAccountId>1</BillingAccountId>
  <BillingAccountName>string</BillingAccountName>
</Inline Model>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
appId	path	string
paginationParameters.page	query	integer
paginationParameters.page_Size	query	integer

get /api/integrations/{appId}/admin/service/billing/subscriptions/{subscriptionId}

Get subscription details from the billing system.

Response Class (Status 200)

OK

{
  "SubscriptionId": "string",
  "SubscriptionName": "string",
  "AdminId": "string",
  "IsDeleted": true,
  "CreatedTime": "2024-02-06T12:47:39.431Z",
  "CurrencySymbol": "string",
  "CurrencyCode": "string",
  "BillingAccountId": 0,
  "BillingAccountName": "string"
}

<?xml version="1.0"?>
<CloudAssert.WAP.Billing.Common.Contracts.SubscriptionDetails>
  <SubscriptionId>string</SubscriptionId>
  <SubscriptionName>string</SubscriptionName>
  <AdminId>string</AdminId>
  <IsDeleted>true</IsDeleted>
  <CreatedTime>1970-01-01T00:00:00.001Z</CreatedTime>
  <CurrencySymbol>string</CurrencySymbol>
  <CurrencyCode>string</CurrencyCode>
  <BillingAccountId>1</BillingAccountId>
  <BillingAccountName>string</BillingAccountName>
</CloudAssert.WAP.Billing.Common.Contracts.SubscriptionDetails>

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
subscriptionId			path	string
appId			path	string

get /api/integrations/{appId}/admin/service/billing/subscriptions/subscriptionSummaryForMonth

Gets the list of subscriptions created during the specified month.

Response Class (Status 200)

OK

[
  {
    "SubscriptionId": "string",
    "AdminId": "string",
    "PlanName": "string",
    "SubscriptionName": "string",
    "CoAdminIds": "string",
    "CreatedTime": "2024-02-06T12:47:39.434Z",
    "DeletedTime": "2024-02-06T12:47:39.434Z",
    "IsCleanupCompletedAfterDelete": true,
    "IsDeleted": true,
    "LastErrorMessage": "string",
    "LifeCycleState": 0,
    "QuotaUpdatedTime": "2024-02-06T12:47:39.434Z",
    "State": 0,
    "UpdatedTime": "2024-02-06T12:47:39.434Z",
    "PricingProfileId": 0,
    "SuspendedBy": "string",
    "SuspendedTime": "2024-02-06T12:47:39.434Z",
    "CommitmentExpiryDate": "2024-02-06T12:47:39.434Z",
    "ShouldApplyOneTimeFee": true,
    "OneTimeFeeExpiryDate": "2024-02-06T12:47:39.434Z",
    "SubscriptionType": 0,
    "SubscriptionTypeString": "string",
    "QuotaSettings": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  }
]

<?xml version="1.0"?>
<Inline Model>
  <SubscriptionId>string</SubscriptionId>
  <AdminId>string</AdminId>
  <PlanName>string</PlanName>
  <SubscriptionName>string</SubscriptionName>
  <CoAdminIds>string</CoAdminIds>
  <CreatedTime>1970-01-01T00:00:00.001Z</CreatedTime>
  <DeletedTime>1970-01-01T00:00:00.001Z</DeletedTime>
  <IsCleanupCompletedAfterDelete>true</IsCleanupCompletedAfterDelete>
  <IsDeleted>true</IsDeleted>
  <LastErrorMessage>string</LastErrorMessage>
  <LifeCycleState>1</LifeCycleState>
  <QuotaUpdatedTime>1970-01-01T00:00:00.001Z</QuotaUpdatedTime>
  <State>1</State>
  <UpdatedTime>1970-01-01T00:00:00.001Z</UpdatedTime>
  <PricingProfileId>1</PricingProfileId>
  <SuspendedBy>string</SuspendedBy>
  <SuspendedTime>1970-01-01T00:00:00.001Z</SuspendedTime>
  <CommitmentExpiryDate>1970-01-01T00:00:00.001Z</CommitmentExpiryDate>
  <ShouldApplyOneTimeFee>true</ShouldApplyOneTimeFee>
  <OneTimeFeeExpiryDate>1970-01-01T00:00:00.001Z</OneTimeFeeExpiryDate>
  <SubscriptionType>0</SubscriptionType>
  <SubscriptionTypeString>string</SubscriptionTypeString>
  <QuotaSettings>
    <Key>string</Key>
    <Value>string</Value>
  </QuotaSettings>
</Inline Model>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
month	query	integer
year	query	integer
isIncludeAllSubscriptions	query	boolean
appId	path	string

AdminBillingUsages

get /api/integrations/{appId}/admin/service/billing/usages/{provider}/{service}

Get custom raw usage records from billing service that were added by the provider.

Response Class (Status 200)

OK

[
  {
    "UsageSourceString": "string",
    "EventId": 0,
    "ExternalRecordId": "string",
    "ResourceId": "string",
    "StartTime": "2024-02-06T12:47:39.440Z",
    "EndTime": "2024-02-06T12:47:39.440Z",
    "ProviderName": "string",
    "ServiceType": "string",
    "SubscriptionId": "string",
    "Properties": {},
    "Resources": {}
  }
]

<?xml version="1.0"?>
<Inline Model>
  <UsageSourceString>string</UsageSourceString>
  <EventId>1</EventId>
  <ExternalRecordId>string</ExternalRecordId>
  <ResourceId>string</ResourceId>
  <StartTime>1970-01-01T00:00:00.001Z</StartTime>
  <EndTime>1970-01-01T00:00:00.001Z</EndTime>
  <ProviderName>string</ProviderName>
  <ServiceType>string</ServiceType>
  <SubscriptionId>string</SubscriptionId>
  <Properties>
    <!-- additional elements allowed -->
  </Properties>
  <Resources>
    <!-- additional elements allowed -->
  </Resources>
</Inline Model>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
provider	path	string
service	path	string
startTime	query	date-time
endTime	query	date-time
appId	path	string

post /api/integrations/{appId}/admin/service/billing/usages/addUsages

Add custom raw usage records to the billing service. These records will be used to calculate the usage for the subscription.

Response Class (Status 200)

OK

{
  "IsSuccess": true,
  "Message": "string"
}

<?xml version="1.0"?>
<Trisul.Org.Api.Web.Api.Controllers.Integrations.IntegrationActionResponse>
  <IsSuccess>true</IsSuccess>
  <Message>string</Message>
</Trisul.Org.Api.Web.Api.Controllers.Integrations.IntegrationActionResponse>

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

usageRecords

Parameter content type:

body

[
  {
    "UsageSourceString": "string",
    "EventId": 0,
    "ExternalRecordId": "string",
    "ResourceId": "string",
    "StartTime": "2024-02-06T12:47:39.446Z",
    "EndTime": "2024-02-06T12:47:39.446Z",
    "ProviderName": "string",
    "ServiceType": "string",
    "SubscriptionId": "string",
    "Properties": {},
    "Resources": {}
  }
]

<?xml version="1.0"?>
<CloudAssert.Billing.Contracts.UsageRecord>
  <UsageSourceString>string</UsageSourceString>
  <EventId>1</EventId>
  <ExternalRecordId>string</ExternalRecordId>
  <ResourceId>string</ResourceId>
  <StartTime>1970-01-01T00:00:00.001Z</StartTime>
  <EndTime>1970-01-01T00:00:00.001Z</EndTime>
  <ProviderName>string</ProviderName>
  <ServiceType>string</ServiceType>
  <SubscriptionId>string</SubscriptionId>
  <Properties>
    <!-- additional elements allowed -->
  </Properties>
  <Resources>
    <!-- additional elements allowed -->
  </Resources>
</CloudAssert.Billing.Contracts.UsageRecord>

update query boolean

appId path string

post /api/integrations/{appId}/admin/service/billing/usages/addUsage

Add custom raw usage record to the billing service. These records will be used to calculate the usage for the subscription.

Response Class (Status 200)

OK

{
  "IsSuccess": true,
  "Message": "string"
}

<?xml version="1.0"?>
<Trisul.Org.Api.Web.Api.Controllers.Integrations.IntegrationActionResponse>
  <IsSuccess>true</IsSuccess>
  <Message>string</Message>
</Trisul.Org.Api.Web.Api.Controllers.Integrations.IntegrationActionResponse>

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

usageRecord

Parameter content type:

body

{
  "UsageSourceString": "string",
  "EventId": 0,
  "ExternalRecordId": "string",
  "ResourceId": "string",
  "StartTime": "2024-02-06T12:47:39.450Z",
  "EndTime": "2024-02-06T12:47:39.450Z",
  "ProviderName": "string",
  "ServiceType": "string",
  "SubscriptionId": "string",
  "Properties": {},
  "Resources": {}
}

<?xml version="1.0"?>
<CloudAssert.Billing.Contracts.UsageRecord>
  <UsageSourceString>string</UsageSourceString>
  <EventId>1</EventId>
  <ExternalRecordId>string</ExternalRecordId>
  <ResourceId>string</ResourceId>
  <StartTime>1970-01-01T00:00:00.001Z</StartTime>
  <EndTime>1970-01-01T00:00:00.001Z</EndTime>
  <ProviderName>string</ProviderName>
  <ServiceType>string</ServiceType>
  <SubscriptionId>string</SubscriptionId>
  <Properties>
    <!-- additional elements allowed -->
  </Properties>
  <Resources>
    <!-- additional elements allowed -->
  </Resources>
</CloudAssert.Billing.Contracts.UsageRecord>

appId path string

AdminCoconutCoreEvents

post /api/integrations/{appId}/admin/service/coconutCore/events

BETA. This API is not yet finalized and is subject to change. Adds event data to the new Coconut Core event processing.

Response Class (Status 200)

OK

{
  "EventId": "string",
  "UniqueId": "string"
}

<?xml version="1.0"?>
<Trisul.Org.Cloud.Contracts.Reporting.EventOut>
  <EventId>string</EventId>
  <UniqueId>string</UniqueId>
</Trisul.Org.Cloud.Contracts.Reporting.EventOut>

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

eventData

Parameter content type:

body

{
  "Application": "string",
  "Category": "string",
  "SubCategory": "string",
  "ScopeType": "string",
  "ScopeId": "string",
  "EventName": "string",
  "EventConfigName": "string",
  "EventTitle": "string",
  "EventType": "string",
  "Description": "string",
  "EventSourceType": "string",
  "EventSourceId": "string",
  "EventSeverity": 0,
  "EventSeverityString": "string",
  "Status": 0,
  "StatusString": "string",
  "SuppressUntilDateTime": "2024-02-06T12:47:39.455Z",
  "EntityType": "string",
  "EntityId": "string",
  "EntityStatus": "string",
  "EventPayloadType": "string",
  "FirstTimestamp": "2024-02-06T12:47:39.455Z",
  "LastTimestamp": "2024-02-06T12:47:39.455Z",
  "TimestampString": "string",
  "ResolvedTimestamp": "2024-02-06T12:47:39.455Z",
  "EvaluationPeriodType": "string",
  "EvaluationPeriodStartDate": "2024-02-06T12:47:39.455Z",
  "EvaluationPeriodEndDate": "2024-02-06T12:47:39.455Z",
  "EventCount": 0,
  "BatchId": 0,
  "Properties": {},
  "EventPayload": "string",
  "ChangeHistory": [
    {
      "RuleId": 0,
      "Change": "string",
      "Type": "string",
      "Details": "string",
      "InitiatedBy": "string",
      "OldStatus": "string",
      "NewStatus": "string",
      "Timestamp": "2024-02-06T12:47:39.455Z"
    }
  ],
  "ActionsHistory": [
    {
      "ActionGroupId": "string",
      "ActionTemplateId": "string",
      "ActionName": "string",
      "Details": "string",
      "Status": "string",
      "Message": "string",
      "Timestamp": "2024-02-06T12:47:39.455Z"
    }
  ],
  "EventId": "string",
  "UniqueId": "string"
}

<?xml version="1.0"?>
<Trisul.Org.Cloud.Contracts.Reporting.EventDto>
  <Application>string</Application>
  <Category>string</Category>
  <SubCategory>string</SubCategory>
  <ScopeType>string</ScopeType>
  <ScopeId>string</ScopeId>
  <EventName>string</EventName>
  <EventConfigName>string</EventConfigName>
  <EventTitle>string</EventTitle>
  <EventType>string</EventType>
  <Description>string</Description>
  <EventSourceType>string</EventSourceType>
  <EventSourceId>string</EventSourceId>
  <EventSeverity>0</EventSeverity>
  <EventSeverityString>string</EventSeverityString>
  <Status>0</Status>
  <StatusString>string</StatusString>
  <SuppressUntilDateTime>1970-01-01T00:00:00.001Z</SuppressUntilDateTime>
  <EntityType>string</EntityType>
  <EntityId>string</EntityId>
  <EntityStatus>string</EntityStatus>
  <EventPayloadType>string</EventPayloadType>
  <FirstTimestamp>1970-01-01T00:00:00.001Z</FirstTimestamp>
  <LastTimestamp>1970-01-01T00:00:00.001Z</LastTimestamp>
  <TimestampString>string</TimestampString>
  <ResolvedTimestamp>1970-01-01T00:00:00.001Z</ResolvedTimestamp>
  <EvaluationPeriodType>string</EvaluationPeriodType>
  <EvaluationPeriodStartDate>1970-01-01T00:00:00.001Z</EvaluationPeriodStartDate>
  <EvaluationPeriodEndDate>1970-01-01T00:00:00.001Z</EvaluationPeriodEndDate>
  <EventCount>1</EventCount>
  <BatchId>1</BatchId>
  <Properties>
    <!-- additional elements allowed -->
  </Properties>
  <EventPayload>string</EventPayload>
  <ChangeHistory>
    <RuleId>1</RuleId>
    <Change>string</Change>
    <Type>string</Type>
    <Details>string</Details>
    <InitiatedBy>string</InitiatedBy>
    <OldStatus>string</OldStatus>
    <NewStatus>string</NewStatus>
    <Timestamp>1970-01-01T00:00:00.001Z</Timestamp>
  </ChangeHistory>
  <ActionsHistory>
    <ActionGroupId>string</ActionGroupId>
    <ActionTemplateId>string</ActionTemplateId>
    <ActionName>string</ActionName>
    <Details>string</Details>
    <Status>string</Status>
    <Message>string</Message>
    <Timestamp>1970-01-01T00:00:00.001Z</Timestamp>
  </ActionsHistory>
  <EventId>string</EventId>
  <UniqueId>string</UniqueId>
</Trisul.Org.Cloud.Contracts.Reporting.EventDto>

appId path string

AdminCoconutCoreUsage

post /api/integrations/{appId}/admin/service/coconutCore/usage/usageData

BETA. This API is not yet finalized and is subject to change. Adds usage data to the new Coconut Core data processing and billing pipeline.

Response Class (Status 200)

OK

{}

<?xml version="1.0"?>
<!-- invalid XML -->

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

usageData

Parameter content type:

body

[
  {
    "UniqueId": "string",
    "BatchId": "string",
    "ConnectionId": 0,
    "TaskConfigId": 0,
    "CreatedTimestamp": "2024-02-06T12:47:39.461Z",
    "UpdatedTimestamp": "2024-02-06T12:47:39.461Z",
    "RowVersion": 0,
    "Provider": "string",
    "UsageSource": "string",
    "AggGranularity": "string",
    "AggStartDate": "2024-02-06T12:47:39.461Z",
    "AggEndDate": "2024-02-06T12:47:39.461Z",
    "ReportedStartDate": "2024-02-06T12:47:39.462Z",
    "ReportedEndDate": "2024-02-06T12:47:39.462Z",
    "SourceBillingEntity": "string",
    "SourceLineItemType": "string",
    "SourceInvoiceId": "string",
    "SourceRootBillingAccountId": "string",
    "SourceRootBillingAccountName": "string",
    "SourceBillingPeriodStartDate": "2024-02-06T12:47:39.462Z",
    "SourceBillingPeriodEndDate": "2024-02-06T12:47:39.462Z",
    "SourceSubscriptionAccountProjectId": "string",
    "SourceSubscriptionAccountProjectName": "string",
    "SourceResourceGroup": "string",
    "SourceAdditionalInfo": "string",
    "SourceDataType": "string",
    "SourceMeterCategory": "string",
    "SourceMeterSubcategory": "string",
    "SourceProduct": "string",
    "SourceResourceId": "string",
    "SourceResourceName": "string",
    "SourceResourceType": "string",
    "SourceService": "string",
    "SourceSku": "string",
    "SourceUsageMeterId": "string",
    "SourceUsageMeterName": "string",
    "SourceUsageRegion": "string",
    "SourceResourceRegion": "string",
    "AvailabilityZone": "string",
    "Owner": "string",
    "Department": "string",
    "CostCenter": "string",
    "ProjectCode": "string",
    "Environment": "string",
    "Team": "string",
    "ReservationId": "string",
    "ReservationName": "string",
    "Term": "string",
    "OfferId": "string",
    "PublisherName": "string",
    "PlanName": "string",
    "Frequency": "string",
    "PublisherType": "string",
    "PricingModel": "string",
    "SourceBillingCurrency": "string",
    "SourceUnitOfMeasure": "string",
    "SourceUsageQuantity": 0,
    "MinUnitPrice": 0,
    "MaxUnitPrice": 0,
    "MinEffectivePrice": 0,
    "MaxEffectivePrice": 0,
    "SourceCost": 0,
    "RecordCount": 0,
    "SourceTags": "string"
  }
]

<?xml version="1.0"?>
<Trisul.Org.Business.Models.Requests.CommonCostDataFormatIn>
  <UniqueId>string</UniqueId>
  <BatchId>string</BatchId>
  <ConnectionId>1</ConnectionId>
  <TaskConfigId>1</TaskConfigId>
  <CreatedTimestamp>1970-01-01T00:00:00.001Z</CreatedTimestamp>
  <UpdatedTimestamp>1970-01-01T00:00:00.001Z</UpdatedTimestamp>
  <RowVersion>1</RowVersion>
  <Provider>string</Provider>
  <UsageSource>string</UsageSource>
  <AggGranularity>string</AggGranularity>
  <AggStartDate>1970-01-01T00:00:00.001Z</AggStartDate>
  <AggEndDate>1970-01-01T00:00:00.001Z</AggEndDate>
  <ReportedStartDate>1970-01-01T00:00:00.001Z</ReportedStartDate>
  <ReportedEndDate>1970-01-01T00:00:00.001Z</ReportedEndDate>
  <SourceBillingEntity>string</SourceBillingEntity>
  <SourceLineItemType>string</SourceLineItemType>
  <SourceInvoiceId>string</SourceInvoiceId>
  <SourceRootBillingAccountId>string</SourceRootBillingAccountId>
  <SourceRootBillingAccountName>string</SourceRootBillingAccountName>
  <SourceBillingPeriodStartDate>1970-01-01T00:00:00.001Z</SourceBillingPeriodStartDate>
  <SourceBillingPeriodEndDate>1970-01-01T00:00:00.001Z</SourceBillingPeriodEndDate>
  <SourceSubscriptionAccountProjectId>string</SourceSubscriptionAccountProjectId>
  <SourceSubscriptionAccountProjectName>string</SourceSubscriptionAccountProjectName>
  <SourceResourceGroup>string</SourceResourceGroup>
  <SourceAdditionalInfo>string</SourceAdditionalInfo>
  <SourceDataType>string</SourceDataType>
  <SourceMeterCategory>string</SourceMeterCategory>
  <SourceMeterSubcategory>string</SourceMeterSubcategory>
  <SourceProduct>string</SourceProduct>
  <SourceResourceId>string</SourceResourceId>
  <SourceResourceName>string</SourceResourceName>
  <SourceResourceType>string</SourceResourceType>
  <SourceService>string</SourceService>
  <SourceSku>string</SourceSku>
  <SourceUsageMeterId>string</SourceUsageMeterId>
  <SourceUsageMeterName>string</SourceUsageMeterName>
  <SourceUsageRegion>string</SourceUsageRegion>
  <SourceResourceRegion>string</SourceResourceRegion>
  <AvailabilityZone>string</AvailabilityZone>
  <Owner>string</Owner>
  <Department>string</Department>
  <CostCenter>string</CostCenter>
  <ProjectCode>string</ProjectCode>
  <Environment>string</Environment>
  <Team>string</Team>
  <ReservationId>string</ReservationId>
  <ReservationName>string</ReservationName>
  <Term>string</Term>
  <OfferId>string</OfferId>
  <PublisherName>string</PublisherName>
  <PlanName>string</PlanName>
  <Frequency>string</Frequency>
  <PublisherType>string</PublisherType>
  <PricingModel>string</PricingModel>
  <SourceBillingCurrency>string</SourceBillingCurrency>
  <SourceUnitOfMeasure>string</SourceUnitOfMeasure>
  <SourceUsageQuantity>1.1</SourceUsageQuantity>
  <MinUnitPrice>1.1</MinUnitPrice>
  <MaxUnitPrice>1.1</MaxUnitPrice>
  <MinEffectivePrice>1.1</MinEffectivePrice>
  <MaxEffectivePrice>1.1</MaxEffectivePrice>
  <SourceCost>1.1</SourceCost>
  <RecordCount>1</RecordCount>
  <SourceTags>string</SourceTags>
</Trisul.Org.Business.Models.Requests.CommonCostDataFormatIn>

appId path string

post /api/integrations/{appId}/admin/service/coconutCore/usage/costData

BETA. This API is not yet finalized and is subject to change. Adds cost data to the new Coconut Core data processing and billing pipeline.

Response Class (Status 200)

OK

{}

<?xml version="1.0"?>
<!-- invalid XML -->

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

costData

Parameter content type:

body

[
  {
    "UniqueId": "string",
    "BatchId": "string",
    "ConnectionId": 0,
    "TaskConfigId": 0,
    "CreatedTimestamp": "2024-02-06T12:47:39.470Z",
    "UpdatedTimestamp": "2024-02-06T12:47:39.470Z",
    "RowVersion": 0,
    "Provider": "string",
    "UsageSource": "string",
    "AggGranularity": "string",
    "AggStartDate": "2024-02-06T12:47:39.470Z",
    "AggEndDate": "2024-02-06T12:47:39.470Z",
    "ReportedStartDate": "2024-02-06T12:47:39.470Z",
    "ReportedEndDate": "2024-02-06T12:47:39.470Z",
    "SourceBillingEntity": "string",
    "SourceLineItemType": "string",
    "SourceInvoiceId": "string",
    "SourceRootBillingAccountId": "string",
    "SourceRootBillingAccountName": "string",
    "SourceBillingPeriodStartDate": "2024-02-06T12:47:39.470Z",
    "SourceBillingPeriodEndDate": "2024-02-06T12:47:39.470Z",
    "SourceSubscriptionAccountProjectId": "string",
    "SourceSubscriptionAccountProjectName": "string",
    "SourceResourceGroup": "string",
    "SourceAdditionalInfo": "string",
    "SourceDataType": "string",
    "SourceMeterCategory": "string",
    "SourceMeterSubcategory": "string",
    "SourceProduct": "string",
    "SourceResourceId": "string",
    "SourceResourceName": "string",
    "SourceResourceType": "string",
    "SourceService": "string",
    "SourceSku": "string",
    "SourceUsageMeterId": "string",
    "SourceUsageMeterName": "string",
    "SourceUsageRegion": "string",
    "SourceResourceRegion": "string",
    "AvailabilityZone": "string",
    "Owner": "string",
    "Department": "string",
    "CostCenter": "string",
    "ProjectCode": "string",
    "Environment": "string",
    "Team": "string",
    "ReservationId": "string",
    "ReservationName": "string",
    "Term": "string",
    "OfferId": "string",
    "PublisherName": "string",
    "PlanName": "string",
    "Frequency": "string",
    "PublisherType": "string",
    "PricingModel": "string",
    "SourceBillingCurrency": "string",
    "SourceUnitOfMeasure": "string",
    "SourceUsageQuantity": 0,
    "MinUnitPrice": 0,
    "MaxUnitPrice": 0,
    "MinEffectivePrice": 0,
    "MaxEffectivePrice": 0,
    "SourceCost": 0,
    "RecordCount": 0,
    "SourceTags": "string"
  }
]

<?xml version="1.0"?>
<Trisul.Org.Business.Models.Requests.CommonCostDataFormatIn>
  <UniqueId>string</UniqueId>
  <BatchId>string</BatchId>
  <ConnectionId>1</ConnectionId>
  <TaskConfigId>1</TaskConfigId>
  <CreatedTimestamp>1970-01-01T00:00:00.001Z</CreatedTimestamp>
  <UpdatedTimestamp>1970-01-01T00:00:00.001Z</UpdatedTimestamp>
  <RowVersion>1</RowVersion>
  <Provider>string</Provider>
  <UsageSource>string</UsageSource>
  <AggGranularity>string</AggGranularity>
  <AggStartDate>1970-01-01T00:00:00.001Z</AggStartDate>
  <AggEndDate>1970-01-01T00:00:00.001Z</AggEndDate>
  <ReportedStartDate>1970-01-01T00:00:00.001Z</ReportedStartDate>
  <ReportedEndDate>1970-01-01T00:00:00.001Z</ReportedEndDate>
  <SourceBillingEntity>string</SourceBillingEntity>
  <SourceLineItemType>string</SourceLineItemType>
  <SourceInvoiceId>string</SourceInvoiceId>
  <SourceRootBillingAccountId>string</SourceRootBillingAccountId>
  <SourceRootBillingAccountName>string</SourceRootBillingAccountName>
  <SourceBillingPeriodStartDate>1970-01-01T00:00:00.001Z</SourceBillingPeriodStartDate>
  <SourceBillingPeriodEndDate>1970-01-01T00:00:00.001Z</SourceBillingPeriodEndDate>
  <SourceSubscriptionAccountProjectId>string</SourceSubscriptionAccountProjectId>
  <SourceSubscriptionAccountProjectName>string</SourceSubscriptionAccountProjectName>
  <SourceResourceGroup>string</SourceResourceGroup>
  <SourceAdditionalInfo>string</SourceAdditionalInfo>
  <SourceDataType>string</SourceDataType>
  <SourceMeterCategory>string</SourceMeterCategory>
  <SourceMeterSubcategory>string</SourceMeterSubcategory>
  <SourceProduct>string</SourceProduct>
  <SourceResourceId>string</SourceResourceId>
  <SourceResourceName>string</SourceResourceName>
  <SourceResourceType>string</SourceResourceType>
  <SourceService>string</SourceService>
  <SourceSku>string</SourceSku>
  <SourceUsageMeterId>string</SourceUsageMeterId>
  <SourceUsageMeterName>string</SourceUsageMeterName>
  <SourceUsageRegion>string</SourceUsageRegion>
  <SourceResourceRegion>string</SourceResourceRegion>
  <AvailabilityZone>string</AvailabilityZone>
  <Owner>string</Owner>
  <Department>string</Department>
  <CostCenter>string</CostCenter>
  <ProjectCode>string</ProjectCode>
  <Environment>string</Environment>
  <Team>string</Team>
  <ReservationId>string</ReservationId>
  <ReservationName>string</ReservationName>
  <Term>string</Term>
  <OfferId>string</OfferId>
  <PublisherName>string</PublisherName>
  <PlanName>string</PlanName>
  <Frequency>string</Frequency>
  <PublisherType>string</PublisherType>
  <PricingModel>string</PricingModel>
  <SourceBillingCurrency>string</SourceBillingCurrency>
  <SourceUnitOfMeasure>string</SourceUnitOfMeasure>
  <SourceUsageQuantity>1.1</SourceUsageQuantity>
  <MinUnitPrice>1.1</MinUnitPrice>
  <MaxUnitPrice>1.1</MaxUnitPrice>
  <MinEffectivePrice>1.1</MinEffectivePrice>
  <MaxEffectivePrice>1.1</MaxEffectivePrice>
  <SourceCost>1.1</SourceCost>
  <RecordCount>1</RecordCount>
  <SourceTags>string</SourceTags>
</Trisul.Org.Business.Models.Requests.CommonCostDataFormatIn>

appId path string

post /api/integrations/{appId}/admin/service/coconutCore/usage/importUsageFile

BETA. This API is not yet finalized and is subject to change. Imports raw usage file from the source directly to the new Coconut Core data processing and billing pipeline.

Response Class (Status 200)

OK

{}

<?xml version="1.0"?>
<!-- invalid XML -->

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
provider	query	string
sourceDataType	query	string
connectionId	query	integer
sourcePath	query	string
appId	path	string

get /api/integrations/{appId}/admin/service/coconutCore/usage/ccdfUsage

BETA. This API is not yet finalized and is subject to change. Queries usage data from the Coconut Core data processing and billing pipeline.

Response Class (Status 200)

OK

{}

<?xml version="1.0"?>
<!-- invalid XML -->

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
sourceDataType	query	string
sourceSubscriptionId	query	string
granularity	query	string
startTime	query	string
endTime	query	string
skip	query	long
take	query	long
appId	path	string

get /api/integrations/{appId}/admin/service/coconutCore/usage/ccdfFinal

BETA. This API is not yet finalized and is subject to change. Queries cost data from the Coconut Core data processing and billing pipeline.

Response Class (Status 200)

OK

{}

<?xml version="1.0"?>
<!-- invalid XML -->

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
sourceDataType	query	string
sourceSubscriptionId	query	string
granularity	query	string
startTime	query	string
endTime	query	string
skip	query	long
take	query	long
appId	path	string

AdminHybrCompanies

get /api/integrations/{appId}/admin/service/core/companies

Get all companies.

Response Class (Status 200)

OK

{
  "draw": 0,
  "recordsFiltered": 0,
  "recordsTotal": 0,
  "data": [
    {
      "CompanyId": "00000000-0000-0000-0000-000000000000",
      "OfferId": "00000000-0000-0000-0000-000000000000",
      "OfferName": "string",
      "CompanyName": "string",
      "IdentityProviderType": "string",
      "IdentityProviderDisplayName": "string",
      "Issuer": "string",
      "PrimaryIssuer": "string",
      "AdditionalSupportedDomains": "string",
      "IsAddAdminAccountAsUser": true,
      "IsAdminConsent": true,
      "Status": 0,
      "AdminUser": "string",
      "Created": "2024-02-06T12:47:39.498Z",
      "Updated": "2024-02-06T12:47:39.498Z",
      "OrgId": "00000000-0000-0000-0000-000000000000",
      "Address": {
        "AddressType": 0,
        "AddressTypeString": "string",
        "Email": "string",
        "PhoneNumber": "string",
        "Address1": "string",
        "Address2": "string",
        "City": "string",
        "State": "string",
        "CountryId": 0,
        "PostalCode": "string"
      },
      "IsAutoOnboardUsers": true,
      "DirectoryName": "string",
      "ApplicationId": "string",
      "SignInAndSignUpPolicy": "string",
      "PasswordResetPolicy": "string",
      "Acr": "string",
      "Scope": "string",
      "UserUpn": "string",
      "UserEmail": "string",
      "UserMobile": "string",
      "UserRole": "string",
      "CustomProperties": "string",
      "ResellerCompanyId": "00000000-0000-0000-0000-000000000000"
    }
  ]
}

<?xml version="1.0"?>
<Trisul.Org.Api.Web.Areas.Admin.Models.DataTable[Trisul.Org.Business.Models.Responses.TenantCompanyInfo]>
  <draw>1</draw>
  <recordsFiltered>1</recordsFiltered>
  <recordsTotal>1</recordsTotal>
  <data>
    <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
    <OfferId>00000000-0000-0000-0000-000000000000</OfferId>
    <OfferName>string</OfferName>
    <CompanyName>string</CompanyName>
    <IdentityProviderType>string</IdentityProviderType>
    <IdentityProviderDisplayName>string</IdentityProviderDisplayName>
    <Issuer>string</Issuer>
    <PrimaryIssuer>string</PrimaryIssuer>
    <AdditionalSupportedDomains>string</AdditionalSupportedDomains>
    <IsAddAdminAccountAsUser>true</IsAddAdminAccountAsUser>
    <IsAdminConsent>true</IsAdminConsent>
    <Status>0</Status>
    <AdminUser>string</AdminUser>
    <Created>1970-01-01T00:00:00.001Z</Created>
    <Updated>1970-01-01T00:00:00.001Z</Updated>
    <OrgId>00000000-0000-0000-0000-000000000000</OrgId>
    <Address>
      <AddressType>0</AddressType>
      <AddressTypeString>string</AddressTypeString>
      <Email>string</Email>
      <PhoneNumber>string</PhoneNumber>
      <Address1>string</Address1>
      <Address2>string</Address2>
      <City>string</City>
      <State>string</State>
      <CountryId>1</CountryId>
      <PostalCode>string</PostalCode>
    </Address>
    <IsAutoOnboardUsers>true</IsAutoOnboardUsers>
    <DirectoryName>string</DirectoryName>
    <ApplicationId>string</ApplicationId>
    <SignInAndSignUpPolicy>string</SignInAndSignUpPolicy>
    <PasswordResetPolicy>string</PasswordResetPolicy>
    <Acr>string</Acr>
    <Scope>string</Scope>
    <UserUpn>string</UserUpn>
    <UserEmail>string</UserEmail>
    <UserMobile>string</UserMobile>
    <UserRole>string</UserRole>
    <CustomProperties>string</CustomProperties>
    <ResellerCompanyId>00000000-0000-0000-0000-000000000000</ResellerCompanyId>
  </data>
</Trisul.Org.Api.Web.Areas.Admin.Models.DataTable[Trisul.Org.Business.Models.Responses.TenantCompanyInfo]>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
appId	path	string
paginationParameters.page	query	integer
paginationParameters.page_Size	query	integer

post /api/integrations/{appId}/admin/service/core/companies

Creates Tenant Company Only. No subscription will be created.

Response Class (Status 200)

OK

{
  "CompanyId": "00000000-0000-0000-0000-000000000000",
  "OfferId": "00000000-0000-0000-0000-000000000000",
  "OfferName": "string",
  "CompanyName": "string",
  "IdentityProviderType": "string",
  "IdentityProviderDisplayName": "string",
  "Issuer": "string",
  "PrimaryIssuer": "string",
  "AdditionalSupportedDomains": "string",
  "IsAddAdminAccountAsUser": true,
  "IsAdminConsent": true,
  "Status": 0,
  "AdminUser": "string",
  "Created": "2024-02-06T12:47:39.504Z",
  "Updated": "2024-02-06T12:47:39.504Z",
  "OrgId": "00000000-0000-0000-0000-000000000000",
  "Address": {
    "AddressType": 0,
    "AddressTypeString": "string",
    "Email": "string",
    "PhoneNumber": "string",
    "Address1": "string",
    "Address2": "string",
    "City": "string",
    "State": "string",
    "CountryId": 0,
    "PostalCode": "string"
  },
  "IsAutoOnboardUsers": true,
  "DirectoryName": "string",
  "ApplicationId": "string",
  "SignInAndSignUpPolicy": "string",
  "PasswordResetPolicy": "string",
  "Acr": "string",
  "Scope": "string",
  "UserUpn": "string",
  "UserEmail": "string",
  "UserMobile": "string",
  "UserRole": "string",
  "CustomProperties": "string",
  "ResellerCompanyId": "00000000-0000-0000-0000-000000000000"
}

<?xml version="1.0"?>
<Trisul.Org.Business.Models.Responses.TenantCompanyInfo>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <OfferId>00000000-0000-0000-0000-000000000000</OfferId>
  <OfferName>string</OfferName>
  <CompanyName>string</CompanyName>
  <IdentityProviderType>string</IdentityProviderType>
  <IdentityProviderDisplayName>string</IdentityProviderDisplayName>
  <Issuer>string</Issuer>
  <PrimaryIssuer>string</PrimaryIssuer>
  <AdditionalSupportedDomains>string</AdditionalSupportedDomains>
  <IsAddAdminAccountAsUser>true</IsAddAdminAccountAsUser>
  <IsAdminConsent>true</IsAdminConsent>
  <Status>0</Status>
  <AdminUser>string</AdminUser>
  <Created>1970-01-01T00:00:00.001Z</Created>
  <Updated>1970-01-01T00:00:00.001Z</Updated>
  <OrgId>00000000-0000-0000-0000-000000000000</OrgId>
  <Address>
    <AddressType>0</AddressType>
    <AddressTypeString>string</AddressTypeString>
    <Email>string</Email>
    <PhoneNumber>string</PhoneNumber>
    <Address1>string</Address1>
    <Address2>string</Address2>
    <City>string</City>
    <State>string</State>
    <CountryId>1</CountryId>
    <PostalCode>string</PostalCode>
  </Address>
  <IsAutoOnboardUsers>true</IsAutoOnboardUsers>
  <DirectoryName>string</DirectoryName>
  <ApplicationId>string</ApplicationId>
  <SignInAndSignUpPolicy>string</SignInAndSignUpPolicy>
  <PasswordResetPolicy>string</PasswordResetPolicy>
  <Acr>string</Acr>
  <Scope>string</Scope>
  <UserUpn>string</UserUpn>
  <UserEmail>string</UserEmail>
  <UserMobile>string</UserMobile>
  <UserRole>string</UserRole>
  <CustomProperties>string</CustomProperties>
  <ResellerCompanyId>00000000-0000-0000-0000-000000000000</ResellerCompanyId>
</Trisul.Org.Business.Models.Responses.TenantCompanyInfo>

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

companyModel

Parameter content type:

body

{
  "CompanyName": "string",
  "Issuer": "string",
  "AdditionalSupportedDomains": "string",
  "Email": "string",
  "PhoneNumber": "string",
  "Address1": "string",
  "Address2": "string",
  "City": "string",
  "State": "string",
  "CountryId": "string",
  "CountryCode": "string",
  "OfferId": "00000000-0000-0000-0000-000000000000",
  "ResellerCompanyId": "00000000-0000-0000-0000-000000000000",
  "PostalCode": "string",
  "UserUpn": "string",
  "AdminUser": "string",
  "UserName": "string",
  "IsAdminConcent": true,
  "UserEmail": "string",
  "UserMobile": "string",
  "IsAddAdminAccountAsUser": true,
  "IsResellerEnabled": true,
  "IsAutoOnboardUsers": true,
  "IdentityProviderType": "string",
  "DirectoryName": "string",
  "ApplicationId": "string",
  "ApplicationSecret": "string",
  "SignInAndSignUpPolicy": "string",
  "PasswordResetPolicy": "string",
  "Acr": "string",
  "Scope": "string",
  "UserRole": "string",
  "CustomProperties": "string",
  "SubscriptionName": "string",
  "SubscriptionOwner": "string",
  "CloneExistingOffer": true,
  "CloneOfferName": "string",
  "ClonePlanName": "string",
  "ClonePricingProfileName": "string",
  "MapWithReseller": true,
  "CspCustomerId": "string"
}

<?xml version="1.0"?>
<Trisul.Org.Business.Models.Requests.TenantCompanyCreateRequest>
  <CompanyName>string</CompanyName>
  <Issuer>string</Issuer>
  <AdditionalSupportedDomains>string</AdditionalSupportedDomains>
  <Email>string</Email>
  <PhoneNumber>string</PhoneNumber>
  <Address1>string</Address1>
  <Address2>string</Address2>
  <City>string</City>
  <State>string</State>
  <CountryId>string</CountryId>
  <CountryCode>string</CountryCode>
  <OfferId>00000000-0000-0000-0000-000000000000</OfferId>
  <ResellerCompanyId>00000000-0000-0000-0000-000000000000</ResellerCompanyId>
  <PostalCode>string</PostalCode>
  <UserUpn>string</UserUpn>
  <IsAdminConcent>true</IsAdminConcent>
  <UserEmail>string</UserEmail>
  <UserMobile>string</UserMobile>
  <IsAddAdminAccountAsUser>true</IsAddAdminAccountAsUser>
  <IsResellerEnabled>true</IsResellerEnabled>
  <IsAutoOnboardUsers>true</IsAutoOnboardUsers>
  <IdentityProviderType>string</IdentityProviderType>
  <DirectoryName>string</DirectoryName>
  <ApplicationId>string</ApplicationId>
  <ApplicationSecret>string</ApplicationSecret>
  <SignInAndSignUpPolicy>string</SignInAndSignUpPolicy>
  <PasswordResetPolicy>string</PasswordResetPolicy>
  <Acr>string</Acr>
  <Scope>string</Scope>
  <UserRole>string</UserRole>
  <CustomProperties>string</CustomProperties>
  <SubscriptionName>string</SubscriptionName>
  <SubscriptionOwner>string</SubscriptionOwner>
  <CloneExistingOffer>true</CloneExistingOffer>
  <CloneOfferName>string</CloneOfferName>
  <ClonePlanName>string</ClonePlanName>
  <ClonePricingProfileName>string</ClonePricingProfileName>
  <MapWithReseller>true</MapWithReseller>
  <CspCustomerId>string</CspCustomerId>
</Trisul.Org.Business.Models.Requests.TenantCompanyCreateRequest>

appId path string

delete /api/integrations/{appId}/admin/service/core/companies/{companyId}

Deletes Tenant Company. Company should not have any subscriptions, so delete those separately before calling this API. This will DELETE ALL users and related user entity roles associated with the company.

Response Class (Status 200)

OK

{
  "IsSuccess": true,
  "Message": "string"
}

<?xml version="1.0"?>
<Trisul.Org.Api.Web.Api.Controllers.Integrations.IntegrationActionResponse>
  <IsSuccess>true</IsSuccess>
  <Message>string</Message>
</Trisul.Org.Api.Web.Api.Controllers.Integrations.IntegrationActionResponse>

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
companyId			path	string
appId			path	string

get /api/integrations/{appId}/admin/service/core/companies/{companyId}

Response Class (Status 200)

OK

{
  "CompanyId": "00000000-0000-0000-0000-000000000000",
  "OfferId": "00000000-0000-0000-0000-000000000000",
  "OfferName": "string",
  "CompanyName": "string",
  "IdentityProviderType": "string",
  "IdentityProviderDisplayName": "string",
  "Issuer": "string",
  "PrimaryIssuer": "string",
  "AdditionalSupportedDomains": "string",
  "IsAddAdminAccountAsUser": true,
  "IsAdminConsent": true,
  "Status": 0,
  "AdminUser": "string",
  "Created": "2024-02-06T12:47:39.521Z",
  "Updated": "2024-02-06T12:47:39.521Z",
  "OrgId": "00000000-0000-0000-0000-000000000000",
  "Address": {
    "AddressType": 0,
    "AddressTypeString": "string",
    "Email": "string",
    "PhoneNumber": "string",
    "Address1": "string",
    "Address2": "string",
    "City": "string",
    "State": "string",
    "CountryId": 0,
    "PostalCode": "string"
  },
  "IsAutoOnboardUsers": true,
  "DirectoryName": "string",
  "ApplicationId": "string",
  "SignInAndSignUpPolicy": "string",
  "PasswordResetPolicy": "string",
  "Acr": "string",
  "Scope": "string",
  "UserUpn": "string",
  "UserEmail": "string",
  "UserMobile": "string",
  "UserRole": "string",
  "CustomProperties": "string",
  "ResellerCompanyId": "00000000-0000-0000-0000-000000000000"
}

<?xml version="1.0"?>
<Trisul.Org.Business.Models.Responses.TenantCompanyInfo>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <OfferId>00000000-0000-0000-0000-000000000000</OfferId>
  <OfferName>string</OfferName>
  <CompanyName>string</CompanyName>
  <IdentityProviderType>string</IdentityProviderType>
  <IdentityProviderDisplayName>string</IdentityProviderDisplayName>
  <Issuer>string</Issuer>
  <PrimaryIssuer>string</PrimaryIssuer>
  <AdditionalSupportedDomains>string</AdditionalSupportedDomains>
  <IsAddAdminAccountAsUser>true</IsAddAdminAccountAsUser>
  <IsAdminConsent>true</IsAdminConsent>
  <Status>0</Status>
  <AdminUser>string</AdminUser>
  <Created>1970-01-01T00:00:00.001Z</Created>
  <Updated>1970-01-01T00:00:00.001Z</Updated>
  <OrgId>00000000-0000-0000-0000-000000000000</OrgId>
  <Address>
    <AddressType>0</AddressType>
    <AddressTypeString>string</AddressTypeString>
    <Email>string</Email>
    <PhoneNumber>string</PhoneNumber>
    <Address1>string</Address1>
    <Address2>string</Address2>
    <City>string</City>
    <State>string</State>
    <CountryId>1</CountryId>
    <PostalCode>string</PostalCode>
  </Address>
  <IsAutoOnboardUsers>true</IsAutoOnboardUsers>
  <DirectoryName>string</DirectoryName>
  <ApplicationId>string</ApplicationId>
  <SignInAndSignUpPolicy>string</SignInAndSignUpPolicy>
  <PasswordResetPolicy>string</PasswordResetPolicy>
  <Acr>string</Acr>
  <Scope>string</Scope>
  <UserUpn>string</UserUpn>
  <UserEmail>string</UserEmail>
  <UserMobile>string</UserMobile>
  <UserRole>string</UserRole>
  <CustomProperties>string</CustomProperties>
  <ResellerCompanyId>00000000-0000-0000-0000-000000000000</ResellerCompanyId>
</Trisul.Org.Business.Models.Responses.TenantCompanyInfo>

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
companyId			path	string
appId			path	string

put /api/integrations/{appId}/admin/service/core/companies/{companyId}

Update Tenant Company

Response Class (Status 200)

OK

{
  "CompanyId": "00000000-0000-0000-0000-000000000000",
  "OfferId": "00000000-0000-0000-0000-000000000000",
  "OfferName": "string",
  "CompanyName": "string",
  "IdentityProviderType": "string",
  "IdentityProviderDisplayName": "string",
  "Issuer": "string",
  "PrimaryIssuer": "string",
  "AdditionalSupportedDomains": "string",
  "IsAddAdminAccountAsUser": true,
  "IsAdminConsent": true,
  "Status": 0,
  "AdminUser": "string",
  "Created": "2024-02-06T12:47:39.553Z",
  "Updated": "2024-02-06T12:47:39.553Z",
  "OrgId": "00000000-0000-0000-0000-000000000000",
  "Address": {
    "AddressType": 0,
    "AddressTypeString": "string",
    "Email": "string",
    "PhoneNumber": "string",
    "Address1": "string",
    "Address2": "string",
    "City": "string",
    "State": "string",
    "CountryId": 0,
    "PostalCode": "string"
  },
  "IsAutoOnboardUsers": true,
  "DirectoryName": "string",
  "ApplicationId": "string",
  "SignInAndSignUpPolicy": "string",
  "PasswordResetPolicy": "string",
  "Acr": "string",
  "Scope": "string",
  "UserUpn": "string",
  "UserEmail": "string",
  "UserMobile": "string",
  "UserRole": "string",
  "CustomProperties": "string",
  "ResellerCompanyId": "00000000-0000-0000-0000-000000000000"
}

<?xml version="1.0"?>
<Trisul.Org.Business.Models.Responses.TenantCompanyInfo>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <OfferId>00000000-0000-0000-0000-000000000000</OfferId>
  <OfferName>string</OfferName>
  <CompanyName>string</CompanyName>
  <IdentityProviderType>string</IdentityProviderType>
  <IdentityProviderDisplayName>string</IdentityProviderDisplayName>
  <Issuer>string</Issuer>
  <PrimaryIssuer>string</PrimaryIssuer>
  <AdditionalSupportedDomains>string</AdditionalSupportedDomains>
  <IsAddAdminAccountAsUser>true</IsAddAdminAccountAsUser>
  <IsAdminConsent>true</IsAdminConsent>
  <Status>0</Status>
  <AdminUser>string</AdminUser>
  <Created>1970-01-01T00:00:00.001Z</Created>
  <Updated>1970-01-01T00:00:00.001Z</Updated>
  <OrgId>00000000-0000-0000-0000-000000000000</OrgId>
  <Address>
    <AddressType>0</AddressType>
    <AddressTypeString>string</AddressTypeString>
    <Email>string</Email>
    <PhoneNumber>string</PhoneNumber>
    <Address1>string</Address1>
    <Address2>string</Address2>
    <City>string</City>
    <State>string</State>
    <CountryId>1</CountryId>
    <PostalCode>string</PostalCode>
  </Address>
  <IsAutoOnboardUsers>true</IsAutoOnboardUsers>
  <DirectoryName>string</DirectoryName>
  <ApplicationId>string</ApplicationId>
  <SignInAndSignUpPolicy>string</SignInAndSignUpPolicy>
  <PasswordResetPolicy>string</PasswordResetPolicy>
  <Acr>string</Acr>
  <Scope>string</Scope>
  <UserUpn>string</UserUpn>
  <UserEmail>string</UserEmail>
  <UserMobile>string</UserMobile>
  <UserRole>string</UserRole>
  <CustomProperties>string</CustomProperties>
  <ResellerCompanyId>00000000-0000-0000-0000-000000000000</ResellerCompanyId>
</Trisul.Org.Business.Models.Responses.TenantCompanyInfo>

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

companyId path string

company

Parameter content type:

body

{
  "CompanyId": "00000000-0000-0000-0000-000000000000",
  "OfferId": "00000000-0000-0000-0000-000000000000",
  "OfferName": "string",
  "CompanyName": "string",
  "IdentityProviderType": "string",
  "IdentityProviderDisplayName": "string",
  "Issuer": "string",
  "PrimaryIssuer": "string",
  "AdditionalSupportedDomains": "string",
  "IsAddAdminAccountAsUser": true,
  "IsAdminConsent": true,
  "Status": 0,
  "AdminUser": "string",
  "Created": "2024-02-06T12:47:39.557Z",
  "Updated": "2024-02-06T12:47:39.557Z",
  "OrgId": "00000000-0000-0000-0000-000000000000",
  "Address": {
    "AddressType": 0,
    "AddressTypeString": "string",
    "Email": "string",
    "PhoneNumber": "string",
    "Address1": "string",
    "Address2": "string",
    "City": "string",
    "State": "string",
    "CountryId": 0,
    "PostalCode": "string"
  },
  "IsAutoOnboardUsers": true,
  "DirectoryName": "string",
  "ApplicationId": "string",
  "SignInAndSignUpPolicy": "string",
  "PasswordResetPolicy": "string",
  "Acr": "string",
  "Scope": "string",
  "UserUpn": "string",
  "UserEmail": "string",
  "UserMobile": "string",
  "UserRole": "string",
  "CustomProperties": "string",
  "ResellerCompanyId": "00000000-0000-0000-0000-000000000000"
}

<?xml version="1.0"?>
<Trisul.Org.Business.Models.Responses.TenantCompanyInfo>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <OfferId>00000000-0000-0000-0000-000000000000</OfferId>
  <OfferName>string</OfferName>
  <CompanyName>string</CompanyName>
  <IdentityProviderType>string</IdentityProviderType>
  <IdentityProviderDisplayName>string</IdentityProviderDisplayName>
  <Issuer>string</Issuer>
  <PrimaryIssuer>string</PrimaryIssuer>
  <AdditionalSupportedDomains>string</AdditionalSupportedDomains>
  <IsAddAdminAccountAsUser>true</IsAddAdminAccountAsUser>
  <IsAdminConsent>true</IsAdminConsent>
  <Status>0</Status>
  <AdminUser>string</AdminUser>
  <Created>1970-01-01T00:00:00.001Z</Created>
  <Updated>1970-01-01T00:00:00.001Z</Updated>
  <OrgId>00000000-0000-0000-0000-000000000000</OrgId>
  <Address>
    <AddressType>0</AddressType>
    <AddressTypeString>string</AddressTypeString>
    <Email>string</Email>
    <PhoneNumber>string</PhoneNumber>
    <Address1>string</Address1>
    <Address2>string</Address2>
    <City>string</City>
    <State>string</State>
    <CountryId>1</CountryId>
    <PostalCode>string</PostalCode>
  </Address>
  <IsAutoOnboardUsers>true</IsAutoOnboardUsers>
  <DirectoryName>string</DirectoryName>
  <ApplicationId>string</ApplicationId>
  <SignInAndSignUpPolicy>string</SignInAndSignUpPolicy>
  <PasswordResetPolicy>string</PasswordResetPolicy>
  <Acr>string</Acr>
  <Scope>string</Scope>
  <UserEmail>string</UserEmail>
  <UserMobile>string</UserMobile>
  <UserRole>string</UserRole>
  <CustomProperties>string</CustomProperties>
  <ResellerCompanyId>00000000-0000-0000-0000-000000000000</ResellerCompanyId>
</Trisul.Org.Business.Models.Responses.TenantCompanyInfo>

appId path string

post /api/integrations/{appId}/admin/service/core/companies/createCompanyAndSubscription

Create Tenant Company, Subscription for the provided Offer and Assign the provided user as owner to the subscription

Response Class (Status 200)

OK

{
  "CompanyId": "00000000-0000-0000-0000-000000000000",
  "OfferId": "00000000-0000-0000-0000-000000000000",
  "OfferName": "string",
  "CompanyName": "string",
  "IdentityProviderType": "string",
  "IdentityProviderDisplayName": "string",
  "Issuer": "string",
  "PrimaryIssuer": "string",
  "AdditionalSupportedDomains": "string",
  "IsAddAdminAccountAsUser": true,
  "IsAdminConsent": true,
  "Status": 0,
  "AdminUser": "string",
  "Created": "2024-02-06T12:47:39.562Z",
  "Updated": "2024-02-06T12:47:39.562Z",
  "OrgId": "00000000-0000-0000-0000-000000000000",
  "Address": {
    "AddressType": 0,
    "AddressTypeString": "string",
    "Email": "string",
    "PhoneNumber": "string",
    "Address1": "string",
    "Address2": "string",
    "City": "string",
    "State": "string",
    "CountryId": 0,
    "PostalCode": "string"
  },
  "IsAutoOnboardUsers": true,
  "DirectoryName": "string",
  "ApplicationId": "string",
  "SignInAndSignUpPolicy": "string",
  "PasswordResetPolicy": "string",
  "Acr": "string",
  "Scope": "string",
  "UserUpn": "string",
  "UserEmail": "string",
  "UserMobile": "string",
  "UserRole": "string",
  "CustomProperties": "string",
  "ResellerCompanyId": "00000000-0000-0000-0000-000000000000"
}

<?xml version="1.0"?>
<Trisul.Org.Business.Models.Responses.TenantCompanyInfo>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <OfferId>00000000-0000-0000-0000-000000000000</OfferId>
  <OfferName>string</OfferName>
  <CompanyName>string</CompanyName>
  <IdentityProviderType>string</IdentityProviderType>
  <IdentityProviderDisplayName>string</IdentityProviderDisplayName>
  <Issuer>string</Issuer>
  <PrimaryIssuer>string</PrimaryIssuer>
  <AdditionalSupportedDomains>string</AdditionalSupportedDomains>
  <IsAddAdminAccountAsUser>true</IsAddAdminAccountAsUser>
  <IsAdminConsent>true</IsAdminConsent>
  <Status>0</Status>
  <AdminUser>string</AdminUser>
  <Created>1970-01-01T00:00:00.001Z</Created>
  <Updated>1970-01-01T00:00:00.001Z</Updated>
  <OrgId>00000000-0000-0000-0000-000000000000</OrgId>
  <Address>
    <AddressType>0</AddressType>
    <AddressTypeString>string</AddressTypeString>
    <Email>string</Email>
    <PhoneNumber>string</PhoneNumber>
    <Address1>string</Address1>
    <Address2>string</Address2>
    <City>string</City>
    <State>string</State>
    <CountryId>1</CountryId>
    <PostalCode>string</PostalCode>
  </Address>
  <IsAutoOnboardUsers>true</IsAutoOnboardUsers>
  <DirectoryName>string</DirectoryName>
  <ApplicationId>string</ApplicationId>
  <SignInAndSignUpPolicy>string</SignInAndSignUpPolicy>
  <PasswordResetPolicy>string</PasswordResetPolicy>
  <Acr>string</Acr>
  <Scope>string</Scope>
  <UserUpn>string</UserUpn>
  <UserEmail>string</UserEmail>
  <UserMobile>string</UserMobile>
  <UserRole>string</UserRole>
  <CustomProperties>string</CustomProperties>
  <ResellerCompanyId>00000000-0000-0000-0000-000000000000</ResellerCompanyId>
</Trisul.Org.Business.Models.Responses.TenantCompanyInfo>

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

companyModel

Parameter content type:

body

{
  "CompanyName": "string",
  "Issuer": "string",
  "AdditionalSupportedDomains": "string",
  "Email": "string",
  "PhoneNumber": "string",
  "Address1": "string",
  "Address2": "string",
  "City": "string",
  "State": "string",
  "CountryId": "string",
  "CountryCode": "string",
  "OfferId": "00000000-0000-0000-0000-000000000000",
  "ResellerCompanyId": "00000000-0000-0000-0000-000000000000",
  "PostalCode": "string",
  "UserUpn": "string",
  "AdminUser": "string",
  "UserName": "string",
  "IsAdminConcent": true,
  "UserEmail": "string",
  "UserMobile": "string",
  "IsAddAdminAccountAsUser": true,
  "IsResellerEnabled": true,
  "IsAutoOnboardUsers": true,
  "IdentityProviderType": "string",
  "DirectoryName": "string",
  "ApplicationId": "string",
  "ApplicationSecret": "string",
  "SignInAndSignUpPolicy": "string",
  "PasswordResetPolicy": "string",
  "Acr": "string",
  "Scope": "string",
  "UserRole": "string",
  "CustomProperties": "string",
  "SubscriptionName": "string",
  "SubscriptionOwner": "string",
  "CloneExistingOffer": true,
  "CloneOfferName": "string",
  "ClonePlanName": "string",
  "ClonePricingProfileName": "string",
  "MapWithReseller": true,
  "CspCustomerId": "string"
}

<?xml version="1.0"?>
<Trisul.Org.Business.Models.Requests.TenantCompanyCreateRequest>
  <CompanyName>string</CompanyName>
  <Issuer>string</Issuer>
  <AdditionalSupportedDomains>string</AdditionalSupportedDomains>
  <Email>string</Email>
  <PhoneNumber>string</PhoneNumber>
  <Address1>string</Address1>
  <Address2>string</Address2>
  <City>string</City>
  <State>string</State>
  <CountryId>string</CountryId>
  <CountryCode>string</CountryCode>
  <OfferId>00000000-0000-0000-0000-000000000000</OfferId>
  <ResellerCompanyId>00000000-0000-0000-0000-000000000000</ResellerCompanyId>
  <PostalCode>string</PostalCode>
  <UserUpn>string</UserUpn>
  <IsAdminConcent>true</IsAdminConcent>
  <UserEmail>string</UserEmail>
  <UserMobile>string</UserMobile>
  <IsAddAdminAccountAsUser>true</IsAddAdminAccountAsUser>
  <IsResellerEnabled>true</IsResellerEnabled>
  <IsAutoOnboardUsers>true</IsAutoOnboardUsers>
  <IdentityProviderType>string</IdentityProviderType>
  <DirectoryName>string</DirectoryName>
  <ApplicationId>string</ApplicationId>
  <ApplicationSecret>string</ApplicationSecret>
  <SignInAndSignUpPolicy>string</SignInAndSignUpPolicy>
  <PasswordResetPolicy>string</PasswordResetPolicy>
  <Acr>string</Acr>
  <Scope>string</Scope>
  <UserRole>string</UserRole>
  <CustomProperties>string</CustomProperties>
  <SubscriptionName>string</SubscriptionName>
  <SubscriptionOwner>string</SubscriptionOwner>
  <CloneExistingOffer>true</CloneExistingOffer>
  <CloneOfferName>string</CloneOfferName>
  <ClonePlanName>string</ClonePlanName>
  <ClonePricingProfileName>string</ClonePricingProfileName>
  <MapWithReseller>true</MapWithReseller>
  <CspCustomerId>string</CspCustomerId>
</Trisul.Org.Business.Models.Requests.TenantCompanyCreateRequest>

appId path string

get /api/integrations/{appId}/admin/service/core/companies/adminportalusers

Get all users of the hosting parent admin company

Response Class (Status 200)

OK

[
  "string"
]

<?xml version="1.0"?>
  <Inline Model>string</Inline Model>

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
appId			path	string

AdminHybrCompanySubscriptions

get /api/integrations/{appId}/admin/service/core/companies/{companyId}/subscriptions

Get a company's subscriptions

Response Class (Status 200)

OK

[
  {
    "SubscriptionId": "00000000-0000-0000-0000-000000000000",
    "SubscriptionName": "string"
  }
]

<?xml version="1.0"?>
<Inline Model>
  <SubscriptionId>00000000-0000-0000-0000-000000000000</SubscriptionId>
  <SubscriptionName>string</SubscriptionName>
</Inline Model>

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
companyId			path	string
appId			path	string

post /api/integrations/{appId}/admin/service/core/companies/{companyId}/subscriptions

Create a customer company subscription

Response Class (Status 200)

OK

{
  "Created": "2024-02-06T12:47:39.577Z",
  "CreatedByUserId": "string",
  "CompanyId": "00000000-0000-0000-0000-000000000000",
  "CompanyName": "string",
  "Id": "00000000-0000-0000-0000-000000000000",
  "IsAdminSubscription": true,
  "OfferId": "00000000-0000-0000-0000-000000000000",
  "OfferName": "string",
  "PlanName": "string",
  "PlanId": "00000000-0000-0000-0000-000000000000",
  "OrgId": "00000000-0000-0000-0000-000000000000",
  "Status": 0,
  "StatusString": "string",
  "SubscriptionName": "string",
  "SubscriptionUniqueName": "string",
  "SubscriptionType": 0,
  "SubscriptionTypeString": "string",
  "TrialEndDate": "2024-02-06T12:47:39.577Z",
  "Updated": "2024-02-06T12:47:39.577Z",
  "ParentCompanyName": "string",
  "BasePlanName": "string",
  "BasePlanId": "00000000-0000-0000-0000-000000000000",
  "ParentCompanyId": "00000000-0000-0000-0000-000000000000"
}

<?xml version="1.0"?>
<Trisul.Org.Business.Models.Responses.TenantSubscriptionResponse>
  <Created>1970-01-01T00:00:00.001Z</Created>
  <CreatedByUserId>string</CreatedByUserId>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <CompanyName>string</CompanyName>
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <IsAdminSubscription>true</IsAdminSubscription>
  <OfferId>00000000-0000-0000-0000-000000000000</OfferId>
  <OfferName>string</OfferName>
  <PlanName>string</PlanName>
  <PlanId>00000000-0000-0000-0000-000000000000</PlanId>
  <OrgId>00000000-0000-0000-0000-000000000000</OrgId>
  <Status>0</Status>
  <StatusString>string</StatusString>
  <SubscriptionName>string</SubscriptionName>
  <SubscriptionUniqueName>string</SubscriptionUniqueName>
  <SubscriptionType>0</SubscriptionType>
  <SubscriptionTypeString>string</SubscriptionTypeString>
  <TrialEndDate>1970-01-01T00:00:00.001Z</TrialEndDate>
  <Updated>1970-01-01T00:00:00.001Z</Updated>
  <ParentCompanyName>string</ParentCompanyName>
  <BasePlanName>string</BasePlanName>
  <BasePlanId>00000000-0000-0000-0000-000000000000</BasePlanId>
  <ParentCompanyId>00000000-0000-0000-0000-000000000000</ParentCompanyId>
</Trisul.Org.Business.Models.Responses.TenantSubscriptionResponse>

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

companyId path string

createTenantSubscriptionIn

Parameter content type:

body

{
  "OfferId": "00000000-0000-0000-0000-000000000000",
  "SubscriptionAdminUserUpn": "string",
  "SubscriptionName": "string"
}

<?xml version="1.0"?>
<Trisul.Org.Business.Models.Responses.CreateTenantSubscriptionIn>
  <OfferId>00000000-0000-0000-0000-000000000000</OfferId>
  <SubscriptionAdminUserUpn>string</SubscriptionAdminUserUpn>
  <SubscriptionName>string</SubscriptionName>
</Trisul.Org.Business.Models.Responses.CreateTenantSubscriptionIn>

appId path string

delete /api/integrations/{appId}/admin/service/core/companies/{companyId}/subscriptions/{subscriptionId}

Delete a company subscription

Response Class (Status 200)

OK

{
  "IsSuccess": true,
  "Message": "string"
}

<?xml version="1.0"?>
<Trisul.Org.Api.Web.Api.Controllers.Integrations.IntegrationActionResponse>
  <IsSuccess>true</IsSuccess>
  <Message>string</Message>
</Trisul.Org.Api.Web.Api.Controllers.Integrations.IntegrationActionResponse>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
companyId	path	string
subscriptionId	path	string
appId	path	string

get /api/integrations/{appId}/admin/service/core/companies/{companyId}/subscriptions/{subscriptionId}

Get a company's subscription

Response Class (Status 200)

OK

{
  "Created": "2024-02-06T12:47:39.591Z",
  "CreatedByUserId": "string",
  "CompanyId": "00000000-0000-0000-0000-000000000000",
  "CompanyName": "string",
  "Id": "00000000-0000-0000-0000-000000000000",
  "IsAdminSubscription": true,
  "OfferId": "00000000-0000-0000-0000-000000000000",
  "OfferName": "string",
  "PlanName": "string",
  "PlanId": "00000000-0000-0000-0000-000000000000",
  "OrgId": "00000000-0000-0000-0000-000000000000",
  "Status": 0,
  "StatusString": "string",
  "SubscriptionName": "string",
  "SubscriptionUniqueName": "string",
  "SubscriptionType": 0,
  "SubscriptionTypeString": "string",
  "TrialEndDate": "2024-02-06T12:47:39.591Z",
  "Updated": "2024-02-06T12:47:39.591Z",
  "ParentCompanyName": "string",
  "BasePlanName": "string",
  "BasePlanId": "00000000-0000-0000-0000-000000000000",
  "ParentCompanyId": "00000000-0000-0000-0000-000000000000"
}

<?xml version="1.0"?>
<Trisul.Org.Business.Models.Responses.TenantSubscriptionResponse>
  <Created>1970-01-01T00:00:00.001Z</Created>
  <CreatedByUserId>string</CreatedByUserId>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <CompanyName>string</CompanyName>
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <IsAdminSubscription>true</IsAdminSubscription>
  <OfferId>00000000-0000-0000-0000-000000000000</OfferId>
  <OfferName>string</OfferName>
  <PlanName>string</PlanName>
  <PlanId>00000000-0000-0000-0000-000000000000</PlanId>
  <OrgId>00000000-0000-0000-0000-000000000000</OrgId>
  <Status>0</Status>
  <StatusString>string</StatusString>
  <SubscriptionName>string</SubscriptionName>
  <SubscriptionUniqueName>string</SubscriptionUniqueName>
  <SubscriptionType>0</SubscriptionType>
  <SubscriptionTypeString>string</SubscriptionTypeString>
  <TrialEndDate>1970-01-01T00:00:00.001Z</TrialEndDate>
  <Updated>1970-01-01T00:00:00.001Z</Updated>
  <ParentCompanyName>string</ParentCompanyName>
  <BasePlanName>string</BasePlanName>
  <BasePlanId>00000000-0000-0000-0000-000000000000</BasePlanId>
  <ParentCompanyId>00000000-0000-0000-0000-000000000000</ParentCompanyId>
</Trisul.Org.Business.Models.Responses.TenantSubscriptionResponse>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
companyId	path	string
subscriptionId	path	string
appId	path	string

put /api/integrations/{appId}/admin/service/core/companies/{companyId}/subscriptions/{subscriptionId}

Update a company subscription

Response Class (Status 200)

OK

{
  "Created": "2024-02-06T12:47:39.594Z",
  "CreatedByUserId": "string",
  "CompanyId": "00000000-0000-0000-0000-000000000000",
  "CompanyName": "string",
  "Id": "00000000-0000-0000-0000-000000000000",
  "IsAdminSubscription": true,
  "OfferId": "00000000-0000-0000-0000-000000000000",
  "OfferName": "string",
  "PlanName": "string",
  "PlanId": "00000000-0000-0000-0000-000000000000",
  "OrgId": "00000000-0000-0000-0000-000000000000",
  "Status": 0,
  "StatusString": "string",
  "SubscriptionName": "string",
  "SubscriptionUniqueName": "string",
  "SubscriptionType": 0,
  "SubscriptionTypeString": "string",
  "TrialEndDate": "2024-02-06T12:47:39.594Z",
  "Updated": "2024-02-06T12:47:39.594Z",
  "ParentCompanyName": "string",
  "BasePlanName": "string",
  "BasePlanId": "00000000-0000-0000-0000-000000000000",
  "ParentCompanyId": "00000000-0000-0000-0000-000000000000"
}

<?xml version="1.0"?>
<Trisul.Org.Business.Models.Responses.TenantSubscriptionResponse>
  <Created>1970-01-01T00:00:00.001Z</Created>
  <CreatedByUserId>string</CreatedByUserId>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <CompanyName>string</CompanyName>
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <IsAdminSubscription>true</IsAdminSubscription>
  <OfferId>00000000-0000-0000-0000-000000000000</OfferId>
  <OfferName>string</OfferName>
  <PlanName>string</PlanName>
  <PlanId>00000000-0000-0000-0000-000000000000</PlanId>
  <OrgId>00000000-0000-0000-0000-000000000000</OrgId>
  <Status>0</Status>
  <StatusString>string</StatusString>
  <SubscriptionName>string</SubscriptionName>
  <SubscriptionUniqueName>string</SubscriptionUniqueName>
  <SubscriptionType>0</SubscriptionType>
  <SubscriptionTypeString>string</SubscriptionTypeString>
  <TrialEndDate>1970-01-01T00:00:00.001Z</TrialEndDate>
  <Updated>1970-01-01T00:00:00.001Z</Updated>
  <ParentCompanyName>string</ParentCompanyName>
  <BasePlanName>string</BasePlanName>
  <BasePlanId>00000000-0000-0000-0000-000000000000</BasePlanId>
  <ParentCompanyId>00000000-0000-0000-0000-000000000000</ParentCompanyId>
</Trisul.Org.Business.Models.Responses.TenantSubscriptionResponse>

Response Content Type

Parameters

Parameter	Value	Parameter Type	Data Type
companyId		path	string
subscriptionId		path	string
tenantSubscriptionIn	Parameter content type:	body	Model Example Value Trisul.Org.Data.Sql.Models.UpdateTenantSubscriptionIn { SubscriptionId (string, optional), SubscriptionName (string, optional), OfferId (string, optional), CompanyId (string, optional) } `{ "SubscriptionId": "00000000-0000-0000-0000-000000000000", "SubscriptionName": "string", "OfferId": "00000000-0000-0000-0000-000000000000", "CompanyId": "00000000-0000-0000-0000-000000000000" }` `<?xml version="1.0"?> <Trisul.Org.Data.Sql.Models.UpdateTenantSubscriptionIn> <SubscriptionId>00000000-0000-0000-0000-000000000000</SubscriptionId> <SubscriptionName>string</SubscriptionName> <OfferId>00000000-0000-0000-0000-000000000000</OfferId> <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId> </Trisul.Org.Data.Sql.Models.UpdateTenantSubscriptionIn>`
appId		path	string

post /api/integrations/{appId}/admin/service/core/companies/{companyId}/subscriptions/reseller

Create a reseller company subscription

Response Class (Status 200)

OK

{
  "Created": "2024-02-06T12:47:39.599Z",
  "CreatedByUserId": "string",
  "CompanyId": "00000000-0000-0000-0000-000000000000",
  "CompanyName": "string",
  "Id": "00000000-0000-0000-0000-000000000000",
  "IsAdminSubscription": true,
  "OfferId": "00000000-0000-0000-0000-000000000000",
  "OfferName": "string",
  "PlanName": "string",
  "PlanId": "00000000-0000-0000-0000-000000000000",
  "OrgId": "00000000-0000-0000-0000-000000000000",
  "Status": 0,
  "StatusString": "string",
  "SubscriptionName": "string",
  "SubscriptionUniqueName": "string",
  "SubscriptionType": 0,
  "SubscriptionTypeString": "string",
  "TrialEndDate": "2024-02-06T12:47:39.599Z",
  "Updated": "2024-02-06T12:47:39.599Z",
  "ParentCompanyName": "string",
  "BasePlanName": "string",
  "BasePlanId": "00000000-0000-0000-0000-000000000000",
  "ParentCompanyId": "00000000-0000-0000-0000-000000000000"
}

<?xml version="1.0"?>
<Trisul.Org.Business.Models.Responses.TenantSubscriptionResponse>
  <Created>1970-01-01T00:00:00.001Z</Created>
  <CreatedByUserId>string</CreatedByUserId>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <CompanyName>string</CompanyName>
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <IsAdminSubscription>true</IsAdminSubscription>
  <OfferId>00000000-0000-0000-0000-000000000000</OfferId>
  <OfferName>string</OfferName>
  <PlanName>string</PlanName>
  <PlanId>00000000-0000-0000-0000-000000000000</PlanId>
  <OrgId>00000000-0000-0000-0000-000000000000</OrgId>
  <Status>0</Status>
  <StatusString>string</StatusString>
  <SubscriptionName>string</SubscriptionName>
  <SubscriptionUniqueName>string</SubscriptionUniqueName>
  <SubscriptionType>0</SubscriptionType>
  <SubscriptionTypeString>string</SubscriptionTypeString>
  <TrialEndDate>1970-01-01T00:00:00.001Z</TrialEndDate>
  <Updated>1970-01-01T00:00:00.001Z</Updated>
  <ParentCompanyName>string</ParentCompanyName>
  <BasePlanName>string</BasePlanName>
  <BasePlanId>00000000-0000-0000-0000-000000000000</BasePlanId>
  <ParentCompanyId>00000000-0000-0000-0000-000000000000</ParentCompanyId>
</Trisul.Org.Business.Models.Responses.TenantSubscriptionResponse>

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

companyId path string

createTenantSubscriptionIn

Parameter content type:

body

{
  "OfferId": "00000000-0000-0000-0000-000000000000",
  "SubscriptionAdminUserUpn": "string",
  "SubscriptionName": "string"
}

<?xml version="1.0"?>
<Trisul.Org.Business.Models.Responses.CreateTenantSubscriptionIn>
  <OfferId>00000000-0000-0000-0000-000000000000</OfferId>
  <SubscriptionAdminUserUpn>string</SubscriptionAdminUserUpn>
  <SubscriptionName>string</SubscriptionName>
</Trisul.Org.Business.Models.Responses.CreateTenantSubscriptionIn>

appId path string

get /api/integrations/{appId}/admin/service/core/companies/{companyId}/subscriptions/{subscriptionId}/subscriptionUserRoles

Get User Subscription Roles for a company subscription

Response Class (Status 200)

OK

[
  {
    "AccessControlRoleId": "00000000-0000-0000-0000-000000000000",
    "AccessControlRoleName": "string",
    "CompanyId": "00000000-0000-0000-0000-000000000000",
    "IdentityType": 0,
    "SubscriptionId": "00000000-0000-0000-0000-000000000000",
    "UserUpn": "string"
  }
]

<?xml version="1.0"?>
<Inline Model>
  <AccessControlRoleId>00000000-0000-0000-0000-000000000000</AccessControlRoleId>
  <AccessControlRoleName>string</AccessControlRoleName>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <IdentityType>0</IdentityType>
  <SubscriptionId>00000000-0000-0000-0000-000000000000</SubscriptionId>
  <UserUpn>string</UserUpn>
</Inline Model>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
companyId	path	string
subscriptionId	path	string
appId	path	string

post /api/integrations/{appId}/admin/service/core/companies/{companyId}/subscriptions/{subscriptionId}/subscriptionUserRoles

Assign User Role to a company subscription

Response Class (Status 200)

OK

{
  "AccessControlRoleId": "00000000-0000-0000-0000-000000000000",
  "AccessControlRoleName": "string",
  "CompanyId": "00000000-0000-0000-0000-000000000000",
  "IdentityType": 0,
  "SubscriptionId": "00000000-0000-0000-0000-000000000000",
  "UserUpn": "string"
}

<?xml version="1.0"?>
<Trisul.Org.Business.Models.Responses.UserSubscriptionRoleOut>
  <AccessControlRoleId>00000000-0000-0000-0000-000000000000</AccessControlRoleId>
  <AccessControlRoleName>string</AccessControlRoleName>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <IdentityType>0</IdentityType>
  <SubscriptionId>00000000-0000-0000-0000-000000000000</SubscriptionId>
  <UserUpn>string</UserUpn>
</Trisul.Org.Business.Models.Responses.UserSubscriptionRoleOut>

Response Content Type

Parameters

Parameter	Value	Parameter Type	Data Type
companyId		path	string
subscriptionId		path	string
assignUserSubscriptionRole	Parameter content type:	body	Model Example Value Trisul.Org.Business.Models.Responses.AssignUserSubscriptionRole { UserUpn (string, optional), SubscriptionRoleId (string, optional) } `{ "UserUpn": "string", "SubscriptionRoleId": "00000000-0000-0000-0000-000000000000" }` `<?xml version="1.0"?> <Trisul.Org.Business.Models.Responses.AssignUserSubscriptionRole> <UserUpn>string</UserUpn> <SubscriptionRoleId>00000000-0000-0000-0000-000000000000</SubscriptionRoleId> </Trisul.Org.Business.Models.Responses.AssignUserSubscriptionRole>`
appId		path	string

delete /api/integrations/{appId}/admin/service/core/companies/{companyId}/subscriptions/{subscriptionId}/subscriptionUserRoles/{userUpn}

Remove User Role from a company subscription

Response Class (Status 200)

OK

{
  "IsSuccess": true,
  "Message": "string"
}

<?xml version="1.0"?>
<Trisul.Org.Api.Web.Api.Controllers.Integrations.IntegrationActionResponse>
  <IsSuccess>true</IsSuccess>
  <Message>string</Message>
</Trisul.Org.Api.Web.Api.Controllers.Integrations.IntegrationActionResponse>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
companyId	path	string
subscriptionId	path	string
userUpn	path	string
appId	path	string

AdminHybrCompanyUserRoles

get /api/integrations/{appId}/admin/service/core/companies/{companyId}/userRoles/tenant

Roles for end user tenant company

Response Class (Status 200)

OK

[
  {
    "RoleId": "00000000-0000-0000-0000-000000000000",
    "RoleName": "string"
  }
]

<?xml version="1.0"?>
<Inline Model>
  <RoleId>00000000-0000-0000-0000-000000000000</RoleId>
  <RoleName>string</RoleName>
</Inline Model>

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
companyId			path	string
appId			path	string

get /api/integrations/{appId}/admin/service/core/companies/{companyId}/userRoles/admin

Roles for the hosting parent admin company

Response Class (Status 200)

OK

[
  {
    "RoleId": "00000000-0000-0000-0000-000000000000",
    "RoleName": "string"
  }
]

<?xml version="1.0"?>
<Inline Model>
  <RoleId>00000000-0000-0000-0000-000000000000</RoleId>
  <RoleName>string</RoleName>
</Inline Model>

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
companyId			path	string
appId			path	string

get /api/integrations/{appId}/admin/service/core/companies/{companyId}/userRoles/reseller

Roles for the Reseller tenant company

Response Class (Status 200)

OK

[
  {
    "RoleId": "00000000-0000-0000-0000-000000000000",
    "RoleName": "string"
  }
]

<?xml version="1.0"?>
<Inline Model>
  <RoleId>00000000-0000-0000-0000-000000000000</RoleId>
  <RoleName>string</RoleName>
</Inline Model>

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
companyId			path	string
appId			path	string

AdminHybrCompanyUsers

get /api/integrations/{appId}/admin/service/core/companies/{companyId}/users

Get company users

Response Class (Status 200)

OK

{
  "draw": 0,
  "recordsTotal": 0,
  "recordsFiltered": 0,
  "data": [
    {
      "UserUpn": "string"
    }
  ]
}

<?xml version="1.0"?>
<Trisul.Org.Business.Models.Responses.PagedResponse[Trisul.Org.Business.Models.Responses.TenantCompanyUserIdOut]>
  <draw>1</draw>
  <recordsTotal>1</recordsTotal>
  <recordsFiltered>1</recordsFiltered>
  <data>
    <UserUpn>string</UserUpn>
  </data>
</Trisul.Org.Business.Models.Responses.PagedResponse[Trisul.Org.Business.Models.Responses.TenantCompanyUserIdOut]>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
companyId	path	string
draw	query	integer
start	query	integer
length	query	integer
appId	path	string

post /api/integrations/{appId}/admin/service/core/companies/{companyId}/users

Create a new user in the company. Also creates a new UserProfile for the user.

Response Class (Status 200)

OK

{
  "UserUpn": "string"
}

<?xml version="1.0"?>
<Trisul.Org.Business.Models.Responses.TenantCompanyUserIdOut>
  <UserUpn>string</UserUpn>
</Trisul.Org.Business.Models.Responses.TenantCompanyUserIdOut>

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

companyId path string

createUserIn

Parameter content type:

body

{
  "FirstName": "string",
  "LastName": "string",
  "UserPrincipalName": "string",
  "EmailId": "string"
}

<?xml version="1.0"?>
<Trisul.Org.Business.Models.Responses.CreateUserIn>
  <FirstName>string</FirstName>
  <LastName>string</LastName>
  <UserPrincipalName>string</UserPrincipalName>
  <EmailId>string</EmailId>
</Trisul.Org.Business.Models.Responses.CreateUserIn>

appId path string

put /api/integrations/{appId}/admin/service/core/companies/{companyId}/users

Update company user profile information.

Response Class (Status 200)

OK

{
  "IsSuccess": true,
  "Message": "string"
}

<?xml version="1.0"?>
<Trisul.Org.Api.Web.Api.Controllers.Integrations.IntegrationActionResponse>
  <IsSuccess>true</IsSuccess>
  <Message>string</Message>
</Trisul.Org.Api.Web.Api.Controllers.Integrations.IntegrationActionResponse>

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

companyId path string

profileIn

Parameter content type:

body

{
  "UserProfileId": "00000000-0000-0000-0000-000000000000",
  "AddressId": "00000000-0000-0000-0000-000000000000",
  "Company": "string",
  "CompanyId": "00000000-0000-0000-0000-000000000000",
  "Created": "2024-02-06T12:47:39.633Z",
  "CreatedBy": "string",
  "FirstName": "string",
  "IsInvoiceManual": true,
  "LastName": "string",
  "LastUpdated": "2024-02-06T12:47:39.633Z",
  "LastUpdatedBy": "string",
  "ReferredBy": "string",
  "SignupDate": "2024-02-06T12:47:39.633Z",
  "SignupState": 0,
  "SignupStateString": "string",
  "UserEmailId": "string",
  "UserUpn": "string",
  "UpdatedBy": "string"
}

<?xml version="1.0"?>
<Trisul.Org.Business.Models.Requests.UserBasicProfileIn>
  <UserProfileId>00000000-0000-0000-0000-000000000000</UserProfileId>
  <AddressId>00000000-0000-0000-0000-000000000000</AddressId>
  <Company>string</Company>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Created>1970-01-01T00:00:00.001Z</Created>
  <CreatedBy>string</CreatedBy>
  <FirstName>string</FirstName>
  <IsInvoiceManual>true</IsInvoiceManual>
  <LastName>string</LastName>
  <LastUpdated>1970-01-01T00:00:00.001Z</LastUpdated>
  <LastUpdatedBy>string</LastUpdatedBy>
  <ReferredBy>string</ReferredBy>
  <SignupDate>1970-01-01T00:00:00.001Z</SignupDate>
  <SignupState>0</SignupState>
  <SignupStateString>string</SignupStateString>
  <UserEmailId>string</UserEmailId>
  <UserUpn>string</UserUpn>
  <UpdatedBy>string</UpdatedBy>
</Trisul.Org.Business.Models.Requests.UserBasicProfileIn>

appId path string

delete /api/integrations/{appId}/admin/service/core/companies/{companyId}/users/{userPrincipalName}

Deletes both UserProfile and TenantCompanyUser

Response Class (Status 200)

OK

{
  "IsSuccess": true,
  "Message": "string"
}

<?xml version="1.0"?>
<Trisul.Org.Api.Web.Api.Controllers.Integrations.IntegrationActionResponse>
  <IsSuccess>true</IsSuccess>
  <Message>string</Message>
</Trisul.Org.Api.Web.Api.Controllers.Integrations.IntegrationActionResponse>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
companyId	path	string
userPrincipalName	path	string
appId	path	string

get /api/integrations/{appId}/admin/service/core/companies/{companyId}/users/{userPrincipalName}

Get company user detail

Response Class (Status 200)

OK

{
  "CompanyId": "00000000-0000-0000-0000-000000000000",
  "CompanyName": "string",
  "UserUpn": "string",
  "UserName": "string",
  "Email": "string",
  "Mobile": "string",
  "RegistrationStatus": 0,
  "Created": "2024-02-06T12:47:39.638Z",
  "Updated": "2024-02-06T12:47:39.638Z",
  "IsApproved": true,
  "ApprovedBy": "00000000-0000-0000-0000-000000000000",
  "Id": "string",
  "EmailConfirmed": true,
  "PhoneNumberConfirmed": true,
  "DefaultOrgId": "00000000-0000-0000-0000-000000000000",
  "UserProfileId": "00000000-0000-0000-0000-000000000000",
  "SubscriptionId": "00000000-0000-0000-0000-000000000000",
  "SignupState": 0,
  "UserRole": "string",
  "UserFullName": "string"
}

<?xml version="1.0"?>
<Trisul.Org.Business.Models.Responses.TenantUserInfo>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <CompanyName>string</CompanyName>
  <UserUpn>string</UserUpn>
  <UserName>string</UserName>
  <Email>string</Email>
  <Mobile>string</Mobile>
  <RegistrationStatus>0</RegistrationStatus>
  <Created>1970-01-01T00:00:00.001Z</Created>
  <Updated>1970-01-01T00:00:00.001Z</Updated>
  <IsApproved>true</IsApproved>
  <ApprovedBy>00000000-0000-0000-0000-000000000000</ApprovedBy>
  <Id>string</Id>
  <EmailConfirmed>true</EmailConfirmed>
  <PhoneNumberConfirmed>true</PhoneNumberConfirmed>
  <DefaultOrgId>00000000-0000-0000-0000-000000000000</DefaultOrgId>
  <UserProfileId>00000000-0000-0000-0000-000000000000</UserProfileId>
  <SubscriptionId>00000000-0000-0000-0000-000000000000</SubscriptionId>
  <SignupState>0</SignupState>
  <UserRole>string</UserRole>
  <UserFullName>string</UserFullName>
</Trisul.Org.Business.Models.Responses.TenantUserInfo>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
companyId	path	string
userPrincipalName	path	string
appId	path	string

put /api/integrations/{appId}/admin/service/core/companies/{companyId}/users/{userPrincipalName}

Update company user basic information.

Response Class (Status 200)

OK

{
  "UserUpn": "string"
}

<?xml version="1.0"?>
<Trisul.Org.Business.Models.Responses.TenantCompanyUserIdOut>
  <UserUpn>string</UserUpn>
</Trisul.Org.Business.Models.Responses.TenantCompanyUserIdOut>

Response Content Type

Parameters

Parameter	Value	Parameter Type	Data Type
companyId		path	string
userPrincipalName		path	string
updateUserIn	Parameter content type:	body	Model Example Value Trisul.Org.Business.Models.Responses.UpdateUserIn { UpdatedBy (string, optional), IsApproved (boolean, optional), FirstName (string, optional), LastName (string, optional), UserPrincipalName (string, optional), EmailId (string, optional) } `{ "UpdatedBy": "string", "IsApproved": true, "FirstName": "string", "LastName": "string", "UserPrincipalName": "string", "EmailId": "string" }` `<?xml version="1.0"?> <Trisul.Org.Business.Models.Responses.UpdateUserIn> <UpdatedBy>string</UpdatedBy> <IsApproved>true</IsApproved> <FirstName>string</FirstName> <LastName>string</LastName> <UserPrincipalName>string</UserPrincipalName> <EmailId>string</EmailId> </Trisul.Org.Business.Models.Responses.UpdateUserIn>`
appId		path	string

get /api/integrations/{appId}/admin/service/core/companies/{companyId}/users/{userPrincipalName}/roles

Get company user roles

Response Class (Status 200)

OK

[
  {
    "CompanyId": "00000000-0000-0000-0000-000000000000",
    "CompanyName": "string",
    "EntityPath": "string",
    "RoleId": "00000000-0000-0000-0000-000000000000",
    "RoleName": "string",
    "UserUpn": "string"
  }
]

<?xml version="1.0"?>
<Inline Model>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <CompanyName>string</CompanyName>
  <EntityPath>string</EntityPath>
  <RoleId>00000000-0000-0000-0000-000000000000</RoleId>
  <RoleName>string</RoleName>
  <UserUpn>string</UserUpn>
</Inline Model>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
companyId	path	string
userPrincipalName	path	string
appId	path	string

get /api/integrations/{appId}/admin/service/core/companies/{companyId}/users/allUserRoles

Get company all users and their roles

Response Class (Status 200)

OK

{
  "ParentCompanyId": "00000000-0000-0000-0000-000000000000",
  "draw": 0,
  "recordsTotal": 0,
  "recordsFiltered": 0,
  "data": [
    {
      "CompanyId": "00000000-0000-0000-0000-000000000000",
      "CompanyName": "string",
      "EntityPath": "string",
      "RoleId": "00000000-0000-0000-0000-000000000000",
      "RoleName": "string",
      "UserUpn": "string"
    }
  ]
}

<?xml version="1.0"?>
<Trisul.Org.Business.Models.Responses.ParentCompanyMappedDataResponse[Trisul.Org.Business.Models.Responses.TenantCompanyUserRoleWithCompanyOut]>
  <ParentCompanyId>00000000-0000-0000-0000-000000000000</ParentCompanyId>
  <draw>1</draw>
  <recordsTotal>1</recordsTotal>
  <recordsFiltered>1</recordsFiltered>
  <data>
    <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
    <CompanyName>string</CompanyName>
    <EntityPath>string</EntityPath>
    <RoleId>00000000-0000-0000-0000-000000000000</RoleId>
    <RoleName>string</RoleName>
    <UserUpn>string</UserUpn>
  </data>
</Trisul.Org.Business.Models.Responses.ParentCompanyMappedDataResponse[Trisul.Org.Business.Models.Responses.TenantCompanyUserRoleWithCompanyOut]>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
companyId	path	string
draw	query	integer
start	query	integer
length	query	integer
isOnlyParentCompanyRoles	query	boolean
appId	path	string

AdminHybrOffers

get /api/integrations/{appId}/admin/service/core/offers

Response Class (Status 200)

OK

{
  "draw": 0,
  "recordsFiltered": 0,
  "recordsTotal": 0,
  "data": [
    {
      "OfferId": "00000000-0000-0000-0000-000000000000",
      "Name": "string",
      "Description": "string",
      "DisplayName": "string",
      "AdvertisePrice": "string",
      "AdvertiseText": "string",
      "Status": 0,
      "IsDefaultOffer": true,
      "PlansList": [
        {
          "PlanId": "00000000-0000-0000-0000-000000000000",
          "Name": "string",
          "Description": "string",
          "OwnerId": "00000000-0000-0000-0000-000000000000",
          "PlanServices": [
            {
              "ServiceId": "00000000-0000-0000-0000-000000000000",
              "ServiceName": "string",
              "ServiceRegion": "string",
              "Description": "string",
              "DefaultQuotaSettingsJson": "string",
              "ServiceFeatures": [
                {
                  "FeatureId": "00000000-0000-0000-0000-000000000000",
                  "FeatureName": "string",
                  "Description": "string",
                  "FeatureQuotas": [
                    {}
                  ],
                  "ServiceId": "00000000-0000-0000-0000-000000000000",
                  "Service": {}
                }
              ],
              "PlanId": "00000000-0000-0000-0000-000000000000"
            }
          ],
          "AddOnPlan": true,
          "PlanScopeType": 0
        }
      ],
      "AddOnsList": [
        {
          "PlanId": "00000000-0000-0000-0000-000000000000",
          "Name": "string",
          "Description": "string",
          "OwnerId": "00000000-0000-0000-0000-000000000000",
          "PlanServices": [
            {
              "ServiceId": "00000000-0000-0000-0000-000000000000",
              "ServiceName": "string",
              "ServiceRegion": "string",
              "Description": "string",
              "DefaultQuotaSettingsJson": "string",
              "ServiceFeatures": [
                {
                  "FeatureId": "00000000-0000-0000-0000-000000000000",
                  "FeatureName": "string",
                  "Description": "string",
                  "FeatureQuotas": [
                    {}
                  ],
                  "ServiceId": "00000000-0000-0000-0000-000000000000",
                  "Service": {}
                }
              ],
              "PlanId": "00000000-0000-0000-0000-000000000000"
            }
          ],
          "AddOnPlan": true,
          "PlanScopeType": 0
        }
      ]
    }
  ]
}

<?xml version="1.0"?>
<Trisul.Org.Api.Web.Areas.Admin.Models.DataTable[Trisul.Org.Api.Web.Areas.Admin.ViewModels.Offers.OfferOut]>
  <draw>1</draw>
  <recordsFiltered>1</recordsFiltered>
  <recordsTotal>1</recordsTotal>
  <data>
    <OfferId>00000000-0000-0000-0000-000000000000</OfferId>
    <Name>string</Name>
    <Description>string</Description>
    <DisplayName>string</DisplayName>
    <AdvertisePrice>string</AdvertisePrice>
    <AdvertiseText>string</AdvertiseText>
    <Status>0</Status>
    <IsDefaultOffer>true</IsDefaultOffer>
    <PlansList>
      <PlanId>00000000-0000-0000-0000-000000000000</PlanId>
      <Name>string</Name>
      <Description>string</Description>
      <OwnerId>00000000-0000-0000-0000-000000000000</OwnerId>
      <PlanServices>
        <ServiceId>00000000-0000-0000-0000-000000000000</ServiceId>
        <ServiceName>string</ServiceName>
        <ServiceRegion>string</ServiceRegion>
        <Description>string</Description>
        <DefaultQuotaSettingsJson>string</DefaultQuotaSettingsJson>
        <ServiceFeatures>
          <FeatureId>00000000-0000-0000-0000-000000000000</FeatureId>
          <FeatureName>string</FeatureName>
          <Description>string</Description>
          <FeatureQuotas></FeatureQuotas>
          <ServiceId>00000000-0000-0000-0000-000000000000</ServiceId>
          <Service>
            <!-- Infinite loop $ref:Trisul.Org.Api.Web.Areas.Admin.ViewModels.PlanServices.PlanServiceOut -->
          </Service>
        </ServiceFeatures>
        <PlanId>00000000-0000-0000-0000-000000000000</PlanId>
      </PlanServices>
      <AddOnPlan>true</AddOnPlan>
      <PlanScopeType>0</PlanScopeType>
    </PlansList>
    <AddOnsList>
      <PlanId>00000000-0000-0000-0000-000000000000</PlanId>
      <Name>string</Name>
      <Description>string</Description>
      <OwnerId>00000000-0000-0000-0000-000000000000</OwnerId>
      <PlanServices>
        <ServiceId>00000000-0000-0000-0000-000000000000</ServiceId>
        <ServiceName>string</ServiceName>
        <ServiceRegion>string</ServiceRegion>
        <Description>string</Description>
        <DefaultQuotaSettingsJson>string</DefaultQuotaSettingsJson>
        <ServiceFeatures>
          <FeatureId>00000000-0000-0000-0000-000000000000</FeatureId>
          <FeatureName>string</FeatureName>
          <Description>string</Description>
          <FeatureQuotas></FeatureQuotas>
          <ServiceId>00000000-0000-0000-0000-000000000000</ServiceId>
          <Service>
            <!-- Infinite loop $ref:Trisul.Org.Api.Web.Areas.Admin.ViewModels.PlanServices.PlanServiceOut -->
          </Service>
        </ServiceFeatures>
        <PlanId>00000000-0000-0000-0000-000000000000</PlanId>
      </PlanServices>
      <AddOnPlan>true</AddOnPlan>
      <PlanScopeType>0</PlanScopeType>
    </AddOnsList>
  </data>
</Trisul.Org.Api.Web.Areas.Admin.Models.DataTable[Trisul.Org.Api.Web.Areas.Admin.ViewModels.Offers.OfferOut]>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
searchString	query	string
appId	path	string
paginationParameters.page	query	integer
paginationParameters.page_Size	query	integer

post /api/integrations/{appId}/admin/service/core/offers

Response Class (Status 200)

OK

{
  "OfferId": "00000000-0000-0000-0000-000000000000",
  "Name": "string",
  "Description": "string",
  "DisplayName": "string",
  "AdvertisePrice": "string",
  "AdvertiseText": "string",
  "Status": 0,
  "IsDefaultOffer": true,
  "PlansList": [
    {
      "PlanId": "00000000-0000-0000-0000-000000000000",
      "Name": "string",
      "Description": "string",
      "OwnerId": "00000000-0000-0000-0000-000000000000",
      "PlanServices": [
        {
          "ServiceId": "00000000-0000-0000-0000-000000000000",
          "ServiceName": "string",
          "ServiceRegion": "string",
          "Description": "string",
          "DefaultQuotaSettingsJson": "string",
          "ServiceFeatures": [
            {
              "FeatureId": "00000000-0000-0000-0000-000000000000",
              "FeatureName": "string",
              "Description": "string",
              "FeatureQuotas": [
                {}
              ],
              "ServiceId": "00000000-0000-0000-0000-000000000000",
              "Service": {}
            }
          ],
          "PlanId": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "AddOnPlan": true,
      "PlanScopeType": 0
    }
  ],
  "AddOnsList": [
    {
      "PlanId": "00000000-0000-0000-0000-000000000000",
      "Name": "string",
      "Description": "string",
      "OwnerId": "00000000-0000-0000-0000-000000000000",
      "PlanServices": [
        {
          "ServiceId": "00000000-0000-0000-0000-000000000000",
          "ServiceName": "string",
          "ServiceRegion": "string",
          "Description": "string",
          "DefaultQuotaSettingsJson": "string",
          "ServiceFeatures": [
            {
              "FeatureId": "00000000-0000-0000-0000-000000000000",
              "FeatureName": "string",
              "Description": "string",
              "FeatureQuotas": [
                {}
              ],
              "ServiceId": "00000000-0000-0000-0000-000000000000",
              "Service": {}
            }
          ],
          "PlanId": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "AddOnPlan": true,
      "PlanScopeType": 0
    }
  ]
}

<?xml version="1.0"?>
<Trisul.Org.Api.Web.Areas.Admin.ViewModels.Offers.OfferOut>
  <OfferId>00000000-0000-0000-0000-000000000000</OfferId>
  <Name>string</Name>
  <Description>string</Description>
  <DisplayName>string</DisplayName>
  <AdvertisePrice>string</AdvertisePrice>
  <AdvertiseText>string</AdvertiseText>
  <Status>0</Status>
  <IsDefaultOffer>true</IsDefaultOffer>
  <PlansList>
    <PlanId>00000000-0000-0000-0000-000000000000</PlanId>
    <Name>string</Name>
    <Description>string</Description>
    <OwnerId>00000000-0000-0000-0000-000000000000</OwnerId>
    <PlanServices>
      <ServiceId>00000000-0000-0000-0000-000000000000</ServiceId>
      <ServiceName>string</ServiceName>
      <ServiceRegion>string</ServiceRegion>
      <Description>string</Description>
      <DefaultQuotaSettingsJson>string</DefaultQuotaSettingsJson>
      <ServiceFeatures>
        <FeatureId>00000000-0000-0000-0000-000000000000</FeatureId>
        <FeatureName>string</FeatureName>
        <Description>string</Description>
        <FeatureQuotas></FeatureQuotas>
        <ServiceId>00000000-0000-0000-0000-000000000000</ServiceId>
        <Service>
          <!-- Infinite loop $ref:Trisul.Org.Api.Web.Areas.Admin.ViewModels.PlanServices.PlanServiceOut -->
        </Service>
      </ServiceFeatures>
      <PlanId>00000000-0000-0000-0000-000000000000</PlanId>
    </PlanServices>
    <AddOnPlan>true</AddOnPlan>
    <PlanScopeType>0</PlanScopeType>
  </PlansList>
  <AddOnsList>
    <PlanId>00000000-0000-0000-0000-000000000000</PlanId>
    <Name>string</Name>
    <Description>string</Description>
    <OwnerId>00000000-0000-0000-0000-000000000000</OwnerId>
    <PlanServices>
      <ServiceId>00000000-0000-0000-0000-000000000000</ServiceId>
      <ServiceName>string</ServiceName>
      <ServiceRegion>string</ServiceRegion>
      <Description>string</Description>
      <DefaultQuotaSettingsJson>string</DefaultQuotaSettingsJson>
      <ServiceFeatures>
        <FeatureId>00000000-0000-0000-0000-000000000000</FeatureId>
        <FeatureName>string</FeatureName>
        <Description>string</Description>
        <FeatureQuotas></FeatureQuotas>
        <ServiceId>00000000-0000-0000-0000-000000000000</ServiceId>
        <Service>
          <!-- Infinite loop $ref:Trisul.Org.Api.Web.Areas.Admin.ViewModels.PlanServices.PlanServiceOut -->
        </Service>
      </ServiceFeatures>
      <PlanId>00000000-0000-0000-0000-000000000000</PlanId>
    </PlanServices>
    <AddOnPlan>true</AddOnPlan>
    <PlanScopeType>0</PlanScopeType>
  </AddOnsList>
</Trisul.Org.Api.Web.Areas.Admin.ViewModels.Offers.OfferOut>

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

SubscriptionId query string

input

Parameter content type:

body

{
  "OfferId": "00000000-0000-0000-0000-000000000000",
  "Name": "string",
  "Description": "string",
  "DisplayName": "string",
  "Status": 0,
  "AdvertisePrice": "string",
  "AdvertiseText": "string",
  "IsDefaultOffer": true,
  "OwnerId": "00000000-0000-0000-0000-000000000000"
}

<?xml version="1.0"?>
<Trisul.Org.Api.Web.Areas.Admin.ViewModels.Offers.OfferCreateViewModel>
  <OfferId>00000000-0000-0000-0000-000000000000</OfferId>
  <Name>string</Name>
  <Description>string</Description>
  <DisplayName>string</DisplayName>
  <Status>0</Status>
  <AdvertisePrice>string</AdvertisePrice>
  <AdvertiseText>string</AdvertiseText>
  <IsDefaultOffer>true</IsDefaultOffer>
  <OwnerId>00000000-0000-0000-0000-000000000000</OwnerId>
</Trisul.Org.Api.Web.Areas.Admin.ViewModels.Offers.OfferCreateViewModel>

planId query string

planScope query integer

appId path string

get /api/integrations/{appId}/admin/service/core/offers/{offerId}

Response Class (Status 200)

OK

{
  "OfferId": "00000000-0000-0000-0000-000000000000",
  "Name": "string",
  "Description": "string",
  "DisplayName": "string",
  "AdvertisePrice": "string",
  "AdvertiseText": "string",
  "Status": 0,
  "IsDefaultOffer": true,
  "PlansList": [
    {
      "PlanId": "00000000-0000-0000-0000-000000000000",
      "Name": "string",
      "Description": "string",
      "OwnerId": "00000000-0000-0000-0000-000000000000",
      "PlanServices": [
        {
          "ServiceId": "00000000-0000-0000-0000-000000000000",
          "ServiceName": "string",
          "ServiceRegion": "string",
          "Description": "string",
          "DefaultQuotaSettingsJson": "string",
          "ServiceFeatures": [
            {
              "FeatureId": "00000000-0000-0000-0000-000000000000",
              "FeatureName": "string",
              "Description": "string",
              "FeatureQuotas": [
                {}
              ],
              "ServiceId": "00000000-0000-0000-0000-000000000000",
              "Service": {}
            }
          ],
          "PlanId": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "AddOnPlan": true,
      "PlanScopeType": 0
    }
  ],
  "AddOnsList": [
    {
      "PlanId": "00000000-0000-0000-0000-000000000000",
      "Name": "string",
      "Description": "string",
      "OwnerId": "00000000-0000-0000-0000-000000000000",
      "PlanServices": [
        {
          "ServiceId": "00000000-0000-0000-0000-000000000000",
          "ServiceName": "string",
          "ServiceRegion": "string",
          "Description": "string",
          "DefaultQuotaSettingsJson": "string",
          "ServiceFeatures": [
            {
              "FeatureId": "00000000-0000-0000-0000-000000000000",
              "FeatureName": "string",
              "Description": "string",
              "FeatureQuotas": [
                {}
              ],
              "ServiceId": "00000000-0000-0000-0000-000000000000",
              "Service": {}
            }
          ],
          "PlanId": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "AddOnPlan": true,
      "PlanScopeType": 0
    }
  ]
}

<?xml version="1.0"?>
<Trisul.Org.Api.Web.Areas.Admin.ViewModels.Offers.OfferOut>
  <OfferId>00000000-0000-0000-0000-000000000000</OfferId>
  <Name>string</Name>
  <Description>string</Description>
  <DisplayName>string</DisplayName>
  <AdvertisePrice>string</AdvertisePrice>
  <AdvertiseText>string</AdvertiseText>
  <Status>0</Status>
  <IsDefaultOffer>true</IsDefaultOffer>
  <PlansList>
    <PlanId>00000000-0000-0000-0000-000000000000</PlanId>
    <Name>string</Name>
    <Description>string</Description>
    <OwnerId>00000000-0000-0000-0000-000000000000</OwnerId>
    <PlanServices>
      <ServiceId>00000000-0000-0000-0000-000000000000</ServiceId>
      <ServiceName>string</ServiceName>
      <ServiceRegion>string</ServiceRegion>
      <Description>string</Description>
      <DefaultQuotaSettingsJson>string</DefaultQuotaSettingsJson>
      <ServiceFeatures>
        <FeatureId>00000000-0000-0000-0000-000000000000</FeatureId>
        <FeatureName>string</FeatureName>
        <Description>string</Description>
        <FeatureQuotas></FeatureQuotas>
        <ServiceId>00000000-0000-0000-0000-000000000000</ServiceId>
        <Service>
          <!-- Infinite loop $ref:Trisul.Org.Api.Web.Areas.Admin.ViewModels.PlanServices.PlanServiceOut -->
        </Service>
      </ServiceFeatures>
      <PlanId>00000000-0000-0000-0000-000000000000</PlanId>
    </PlanServices>
    <AddOnPlan>true</AddOnPlan>
    <PlanScopeType>0</PlanScopeType>
  </PlansList>
  <AddOnsList>
    <PlanId>00000000-0000-0000-0000-000000000000</PlanId>
    <Name>string</Name>
    <Description>string</Description>
    <OwnerId>00000000-0000-0000-0000-000000000000</OwnerId>
    <PlanServices>
      <ServiceId>00000000-0000-0000-0000-000000000000</ServiceId>
      <ServiceName>string</ServiceName>
      <ServiceRegion>string</ServiceRegion>
      <Description>string</Description>
      <DefaultQuotaSettingsJson>string</DefaultQuotaSettingsJson>
      <ServiceFeatures>
        <FeatureId>00000000-0000-0000-0000-000000000000</FeatureId>
        <FeatureName>string</FeatureName>
        <Description>string</Description>
        <FeatureQuotas></FeatureQuotas>
        <ServiceId>00000000-0000-0000-0000-000000000000</ServiceId>
        <Service>
          <!-- Infinite loop $ref:Trisul.Org.Api.Web.Areas.Admin.ViewModels.PlanServices.PlanServiceOut -->
        </Service>
      </ServiceFeatures>
      <PlanId>00000000-0000-0000-0000-000000000000</PlanId>
    </PlanServices>
    <AddOnPlan>true</AddOnPlan>
    <PlanScopeType>0</PlanScopeType>
  </AddOnsList>
</Trisul.Org.Api.Web.Areas.Admin.ViewModels.Offers.OfferOut>

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
offerId			path	string
appId			path	string

AdminHybrPlans

get /api/integrations/{appId}/admin/service/core/plans

Response Class (Status 200)

OK

{
  "draw": 0,
  "recordsFiltered": 0,
  "recordsTotal": 0,
  "data": [
    {
      "PlanId": "00000000-0000-0000-0000-000000000000",
      "Name": "string",
      "Description": "string",
      "PlanScopeType": 0,
      "ParentPlanName": "string",
      "ParentPlanId": "00000000-0000-0000-0000-000000000000",
      "OwnerId": "00000000-0000-0000-0000-000000000000",
      "PlanScopeString": "string",
      "PlanServices": [
        {
          "ServiceId": "00000000-0000-0000-0000-000000000000",
          "ServiceName": "string",
          "ServiceRegion": "string",
          "Description": "string",
          "DefaultQuotaSettingsJson": "string",
          "ServiceFeatures": [
            {
              "FeatureId": "00000000-0000-0000-0000-000000000000",
              "FeatureName": "string",
              "Description": "string",
              "ServiceId": "00000000-0000-0000-0000-000000000000",
              "Service": {}
            }
          ],
          "PlanId": "00000000-0000-0000-0000-000000000000",
          "CreatedTime": "2024-02-06T12:47:39.673Z"
        }
      ]
    }
  ]
}

<?xml version="1.0"?>
<Trisul.Org.Api.Web.Areas.Admin.Models.DataTable[Trisul.Org.Cloud.DataManagers.Models.Plans.PlanOut]>
  <draw>1</draw>
  <recordsFiltered>1</recordsFiltered>
  <recordsTotal>1</recordsTotal>
  <data>
    <PlanId>00000000-0000-0000-0000-000000000000</PlanId>
    <Name>string</Name>
    <Description>string</Description>
    <PlanScopeType>0</PlanScopeType>
    <ParentPlanName>string</ParentPlanName>
    <ParentPlanId>00000000-0000-0000-0000-000000000000</ParentPlanId>
    <OwnerId>00000000-0000-0000-0000-000000000000</OwnerId>
    <PlanScopeString>string</PlanScopeString>
    <PlanServices>
      <ServiceId>00000000-0000-0000-0000-000000000000</ServiceId>
      <ServiceName>string</ServiceName>
      <ServiceRegion>string</ServiceRegion>
      <Description>string</Description>
      <DefaultQuotaSettingsJson>string</DefaultQuotaSettingsJson>
      <ServiceFeatures>
        <FeatureId>00000000-0000-0000-0000-000000000000</FeatureId>
        <FeatureName>string</FeatureName>
        <Description>string</Description>
        <ServiceId>00000000-0000-0000-0000-000000000000</ServiceId>
        <Service>
          <!-- Infinite loop $ref:Trisul.Org.Cloud.DataManagers.Models.Plans.PlanServiceOut -->
        </Service>
      </ServiceFeatures>
      <PlanId>00000000-0000-0000-0000-000000000000</PlanId>
      <CreatedTime>1970-01-01T00:00:00.001Z</CreatedTime>
    </PlanServices>
  </data>
</Trisul.Org.Api.Web.Areas.Admin.Models.DataTable[Trisul.Org.Cloud.DataManagers.Models.Plans.PlanOut]>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
searchString	query	string
planScopeType	query	integer
ownerId	query	string
appId	path	string
paginationParameters.page	query	integer
paginationParameters.page_Size	query	integer

post /api/integrations/{appId}/admin/service/core/plans

Response Class (Status 200)

OK

{
  "PlanId": "00000000-0000-0000-0000-000000000000",
  "Name": "string",
  "Description": "string",
  "PlanScopeType": 0,
  "ParentPlanName": "string",
  "ParentPlanId": "00000000-0000-0000-0000-000000000000",
  "OwnerId": "00000000-0000-0000-0000-000000000000",
  "PlanScopeString": "string",
  "PlanServices": [
    {
      "ServiceId": "00000000-0000-0000-0000-000000000000",
      "ServiceName": "string",
      "ServiceRegion": "string",
      "Description": "string",
      "DefaultQuotaSettingsJson": "string",
      "ServiceFeatures": [
        {
          "FeatureId": "00000000-0000-0000-0000-000000000000",
          "FeatureName": "string",
          "Description": "string",
          "ServiceId": "00000000-0000-0000-0000-000000000000",
          "Service": {}
        }
      ],
      "PlanId": "00000000-0000-0000-0000-000000000000",
      "CreatedTime": "2024-02-06T12:47:39.678Z"
    }
  ]
}

<?xml version="1.0"?>
<Trisul.Org.Cloud.DataManagers.Models.Plans.PlanOut>
  <PlanId>00000000-0000-0000-0000-000000000000</PlanId>
  <Name>string</Name>
  <Description>string</Description>
  <PlanScopeType>0</PlanScopeType>
  <ParentPlanName>string</ParentPlanName>
  <ParentPlanId>00000000-0000-0000-0000-000000000000</ParentPlanId>
  <OwnerId>00000000-0000-0000-0000-000000000000</OwnerId>
  <PlanScopeString>string</PlanScopeString>
  <PlanServices>
    <ServiceId>00000000-0000-0000-0000-000000000000</ServiceId>
    <ServiceName>string</ServiceName>
    <ServiceRegion>string</ServiceRegion>
    <Description>string</Description>
    <DefaultQuotaSettingsJson>string</DefaultQuotaSettingsJson>
    <ServiceFeatures>
      <FeatureId>00000000-0000-0000-0000-000000000000</FeatureId>
      <FeatureName>string</FeatureName>
      <Description>string</Description>
      <ServiceId>00000000-0000-0000-0000-000000000000</ServiceId>
      <Service>
        <!-- Infinite loop $ref:Trisul.Org.Cloud.DataManagers.Models.Plans.PlanServiceOut -->
      </Service>
    </ServiceFeatures>
    <PlanId>00000000-0000-0000-0000-000000000000</PlanId>
    <CreatedTime>1970-01-01T00:00:00.001Z</CreatedTime>
  </PlanServices>
</Trisul.Org.Cloud.DataManagers.Models.Plans.PlanOut>

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

input

Parameter content type:

body

{
  "PlanId": "00000000-0000-0000-0000-000000000000",
  "ParentPlanId": "00000000-0000-0000-0000-000000000000",
  "Name": "string",
  "Description": "string",
  "PlanScopeType": 0,
  "PlanServices": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "OwnerId": "00000000-0000-0000-0000-000000000000"
}

<?xml version="1.0"?>
<Trisul.Org.Api.Web.Areas.Admin.ViewModels.Plans.PlanCreateViewModel>
  <PlanId>00000000-0000-0000-0000-000000000000</PlanId>
  <ParentPlanId>00000000-0000-0000-0000-000000000000</ParentPlanId>
  <Name>string</Name>
  <Description>string</Description>
  <PlanScopeType>0</PlanScopeType>
  <PlanServices>00000000-0000-0000-0000-000000000000</PlanServices>
  <OwnerId>00000000-0000-0000-0000-000000000000</OwnerId>
</Trisul.Org.Api.Web.Areas.Admin.ViewModels.Plans.PlanCreateViewModel>

planScopeType query integer

appId path string

get /api/integrations/{appId}/admin/service/core/plans/{planId}

Response Class (Status 200)

OK

{
  "PlanId": "00000000-0000-0000-0000-000000000000",
  "Name": "string",
  "Description": "string",
  "PlanScopeType": 0,
  "ParentPlanName": "string",
  "ParentPlanId": "00000000-0000-0000-0000-000000000000",
  "OwnerId": "00000000-0000-0000-0000-000000000000",
  "PlanScopeString": "string",
  "PlanServices": [
    {
      "ServiceId": "00000000-0000-0000-0000-000000000000",
      "ServiceName": "string",
      "ServiceRegion": "string",
      "Description": "string",
      "DefaultQuotaSettingsJson": "string",
      "ServiceFeatures": [
        {
          "FeatureId": "00000000-0000-0000-0000-000000000000",
          "FeatureName": "string",
          "Description": "string",
          "ServiceId": "00000000-0000-0000-0000-000000000000",
          "Service": {}
        }
      ],
      "PlanId": "00000000-0000-0000-0000-000000000000",
      "CreatedTime": "2024-02-06T12:47:39.683Z"
    }
  ]
}

<?xml version="1.0"?>
<Trisul.Org.Cloud.DataManagers.Models.Plans.PlanOut>
  <PlanId>00000000-0000-0000-0000-000000000000</PlanId>
  <Name>string</Name>
  <Description>string</Description>
  <PlanScopeType>0</PlanScopeType>
  <ParentPlanName>string</ParentPlanName>
  <ParentPlanId>00000000-0000-0000-0000-000000000000</ParentPlanId>
  <OwnerId>00000000-0000-0000-0000-000000000000</OwnerId>
  <PlanScopeString>string</PlanScopeString>
  <PlanServices>
    <ServiceId>00000000-0000-0000-0000-000000000000</ServiceId>
    <ServiceName>string</ServiceName>
    <ServiceRegion>string</ServiceRegion>
    <Description>string</Description>
    <DefaultQuotaSettingsJson>string</DefaultQuotaSettingsJson>
    <ServiceFeatures>
      <FeatureId>00000000-0000-0000-0000-000000000000</FeatureId>
      <FeatureName>string</FeatureName>
      <Description>string</Description>
      <ServiceId>00000000-0000-0000-0000-000000000000</ServiceId>
      <Service>
        <!-- Infinite loop $ref:Trisul.Org.Cloud.DataManagers.Models.Plans.PlanServiceOut -->
      </Service>
    </ServiceFeatures>
    <PlanId>00000000-0000-0000-0000-000000000000</PlanId>
    <CreatedTime>1970-01-01T00:00:00.001Z</CreatedTime>
  </PlanServices>
</Trisul.Org.Cloud.DataManagers.Models.Plans.PlanOut>

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
planId			path	string
appId			path	string

AdminHybrSubscriptions

get /api/integrations/{appId}/admin/service/core/subscriptions

Get all subscriptions.

Response Class (Status 200)

OK

{
  "draw": 0,
  "recordsFiltered": 0,
  "recordsTotal": 0,
  "data": [
    {
      "Created": "2024-02-06T12:47:39.686Z",
      "CreatedByUserId": "string",
      "CompanyId": "00000000-0000-0000-0000-000000000000",
      "CompanyName": "string",
      "Id": "00000000-0000-0000-0000-000000000000",
      "IsAdminSubscription": true,
      "OfferId": "00000000-0000-0000-0000-000000000000",
      "OfferName": "string",
      "PlanName": "string",
      "PlanId": "00000000-0000-0000-0000-000000000000",
      "OrgId": "00000000-0000-0000-0000-000000000000",
      "Status": 0,
      "StatusString": "string",
      "SubscriptionName": "string",
      "SubscriptionUniqueName": "string",
      "SubscriptionType": 0,
      "SubscriptionTypeString": "string",
      "TrialEndDate": "2024-02-06T12:47:39.686Z",
      "Updated": "2024-02-06T12:47:39.686Z",
      "ParentCompanyName": "string",
      "BasePlanName": "string",
      "BasePlanId": "00000000-0000-0000-0000-000000000000",
      "ParentCompanyId": "00000000-0000-0000-0000-000000000000"
    }
  ]
}

<?xml version="1.0"?>
<Trisul.Org.Api.Web.Areas.Admin.Models.DataTable[Trisul.Org.Business.Models.Responses.TenantSubscriptionResponse]>
  <draw>1</draw>
  <recordsFiltered>1</recordsFiltered>
  <recordsTotal>1</recordsTotal>
  <data>
    <Created>1970-01-01T00:00:00.001Z</Created>
    <CreatedByUserId>string</CreatedByUserId>
    <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
    <CompanyName>string</CompanyName>
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <IsAdminSubscription>true</IsAdminSubscription>
    <OfferId>00000000-0000-0000-0000-000000000000</OfferId>
    <OfferName>string</OfferName>
    <PlanName>string</PlanName>
    <PlanId>00000000-0000-0000-0000-000000000000</PlanId>
    <OrgId>00000000-0000-0000-0000-000000000000</OrgId>
    <Status>0</Status>
    <StatusString>string</StatusString>
    <SubscriptionName>string</SubscriptionName>
    <SubscriptionUniqueName>string</SubscriptionUniqueName>
    <SubscriptionType>0</SubscriptionType>
    <SubscriptionTypeString>string</SubscriptionTypeString>
    <TrialEndDate>1970-01-01T00:00:00.001Z</TrialEndDate>
    <Updated>1970-01-01T00:00:00.001Z</Updated>
    <ParentCompanyName>string</ParentCompanyName>
    <BasePlanName>string</BasePlanName>
    <BasePlanId>00000000-0000-0000-0000-000000000000</BasePlanId>
    <ParentCompanyId>00000000-0000-0000-0000-000000000000</ParentCompanyId>
  </data>
</Trisul.Org.Api.Web.Areas.Admin.Models.DataTable[Trisul.Org.Business.Models.Responses.TenantSubscriptionResponse]>

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
appId	path	string
paginationParameters.page	query	integer
paginationParameters.page_Size	query	integer

get /api/integrations/{appId}/admin/service/core/subscriptions/{subscriptionId}

Get subscription details.

Response Class (Status 200)

OK

{
  "Created": "2024-02-06T12:47:39.690Z",
  "CreatedByUserId": "string",
  "CompanyId": "00000000-0000-0000-0000-000000000000",
  "CompanyName": "string",
  "Id": "00000000-0000-0000-0000-000000000000",
  "IsAdminSubscription": true,
  "OfferId": "00000000-0000-0000-0000-000000000000",
  "OfferName": "string",
  "PlanName": "string",
  "PlanId": "00000000-0000-0000-0000-000000000000",
  "OrgId": "00000000-0000-0000-0000-000000000000",
  "Status": 0,
  "StatusString": "string",
  "SubscriptionName": "string",
  "SubscriptionUniqueName": "string",
  "SubscriptionType": 0,
  "SubscriptionTypeString": "string",
  "TrialEndDate": "2024-02-06T12:47:39.690Z",
  "Updated": "2024-02-06T12:47:39.690Z",
  "ParentCompanyName": "string",
  "BasePlanName": "string",
  "BasePlanId": "00000000-0000-0000-0000-000000000000",
  "ParentCompanyId": "00000000-0000-0000-0000-000000000000"
}

<?xml version="1.0"?>
<Trisul.Org.Business.Models.Responses.TenantSubscriptionResponse>
  <Created>1970-01-01T00:00:00.001Z</Created>
  <CreatedByUserId>string</CreatedByUserId>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <CompanyName>string</CompanyName>
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <IsAdminSubscription>true</IsAdminSubscription>
  <OfferId>00000000-0000-0000-0000-000000000000</OfferId>
  <OfferName>string</OfferName>
  <PlanName>string</PlanName>
  <PlanId>00000000-0000-0000-0000-000000000000</PlanId>
  <OrgId>00000000-0000-0000-0000-000000000000</OrgId>
  <Status>0</Status>
  <StatusString>string</StatusString>
  <SubscriptionName>string</SubscriptionName>
  <SubscriptionUniqueName>string</SubscriptionUniqueName>
  <SubscriptionType>0</SubscriptionType>
  <SubscriptionTypeString>string</SubscriptionTypeString>
  <TrialEndDate>1970-01-01T00:00:00.001Z</TrialEndDate>
  <Updated>1970-01-01T00:00:00.001Z</Updated>
  <ParentCompanyName>string</ParentCompanyName>
  <BasePlanName>string</BasePlanName>
  <BasePlanId>00000000-0000-0000-0000-000000000000</BasePlanId>
  <ParentCompanyId>00000000-0000-0000-0000-000000000000</ParentCompanyId>
</Trisul.Org.Business.Models.Responses.TenantSubscriptionResponse>

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
subscriptionId			path	string
appId			path	string

get /api/integrations/{appId}/admin/service/core/subscriptions/{subscriptionId}/subscriptionRelationships

Get all related subscriptions for a subscription. The given subscription is the parent subscription belonging to a reseller company and associated with a reseller plan.

Response Class (Status 200)

OK

[
  {
    "SubscriptionId": "00000000-0000-0000-0000-000000000000",
    "ParentSubscriptionId": "00000000-0000-0000-0000-000000000000",
    "TenureStart": "2024-02-06T12:47:39.693Z",
    "TenureEnd": "2024-02-06T12:47:39.693Z"
  }
]

<?xml version="1.0"?>
<Inline Model>
  <SubscriptionId>00000000-0000-0000-0000-000000000000</SubscriptionId>
  <ParentSubscriptionId>00000000-0000-0000-0000-000000000000</ParentSubscriptionId>
  <TenureStart>1970-01-01T00:00:00.001Z</TenureStart>
  <TenureEnd>1970-01-01T00:00:00.001Z</TenureEnd>
</Inline Model>

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
subscriptionId			path	string
appId			path	string

get /api/integrations/{appId}/admin/service/core/subscriptions/subscriptionRelationships

Get all subscription relationships

Response Class (Status 200)

OK

[
  {
    "SubscriptionId": "00000000-0000-0000-0000-000000000000",
    "ParentSubscriptionId": "00000000-0000-0000-0000-000000000000",
    "TenureStart": "2024-02-06T12:47:39.696Z",
    "TenureEnd": "2024-02-06T12:47:39.696Z"
  }
]

<?xml version="1.0"?>
<Inline Model>
  <SubscriptionId>00000000-0000-0000-0000-000000000000</SubscriptionId>
  <ParentSubscriptionId>00000000-0000-0000-0000-000000000000</ParentSubscriptionId>
  <TenureStart>1970-01-01T00:00:00.001Z</TenureStart>
  <TenureEnd>1970-01-01T00:00:00.001Z</TenureEnd>
</Inline Model>

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
appId			path	string

AdminWebhooks

post /api/integrations/{appId}/admin/webhooks/events/sample

Returns sample data for the given event For example zapier needs sample data to build the zap and test it

Response Class (Status 200)

OK

{}

<?xml version="1.0"?>
<!-- invalid XML -->

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

appId path string

request

Parameter content type:

body

{
  "scopeType": "string",
  "scopeId": "string",
  "eventFilters": [
    "string"
  ]
}

<?xml version="1.0"?>
<Trisul.Org.Cloud.Contracts.CoconutCore.WebHooks.WebHookSampleDataRequest>
  <scopeType>string</scopeType>
  <scopeId>string</scopeId>
  <eventFilters>string</eventFilters>
</Trisul.Org.Cloud.Contracts.CoconutCore.WebHooks.WebHookSampleDataRequest>

get /api/integrations/{appId}/admin/webhooks/events

Get all supported events for the company to which the integration app belongs to and events will be returned based on if the app is for admin or tenant company.

Response Class (Status 200)

OK

[
  {
    "id": "string",
    "eventName": "string",
    "description": "string",
    "application": "string",
    "category": "string",
    "subCategory": "string",
    "isEnabled": true
  }
]

<?xml version="1.0"?>
<Inline Model>
  <id>string</id>
  <eventName>string</eventName>
  <description>string</description>
  <application>string</application>
  <category>string</category>
  <subCategory>string</subCategory>
  <isEnabled>true</isEnabled>
</Inline Model>

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
appId			path	string

get /api/integrations/{appId}/admin/webhooks/registrations

Get list of webhook registrations for the company to which the integration app belongs to.

Response Class (Status 200)

OK

[
  {
    "id": "string",
    "application": "string",
    "category": "string",
    "subCategory": "string",
    "scopeType": "string",
    "scopeId": "string",
    "webHookUri": "string",
    "externalReferenceId": "string",
    "displayName": "string",
    "description": "string",
    "eventFilters": [
      "string"
    ],
    "headers": {},
    "properties": {},
    "isPaused": true
  }
]

<?xml version="1.0"?>
<Inline Model>
  <id>string</id>
  <application>string</application>
  <category>string</category>
  <subCategory>string</subCategory>
  <scopeType>string</scopeType>
  <scopeId>string</scopeId>
  <webHookUri>string</webHookUri>
  <externalReferenceId>string</externalReferenceId>
  <displayName>string</displayName>
  <description>string</description>
  <eventFilters>string</eventFilters>
  <headers>
    <!-- additional elements allowed -->
  </headers>
  <properties>
    <!-- additional elements allowed -->
  </properties>
  <isPaused>true</isPaused>
</Inline Model>

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
appId			path	string

post /api/integrations/{appId}/admin/webhooks/registrations

Register a new webhook for the given event. Subscribe to the event.

Response Class (Status 200)

OK

{
  "id": "string",
  "application": "string",
  "category": "string",
  "subCategory": "string",
  "scopeType": "string",
  "scopeId": "string",
  "webHookUri": "string",
  "externalReferenceId": "string",
  "displayName": "string",
  "description": "string",
  "eventFilters": [
    "string"
  ],
  "headers": {},
  "properties": {},
  "isPaused": true
}

<?xml version="1.0"?>
<Trisul.Org.Cloud.Contracts.CoconutCore.WebHooks.CoconutCoreWebHookRegistrationOut>
  <id>string</id>
  <application>string</application>
  <category>string</category>
  <subCategory>string</subCategory>
  <scopeType>string</scopeType>
  <scopeId>string</scopeId>
  <webHookUri>string</webHookUri>
  <externalReferenceId>string</externalReferenceId>
  <displayName>string</displayName>
  <description>string</description>
  <eventFilters>string</eventFilters>
  <headers>
    <!-- additional elements allowed -->
  </headers>
  <properties>
    <!-- additional elements allowed -->
  </properties>
  <isPaused>true</isPaused>
</Trisul.Org.Cloud.Contracts.CoconutCore.WebHooks.CoconutCoreWebHookRegistrationOut>

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

appId path string

registrationRequest

Parameter content type:

body

{
  "webHookUri": "string",
  "externalReferenceId": "string",
  "displayName": "string",
  "description": "string",
  "subCategory": "string",
  "eventFilters": [
    "string"
  ],
  "headers": {},
  "properties": {},
  "isPaused": true,
  "secret": "string"
}

<?xml version="1.0"?>
<Trisul.Org.Cloud.Contracts.CoconutCore.WebHooks.WebHookRegistrationRequest>
  <webHookUri>string</webHookUri>
  <externalReferenceId>string</externalReferenceId>
  <displayName>string</displayName>
  <description>string</description>
  <subCategory>string</subCategory>
  <eventFilters>string</eventFilters>
  <headers>
    <!-- additional elements allowed -->
  </headers>
  <properties>
    <!-- additional elements allowed -->
  </properties>
  <isPaused>true</isPaused>
  <secret>string</secret>
</Trisul.Org.Cloud.Contracts.CoconutCore.WebHooks.WebHookRegistrationRequest>

delete /api/integrations/{appId}/admin/webhooks/registrations/{id}

Unregister a webhook. Unsubscribe from the event.

Response Class (Status 200)

OK

{
  "IsSuccess": true,
  "Message": "string"
}

<?xml version="1.0"?>
<Trisul.Org.Api.Web.Api.Controllers.Integrations.IntegrationActionResponse>
  <IsSuccess>true</IsSuccess>
  <Message>string</Message>
</Trisul.Org.Api.Web.Api.Controllers.Integrations.IntegrationActionResponse>

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
id			path	string
appId			path	string

Echo

get /api/integrations/{appId}/echo

Response Class (Status 200)

OK

{}

<?xml version="1.0"?>
<!-- invalid XML -->

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
data			query	string
appId			path	string

Response Class (Status 200)

Parameters

Curl

Request URL

Response Body

Response Code

Response Headers

Response Class (Status 200)

Parameters

Curl

Request URL

Response Body

Response Code

Response Headers

Response Class (Status 200)

Parameters

Curl

Request URL

Response Body

Response Code

Response Headers

Response Class (Status 200)

Parameters

Curl

Request URL

Response Body

Response Code

Response Headers

Response Class (Status 200)

Parameters

Curl

Request URL

Response Body

Response Code

Response Headers

Response Class (Status 200)

Parameters

Curl

Request URL

Response Body

Response Code

Response Headers

Response Class (Status 200)

Parameters

Curl

Request URL

Response Body

Response Code

Response Headers

Response Class (Status 200)

Parameters

Curl

Request URL

Response Body

Response Code

Response Headers

Response Class (Status 200)

Parameters

Curl

Request URL

Response Body

Response Code

Response Headers

Response Class (Status 200)

Parameters

Curl

Request URL

Response Body

Response Code

Response Headers

Response Class (Status 200)

Parameters

Curl

Request URL

Response Body

Response Code

Response Headers

Response Class (Status 200)

Parameters

Curl