Lithium Account Management Service (AMS) Client Library

Allows managing accounts.

REST Service Client

Class Description
AccountManagementClient The entry point of the Account Management Service client library.

Client Controllers

Class Description
Accounts Provides operations on accounts.
Items Provides operations on items.
Settings Provides operations on settings.
Solutions Provides operations on solutions.
StaticData Provides operations on static data.
Validations Provides operations on validations.

Models

Class Description
AccountData Describes an account.
AdditionalItemData Describes an additional item.
BusinessPartnerData Describes a business partner.
BusinessPartnersData Describes a business partners.
CountriesConfiguration Describes a countries configuration.
CountryData Describes a country.
DistrictData Describes a district.
DistrictsData Describes a districts.
MessageComponentConfiguration Describes a message component configuration.
ProductSettings Describes a product settings.
SettingsData Describes a settings.
SolutionData Describes a solution.
UpdateSubscriptionAccountRequest Describes an update subscription account request.
ValidateVoucherRequest Describes a validate voucher request.
ValidationResponse Describes a validation response.
VatNumberLookupInfo Describes a vat number lookup.
VatRateData Describes a vat rate.

Enumerations

The client library has no enumerations.

Authorization Policies

Policy Description Scope
DefaultScope Defines an authorization policy that requires the default scope. lithium-accountmanagement

Reference

REST Service Client Classes

AccountManagementClient

Constructors
AccountManagementClient(Uri, BearerTokenCredential)
Parameter Type Description
serviceUri Uri The service URI.
credential BearerTokenCredential The credential that should be used to access the service.
AccountManagementClient(Uri, BearerTokenCredential, AccountManagementClientOptions)
Parameter Type Description
serviceUri Uri The service URI.
credential BearerTokenCredential The credential that should be used to access the service.
clientOptions AccountManagementClientOptions The client options.
Example
Uri address = new Uri("[service-address]");
string clientId = "[client-id]"
string clientSecret = "[client-secret]"

AccountManagementClient client = new AccountManagementClient(
    new Uri(address),
    new ChallengeCredential(
        async (args, cancellationToken) =>
        {
            ClientSecretCredential innerCredential = new ClientSecretCredential(
                args.AuthorizationUri,
                clientId,
                clientSecret);

            return await innerCredential.GetTokenAsync(cancellationToken).ConfigureAwait(false);
        }));

^ Back to top

Client Controllers Classes

AccountsClientController

Provides operations on accounts.

Methods
GetAccountInfoAsync()

Retrieves an account information.

public async Task<RestServiceResult<Primavera.Lithium.AccountManagement.Client.Rest.Models.AccountData>> GetAccountInfoAsync(string accountKey, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.AccountManagement.Client.Rest.Models.AccountData> GetAccountInfo(string accountKey);
Parameters
Parameter Type Description Rules
accountKey string The account key. Required.
Returns
Return Type Description
Primavera.Lithium.AccountManagement.Client.Rest.Models.AccountData The account information.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

UpdateSubscriptionAccountAsync()

Updates a subscription account.

public async Task<RestServiceResult> UpdateSubscriptionAccountAsync(Primavera.Lithium.AccountManagement.Client.Rest.Models.UpdateSubscriptionAccountRequest request, System.Guid userId, System.Guid accountId, System.Guid subscriptionId, CancellationToken cancellationToken = default);

public RestServiceResult UpdateSubscriptionAccount(Primavera.Lithium.AccountManagement.Client.Rest.Models.UpdateSubscriptionAccountRequest request, System.Guid userId, System.Guid accountId, System.Guid subscriptionId);
Parameters
Parameter Type Description Rules
request Primavera.Lithium.AccountManagement.Client.Rest.Models.UpdateSubscriptionAccountRequest The request. Required.
userId System.Guid The user identifier. Required. Not empty.
accountId System.Guid The account identifier. Required. Not empty.
subscriptionId System.Guid The subscription identifier. Required. Not empty.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ValidateCompanyInfoAsync()

Validates if the company info does not violates any business rule.

public async Task<RestServiceResult> ValidateCompanyInfoAsync(Primavera.Lithium.AccountManagement.Client.Rest.Models.UpdateSubscriptionAccountRequest request, System.Guid userId, System.Guid accountId, System.Guid subscriptionId, CancellationToken cancellationToken = default);

public RestServiceResult ValidateCompanyInfo(Primavera.Lithium.AccountManagement.Client.Rest.Models.UpdateSubscriptionAccountRequest request, System.Guid userId, System.Guid accountId, System.Guid subscriptionId);
Parameters
Parameter Type Description Rules
request Primavera.Lithium.AccountManagement.Client.Rest.Models.UpdateSubscriptionAccountRequest The request. Required.
userId System.Guid The user identifier. Required. Not empty.
accountId System.Guid The account identifier. Required. Not empty.
subscriptionId System.Guid The subscription identifier. Required. Not empty.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ItemsClientController

Provides operations on items.

Methods
GetItemAsync()

Gets additional item by key.

public async Task<RestServiceResult<Primavera.Lithium.AccountManagement.Client.Rest.Models.AdditionalItemData>> GetItemAsync(string itemKey, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.AccountManagement.Client.Rest.Models.AdditionalItemData> GetItem(string itemKey);
Parameters
Parameter Type Description Rules
itemKey string The item key. Required.
Returns
Return Type Description
Primavera.Lithium.AccountManagement.Client.Rest.Models.AdditionalItemData The additional item.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SettingsClientController

Provides operations on settings.

Methods
GetSettingsAsync()

Retrieves settings.

public async Task<RestServiceResult<Primavera.Lithium.AccountManagement.Client.Rest.Models.SettingsData>> GetSettingsAsync(string product, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.AccountManagement.Client.Rest.Models.SettingsData> GetSettings(string product);
Parameters
Parameter Type Description Rules
product string The product. Required.
Returns
Return Type Description
Primavera.Lithium.AccountManagement.Client.Rest.Models.SettingsData The service settings.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SaveSettingsAsync()

Save settings for a product.

public async Task<RestServiceResult<string>> SaveSettingsAsync(string product, Primavera.Lithium.AccountManagement.Client.Rest.Models.ProductSettings productSettings, CancellationToken cancellationToken = default);

public RestServiceResult<string> SaveSettings(string product, Primavera.Lithium.AccountManagement.Client.Rest.Models.ProductSettings productSettings);
Parameters
Parameter Type Description Rules
product string The product. Required.
productSettings Primavera.Lithium.AccountManagement.Client.Rest.Models.ProductSettings The product settings. Required.
Returns
Return Type Description
string The product name of the created settings.
Status Codes
Status Code Description
HttpStatusCode.Created Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

SolutionsClientController

Provides operations on solutions.

Methods
GetProductSolutionsAsync()

Retrieves the solutions available for the specified product.

public async Task<RestServiceResult<Primavera.Lithium.AccountManagement.Client.Rest.Models.SolutionData>> GetProductSolutionsAsync(string productKey, string? countryKey, string? segment, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.AccountManagement.Client.Rest.Models.SolutionData> GetProductSolutions(string productKey, string? countryKey, string? segment);
Parameters
Parameter Type Description Rules
productKey string The product key. Required.
countryKey string? The country key. Required.
segment string? The segment. Required.
Returns
Return Type Description
Primavera.Lithium.AccountManagement.Client.Rest.Models.SolutionData The product available solutions.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetSolutionAsync()

Retrieves a solution.

public async Task<RestServiceResult<Primavera.Lithium.AccountManagement.Client.Rest.Models.SolutionData>> GetSolutionAsync(string solutionKey, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.AccountManagement.Client.Rest.Models.SolutionData> GetSolution(string solutionKey);
Parameters
Parameter Type Description Rules
solutionKey string The solution key. Required.
Returns
Return Type Description
Primavera.Lithium.AccountManagement.Client.Rest.Models.SolutionData The solution information.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetTermsAndConditionsAsync()

Retrieves the terms and conditions for the specified solution.

public async Task<RestServiceResult<System.Collections.Generic.IEnumerable<string>>> GetTermsAndConditionsAsync(string solutionKey, CancellationToken cancellationToken = default);

public RestServiceResult<System.Collections.Generic.IEnumerable<string>> GetTermsAndConditions(string solutionKey);
Parameters
Parameter Type Description Rules
solutionKey string The solution key. Required.
Returns
Return Type Description
System.Collections.Generic.IEnumerable<string> The solution terms and conditions.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ValidateVoucherAsync()

Validates a voucher.

public async Task<RestServiceResult> ValidateVoucherAsync(Primavera.Lithium.AccountManagement.Client.Rest.Models.ValidateVoucherRequest request, CancellationToken cancellationToken = default);

public RestServiceResult ValidateVoucher(Primavera.Lithium.AccountManagement.Client.Rest.Models.ValidateVoucherRequest request);
Parameters
Parameter Type Description Rules
request Primavera.Lithium.AccountManagement.Client.Rest.Models.ValidateVoucherRequest The request. Required.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

StaticDataClientController

Provides operations on static data.

Methods
GetBusinessPartnersAsync()

Retrieves a list of business partners.

public async Task<RestServiceResult<System.Collections.Generic.IEnumerable<Primavera.Lithium.AccountManagement.Client.Rest.Models.BusinessPartnerData>>> GetBusinessPartnersAsync(string? country, string? district, int pageIndex, int pageSize, CancellationToken cancellationToken = default);

public RestServiceResult<System.Collections.Generic.IEnumerable<Primavera.Lithium.AccountManagement.Client.Rest.Models.BusinessPartnerData>> GetBusinessPartners(string? country, string? district, int pageIndex, int pageSize);
Parameters
Parameter Type Description Rules
country string? The country. Required.
district string? The district. Required.
pageIndex int The page index. Required.
pageSize int The page size. Required.
Returns
Return Type Description
System.Collections.Generic.IEnumerable<Primavera.Lithium.AccountManagement.Client.Rest.Models.BusinessPartnerData> The business partners information.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetCountriesAsync()

Retrieves a list of countries.

public async Task<RestServiceResult<Primavera.Lithium.AccountManagement.Client.Rest.Models.CountryData>> GetCountriesAsync(string culture, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.AccountManagement.Client.Rest.Models.CountryData> GetCountries(string culture);
Parameters
Parameter Type Description Rules
culture string The culture. Required.
Returns
Return Type Description
Primavera.Lithium.AccountManagement.Client.Rest.Models.CountryData The countries information.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetCurrencyAsync()

Retrieves the currency for a country.

public async Task<RestServiceResult<string>> GetCurrencyAsync(string country, CancellationToken cancellationToken = default);

public RestServiceResult<string> GetCurrency(string country);
Parameters
Parameter Type Description Rules
country string The country. Required.
Returns
Return Type Description
string The currency information.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetDistrictsAsync()

Retrieves a list of districts.

public async Task<RestServiceResult<System.Collections.Generic.IEnumerable<Primavera.Lithium.AccountManagement.Client.Rest.Models.DistrictData>>> GetDistrictsAsync(string country, CancellationToken cancellationToken = default);

public RestServiceResult<System.Collections.Generic.IEnumerable<Primavera.Lithium.AccountManagement.Client.Rest.Models.DistrictData>> GetDistricts(string country);
Parameters
Parameter Type Description Rules
country string The country. Required.
Returns
Return Type Description
System.Collections.Generic.IEnumerable<Primavera.Lithium.AccountManagement.Client.Rest.Models.DistrictData> The discricts information.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

GetVatRatesAsync()

Retrieves a list of VAT rates.

public async Task<RestServiceResult<System.Collections.Generic.IEnumerable<Primavera.Lithium.AccountManagement.Client.Rest.Models.VatRateData>>> GetVatRatesAsync(string countryKey, string paymentCountry, CancellationToken cancellationToken = default);

public RestServiceResult<System.Collections.Generic.IEnumerable<Primavera.Lithium.AccountManagement.Client.Rest.Models.VatRateData>> GetVatRates(string countryKey, string paymentCountry);
Parameters
Parameter Type Description Rules
countryKey string The country key. Required.
paymentCountry string The payment country. Required.
Returns
Return Type Description
System.Collections.Generic.IEnumerable<Primavera.Lithium.AccountManagement.Client.Rest.Models.VatRateData> The VAT rates information.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ValidationsClientController

Provides operations on validations.

Methods
ValidatePostalCodeAsync()

Validates a postal code.

public async Task<RestServiceResult<Primavera.Lithium.AccountManagement.Client.Rest.Models.ValidationResponse>> ValidatePostalCodeAsync(string countryKey, string postalCode, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.AccountManagement.Client.Rest.Models.ValidationResponse> ValidatePostalCode(string countryKey, string postalCode);
Parameters
Parameter Type Description Rules
countryKey string The country key. Required.
postalCode string The postal code. Required.
Returns
Return Type Description
Primavera.Lithium.AccountManagement.Client.Rest.Models.ValidationResponse Whether the postal code is valid.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

ValidateVatNumberAsync()

Validates a tax number.

public async Task<RestServiceResult<Primavera.Lithium.AccountManagement.Client.Rest.Models.ValidationResponse>> ValidateVatNumberAsync(string countryKey, string vatNumber, bool includeContextInfo = false, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.AccountManagement.Client.Rest.Models.ValidationResponse> ValidateVatNumber(string countryKey, string vatNumber, bool includeContextInfo = false);
Parameters
Parameter Type Description Rules
countryKey string The country key. Required. MinLen(2). MaxLen(2).
vatNumber string The vat number. Required.
includeContextInfo bool The include context info. Required.
Returns
Return Type Description
Primavera.Lithium.AccountManagement.Client.Rest.Models.ValidationResponse Whether the tax number is valid.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.
HttpStatusCode.NotFound Failure: not found.
HttpStatusCode.Conflict Failure: conflict.

The operation will raise RestRequestException for any failure status code. The exception may include a body with an instance of RestProblemDetails depending on the status code.

^ Back to top

Models Classes

AccountData

Describes an account.

Properties

The model has no properties.

^ Back to top

AddItem

Describes an add item.

Properties
Property Type Description Rules
ItemKey string Gets or sets the item key. Required.
Quantity int Gets or sets the quantity. Required.
VoucherCode string? Gets or sets the voucher code.

^ Back to top

AdditionalItemData

Describes an additional item.

Properties

The model has no properties.

^ Back to top

AMSPaymentData

Describes an AMS payment.

Properties

The model has no properties.

^ Back to top

AMSUnitPriceData

Describes an AMS unit price.

Properties

The model has no properties.

^ Back to top

AvailableSolutionData

Describes an available solution.

Properties

The model has no properties.

^ Back to top

AvailableSolutionPeriod

Describes an available solution period.

Properties

The model has no properties.

^ Back to top

BusinessPartnerContactData

Describes a business partner contact.

Properties

The model has no properties.

^ Back to top

BusinessPartnerData

Describes a business partner.

Properties

The model has no properties.

^ Back to top

BusinessPartnersData

Describes a business partners.

Properties
Property Type Description Rules
IsBlocked bool Gets or sets the is blocked value. Required.
IsVisible bool Gets or sets the is visible value. Required.
Partners System.Collections.Generic.IList<Primavera.Lithium.AccountManagement.Client.Rest.Models.BusinessPartnerData> Gets or sets the partners. Required.

^ Back to top

BusinessPartnerTypeData

Describes a business partner type.

Properties

The model has no properties.

^ Back to top

ChangeSubscriptionSolutionRequest

Describes a change subscription solution request.

Properties

The model has no properties.

^ Back to top

CountriesConfiguration

Describes a countries configuration.

Properties
Property Type Description Rules
CountryKey string Gets or sets the country key. Required.
TermsAndConditions System.Collections.Generic.IDictionary<string, string> Gets or sets the terms and conditions. Required. Not empty.

^ Back to top

CountryData

Describes a country.

Properties

The model has no properties.

^ Back to top

CreateSubscriptionRequest

Describes a create subscription request.

Properties

The model has no properties.

^ Back to top

CultureData

Describes a culture.

Properties

The model has no properties.

^ Back to top

DistrictData

Describes a district.

Properties
Property Type Description Rules
Name string? Gets or sets the name.
Country string? Gets or sets the country.
IsDefault bool Gets or sets the is default value. Required.

^ Back to top

DistrictsData

Describes a districts.

Properties
Property Type Description Rules
IsBlocked bool Gets or sets the is blocked value. Required.
IsVisible bool Gets or sets the is visible value. Required.
Districts System.Collections.Generic.IList<Primavera.Lithium.AccountManagement.Client.Rest.Models.DistrictData> Gets or sets the districts. Required.

^ Back to top

GetItemPriceRequest

Describes a get item price request.

Properties
Property Type Description Rules
ItemKey string Gets or sets the item key. Required.
VoucherCode string? Gets or sets the voucher code.
Quantity int Gets or sets the quantity. Required.

^ Back to top

GetItemsPriceRequest

Describes a get items price request.

Properties
Property Type Description Rules
Items System.Collections.Generic.IList<Primavera.Lithium.AccountManagement.Client.Rest.Models.GetItemPriceRequest>? Gets or sets the items.
Voucher string? Gets or sets the voucher.

^ Back to top

GetSubscriptionByKeyResponse

Describes a get subscription by key response.

Properties

The model has no properties.

^ Back to top

GetSubscriptionItemsRequest

Describes a get subscription items request.

Properties

The model has no properties.

^ Back to top

GetSubscriptionItemsResponse

Describes a get subscription items response.

Properties

The model has no properties.

^ Back to top

GetSubscriptionPendingPaymentsRequest

Describes a get subscription pending payments request.

Properties

The model has no properties.

^ Back to top

GetSubscriptionRequest

Describes a get subscription request.

Properties

The model has no properties.

^ Back to top

IncludedItemData

Describes an included item.

Properties

The model has no properties.

^ Back to top

ItemPrice

Describes an item price.

Properties
Property Type Description Rules
ItemKey string Gets or sets the item key. Required.
Price double Gets or sets the price. Required.

^ Back to top

ItemsPriceResponse

Describes an items price response.

Properties
Property Type Description Rules
Total double Gets or sets the total. Required.
Items System.Collections.Generic.IList<Primavera.Lithium.AccountManagement.Client.Rest.Models.ItemPrice> Gets or sets the items. Required.

^ Back to top

MessageComponentConfiguration

Describes a message component configuration.

Properties
Property Type Description Rules
Locale string Gets or sets the locale. Required.
Title string Gets or sets the title. Required.
Description string Gets or sets the description. Required.
IconUrl string Gets or sets the icon URL. Required.
IconMessage string Gets or sets the icon message. Required.
LinkUrl string Gets or sets the link URL. Required.
LinkText string Gets or sets the link text. Required.

^ Back to top

NewSubscriptionFromTicketRequest

Describes a new subscription from ticket request.

Properties

The model has no properties.

^ Back to top

OperationData

Describes an operation.

Properties

The model has no properties.

^ Back to top

PreviewSubscriptionRenewalResponse

Describes a preview subscription renewal response.

Properties

The model has no properties.

^ Back to top

PreviewSubscriptionSolutionChangePeriod

Describes a preview subscription solution change period.

Properties

The model has no properties.

^ Back to top

PreviewSubscriptionSolutionChangeRequest

Describes a preview subscription solution change request.

Properties

The model has no properties.

^ Back to top

PreviewSubscriptionSolutionChangeResponse

Describes a preview subscription solution change response.

Properties
Property Type Description Rules
Title string Gets or sets the title. Required.
CurrencySymbol string Gets or sets the currency symbol. Required.
Periods System.Collections.Generic.IList<Primavera.Lithium.AccountManagement.Client.Rest.Models.PreviewSubscriptionSolutionChangePeriod> Gets or sets the periods. Required.

^ Back to top

ProductSettings

Describes a product settings.

Properties
Property Type Description Rules
UseApps bool A value indicating whether the product uses APPS. Required.
ProductName string Gets or sets the product name. Required. RegEx (^(\d|[a-z]|[A-Z]|\.|-|_)*$).
ProductCaption string Gets or sets the product caption. Required.
ProductBaseUri System.Uri Gets or sets the product base URI. Required. Absolute URI.
RedirectUri string Gets or sets the redirect URI. Required.
ModuleValidationBaseUri string Gets or sets the module validation base URI. Required.
ValidateSubscriptionItemAdditionUri string Gets or sets the validate subscription item addition URI. Required.
ValidateSubscriptionItemRemovalUri string Gets or sets the validate subscription item removal URI. Required.
Logo System.Uri Gets or sets the logo. Required. Absolute URI.
Background System.Uri Gets or sets the background. Required. Absolute URI.
NoSubscriptionRedirectUri System.Uri Gets or sets the no subscription redirect URI. Required. Absolute URI.
PartnerInfoIsVisible bool A value indicating whether the partner information should be visible. Required.
AllowSolutionUpgrade bool A value indicating whether the product allows solution upgrade. Required.
AllowSolutionDowngrade bool A value indicating whether the product allows solution downgrade. Required.
AllowItemsPurchases bool A value indicating whether the product allows items purchase. Required.
AllowItemsRemoval bool A value indicating whether the product allows items removal. Required.
AllowProductValidation bool A value indicating whether the product should handle validation. Required.
CountriesConfiguration System.Collections.Generic.IList<Primavera.Lithium.AccountManagement.Client.Rest.Models.CountriesConfiguration> Gets or sets the countries configuration. Required.
MessageComponentConfiguration System.Collections.Generic.IList<Primavera.Lithium.AccountManagement.Client.Rest.Models.MessageComponentConfiguration> Gets or sets the message component configuration. Required.

^ Back to top

RemoveItemsRequest

Describes a remove items request.

Properties

The model has no properties.

^ Back to top

RenewSubscriptionRequest

Describes a renew subscription request.

Properties

The model has no properties.

^ Back to top

RenewSubscriptionResponse

Describes a renew subscription response.

Properties

The model has no properties.

^ Back to top

SettingsData

Describes a settings.

Properties

The model has no properties.

^ Back to top

SolutionData

Describes a solution.

Properties

The model has no properties.

^ Back to top

SolutionParameterData

Describes a solution parameter.

Properties

The model has no properties.

^ Back to top

SubscriptionBasicData

Describes a subscription basic.

Properties

The model has no properties.

^ Back to top

SubscriptionData

Describes a subscription.

Properties
Property Type Description Rules
SubscriptionKey string Gets or sets the subscription key. Required.
SubscriptionAlias string Gets or sets the subscription alias. Required.
SubscriptionDescription string Gets or sets the subscription description. Required.
SubscriptionStateId System.Guid Gets or sets the subscription state identifier. Required. Not empty.
SubscriptionStateKey string Gets or sets the subscription state key. Required.
SubscriptionStateDescription string Gets or sets the subscription state description. Required.
IsAvailable bool Gets or sets a value indicating whether is available. Required.
CountryKey string Gets or sets the country key. Required.
CountryDescription string Gets or sets the country description. Required.
StartDate System.DateTime Gets or sets the start date. Required.
EndDate System.DateTime Gets or sets the end date. Required.
SolutionKey string Gets or sets the solution key. Required.
SolutionDescription string Gets or sets the solution description. Required.
SolutionDetailedDescription string Gets or sets the solution detailed description. Required.
SolutionLogo string Gets or sets the solution logo. Required.
SolutionLogoThumbnail string Gets or sets the solution logo thumbnail. Required.
SubscriptionPeriodKey string Gets or sets the subscription period key. Required.
Total decimal Gets or sets the total. Required.
CurrencyKey string Gets or sets the currency key. Required.
CurrencyDescription string Gets or sets the currency description. Required.
CurrencySymbol string Gets or sets the currency symbol. Required.
HasUpgrades bool Gets or sets a value indicating whether has upgrades. Required.
LegacySubscriptionDate System.DateTime Gets or sets the legacy subscription date. Required.
OwnerSubscriptionId System.Guid Gets or sets the owner subscription identifier. Required. Not empty.
OwnerSubscriptionKey string Gets or sets the owner subscription key. Required.
CanRenewToSolution string Gets or sets the can renew to solution. Required.
Description string Gets or sets the description. Required.
Alias string Gets or sets the alias. Required.
StateDescription string Gets or sets the state description. Required.
AccountId string Gets or sets the account identifier. Required.
AccountKey string Gets or sets the account key. Required.
State int Gets or sets the state. Required.
SolutionId System.Guid Gets or sets the solution identifier. Required. Not empty.
Solution string Gets or sets the solution. Required.
Country string Gets or sets the country. Required.
Id System.Guid Gets or sets the identifier. Required. Not empty.
IsActive bool Gets or sets a value indicating whether subscription is active. Required.
InRenewalPeriod bool Gets or sets a value indicating whether is the subscription in the renew period. Required.
GrossValue decimal Gets or sets the gross value. Required.
Discount decimal Gets or sets the discount. Required.
ReversalValue decimal Gets or sets the reversal value. Required.
PartnerId string Gets or sets the partner identifier. Required.
PartnerName string Gets or sets the partner name. Required.
ExchangeRate decimal Gets or sets the exchange rate. Required.
ExchangeRateDate System.DateTime Gets or sets the exchange rate date. Required.
Amount decimal Gets or sets the amount. Required.
Status string Gets or sets the status. Required.
CompanyName string Gets or sets the company name. Required.
Currency string Gets or sets the currency. Required.
CanRenew bool Gets or sets a value indicating whether is possible to renew this subscription. Required.
RequestUserIsManager bool Gets or sets a value indicating whether [request user is manager]. Required.

^ Back to top

SubscriptionManagerData

Describes a subscription manager.

Properties

The model has no properties.

^ Back to top

SubscriptionStateData

Describes a subscription state.

Properties

The model has no properties.

^ Back to top

SubscriptionTicketData

Describes a subscription ticket.

Properties

The model has no properties.

^ Back to top

UpdateSubscriptionAccountRequest

Describes an update subscription account request.

Properties

The model has no properties.

^ Back to top

UpdateSubscriptionTicketUserEmailRequest

Describes an update subscription ticket user email request.

Properties

The model has no properties.

^ Back to top

UpdateSubscriptionTicketUserIdRequest

Describes an update subscription ticket user identifier request.

Properties

The model has no properties.

^ Back to top

UpdateSubscriptionTicketUserNameRequest

Describes an update subscription ticket user name request.

Properties

The model has no properties.

^ Back to top

UpdateSubscriptionTicketUserRequest

Describes an update subscription ticket user request.

Properties

The model has no properties.

^ Back to top

ValidateVoucherRequest

Describes a validate voucher request.

Properties

The model has no properties.

^ Back to top

ValidationResponse

Describes a validation response.

Properties
Property Type Description Rules
Result bool Gets or sets the result value. Required.
Message string? Gets or sets the message.

^ Back to top

ValidationSubscriptionRequest

Describes a validation subscription request.

Properties
Property Type Description Rules
AccountKey string Gets or sets the account key. Required.
SubscriptionKey string Gets or sets the subscription key. Required.
ItemKey string Gets or sets the item key. Required.
OldQuantity int Gets or sets the old quantity. Required.
NewQuantity int Gets or sets the new quantity. Required.

^ Back to top

VatNumberLookupInfo

Describes a vat number lookup.

Properties
Property Type Description Rules
CountryCode string Gets or sets the country code. Required.
VatNumber string Gets or sets the vat number. Required.
IsValid bool Gets or sets the is valid value. Required.
Name string? Gets or sets the name.
Address string? Gets or sets the address.
StreetName string? Gets or sets the street name.
StreetNumber string? Gets or sets the street number.
PostalCode string? Gets or sets the postal code.
PostalTown string? Gets or sets the postal town.
City string? Gets or sets the city.
Country string? Gets or sets the country.
Email string? Gets or sets the email.
Phone string? Gets or sets the phone.

^ Back to top

VatRateData

Describes a vat rate.

Properties
Property Type Description Rules
Country string Gets or sets the country. Required.
TaxCode string Gets or sets the tax code. Required.
Description string Gets or sets the description. Required.
DetailedDescription string Gets or sets the detailed description. Required.
Type int Gets or sets the type. Required.
PartitionKey string Gets or sets the partition key. Required.
RowKey string Gets or sets the row key. Required.
IsDefault bool Gets or sets the is default value. Required.

^ Back to top