Primavera Lithium ROSE CENTRAL Service (RC) Client Library

The ROSE CENTRAL customers service.

REST Service Client

Class Description
RoseCentralClient The entry point of the ROSE CENTRAL Service client library.

Client Controllers

Class Description
Companies The controller that manages all companies related operations.
CompanySettingsGroups The controller that manages all company settings groups related operations.
EventsLog The controller that manages all event logs operations.
Provisioning Executes operations to provision the product.
RoleGroups The controller that manages all group roles operations.
Roles The controller that manages all roles operations.
SalesImportGroups The controller that manages all sales import groups operations.
UserAppInstances The controller that manages all user appInstances operations.
Users The controller that manages all users operations.

Models

Class Description
AccountingGroupData The accounting group data.
AccountingGroupListResponse A list of accounting groups.
AddressData The address data.
AddressListResponse A list of addresses.
AppDefinitionConfiguration The app definition configuration.
AppInfoSelectorData App information for the selector component.
AppInstanceAccessBulkData A list of entities to add or remove access to an user.
AppInstanceAccessGroupData A entity to add or remove access to an user.
AppInstanceData Describes an application instance data.
AppInstanceFeatureData Describes a feature for an app instance.
AppInstanceInfoData Describes a unique entity of application instance information data.
AppInstanceInfoListResponse Describes a list of app instances information.
AppInstanceInviteData The user app instance data entity containing the info responsible to send invites and give permissions.
AppInstanceResourceData Describes a resource for an app instance.
AppResourcesTreeData The Application model resources tree data.
ChartOfAccountData A Chart of Accounts represents a set of accounts used to record the company's financial transactions.
ChartOfAccountListResponse A list of chart of accounts.
ClearedTableData A cleared table information.
ClientAccountingData The client accounting data.
ClientAccountingListResponse A list of client accountings.
ClosedSubscriptionData Closed subscription information.
CloseSubscriptionData Subscription to be closed information.
CompanyCustomerData Describes a company customer entity.
CompanyData Describes a company.
CompanyDetailsData Describes a company details entity.
CompanyDraftData Describes a company draft data (stepper) entity.
CompanyGroupBulkData Describes a company group bulk data.
CompanyGroupData Describes a company group data.
CompanyKeyVaultData Describes a company key vault entity.
CompanyListResponse A list of companies.
CompanyPayrollParametersData Describes a company payroll parameters.
CompanySettingsGroupCreateResponse The company settings group create response model.
CompanySettingsGroupData Describes a company settings group.
CompanySettingsGroupEntitiesData The company settings group and all related entities.
CompanySettingsGroupListResponse List of company settings group.
CompanyTaxParametersData Describes a company tax parameters.
CompanyTaxParametersTaxReportingPeriodData The reporting periods for the company tax setup.
ConfigurationEntityInsurersData Configuration insurers entity.
ConfigurationEntitySyndicatesData Configuration syndicate entity.
ConfigurationModuleData Payroll configuration module.
ContactData The contact data.
ContactListResponse A list of contacts.
ContextItem Defines the notification context item.
CountryData The country data.
CountryListResponse A list of countries.
CreateCompanyRequest Describes the necessary information to create a company.
CurrencyData The currency data.
CurrencyListResponse A list of currencies.
CurrencyRateDate The currency rate entity.
CustomerGroupData The Customer Group represents an aggregation of suppliers that are similar in some way.
CustomerGroupListResponse A list of customer groups.
CustomerPartyData The Customer Party represents a consumer of the service or product that your company offers (extends Party entity).
CustomerPartyListResponse A list of customers.
CustomerPostingProfileData The Customer Posting Profile represents a way to discover the customer account in the company chart of account.
CustomerPostingProfileListResponse A list of items.
CustomerPostProfileAccountData The Customer Posting Profile represents a way to discover the customer account in the company chart of account.
CustomerSetCompanyData The customer set company data.
CustomerSetData The Customer Set represents a company container where customers are grouped. A customer can belong to a company or to several.
CustomerSetListResponse A list of customer sets.
DataCatalogCaeData The data catalog cae entity.
DataCatalogCaeListResponse The cae list response object.
DataCatalogDistrictData The data catalog district entity.
DataCatalogDistrictListResponse The district list response object.
DataCatalogParishData The data catalog parish entity.
DataCatalogParishListResponse The parishes list response object.
DataCatalogPostalCodeData The data catalog postal code entity.
DataCatalogRegionData The data catalog region entity.
DataCatalogRegionListResponse The region list response object.
DataCatalogTaxJurisdictionServiceData The data catalog tax jurisdiction service entity.
DataCatalogTaxJurisdictionServiceListResponse The tax jurisdiction services list response object.
DocumentTypeSeriesData The document type series data.
EconomicActivityClassificationData The Economic Activity Classification represents the company's activity sector.
EconomicActivityClassificationListResponse A list of economic activity classifications.
EmailData Describes an email.
EntityBase Describes an entity base model.
EntityBaseResponse Common entity base response.
EventLogData Event log entity.
EventLogListResponse Event log list response.
FinancialAccountData The Financial Account represents accounts of type petty cash and bank account.
FinancialAccountDeterminationData The Financial Account Determination represents a general ledger accounts configuration for a chart of account.
FinancialAccountDeterminationListResponse A list of items.
FinancialAccountListResponse A list of customer groups.
FinancialCalendarData The Financial Calendar is used to record information about the financial calendar. The financial calendar consists of twelve operating periods (1-12 represent a calendar month), one opening period (same month as the first period) and up to three closing periods (same month as period 12).
FinancialCalendarListResponse Financial calendar list response.
FinancialConditionData The Company Financial Condition represents a company with financial and tax information like chart of accounts, ledger and others.
FinancialPeriod A financial calendar period.
FinancialSetupData The Financial Setup is used to manage default values for each company, such as the default reciept type or default payment type.
FinancialStatementAccountData Financial statement account entity.
FinancialStatementData The Financial Statements is used to map financial operations (eg balance sheet or profit and loss) that can be viewed in a financial statement report or financial statement by dimension.
FinancialStatementItemData Financial statement item entity.
FinancialStatementListResponse A list of items.
FinancialStatementTaxonomyData Financial statement taxonomy data.
FinancialYearData The Financial Year end point is used to record financial reporting and budgeting by a company or an organization. A financial year is most commonly used for accounting purposes to prepare financial statements. Although a financial ear can start on January 1st and end on December 31st, not all fiscal years correspond with the calendar year. For example, universities often begin and end their fiscal years according to the school year.
FinancialYearDocumentData The financial year entity with documents information.
FinancialYearFinancialYearPeriodsData The financial year period lines.
FinancialYearListResponse A list of financial years.
FiscalDocumentTypeData The Fiscal Document Type represents the type of document for the Portuguese Tax Authority (AT).
FiscalDocumentTypeListResponse A list of items.
FiscalMemoReasonData The Fiscal Memo Reason represents the classification of a memo document.
FiscalMemoReasonListResponse A list of items.
FiscalTimeZoneData The entity data.
FiscalTimeZoneListResponse A list of fiscal time zones.
FiscalWithholdingTaxTypeData The Fiscal WithholdingTaxType represents the fiscal withholding type.
FiscalWithholdingTaxTypeListResponse A list of items.
HiringReasonClassificationData The hiring reasons classification entity.
IdentityUserData Describes an identity user entity.
IdentityUserInvitationPayloadData The identity server user invitation payload.
IdentityUserInvite The user invite result entity.
IdentityUserPayloadData The identity server user payload.
IncomingNotification Defines a notification received by the service.
InviteData The rose user invite entity.
InviteGroupData Entity with all fields necessary to send an invite.
InvoiceTypeData The invoice type data entity.
InvoiceTypeListResponse A list of invoice types.
InvoiceTypeSeriesData Invoice type serie entity.
ItemTaxSchemaMappingData Describes the mapping between a tax sub class and a item tax schema.
ItemTypeMappingData Describes a mapping between a fiscal type and a item account type.
LedgerData The Ledger represents business activities and money (received or paid), the ledger can be budget or actual. This service manage the common operations of this entity.
LedgerListResponse The tax sub classes list response object.
LegalNatureData The legel nature entity.
LegalNatureListResponse The legal natures list response object.
MaterialAcctDeterminationData The materials account determinations endpoint is used to store the account types and his determination the a select chart of account.
MaterialAcctDeterminationListResponse A list of items.
MaterialsAcctDeterminationLineData Materials acct determination line entity.
MemoTypeData The Memo Type represents a sales document with specific characteristics.
MemoTypeListResponse A list of memo types.
MenuData The menu data entity.
MenuDefaultActionData The menu default action data.
MenuItemData The first level menu entity.
MessageItem Defines the notification message item.
ModelWithProperties The base model for models with Properties.
MonitoringData The monitoring data entity.
OrganizationData Describes a organization data.
PartyAccountTypeData A Party Account Type represents a classifier used to decode the GL account for a given party.
PartyAccountTypeListResponse A list of party account types.
PartyAddressData The party's addresses.
PartyContactData The party's contacts.
PartyData A Party represents an entity that provides or consumes services or goods.
PartyListResponse The parties list response object.
PartySettingsGroupData Party settings groups entity.
PartySettingsGroupListResponse The party settings group list response.
PartyTaxSchemaData A Party Tax Schema represents a tax aggregation and is associated with the party.
PartyTaxSchemaListData The party tax schema tax list.
PartyTaxSchemaListResponse A list of items.
PartyTypeDetailData The list of types that party can assume.
PayrollCoreSetupData The payroll core setup entity.
PayrollEntityBase Payroll base entity.
PayrollPropertyData Payroll core setup property data.
PayrollPropertyListData Financial setup list of properties to be updated.
PayrollStatusData The payroll statuses entity.
PostingCategoryAccountData The posting category account entity.
PostingCategoryData The Posting Category represents the decoded gl accounts for the account posting of taxes.
PostingCategoryListResponse A list of items.
PriceListLineData The price list line entity.
PropertyData Property data to be updated.
PropertyListData A list of properties to update.
ProvisioningStateData Describes the data about a particular state of the provisioning operation.
PurchasesAcctDeterminationData The Purchases Account Determination endpoint is used to discover the purchases account in the company chart of account.
PurchasesAcctDeterminationListResponse A list of items.
PurchasesGLAccountData The posting category account entity.
PurchasesGLAccountMaterialsData Purchases GL account entity.
PurchasesImportGroupData Purchase import group entity.
PurchasesImportGroupListResponse The purchase import group list response.
QuickMenuData Quick menu data entity.
RoleData Describes a user role entity.
RoleGroupData Describes a group of roles.
RoleGroupListResponse Describes a group role list response.
RoleGroupUsersBulkData The entity with the list of users to associate with a role group.
RoleListResponse Describes a user role list response.
RoleSimpleData Describes a role simple entity.
RoseCultureData The entity data.
RoseCultureListResponse A list of cultures.
RoseEntityBase Describes a ROSE entity base model.
RoseEntityBulkListResponse A bulk list response for ROSE entities.
RoseEntityBulkResponse A bulk response for ROSE entities.
RoseRoleData The user roles entity.
RoseRoleListResponse A list of roles.
RoseUserData ROSE user entity.
RoseUserListResponse A list of ROSE users.
SaftConfiguration The saft configuration model.
SaftImportGroupData The SAFT Import Group is used to manage default values for each type of saft, such as Group By Anonymous Customer, Customer Creation, Item Fiscal Type and Account Type and Taxes.
SaftImportGroupListResponse The SAFT import group data.
SaftItems A list of items for a sales import group.
SaftItemTaxSchemaMappingData Describes the mapping between a tax sub class and a item tax schema.
SaftItemTypeMappingData Describes a mapping between a fiscal type and a item account type.
SaftTaxes A list of taxes for a sales import group.
SalesAccountDeterminationData The Sales Account Profile Determination endpoint is used to discover the sales account in the company chart of account.
SalesAccountDeterminationListResponse A list of items.
SalesGLAccountData The posting category account entity.
SalesImportGroupBulkData Describes a model used to update, in bulk, a sales import group in multiple companies.
SalesImportGroupData Sales import group data entity.
SalesImportGroupListResponse List of sales import group.
SalesItemData The Sales Item represents a service or product that your company provides.
SalesItemDimensionData The sales itme dimensions entity.
SalesItemListResponse A list of items.
SeedGroupData Entities needed to seed db.
SupplierGroupData The Supplier Group represents an aggregation of suppliers that are similar in some way.
SupplierGroupListResponse A list of supplier groups.
SupplierPartyData The Supplier Party represents companies or individuals who provide you with products or services.
SupplierPartyListResponse A list of suppliers.
SupplierPostingProfileData The Supplier Posting Profile represents a way to discover the customer account in the company chart of account.
SupplierPostingProfileListResponse A list of items.
SupplierPostProfileAccountData The supplier profile account entity.
SupplierSetData The Supplier Set represents a company container where supplier are grouped. A supplier can belong to a company or to several.
SupplierSetListResponse A list of supplier sets.
TargetCompanyData The target company aditional information (used in bulk operations).
TaxAuthoritySetupPTData The Tax Authority Setup is used to manage default values for each company, such as the Communication to the Tax Authority and Tax Reporting.
TaxAuthoritySetupPTListResponse Tax auth setup PT list response.
TaxCodeRateData The tax code rate.
TaxesSetupData The Taxes Setup is used to manage default values for each company, such as the fiscal time zone and tax regional area.
TaxesSetupListResponse A list of tax setups.
TaxesSetupTaxReportingPeriodData The reporting periods for the tax classes.
TaxonomyClassData A Taxonomy Class represents a set of taxonomies which share the same accounting classification such as SNC Micro-entities.
TaxonomyClassListResponse A list of items.
TaxRegionalAreaData A Tax Regional Area represents which region the tax type code applies to.
TaxRegionalAreaListResponse A list of party account types.
TaxReportFieldData Tax report field entity.
TaxReportSetupData The Tax Report Setup is used to manage new reports to send to a specificTax Authority, such as like DPIVA or DPIVA-AC( Portuguese Tax Authority (AT)).
TaxReportSetupListResponse A list of items.
TaxReportSummaryData Tax report summary entity.
TaxTypeCodeData A Tax Type Code represents one or more Tax Rules to transactions based on various criteria.
TaxTypeCodeListResponse A list of items.
UserAppInstanceData Describes a user app instance entity.
UserAppInstanceInviteData The invite complete object.
UserAppInstanceListResponse A user app instance list response.
UserAppInstancePayloadData Describes the association between a user and an app instance.
UserAppInstanceUserData Describes a user app instance and a user data.
UserCompanyData The user current companies.
UserCompanyListResponse The list of current user companies.
UserData Describes a user entity.
UserInviteData Entity with invite and roles information.
UserListResponse Describes a user list response.
UserSimpleData Describes a user entity.
VatNumberInfoData The vat number information data.
VatNumberInfoOwnerData The vat number information owner data.
VersionData The version of the entity.
WorkLocationData The work location entity.
WorkspaceData Describes a workspace data.

Enumerations

Class Description
AccountingNature The default nature of the account (debit or credit).
AccountingSchema The entity's accounting organization method. This organization can follow the rules of "Cash Accounting" or "Accrual Accounting".
AllowedIn The item tax schemas allowed in modules.
AppInstanceState The organization State enumeration.
ApplicationType The application type.
BalancePeriod Balance period enum.
BaseValue BaseValue enum.
ClientAccountingStatus The company new subscription status.
CodificationRule Types of rules to create a party.
CommunicationType Communication type.
CompanyOperationStatus Describes a company initilization operation status mode.
CompanyOperationStatusType Describes the type of a company initialization operation.
CompanySaveMode The company save mode.
CompanyStatus The company new subscription status.
DateFormat The date format.
DestinySchemaEntity The end request source.
ElectronicTransferFileType Electronic transfer file type.
ElectronicTransferPurpose Electronic transfer purpose.
EntityStatus The company new subscription status.
EventLevel The event log entry type.
FinancialAccountType The financial account type enumeration.
FinancialStatementItemType Financial statement item type enum.
FinancialStatementPurpose Financial statement item type enum.
FinancialYearOperations The operations regarding documents on a financial year.
FiscalMemoReasonType Fiscal Memo Reason Type.
FiscalNumberValidationState The fiscal number validation states.
FiscalType The sales type mapping fiscal type.
FiscalUse Fiscal use.
ItemType Item type enum.
JournalNumbering The type of jounal numbering (monthly or yearly).
LedgerType The ledger type enumerator.
MaritalStatus The contact’s marital status.
Month The month enumerator.
NotificationType Defines the type of the notifications.
OrganizationState The organization State enumeration.
PartyType Types of Party.
PaymentMethodType Payment method type.
PayrollEntities Enumerate all payroll entities.
PeriodType The period type (opening, regular, closing).
PlanConfiguration The plan configuration.
ProvisioningState The existing provisioning states.
RateType Rate type enum.
ReportingPeriod Reporting periods.
RoleGroupType The user type.
RoleType The types of roles.
RoseEntities Enumerate all rose entities.
RoundingType Rounding type enum.
Salutation The contact's greeting.
ScaleMethod Scale method enum.
SourceSchemaEntity The request source.
SubAccountType Describes a sub account type.
SubscriptionType Types of subscriptions (for closing purposes).
TaxAmount Tax amount enum.
TaxReportFieldType Tax report field type enum.
TaxReportForm Teh tax report form enum.
TaxType Tax type enum.
TransactionType The type of transaction of a journal type.
UserAppInstanceType Defines a type of user app instance.
UserType The user type.
WorkspaceState The workspace State enumeration.

Authorization Policies

Policy Description Scope
DefaultScope Defines an authorization policy that requires the default scope. lithium-rose-central
DeprovisioningAppAccess Requires a specific scope to deprovision a Rose Central subscription. N/A
RequireAppAccess Requires an authenticated user with access to the subscription in context. N/A

Reference

REST Service Client Classes

RoseCentralClient

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

RoseCentralClient client = new RoseCentralClient(
    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

CompaniesClientController

The controller that manages all companies related operations.

Methods
CancelAsync()

Cancels the specified company, removing it.

public async Task<RestServiceResult> CancelAsync(string account, string subscription, int id, CancellationToken cancellationToken = default);

public RestServiceResult Cancel(string account, string subscription, int id);
Parameters
Parameter Type Description Rules
id int The company unique identifier.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent 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 a RestServiceError depending on the status code.

^ Back to top

CreateAsync()

Creates the specified company.

public async Task<RestServiceResult<int>> CreateAsync(string account, string subscription, Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyData company, CancellationToken cancellationToken = default);

public RestServiceResult<int> Create(string account, string subscription, Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyData company);
Parameters
Parameter Type Description Rules
company Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyData The company information. Required.
Returns
Return Type Description
int The company identifier.
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 a RestServiceError depending on the status code.

^ Back to top

CreateDraftAsync()

Creates the specified company with draft information.

public async Task<RestServiceResult<int>> CreateDraftAsync(string account, string subscription, Primavera.Lithium.RoseCentral.Client.Rest.Models.CreateCompanyRequest request, CancellationToken cancellationToken = default);

public RestServiceResult<int> CreateDraft(string account, string subscription, Primavera.Lithium.RoseCentral.Client.Rest.Models.CreateCompanyRequest request);
Parameters
Parameter Type Description Rules
request Primavera.Lithium.RoseCentral.Client.Rest.Models.CreateCompanyRequest The information about the request to create a company. Required.
Returns
Return Type Description
int The company identifier.
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 a RestServiceError depending on the status code.

^ Back to top

DeleteAsync()

Deletes the specified company.

public async Task<RestServiceResult> DeleteAsync(string account, string subscription, int id, CancellationToken cancellationToken = default);

public RestServiceResult Delete(string account, string subscription, int id);
Parameters
Parameter Type Description Rules
id int The company unique identifier.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent 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 a RestServiceError depending on the status code.

^ Back to top

GetAsync()

The requested company data.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyData>> GetAsync(string account, string subscription, int id, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyData> Get(string account, string subscription, int id);
Parameters
Parameter Type Description Rules
id int The company unique identifier.
Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyData The requested company data.
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 a RestServiceError depending on the status code.

^ Back to top

GetAllAsync()

The operation to retrieve all companies.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyListResponse>> GetAllAsync(string account, string subscription, string? filterFields, string? filterCriteria, string? orderFields, string? orderCriteria, int skip, int take, bool onlyActives, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyListResponse> GetAll(string account, string subscription, string? filterFields, string? filterCriteria, string? orderFields, string? orderCriteria, int skip, int take, bool onlyActives);
Parameters
Parameter Type Description Rules
filterFields string? List of fields separated by ' ' that must be filtered by the data existing in 'FilterCriteria.
filterCriteria string? List of values separeted by ' ' ​​to be used as filters.
orderFields string? List of fields separated by ' ' that will be used to order by the results according to the criteria existing on 'OrderCriteria'.
orderCriteria string? List of values separeted by ' ' ​​to be used as order criteria (ascending or descending).
skip int Number of items to skip.
take int Number of items to take.
onlyActives bool If true only retrieves companies with status equals to active.
Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyListResponse Returns a companies list.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.

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

^ Back to top

GetByAccountSubscriptionAsync()

The list of companies with the given account and subscription keys.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyListResponse>> GetByAccountSubscriptionAsync(string account, string subscription, string accountKey, string subscriptionKey, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyListResponse> GetByAccountSubscription(string account, string subscription, string accountKey, string subscriptionKey);
Parameters
Parameter Type Description Rules
accountKey string The account key. Required.
subscriptionKey string The subscription key. Required.
Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyListResponse A list of companies related to an account and subscription.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.

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

^ Back to top

GetByAccountSubscriptionCompanyKeyAsync()

The list of companies with the given account, subscription and company keys.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyData>> GetByAccountSubscriptionCompanyKeyAsync(string account, string subscription, string accountKey, string subscriptionKey, string companyKey, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyData> GetByAccountSubscriptionCompanyKey(string account, string subscription, string accountKey, string subscriptionKey, string companyKey);
Parameters
Parameter Type Description Rules
accountKey string The account key. Required.
subscriptionKey string The subscription key. Required.
companyKey string The company key. Required.
Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyData A list of companies related to an account, subscription and company key.
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 a RestServiceError depending on the status code.

^ Back to top

GetByAccountSubscriptionTaxIdAsync()

The requested company data.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyData>> GetByAccountSubscriptionTaxIdAsync(string account, string subscription, string accountKey, string subscriptionKey, string taxId, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyData> GetByAccountSubscriptionTaxId(string account, string subscription, string accountKey, string subscriptionKey, string taxId);
Parameters
Parameter Type Description Rules
accountKey string The account key. Required.
subscriptionKey string The subscription key. Required.
taxId string The tax number identifier. Required.
Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyData The requested company data.
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 a RestServiceError depending on the status code.

^ Back to top

GetByUserKeyAsync()

Retrieves companies by user identifier.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyListResponse>> GetByUserKeyAsync(string account, string subscription, string userKey, string? filterFields, string? filterCriteria, string? orderFields, string? orderCriteria, int skip, int take, bool onlyActives, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyListResponse> GetByUserKey(string account, string subscription, string userKey, string? filterFields, string? filterCriteria, string? orderFields, string? orderCriteria, int skip, int take, bool onlyActives);
Parameters
Parameter Type Description Rules
userKey string The user key. Required.
filterFields string? List of fields separated by ' ' that must be filtered by the data existing in 'FilterCriteria.
filterCriteria string? List of values separeted by ' ' ​​to be used as filters.
orderFields string? List of fields separated by ' ' that will be used to order by the results according to the criteria existing on 'OrderCriteria'.
orderCriteria string? List of values separeted by ' ' ​​to be used as order criteria (ascending or descending).
skip int Number of items to skip.
take int Number of items to take.
onlyActives bool If true only retrieves companies with status equals to active.
Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyListResponse A list of user companies.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.

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

^ Back to top

GetMyRoseAsync()

Gets the app instance marked as 'MyRose'.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyData>> GetMyRoseAsync(string account, string subscription, bool justCheck, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyData> GetMyRose(string account, string subscription, bool justCheck);
Parameters
Parameter Type Description Rules
justCheck bool If it's only a check operation or a check plus a create or update opearation.
Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyData The my rose app instance, if it exists.
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 a RestServiceError depending on the status code.

^ Back to top

RetryCreateDraftAsync()

Retries the subscription/company create operation.

public async Task<RestServiceResult<bool>> RetryCreateDraftAsync(string account, string subscription, int id, CancellationToken cancellationToken = default);

public RestServiceResult<bool> RetryCreateDraft(string account, string subscription, int id);
Parameters
Parameter Type Description Rules
id int The company unique identifier.
Returns
Return Type Description
bool If operation was successful.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.

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

^ Back to top

UpdateAsync()

Updates the specified company.

public async Task<RestServiceResult<int>> UpdateAsync(string account, string subscription, int id, Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyData company, CancellationToken cancellationToken = default);

public RestServiceResult<int> Update(string account, string subscription, int id, Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyData company);
Parameters
Parameter Type Description Rules
id int The company unique identifier.
company Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyData The company entity that will be updated. Required.
Returns
Return Type Description
int The company identifier.
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 a RestServiceError depending on the status code.

^ Back to top

UpdateDraftAsync()

Updates the specified company with draft data.

public async Task<RestServiceResult<int>> UpdateDraftAsync(string account, string subscription, int id, Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyDraftData company, bool updateSubscription, CancellationToken cancellationToken = default);

public RestServiceResult<int> UpdateDraft(string account, string subscription, int id, Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyDraftData company, bool updateSubscription);
Parameters
Parameter Type Description Rules
id int The company unique identifier.
company Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyDraftData The company entity that will be updated. Required.
updateSubscription bool Whether the subscription description is to be updated.
Returns
Return Type Description
int The company identifier.
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 a RestServiceError depending on the status code.

^ Back to top

CompanySettingsGroupsClientController

The controller that manages all company settings groups related operations.

Methods
CreateAsync()

Create the specified company settings group.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanySettingsGroupCreateResponse>> CreateAsync(string account, string subscription, Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanySettingsGroupEntitiesData companySettingsGroupEntities, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanySettingsGroupCreateResponse> Create(string account, string subscription, Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanySettingsGroupEntitiesData companySettingsGroupEntities);
Parameters
Parameter Type Description Rules
companySettingsGroupEntities Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanySettingsGroupEntitiesData The company settings group that should be created. Required.
Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanySettingsGroupCreateResponse The related entities identifiers.
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 a RestServiceError depending on the status code.

^ Back to top

DeleteAsync()

Deletes the specified company settings group.

public async Task<RestServiceResult> DeleteAsync(string account, string subscription, int id, CancellationToken cancellationToken = default);

public RestServiceResult Delete(string account, string subscription, int id);
Parameters
Parameter Type Description Rules
id int The company settings group unique identifier.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent 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 a RestServiceError depending on the status code.

^ Back to top

GetAsync()

Gets the requested company settings group and all related entities.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanySettingsGroupEntitiesData>> GetAsync(string account, string subscription, int id, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanySettingsGroupEntitiesData> Get(string account, string subscription, int id);
Parameters
Parameter Type Description Rules
id int The company settings group unique identifier.
Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanySettingsGroupEntitiesData The requested company settings group and all related entities.
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 a RestServiceError depending on the status code.

^ Back to top

GetAllAsync()

Gets a list of company settings groups according to the input parameters.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanySettingsGroupListResponse>> GetAllAsync(string account, string subscription, string? filterFields, string? filterCriteria, string? orderFields, string? orderCriteria, int skip, int take, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanySettingsGroupListResponse> GetAll(string account, string subscription, string? filterFields, string? filterCriteria, string? orderFields, string? orderCriteria, int skip, int take);
Parameters
Parameter Type Description Rules
filterFields string? List of fields separated by ' ' that must be filtered by the data existing in 'FilterCriteria.
filterCriteria string? List of values separeted by ' ' ​​to be used as filters.
orderFields string? List of fields separated by ' ' that will be used to order by the results according to the criteria existing on 'OrderCriteria'.
orderCriteria string? List of values separeted by ' ' ​​to be used as order criteria (ascending or descending).
skip int Number of items to skip.
take int Number of items to take.
Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanySettingsGroupListResponse List of company settings group.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.

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

^ Back to top

GetDefaultModelAsync()

Gets the default model.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanySettingsGroupData>> GetDefaultModelAsync(string account, string subscription, , CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanySettingsGroupData> GetDefaultModel(string account, string subscription, );
Parameters

The operation has no parameters.

Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanySettingsGroupData The company settings group default model.
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 a RestServiceError depending on the status code.

^ Back to top

UpdateAsync()

Updates an existing entity.

public async Task<RestServiceResult<int>> UpdateAsync(string account, string subscription, int id, Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanySettingsGroupEntitiesData companySettingsGroupEntities, CancellationToken cancellationToken = default);

public RestServiceResult<int> Update(string account, string subscription, int id, Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanySettingsGroupEntitiesData companySettingsGroupEntities);
Parameters
Parameter Type Description Rules
id int The company settings group unique identifier.
companySettingsGroupEntities Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanySettingsGroupEntitiesData The bulk company settings group update information. Required.
Returns
Return Type Description
int Returns information about the sucess of the operation.
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 a RestServiceError depending on the status code.

^ Back to top

EventsLogClientController

The controller that manages all event logs operations.

Methods
GetAsync()

Gets an event log entry entity.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.EventLogData>> GetAsync(string account, string subscription, int id, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.EventLogData> Get(string account, string subscription, int id);
Parameters
Parameter Type Description Rules
id int The entity unique identifier.
Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.EventLogData An event log entry.
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 a RestServiceError depending on the status code.

^ Back to top

GetAllAsync()

Gets a list of event log entries.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.EventLogListResponse>> GetAllAsync(string account, string subscription, string? filterFields, string? filterCriteria, string? orderFields, string? orderCriteria, int skip, int take, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.EventLogListResponse> GetAll(string account, string subscription, string? filterFields, string? filterCriteria, string? orderFields, string? orderCriteria, int skip, int take);
Parameters
Parameter Type Description Rules
filterFields string? List of fields separated by ' ' that must be filtered by the data existing in 'FilterCriteria.
filterCriteria string? List of values separeted by ' ' ​​to be used as filters.
orderFields string? Order by fields.
orderCriteria string? List of fields separated by ' ' that will be used to order by the results according to the criteria existing on 'OrderCriteria'.
skip int Number of items to skip.
take int Number of items to take.
Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.EventLogListResponse List of event log entries.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.

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

^ Back to top

GetAllNonSystemAsync()

Gets a list of non system event log entries.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.EventLogListResponse>> GetAllNonSystemAsync(string account, string subscription, string? filterFields, string? filterCriteria, string? orderFields, string? orderCriteria, int skip, int take, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.EventLogListResponse> GetAllNonSystem(string account, string subscription, string? filterFields, string? filterCriteria, string? orderFields, string? orderCriteria, int skip, int take);
Parameters
Parameter Type Description Rules
filterFields string? List of fields separated by ' ' that must be filtered by the data existing in 'FilterCriteria.
filterCriteria string? List of values separeted by ' ' ​​to be used as filters.
orderFields string? List of fields separated by ' ' that will be used to order by the results according to the criteria existing on 'OrderCriteria'.
orderCriteria string? The order by criteria.
skip int Number of items to skip.
take int Number of items to take.
Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.EventLogListResponse List of non system event log entries.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.

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

^ Back to top

ProvisioningClientController

Executes operations to provision the product.

Methods
ClearTenantAsync()

Clears a ROSE Central database information.

public async Task<RestServiceResult<System.Collections.Generic.IEnumerable<Primavera.Lithium.RoseCentral.Client.Rest.Models.ClearedTableData>>> ClearTenantAsync(string account, string subscription, , CancellationToken cancellationToken = default);

public RestServiceResult<System.Collections.Generic.IEnumerable<Primavera.Lithium.RoseCentral.Client.Rest.Models.ClearedTableData>> ClearTenant(string account, string subscription, );
Parameters

The operation has no parameters.

Returns
Return Type Description
System.Collections.Generic.IEnumerable<Primavera.Lithium.RoseCentral.Client.Rest.Models.ClearedTableData> A list of cleared table and it's status.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.

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

^ Back to top

CloseSubscriptionAsync()

Closes a ROSE Central subscription.

public async Task<RestServiceResult<System.Collections.Generic.IEnumerable<Primavera.Lithium.RoseCentral.Client.Rest.Models.ClosedSubscriptionData>>> CloseSubscriptionAsync(string account, string subscription, System.Collections.Generic.IEnumerable<Primavera.Lithium.RoseCentral.Client.Rest.Models.CloseSubscriptionData>? closeSubscriptions, CancellationToken cancellationToken = default);

public RestServiceResult<System.Collections.Generic.IEnumerable<Primavera.Lithium.RoseCentral.Client.Rest.Models.ClosedSubscriptionData>> CloseSubscription(string account, string subscription, System.Collections.Generic.IEnumerable<Primavera.Lithium.RoseCentral.Client.Rest.Models.CloseSubscriptionData>? closeSubscriptions);
Parameters
Parameter Type Description Rules
closeSubscriptions System.Collections.Generic.IEnumerable<Primavera.Lithium.RoseCentral.Client.Rest.Models.CloseSubscriptionData>? A list of subscription types to be closed.
Returns
Return Type Description
System.Collections.Generic.IEnumerable<Primavera.Lithium.RoseCentral.Client.Rest.Models.ClosedSubscriptionData> A list of closed or not closed (by error) subscriptions.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.

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

^ Back to top

CreateRoseCentralAppInstanceAsync()

Creates a ROSE Central app instance from a ROSE AS app instance.

public async Task<RestServiceResult<bool>> CreateRoseCentralAppInstanceAsync(string account, string subscription, string roseAccount, string roseSubscription, CancellationToken cancellationToken = default);

public RestServiceResult<bool> CreateRoseCentralAppInstance(string account, string subscription, string roseAccount, string roseSubscription);
Parameters
Parameter Type Description Rules
roseAccount string The rose account value. Required.
roseSubscription string The rose subscription value. Required.
Returns
Return Type Description
bool A boolean indicating success.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.

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

^ Back to top

InitializeCompanyAsync()

Initialize a rose upgrade.

public async Task<RestServiceResult<bool>> InitializeCompanyAsync(string account, string subscription, , CancellationToken cancellationToken = default);

public RestServiceResult<bool> InitializeCompany(string account, string subscription, );
Parameters

The operation has no parameters.

Returns
Return Type Description
bool A boolean indicating if it needs upgrade or not.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.

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

^ Back to top

InitializeTenantAsync()

Initializes and upgrades a tenant.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.ProvisioningStateData>> InitializeTenantAsync(string account, string subscription, , CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.ProvisioningStateData> InitializeTenant(string account, string subscription, );
Parameters

The operation has no parameters.

Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.ProvisioningStateData The current provisioning state.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.

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

^ Back to top

RoleGroupsClientController

The controller that manages all group roles operations.

Methods
CreateAsync()

Method to retreive an role group.

public async Task<RestServiceResult<int>> CreateAsync(string account, string subscription, Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleGroupUsersBulkData roleGroupUsers, CancellationToken cancellationToken = default);

public RestServiceResult<int> Create(string account, string subscription, Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleGroupUsersBulkData roleGroupUsers);
Parameters
Parameter Type Description Rules
roleGroupUsers Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleGroupUsersBulkData The list of users to associate with the group role to be created. Required.
Returns
Return Type Description
int An role group.
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 a RestServiceError depending on the status code.

^ Back to top

DeleteAsync()

Action to delte a role group.

public async Task<RestServiceResult> DeleteAsync(string account, string subscription, int id, CancellationToken cancellationToken = default);

public RestServiceResult Delete(string account, string subscription, int id);
Parameters
Parameter Type Description Rules
id int The user id.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent 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 a RestServiceError depending on the status code.

^ Back to top

GetAsync()

Gets an group role entity.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleGroupData>> GetAsync(string account, string subscription, int id, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleGroupData> Get(string account, string subscription, int id);
Parameters
Parameter Type Description Rules
id int The entity unique identifier.
Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleGroupData A single group role entity.
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 a RestServiceError depending on the status code.

^ Back to top

GetAllAsync()

Gets a list of users.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleGroupListResponse>> GetAllAsync(string account, string subscription, string? filterFields, string? filterCriteria, string? orderFields, string? orderCriteria, int skip, int take, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleGroupListResponse> GetAll(string account, string subscription, string? filterFields, string? filterCriteria, string? orderFields, string? orderCriteria, int skip, int take);
Parameters
Parameter Type Description Rules
filterFields string? List of fields separated by ' ' that must be filtered by the data existing in 'FilterCriteria.
filterCriteria string? List of values separeted by ' ' ​​to be used as filters.
orderFields string? List of fields separated by ' ' that will be used to order by the results according to the criteria existing on 'OrderCriteria'.
orderCriteria string? List of values separeted by ' ' ​​to be used as order criteria (ascending or descending).
skip int Number of items to skip.
take int Number of items to take.
Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleGroupListResponse A list of users.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.

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

^ Back to top

GetAllNonCentralAsync()

Gets a list of role groups.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleGroupListResponse>> GetAllNonCentralAsync(string account, string subscription, string? filterFields, string? filterCriteria, string? orderFields, string? orderCriteria, int skip, int take, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleGroupListResponse> GetAllNonCentral(string account, string subscription, string? filterFields, string? filterCriteria, string? orderFields, string? orderCriteria, int skip, int take);
Parameters
Parameter Type Description Rules
filterFields string? List of fields separated by ' ' that must be filtered by the data existing in 'FilterCriteria.
filterCriteria string? List of values separeted by ' ' ​​to be used as filters.
orderFields string? List of fields separated by ' ' that will be used to order by the results according to the criteria existing on 'OrderCriteria'.
orderCriteria string? List of values separeted by ' ' ​​to be used as order criteria (ascending or descending).
skip int Number of items to skip.
take int Number of items to take.
Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleGroupListResponse Get all role groups except the ones that have role type setted as Central.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.

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

^ Back to top

GetByKeyAsync()

Gets an group role entity by key.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleGroupData>> GetByKeyAsync(string account, string subscription, string key, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleGroupData> GetByKey(string account, string subscription, string key);
Parameters
Parameter Type Description Rules
key string The entity key. Required.
Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleGroupData A single role group entity.
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 a RestServiceError depending on the status code.

^ Back to top

UpdateAsync()

Action to update a role group information.

public async Task<RestServiceResult<int>> UpdateAsync(string account, string subscription, int id, Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleGroupUsersBulkData roleGroupUsers, CancellationToken cancellationToken = default);

public RestServiceResult<int> Update(string account, string subscription, int id, Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleGroupUsersBulkData roleGroupUsers);
Parameters
Parameter Type Description Rules
id int The user id.
roleGroupUsers Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleGroupUsersBulkData The list of users to associate with the group role. Required.
Returns
Return Type Description
int The updated role group id.
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 a RestServiceError depending on the status code.

^ Back to top

RolesClientController

The controller that manages all roles operations.

Methods
GetAllAsync()

Retrieves a list of all roles.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleListResponse>> GetAllAsync(string account, string subscription, , CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleListResponse> GetAll(string account, string subscription, );
Parameters

The operation has no parameters.

Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleListResponse A list of all roles.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.

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

^ Back to top

SalesImportGroupsClientController

The controller that manages all sales import groups operations.

Methods
CreateAsync()

Create the specified sales import group entity.

public async Task<RestServiceResult<int>> CreateAsync(string account, string subscription, Primavera.Lithium.RoseCentral.Client.Rest.Models.SalesImportGroupBulkData salesImportGroupBulk, CancellationToken cancellationToken = default);

public RestServiceResult<int> Create(string account, string subscription, Primavera.Lithium.RoseCentral.Client.Rest.Models.SalesImportGroupBulkData salesImportGroupBulk);
Parameters
Parameter Type Description Rules
salesImportGroupBulk Primavera.Lithium.RoseCentral.Client.Rest.Models.SalesImportGroupBulkData The sales import group entity that should be created. Required.
Returns
Return Type Description
int The sales import group unique identifier.
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 a RestServiceError depending on the status code.

^ Back to top

DeleteAsync()

Deletes the specified sales import group.

public async Task<RestServiceResult> DeleteAsync(string account, string subscription, int id, CancellationToken cancellationToken = default);

public RestServiceResult Delete(string account, string subscription, int id);
Parameters
Parameter Type Description Rules
id int The sales import group unique identifier.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent 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 a RestServiceError depending on the status code.

^ Back to top

GetAsync()

Gets a sales import group and all related entities.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.SalesImportGroupData>> GetAsync(string account, string subscription, int id, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.SalesImportGroupData> Get(string account, string subscription, int id);
Parameters
Parameter Type Description Rules
id int The company settings group unique identifier.
Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.SalesImportGroupData The sales import group and all related entities.
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 a RestServiceError depending on the status code.

^ Back to top

GetAllAsync()

Get a list of sales import groups.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.SalesImportGroupListResponse>> GetAllAsync(string account, string subscription, string? filterFields, string? filterCriteria, string? orderFields, string? orderCriteria, int skip, int take, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.SalesImportGroupListResponse> GetAll(string account, string subscription, string? filterFields, string? filterCriteria, string? orderFields, string? orderCriteria, int skip, int take);
Parameters
Parameter Type Description Rules
filterFields string? List of fields separated by ' ' that must be filtered by the data existing in 'FilterCriteria.
filterCriteria string? List of values separeted by ' ' ​​to be used as filters.
orderFields string? List of fields separated by ' ' that will be used to order by the results according to the criteria existing on 'OrderCriteria'.
orderCriteria string? List of values separeted by ' ' ​​to be used as order criteria (ascending or descending).
skip int Number of items to skip.
take int Number of items to take.
Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.SalesImportGroupListResponse A list of sales import group according to the given parameters.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.

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

^ Back to top

GetDefaultModelAsync()

Gets the sales import group default model.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.SalesImportGroupData>> GetDefaultModelAsync(string account, string subscription, , CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.SalesImportGroupData> GetDefaultModel(string account, string subscription, );
Parameters

The operation has no parameters.

Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.SalesImportGroupData The entity default model.
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 a RestServiceError depending on the status code.

^ Back to top

GetRoseSaftConfigurationAsync()

Gets the data needed for a SAF-T import operation.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.SaftConfiguration>> GetRoseSaftConfigurationAsync(string account, string subscription, string targetAccount, string targetSubscription, string companyTaxId, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.SaftConfiguration> GetRoseSaftConfiguration(string account, string subscription, string targetAccount, string targetSubscription, string companyTaxId);
Parameters
Parameter Type Description Rules
targetAccount string The target account key. Required.
targetSubscription string The target subscription key. Required.
companyTaxId string The company tax id number. Required.
Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.SaftConfiguration A saft configuration data.
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 a RestServiceError depending on the status code.

^ Back to top

UpdateAsync()

Updates an existing sales import group.

public async Task<RestServiceResult<int>> UpdateAsync(string account, string subscription, int id, Primavera.Lithium.RoseCentral.Client.Rest.Models.SalesImportGroupBulkData salesImportGroupBulk, CancellationToken cancellationToken = default);

public RestServiceResult<int> Update(string account, string subscription, int id, Primavera.Lithium.RoseCentral.Client.Rest.Models.SalesImportGroupBulkData salesImportGroupBulk);
Parameters
Parameter Type Description Rules
id int The sales import group unique identifier.
salesImportGroupBulk Primavera.Lithium.RoseCentral.Client.Rest.Models.SalesImportGroupBulkData The sales import group bulk entity to be updated. Required.
Returns
Return Type Description
int Returns information about the sucess of the operation.
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 a RestServiceError depending on the status code.

^ Back to top

UserAppInstancesClientController

The controller that manages all user appInstances operations.

Methods
GetByAccountSubscriptionUserKeyAsync()

The requested user app instance with the given account, subscription and user keys.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.UserAppInstanceData>> GetByAccountSubscriptionUserKeyAsync(string account, string subscription, string accountKey, string subscriptionKey, string userKey, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.UserAppInstanceData> GetByAccountSubscriptionUserKey(string account, string subscription, string accountKey, string subscriptionKey, string userKey);
Parameters
Parameter Type Description Rules
accountKey string The account key. Required.
subscriptionKey string The subscription key. Required.
userKey string The user key. Required.
Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.UserAppInstanceData A single user app instance.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.

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

^ Back to top

GetFromUserAsync()

Gets a list of user app instances and roles for a specific user unique identifier.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.UserAppInstanceListResponse>> GetFromUserAsync(string account, string subscription, int userId, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.UserAppInstanceListResponse> GetFromUser(string account, string subscription, int userId);
Parameters
Parameter Type Description Rules
userId int The user unique identifier.
Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.UserAppInstanceListResponse A list of user app instances and roles.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.

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

^ Back to top

GetFromUserKeyAsync()

Gets a list of user app instances and roles.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.UserAppInstanceListResponse>> GetFromUserKeyAsync(string account, string subscription, string userKey, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.UserAppInstanceListResponse> GetFromUserKey(string account, string subscription, string userKey);
Parameters
Parameter Type Description Rules
userKey string The user key. Required.
Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.UserAppInstanceListResponse A list of user app instances and roles.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.

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

^ Back to top

GetUserByAccountSubscriptionAsync()

A list of user appInstances with the given account and subscription.

public async Task<RestServiceResult<System.Collections.Generic.IEnumerable<Primavera.Lithium.RoseCentral.Client.Rest.Models.UserAppInstanceUserData>>> GetUserByAccountSubscriptionAsync(string account, string subscription, string accountKey, string subscriptionKey, CancellationToken cancellationToken = default);

public RestServiceResult<System.Collections.Generic.IEnumerable<Primavera.Lithium.RoseCentral.Client.Rest.Models.UserAppInstanceUserData>> GetUserByAccountSubscription(string account, string subscription, string accountKey, string subscriptionKey);
Parameters
Parameter Type Description Rules
accountKey string The app instance account key. Required.
subscriptionKey string The app instance account key. Required.
Returns
Return Type Description
System.Collections.Generic.IEnumerable<Primavera.Lithium.RoseCentral.Client.Rest.Models.UserAppInstanceUserData> A list of user app instances.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.

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

^ Back to top

InviteUserAsync()

Invites a user and manages roles for a user.

public async Task<RestServiceResult<bool>> InviteUserAsync(string account, string subscription, Primavera.Lithium.RoseCentral.Client.Rest.Models.UserAppInstanceInviteData userInvitation, CancellationToken cancellationToken = default);

public RestServiceResult<bool> InviteUser(string account, string subscription, Primavera.Lithium.RoseCentral.Client.Rest.Models.UserAppInstanceInviteData userInvitation);
Parameters
Parameter Type Description Rules
userInvitation Primavera.Lithium.RoseCentral.Client.Rest.Models.UserAppInstanceInviteData The user invitation model. Required.
Returns
Return Type Description
bool If operation was successful or not.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.

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

^ Back to top

UsersClientController

The controller that manages all users operations.

Methods
DeleteAsync()

Action to delte a user.

public async Task<RestServiceResult> DeleteAsync(string account, string subscription, int id, CancellationToken cancellationToken = default);

public RestServiceResult Delete(string account, string subscription, int id);
Parameters
Parameter Type Description Rules
id int The user id.
Returns
Return Type Description
None The operation has no return value.
Status Codes
Status Code Description
HttpStatusCode.NoContent 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 a RestServiceError depending on the status code.

^ Back to top

GetAsync()

Gets an user entity.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.UserData>> GetAsync(string account, string subscription, int id, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.UserData> Get(string account, string subscription, int id);
Parameters
Parameter Type Description Rules
id int The entity unique identifier.
Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.UserData A single user entity.
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 a RestServiceError depending on the status code.

^ Back to top

GetAllAsync()

Gets a list of users.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.UserListResponse>> GetAllAsync(string account, string subscription, string? filterFields, string? filterCriteria, string? orderFields, string? orderCriteria, int skip, int take, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.UserListResponse> GetAll(string account, string subscription, string? filterFields, string? filterCriteria, string? orderFields, string? orderCriteria, int skip, int take);
Parameters
Parameter Type Description Rules
filterFields string? List of fields separated by ' ' that must be filtered by the data existing in 'FilterCriteria.
filterCriteria string? List of values separeted by ' ' ​​to be used as filters.
orderFields string? List of fields separated by ' ' that will be used to order by the results according to the criteria existing on 'OrderCriteria'.
orderCriteria string? List of values separeted by ' ' ​​to be used as order criteria (ascending or descending).
skip int Number of items to skip.
take int Number of items to take.
Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.UserListResponse A list of users.
Status Codes
Status Code Description
HttpStatusCode.Ok Success.
HttpStatusCode.BadRequest Failure: the request is invalid.

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

^ Back to top

GetByEmailAsync()

Retrieves a user by email.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.UserData>> GetByEmailAsync(string account, string subscription, string email, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.UserData> GetByEmail(string account, string subscription, string email);
Parameters
Parameter Type Description Rules
email string The user email. Required.
Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.UserData A single user instance.
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 a RestServiceError depending on the status code.

^ Back to top

GetByKeyAsync()

Retrieves a user by key.

public async Task<RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.UserData>> GetByKeyAsync(string account, string subscription, string key, CancellationToken cancellationToken = default);

public RestServiceResult<Primavera.Lithium.RoseCentral.Client.Rest.Models.UserData> GetByKey(string account, string subscription, string key);
Parameters
Parameter Type Description Rules
key string The entity key. Required.
Returns
Return Type Description
Primavera.Lithium.RoseCentral.Client.Rest.Models.UserData A single user entity.
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 a RestServiceError depending on the status code.

^ Back to top

UpdateAsync()

Action to update user information.

public async Task<RestServiceResult<int>> UpdateAsync(string account, string subscription, int id, Primavera.Lithium.RoseCentral.Client.Rest.Models.UserData user, CancellationToken cancellationToken = default);

public RestServiceResult<int> Update(string account, string subscription, int id, Primavera.Lithium.RoseCentral.Client.Rest.Models.UserData user);
Parameters
Parameter Type Description Rules
id int The user id.
user Primavera.Lithium.RoseCentral.Client.Rest.Models.UserData The user to update. Required.
Returns
Return Type Description
int The updated user id.
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 a RestServiceError depending on the status code.

^ Back to top

Models Classes

AccountingGroupData

The accounting group data.

Properties
Property Type Description Rules
AccountingGroupKey string The accounting group key. Required.
Description string? The accounting group description.
ChartOfAccount string The accounting group chart of account. Required.
ChartOfAccountId string The accounting group chart of account identifier. Required.
ChartOfAccountDescription string? The accounting group chart of account description.
Ledger string The accounting group ledger key. Required.
LedgerId string The accounting group ledger identifier. Required.
LedgerDescription string? The accounting group ledger description.
FinancialCalendar string The accounting group financial calendar key. Required.
FinancialCalendarId string The accounting group financial calendar identifier. Required.
FinancialCalendarDescription string? The accounting group financial calendar description.
ReportingPeriod Primavera.Lithium.RoseCentral.Client.Rest.Models.ReportingPeriod The accounting group reporting period.

^ Back to top

AccountingGroupListResponse

A list of accounting groups.

Properties
Property Type Description Rules
AccountingGroups System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.AccountingGroupData> A list of accounting groups. Required.

^ Back to top

AccountingPostingData

Accounting postings data.

Properties
Property Type Description Rules
Company string The company of the transaction. Required.
FinancialYear string The financial year of the posting. Required.
JournalType string The journal type assigned to the source doc. Required.
SourceDoc string The original document identification. Required.
SourceDocId string The original document ID. Required.

^ Back to top

AccountingPostingListResponse

A list of accounting postings.

Properties
Property Type Description Rules
AccountingPostings System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.AccountingPostingData> A list of accounting postings. Required.

^ Back to top

AddressData

The address data.

Properties
Property Type Description Rules
AddressKey int The key for address.
IsExternallyManaged bool A flag indicating if the address is externally managed.
Country string The country name key. Required.
CountryId string The country identifier. Required.
CountryDescription string The country description. Required.
BuildingNumber string? Building number.
StreetName string? Street name.
CityName string? City name.
PostalZone string? Postal zone.

^ Back to top

AddressListResponse

A list of addresses.

Properties
Property Type Description Rules
Addresses System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.AddressData> A list of economic activity classifications. Required.

^ Back to top

AppDefinitionConfiguration

The app definition configuration.

Properties
Property Type Description Rules
AppDefinitionKey string The app instance definition key. Required.
ClientAppDefinitionKey string The client app instance definition key. Required.
Plan Primavera.Lithium.RoseCentral.Client.Rest.Models.PlanConfiguration The app instance plan.

^ Back to top

AppInfoSelectorData

App information for the selector component.

Properties
Property Type Description Rules
AccountId string The account identifier. Required.
AccountKey string The account key. Required.
Claims string User claim. Required.
Companies System.Collections.Generic.IList<string> List of companies. Required.
SubscriptionAlias string Alias for subscription. Required.
SubscriptionDescription string The subscription description. Required.
SubscriptionId string The subscription unique identifier. Required.
Managers System.Collections.Generic.IList<string> The list of manager user keys. Required.

^ Back to top

AppInstanceAccessBulkData

A list of entities to add or remove access to an user.

Properties
Property Type Description Rules
AppInstanceAccessGroups System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.AppInstanceAccessGroupData> The bulk entity. Required.

^ Back to top

AppInstanceAccessGroupData

A entity to add or remove access to an user.

Properties
Property Type Description Rules
UserKey string The user unique identifier. Required.
ResourceKey string A list of app instances. Required.
Admin bool Indicates wether the user is an admin.

^ Back to top

AppInstanceData

Describes an application instance data.

Properties
Property Type Description Rules
Key string The app instance key. Required.
OrganizationKey string The app instance organization key. Required.
AppDefinitionKey string The app definition key. Required.
Name string? The app instance name.
Group string The application instance group identifier. Required.
Description string The description of the app instance. Required.
SharedKey string The app instance shared key. Required.
State Primavera.Lithium.RoseCentral.Client.Rest.Models.AppInstanceState The app instance state.
Features System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.AppInstanceFeatureData>? The app instance features.
Resources System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.AppInstanceResourceData> The app instance resources. Required.
Version string? The app instance database version.
AccessTags string? The access tags for the instance.

^ Back to top

AppInstanceFeatureData

Describes a feature for an app instance.

Properties
Property Type Description Rules
Key string The feature key. Required.
Value string The feature value. Required.
Class string The feature class. Required.

^ Back to top

AppInstanceInfoData

Describes a unique entity of application instance information data.

Properties
Property Type Description Rules
AppInstance Primavera.Lithium.RoseCentral.Client.Rest.Models.AppInstanceData The application resources application instance. Required.
Organization Primavera.Lithium.RoseCentral.Client.Rest.Models.OrganizationData The application resources organization data. Required.
Workspace Primavera.Lithium.RoseCentral.Client.Rest.Models.WorkspaceData The application resources workspace data. Required.

^ Back to top

AppInstanceInfoListResponse

Describes a list of app instances information.

Properties
Property Type Description Rules
AppInstancesInfo System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.AppInstanceInfoData> The list of app instances information data. Required.

^ Back to top

AppInstanceInviteData

The user app instance data entity containing the info responsible to send invites and give permissions.

Properties
Property Type Description Rules
AppInstanceKey string? The app instance key.
Account string? The app instance account (workspace).
Subscription string? The app instance subscription (organization-appinstance).
Description string? The app instance description.
RoleGroupId int The role group unique identifier.
IsDeleted bool Indicates if permission is to remove.
IsNew bool Indicates if permission is a new one.

^ Back to top

AppInstanceKey

Describes an app instance key.

Properties
Property Type Description Rules
Id string The app instance id. Required.
Description string The app instance description. Required.
Workspace string The app instance workspace property. Required.
Organization string The app instance organization property. Required.
AppInstance string The app instance app instance property. Required.
Name string? The app instance name.
Resources System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.AppInstanceResourceData> The app instance resources property. Required.
State Primavera.Lithium.RoseCentral.Client.Rest.Models.AppInstanceState The app instance state.
Features System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.AppInstanceFeatureData>? The app instance features.
AccessTags string? The access tags for the instance.
AppDefinitionKey string The app instance definition key. Required.

^ Back to top

AppInstanceResourceData

Describes a resource for an app instance.

Properties
Property Type Description Rules
Key string The feature key. Required.
Value string The feature value. Required.
IsProtected bool Defines whether the resource is, or not, protected.

^ Back to top

AppResourcesTreeData

The Application model resources tree data.

Properties
Property Type Description Rules
AppInstances System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.AppInstanceData> The application resources application instances. Required.
Organizations System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.OrganizationData> The application resources organizations data. Required.
Workspaces System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.WorkspaceData> The application resources workspaces data. Required.

^ Back to top

ChartOfAccountData

A Chart of Accounts represents a set of accounts used to record the company's financial transactions.

Properties
Property Type Description Rules
ChartOfAccountsKey string Chart of accounts key. Required.
Description string? A bried description of the entity.
AccountLength int If the accounts have a fixed lengh then set it here, otherwise leave it as 0.
IsAlphanumeric bool Choose whether the accounts can have alphanumeric accounts or not.
HasPurchasesAccounts bool If is true the chart of accounts allows purchases accounts.
TaxonomyClass string? If the chart of accounts is linked to a taxonomy then choose the class. In such case for movement accounts the taxanomy will be mandatory.
TaxonomyClassDescription string? The taxonomy class description.
TaxonomyReference int? The taxonomy reference for SAF-T export process (Portugal).
TaxonomyReferenceDescription string? The taxonomy reference description.

^ Back to top

ChartOfAccountListResponse

A list of chart of accounts.

Properties
Property Type Description Rules
ChartOfAccounts System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.ChartOfAccountData> A list of chart of accounts. Required.

^ Back to top

ClearedTableData

A cleared table information.

Properties
Property Type Description Rules
Table string The table name. Required.
Cleared bool If table was cleared or not.

^ Back to top

ClientAccountingData

The client accounting data.

Properties
Property Type Description Rules
Account string The client accounting account. Required.
Subscription string The client accounting subscription. Required.
ImportSalesUsingSaft bool? If sales import uses SAFT.
PayrollSubscription string The client accounting payroll subscription. Required.
Client string? The client accounting client key.
ClientId string? The client accounting client identifier.
ClientDescription string? The client accounting client description/name.
Status Primavera.Lithium.RoseCentral.Client.Rest.Models.ClientAccountingStatus The client accounting status.
AccountingGroup string The client accounting accounting group key. Required.
AccountingGroupId string The client accounting accounting group identifier. Required.
AccountingGroupDescription string? The client accounting accounting group description.
Responsible string The client accounting responsible key. Required.
ResponsibleId string The client accounting responsible identifier. Required.
ResponsibleDescription string? The client accounting responsible description.
ResponsibleThumbnailImage string? The client accounting responsible thumbnail image.
SaftImportGroup string? The client accounting SAFT import group.
SaftImportGroupId string? The client accounting SAFT import group identifier.
SaftImportGroupDescription string? The client accounting SAFT import group description.
AuthorizedEmails System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.EmailData>? The list of authorized emails.

^ Back to top

ClientAccountingListResponse

A list of client accountings.

Properties
Property Type Description Rules
ClientAccountings System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.ClientAccountingData> A list of client accountings. Required.

^ Back to top

ClosedSubscriptionData

Closed subscription information.

Properties
Property Type Description Rules
Subscription string The subscription key. Required.
Closed bool If subscription was closed or not.

^ Back to top

CloseSubscriptionData

Subscription to be closed information.

Properties
Property Type Description Rules
SubscriptionType Primavera.Lithium.RoseCentral.Client.Rest.Models.SubscriptionType The subscription type.

^ Back to top

CompanyCustomerData

Describes a company customer entity.

Properties
Property Type Description Rules
CreateCustomer bool Indicates whether a customer should be created.
Client string? The client key.
SearchTerm string? The search term.
PartyAccountType string? The type of party for accounting purposes.
IsPerson bool Indicates that this entity is a person.
CustomerSet string? The customer set.
CustomerGroup string? The customer group.

^ Back to top

CompanyData

Describes a company.

Properties
Property Type Description Rules
Account string? The account.
Subscription string? The subscription (based on "BaseKey").
ImportSalesUsingSaft bool If sales import uses SAF-T.
Status Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyStatus The company subscription status.
Client string? The client key.
ClientId string? The client identifier.
ClientDescription string? The client description.
ClientCompanyTaxId string? The client TAX identifier.
Responsible string? The responsible key.
ResponsibleId int The responsible unique identifier.
ResponsibleDescription string? The responsible description.
ResponsibleThumbnailImage string? The path to the responsible thumbnail image.
MyROSE bool If company is the MyROSE one.
CompanySettingsGroupId int? The company settings group identifier.
CompanySettingsGroupKey string? The company settings group key.
CompanySettingsGroupDescription string? The company settings group description.
ReportingPeriod Primavera.Lithium.RoseCentral.Client.Rest.Models.ReportingPeriod The company settings group tax reporting period.
AuthorizedEmails System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.EmailData>? The list of authorized emails.
CompanyId string? The company identification.
CompanyKey string? The associated company key.
CompanyDescription string? The associated company description.
PayrollAccount string? The payroll account.
PayrollSubscription string? The payroll subscription (based on "BaseKey").
HasAccountingPostings bool If company has accounting postings.
SalesImportGroupId int? The sales import group identifier.
SalesImportGroupKey string? The sales import group key.
SalesImportGroupDescription string? The sales import group description.
Saving bool? If record is begin saved.
Logo string? The company logo.
ParentSubscriptionDescription string? The parent subcription description.
DistrictKey string? The district key.
RegionKey string? The region key.
ParishKey string? The parish key.
SubscriptionKey string? The Rose AS app instance key (based on "Key").
PayrollSubscriptionKey string? The Payroll app instance key (based on "Key").

^ Back to top

CompanyDetailsData

Describes a company details entity.

Properties
Property Type Description Rules
Abbreviation string Company abbreviation (key). Required.
Name string The entity description. Required.
CompanyTaxID string The company's tax identifier. Required.
Country string The company's country. Required.
BaseCurrency string The company's base currency. Required.
Telephone string? Telephone number.
TeleFax string? TeleFax number.
Mobile string? Mobile number.
ElectronicMail string? Email adress.
EquityCapital string? Equity capital.
RegistrationOffice string? Registration office.
RegistrationNumber string? Registration number.
BuildingNumber string? Building number.
StreetName string? Street name.
CityName string? City name.
PostalZone string? Postal zone.

^ Back to top

CompanyDraftData

Describes a company draft data (stepper) entity.

Properties
Property Type Description Rules
CompanySettingsGroupId int? The company settings group identifier.
SalesImportGroupId int? The sales import group identifier.
ResponsibleId int The responsible identifier.
User string? The user email.
UserId string? The user identifier.
Logo string? The company logo.
Company Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyData The company information. Required.
CompanyDetails Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyDetailsData The company details. Required.
CompanyCustomer Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyCustomerData? The company customer.
CompanyTaxParameters Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyTaxParametersData The company tax parameters. Required.
CompanyPayrollParameters Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyPayrollParametersData? The company payroll parameters.
CompanyKeyVault Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyKeyVaultData? The company key vault.
Invites Primavera.Lithium.RoseCentral.Client.Rest.Models.UserInviteData? The list of invites.
SaveMode Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanySaveMode? The company save mode.
AccountingState Primavera.Lithium.RoseCentral.Client.Rest.Models.AppInstanceState? The ROSE AS app instance state.
PayrollState Primavera.Lithium.RoseCentral.Client.Rest.Models.AppInstanceState? The ROSE Payroll app instance state.
ChartOfAccount string? The company chart of account (for MyRose creation only).
Ledger string? The company ledger (for MyRose creation only).
FinancialCalendar string? The company financial calendar (for MyRose creation only).
ReportingPeriod Primavera.Lithium.RoseCentral.Client.Rest.Models.ReportingPeriod? The company reporting period (for MyRose creation only).

^ Back to top

CompanyGroupBulkData

Describes a company group bulk data.

Properties
Property Type Description Rules
CompanyGroup System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyGroupData> A list of companies group entities. Required.

^ Back to top

CompanyGroupData

Describes a company group data.

Properties
Property Type Description Rules
CompanyId int The company identifier.
Checked bool If the company is selected or not.
CurrentGroupId int Indicates the current group (sales, purchase, company settings or other) of the entity.
HasAccountingPostings bool If company has accounting postings.
TargetCompany Primavera.Lithium.RoseCentral.Client.Rest.Models.TargetCompanyData The target company data. Required.

^ Back to top

CompanyKeyVaultData

Describes a company key vault entity.

Properties
Property Type Description Rules
AuthorityCommUserName string? Authority comm user name.
AuthorityCommPassword string? Authority comm password.
PlatformAccessInteroperability string? The password of the login that allows the user to communicate with the Seguranca Social.

^ Back to top

CompanyListResponse

A list of companies.

Properties
Property Type Description Rules
Companies System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyData> The list of companies. Required.

^ Back to top

CompanyOperationStatusData

Describes a company initialization operation.

Properties
Property Type Description Rules
OperationDescription string The description of the operation executed. Required.
OperationStatus Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyOperationStatus The company initialization operation status.
OperationType Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyOperationStatusType The company initialization operation type.

^ Back to top

CompanyPayrollParametersData

Describes a company payroll parameters.

Properties
Property Type Description Rules
WorkLocationKey string? The key of the work location.
Name string? The company name of the work location.
NISS string? The niss of tax data work location.
SingleReportCode string? The single report code of tax data work location.
ActivityStartDate System.DateTime? The start activity date of tax data work location.
WorkLocationCode string? The code of tax data work location.
LegalNature string? The legal nature.
EstablishmentDate System.DateTime? The establishment date.
NationalPrivatePercentage decimal? The national private percentage.
NationalPublicPercentage decimal? The national public percentage.
ForeignPercentage decimal? The foreign percentage.
IsHeadQuarter bool? Indicates if the tax data work location is an headquarter.
ActivatePayroll bool? Indicates if payroll subscription is activated.
Location string? The tax jurisdiction service location code.

^ Back to top

CompanySettingsGroupCreateResponse

The company settings group create response model.

Properties
Property Type Description Rules
CompanySettingsGroupId int The new company settings group identifier.
PurchasesImportGroup int The new purchases import group identifier.
PartySettingsGroupId int The new party settings group identifier.

^ Back to top

CompanySettingsGroupData

Describes a company settings group.

Properties
Property Type Description Rules
CompanySettingsGroupKey string The company settings group code. Required.
Description string The company settings group description. Required.
CompanyIdModel int Indicates the company that serves as model in the creation of this entity.
ChartOfAccountId string The chart of account id. Required.
ChartOfAccount string Chart of account code. Required.
ChartOfAccountDescription string? Chart of account description.
LedgerId string? The ledger id.
Ledger string? Ledger code.
LedgerDescription string? Ledger description.
FinancialCalendarId string? The financial calendar id.
FinancialCalendar string? Financial calendar code.
FinancialCalendarDescription string? Financial calendar description.
OpeningJournalTypeId string? The opening journal type id.
OpeningJournalTypeKey string? The opening journal type key.
OpeningJournalTypeDescription string? The opening journal type description.
ClosingJournalTypeId string? The closing journal type id.
ClosingJournalTypeKey string? The closing journal key.
ClosingJournalTypeDescription string? The closing journal description.
BudgetJournalTypeId string? The budget journal type id.
BudgetJournalTypeKey string? The budget journal type key.
BudgetJournalTypeDescription string? The budget journal type description.
TaxSettlementJournalTypeId string? The tax settlement journal type id.
TaxSettlementJournalTypeKey string? The tax settlement journal type key.
TaxSettlementJournalTypeDescription string? The tax settlement journal type description.
DepositSlipJournalTypeId string? The deposit slip journal type id.
DepositSlipJournalTypeKey string? The deposit slip journal type key.
DepositSlipJournalTypeDescription string? The deposit slip journal type description.
CurrentBudgetLedgerId string? The current budget ledger id.
CurrentBudgetLedgerKey string? The current budget ledger key.
CurrentBudgetLedgerDescription string? The current budget ledger description.
NegativePostingAllowed bool Indicates if negative posting allowed.
NegativeReversal bool Indicates if is negative reversal.
IsDefaultModel bool Indicates if this entity is the default entity.
IsSystem bool Identifies if entiy is system base.
ReportingPeriod Primavera.Lithium.RoseCentral.Client.Rest.Models.ReportingPeriod The tax reporting period.
Status Primavera.Lithium.RoseCentral.Client.Rest.Models.EntityStatus Reference to the creation status.
PayrollJournalTypeId string? Payroll journal type id.
PayrollJournalTypeKey string? Payroll journal type key.
PayrollJournalTypeDescription string? Payroll journal type description.
NonWorkingDaysId string? Non working days id.
NonWorkingDaysKey string? Non working days key.
NonWorkingDaysDescription string? Non working days description.
ScheduleId string? Schedule id.
ScheduleDescription string? Schedule description.
ScheduleKey string? Schedule key.
JournalTypeDriId string? Journal type DRi id.
JournalTypeDriKey string? Journal type DRi key.
JournalTypeDriDescription string? Journal type DRi description.
GLAccountEmployerId string? Gl account employer id.
GLAccountEmployerKey string? Gl account employer key.
GLAccountEmployerDescription string? Gl account employer description.
GLAccountChargeId string? GL account charge id.
GLAccountChargeKey string? GL account charge key.
GLAccountChargeDescription string? GL account charge description.
PaymentMethodId string? Payment method id.
PaymentMethodKey string? Payment method key.
PaymentMethodDescription string? Payment method description.
PaymentTermId string? Payment term id.
PaymentTermKey string? Payment term key.
PaymentTermDescription string? Payment term description.
CreateGLAccounts bool Indicates if gl accounts should be created.
UpdateConfigurations bool? Indicates if configurations should be updated on a new subscription.

^ Back to top

CompanySettingsGroupEntitiesData

The company settings group and all related entities.

Properties
Property Type Description Rules
CompanySettingsGroup Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanySettingsGroupData The company settings group. Required.
PurchasesImportGroup Primavera.Lithium.RoseCentral.Client.Rest.Models.PurchasesImportGroupData The purchases import group. Required.
PartySettingsGroup Primavera.Lithium.RoseCentral.Client.Rest.Models.PartySettingsGroupData The party settings group. Required.

^ Back to top

CompanySettingsGroupListResponse

List of company settings group.

Properties
Property Type Description Rules
CompanySettingsGroups System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanySettingsGroupData> List of company settings group. Required.

^ Back to top

CompanyTaxParametersData

Describes a company tax parameters.

Properties
Property Type Description Rules
LegalRepresentativeId string? The tax id of the legal representative.
TechnicalAccountantId string? The tax id of technical account.
TaxRegionalArea string The tax regional area indicates the region where the company take place. Required.
FiscalTimeZone string The timezone of the company. Required.
EconomicActivityClassification string? The CEA's company. A national legal standard that attributes a 5-digit value to identify a company's specific category of professional activity.
EconomicActivityClassificationDescription string? The CEA's company description.
TaxJurisdictionService string? The tax jurisdiction service.
TaxReportingPeriods System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyTaxParametersTaxReportingPeriodData>? The reporting periods for the tax classes.

^ Back to top

CompanyTaxParametersTaxReportingPeriodData

The reporting periods for the company tax setup.

Properties
Property Type Description Rules
TaxClass string Tax class. Required.
ReportingPeriod Primavera.Lithium.RoseCentral.Client.Rest.Models.ReportingPeriod The reporting period.
PublicAuthority string Public authority designation. Required.
Index int The item index on list.

^ Back to top

ConfigurationEntityInsurersData

Configuration insurers entity.

Properties
Property Type Description Rules
Party string Party key. Required.
PartyId string The party id. Required.
PartyDescription string The party description. Required.
SEGCode string SEG code key. Required.
IncludeZeroLines bool? Include zero lines.
ConfigurationModuleId string The configuration module id. Required.
Index int The index number.

^ Back to top

ConfigurationEntitySyndicatesData

Configuration syndicate entity.

Properties
Property Type Description Rules
Party string Party key. Required.
PartyId string The party id. Required.
PartyDescription string The party description. Required.
ConfigurationModuleId string The configuration module id. Required.
Index int The index number.

^ Back to top

ConfigurationModuleData

Payroll configuration module.

Properties
Property Type Description Rules
Company string The company key. Required.
CompanyId string The company id. Required.
CompanyDescription string The company description. Required.
AtTaxJurisdictionService string? At tax jurisdiction service.
ChartOfAccount string? Chart of account key.
ChartOfAccountId string? Chart of account id.
ChartOfAccountDescription string? Chart of account description.
GLAccountCharge string? GL account charge key.
GLAccountChargeId string? GL account charge id.
GLAccountChargeDescription string? GL account charge description.
GLAccountEmployer string? GL account employer key.
GLAccountEmployerId string? GL account employer id.
GLAccountEmployerDescription string? GL account employer description.
JournalType string? Journal type key.
JournalTypeId string? Journal type id.
JournalTypeDescription string? Journal type description.
AtParty string? At party key.
AtPartyId string? At party id.
AtPartyDescription string? At party description.
SegSocParty string? Seg soc party key.
SegSocPartyId string? Seg soc party id.
SegSocPartyDescription string? Seg soc party description.
SegSocPaymentMethod string? Seg soc payment method key.
SegSocPaymentMethodId string? Seg soc payment method id.
SegSocPaymentMethodDescription string? Seg soc payment method description.
SegSocPaymentTerm string? Seg soc payment term key.
SegSocPaymentTermId string? Seg soc payment term id.
SegSocPaymentTermDescription string? Seg soc payment term description.
PlatformAccessInteroperability string? The password of the login that allows the user to communicate with the Seguranca Social.
HiringReasonsClassifications System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.HiringReasonClassificationData>? A list of hiring reasons classifications.
ConfigurationEntitySyndicates System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.ConfigurationEntitySyndicatesData>? Configuration Entity Syndicates.
ConfigurationEntityInsurers System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.ConfigurationEntityInsurersData>? List of configuration entity insurers.
LegalNature string? The legal nature.
EstablishmentDate System.DateTime? The establishment date.
NationalPrivatePercentage decimal? The national private percentage.
NationalPublicPercentage decimal? The national public percentage.
ForeignPercentage decimal? The foreign percentage.

^ Back to top

ContactData

The contact data.

Properties
Property Type Description Rules
FileNumber int The contact's file number.
Name string The contact’s name. Required.
ContactType string The contact's type. Required.
ContactTypeDescription string? The contact's type description.
ContactTypeId string? The contact's type identifier.
Culture string The contact's culture. Required.
CultureDescription string? The contact's description.
CultureId string? The contact's identifier.
Greeting string? The contact's greeting.
JobTitle string? The contact's job title.
Title string? Mr., Mrs., Miss...
FirstName string? The contact’s first name.
MiddleName string? The contact’s middle name.
LastName string? The contact’s last name.
ElectronicMail string? The contact’s electronic mail.
WebsiteUrl string? The contact’s website page.
BusinessTelephone string? The contact’s business telephone.
HomeTelephone string? The contact’s home telephone.
Mobile string? The contact’s mobile.
Facebook string? The contact’s facebook page.
LinkedIn string? The contact’s linkedIn page.
Notes string? The contact’s notes.
Picture string? The contact’s picture.
BirthDate System.DateTime? The contact’s birth date.
StreetName string? The contact’s street name.
BuildingNumber string? The contact’s house number.
CityName string? The contact’s city name.
PostalZone string? The contact’s postal code.
Country string? The contact’s country name.
CountryDescription string? The contact’s country description.
CountryId string? The contact’s country identifier.
Address string? The contact’s address.
AddressDescription string? The contact’s address description.
AddressId string? The contact’s address identifier.
MaritalStatus Primavera.Lithium.RoseCentral.Client.Rest.Models.MaritalStatus? The contact’s marital status.
PartyId string? The party identifier.
BelongsToParty bool? If contact belongs to party.
Salutation Primavera.Lithium.RoseCentral.Client.Rest.Models.Salutation? The contact's greeting.

^ Back to top

ContactListResponse

A list of contacts.

Properties
Property Type Description Rules
Contacts System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.ContactData> A list of economic activity classifications. Required.

^ Back to top

ContextItem

Defines the notification context item.

Properties
Property Type Description Rules
Key string The context item key. Required.
Value string The context item value. Required.

^ Back to top

CountryData

The country data.

Properties
Property Type Description Rules
CountryKey string The key for the country. Required.
Name string The country's name. Required.
EU bool EU member.
IsExternallyManaged bool Is externally managed.
Culture string The country’s culture. Required.
CallingCode string The country’s calling code. Required.
NumberFormat string The country’s number format. Required.
AddressFormat string? The country’s address format.
ExternalId string? The country’s external identifier.
DateFormat Primavera.Lithium.RoseCentral.Client.Rest.Models.DateFormat? The country’s date format.
BankAccountMinLength int? The Bank Account Min Length.
BankAccountMaxLength int? The Bank Account Max Length.
PostalCodeMinLength int? The Postal Code Min Length.
PostalCodeMaxLength int? The Postal Code Max Length.
CompanyTaxIdMinLength int? The Company Tax ID Min Length.
CompanyTaxIdMaxLength int? The Company Tax ID Max Length.

^ Back to top

CountryListResponse

A list of countries.

Properties
Property Type Description Rules
Countries System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.CountryData> A list of countries. Required.

^ Back to top

CreateCompanyRequest

Describes the necessary information to create a company.

Properties
Property Type Description Rules
CreateAppInstances bool Defines if the app instances should be created with the company.
Company Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyDraftData The company that should be created. Required.

^ Back to top

CultureData

Describes a culture entity.

Properties
Property Type Description Rules
CultureKey string The culture key. Required.
Name string The culture name. Required.

^ Back to top

CultureListResponse

Describes a list of cultures entity.

Properties
Property Type Description Rules
Cultures System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.CultureData> The list of cultures. Required.

^ Back to top

CurrencyData

The currency data.

Properties
Property Type Description Rules
CurrencyKey string The currency's logical key. Required.
Description string The description for the currency. Required.
FractionDigits int The number of digits used to represent fraction values.
CurrencyUnit string The currency main unit (e.g. Euro). Required.
IsoCode string The ISO standard currency code. Required.
Symbol string The symbol used to represent values in the currency (e.g. $). Required.
IsExternallyManaged bool A flag indicating if the currency is externally managed.
CurrencySubUnit string? The currency sub unit (e.g. Cent).
ValidFrom System.DateTime? The start date for validity period.
ValidTo System.DateTime? The end date for validity period.
UseFixedRate byte[] Use Fixed Rate. Required.
ConversionFactor decimal? The Conversion Factor.
PricesFractionDigits int? The explicit number of digits used to represent fraction values in Prices.
ExternalId string? The external identifier.
ExternalVersion string? The external version.
FixedRateReferenceCurrency string? The Fixed Rate Reference Currency.
CurrencyRates System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.CurrencyRateDate>? The Currency Rates.

^ Back to top

CurrencyListResponse

A list of currencies.

Properties
Property Type Description Rules
Currencies System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.CurrencyData> A list of currencies. Required.

^ Back to top

CurrencyRateDate

The currency rate entity.

Properties
Property Type Description Rules
TargetCurrency string The Target Currency. Required.
Rate string The actua rate. Required.

^ Back to top

CustomerGroupData

The Customer Group represents an aggregation of suppliers that are similar in some way.

Properties
Property Type Description Rules
CustomerGroupKey string The item key. Required.
IsDefault bool If is default.
Description string? The description of the customer group.
PaymentMethod string? The financial transfer method used by the entity responsible for paying a transaction.
PaymentMethodId string? The financial transfer method used by the entity responsible for paying a transaction.
PaymentMethodDescription string? The financial transfer method used by the entity responsible for paying a transaction.
PaymentTerm string? Specify the manner in which a trade will be done. Generally, these terms specify a period in which the buyer can pay the due amount.
PaymentTermId string? Specify the manner in which a trade will be done. Generally, these terms specify a period in which the buyer can pay the due amount.
PaymentTermDescription string? Specify the manner in which a trade will be done. Generally, these terms specify a period in which the buyer can pay the due amount.
PartyTaxSchema string? The tax schema identifies the group of taxes a party is liable for. The tax schema is defined in the customer party.
PartyTaxSchemaId string? The tax schema identifies the group of taxes a party is liable for. The tax schema is defined in the customer party.
PartyTaxSchemaDescription string? The tax schema identifies the group of taxes a party is liable for. The tax schema is defined in the customer party.
PartyWithholdingTaxSchema string? The withholding tax schema identifies the group of withholding taxes a party is liable for. The withholding tax schema is defined in the customer party.
PartyWithholdingTaxSchemaId string? The withholding tax schema identifies the group of withholding taxes a party is liable for. The withholding tax schema is defined in the customer party.
PartyWithholdingTaxSchemaDescription string? The withholding tax schema identifies the group of withholding taxes a party is liable for. The withholding tax schema is defined in the customer party.
DeliveryTerm string? The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the customer party.
DeliveryTermId string? The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the customer party.
DeliveryTermDescription string? The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the customer party.
PriceList string? The catalogued table values that sets the standard price for the products and goods traded by a specific entity. The default is inferred from the customer party if defined, otherwise from the sales setup.
PriceListId string? The catalogued table values that sets the standard price for the products and goods traded by a specific entity. The default is inferred from the customer party if defined, otherwise from the sales setup.
PriceListDescription string? The catalogued table values that sets the standard price for the products and goods traded by a specific entity. The default is inferred from the customer party if defined, otherwise from the sales setup.
DeliveryMode string? The Delivery mode. (ex: mail).
DeliveryModeId string? The Delivery mode. (ex: mail).
DeliveryModeDescription string? The Delivery mode. (ex: mail).
SettlementDiscountPercent decimal? The settlement's discount percentage.

^ Back to top

CustomerGroupListResponse

A list of customer groups.

Properties
Property Type Description Rules
CustomerGroups System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.CustomerGroupData> A list of customer sets. Required.

^ Back to top

CustomerPartyData

The Customer Party represents a consumer of the service or product that your company offers (extends Party entity).

Properties
Property Type Description Rules
CustomerGroup string The customer's party customer group. Required.
CustomerGroupId string? Customer group id.
CustomerGroupDescription string? Customer group description.
PaymentMethod string The financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. Required.
PaymentMethodId string Payment method id. Required.
PaymentMethodDescription string Payment method description. Required.
PaymentTerm string Specify the away in which a trade will be done. Generally these terms specify a period in which the buyer can pay the due amount. Required.
PaymentTermId string Payment term id. Required.
PaymentTermDescription string Payment term description. Required.
PartyTaxSchema string The tax schema identifies the group of taxes a party is liable for. The tax schema is defined in the customer party. Required.
PartyTaxSchemaId string Party tax schema id. Required.
PartyTaxSchemaDescription string Party tax schema description. Required.
Locked bool Indicates whether the customer party is locked.
AccountingSchema Primavera.Lithium.RoseCentral.Client.Rest.Models.AccountingSchema The type of accounting schema is used by the customer: 1 - Accrual; 2 - Cash.
AccountingSchemaDescription string Accounting schema description. Required.
EndCustomer bool Specify if the customer is an end customer or not.
CustomerSet string Customer set. Required.
CustomerSetId string Customer set id. Required.
CustomerSetDescription string Customer set description. Required.
PriceList string? The catalogued table values that sets the standard price for the products and goods traded by a specific entity. The default is inferred from the customer party if defined, otherwise from the sales setup.
PriceListId string? The catalogued table values that sets the standard price for the products and goods traded by a specific entity. The default is inferred from the customer party if defined, otherwise from the sales setup.
PriceListDescription string? The catalogued table values that sets the standard price for the products and goods traded by a specific entity. The default is inferred from the customer party if defined, otherwise from the sales setup.
DeliveryMode string? The Delivery mode. (ex: mail).
DeliveryModeId string? The Delivery mode. (ex: mail).
DeliveryModeDescription string? The Delivery mode. (ex: mail).
SettlementDiscountPercent decimal? The settlement's discount percentage.
PartyWithholdingTaxSchema string? The withholding tax schema identifies the group of withholding taxes a party is liable for. The withholding tax schema is defined in the customer party.
PartyWithholdingTaxSchemaId string? The withholding tax schema identifies the group of withholding taxes a party is liable for. The withholding tax schema is defined in the customer party.
PartyWithholdingTaxSchemaDescription string? The withholding tax schema identifies the group of withholding taxes a party is liable for. The withholding tax schema is defined in the customer party.
DeliveryTerm string? The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the customer party.
DeliveryTermId string? The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the customer party.
DeliveryTermDescription string? The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the customer party.
AccountingParty string? The accounting party.
AccountingPartyId string? The accounting identifier.
AccountingPartyDescription string? The accounting party description.

^ Back to top

CustomerPartyListResponse

A list of customers.

Properties
Property Type Description Rules
Customers System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.CustomerPartyData> A list of items. Required.

^ Back to top

CustomerPostingProfileData

The Customer Posting Profile represents a way to discover the customer account in the company chart of account.

Properties
Property Type Description Rules
PostingCustomerProfileKey string The posting profile key. Required.
Description string? The description of the posting profile.
CustomerPostProfileAccounts System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.CustomerPostProfileAccountData>? The list of customer posting profile accounts.

^ Back to top

CustomerPostingProfileListResponse

A list of items.

Properties
Property Type Description Rules
CustomerPostingProfiles System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.CustomerPostingProfileData> A list of items. Required.

^ Back to top

CustomerPostProfileAccountData

The Customer Posting Profile represents a way to discover the customer account in the company chart of account.

Properties
Property Type Description Rules
ChartOfAccount string The chart of accounts. Required.
ChartOfAccountId string The chart of accounts identifier. Required.
GlAccount string? The tax GL account for the chart of accounts and fiscal memo reason.
PartyAccountType string The party account type. Required.
PartyTaxSchema string The party tax schema (optional). Required.

^ Back to top

CustomerSetCompanyData

The customer set company data.

Properties
Property Type Description Rules
CustomerSetId string Customer set id. Required.
Company string The company key. Required.
CompanyId string The company id. Required.
CompanyDescription string The company description. Required.
Index int The index.

^ Back to top

CustomerSetData

The Customer Set represents a company container where customers are grouped. A customer can belong to a company or to several.

Properties
Property Type Description Rules
CustomerSetKey string The item key. Required.
IsDefault bool If is default.
Description string? The description of the customer set.
CustomerSetCompanies System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.CustomerSetCompanyData> The companies that can use this customer set. Required.

^ Back to top

CustomerSetListResponse

A list of customer sets.

Properties
Property Type Description Rules
CustomerSets System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.CustomerSetData> A list of customer sets. Required.

^ Back to top

DataCatalogCaeData

The data catalog cae entity.

Properties
Property Type Description Rules
Country string The country key. Required.
Key string The entity key. Required.
Description string A small description. Required.

^ Back to top

DataCatalogCaeListResponse

The cae list response object.

Properties
Property Type Description Rules
Caes System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.DataCatalogCaeData> The list of CAEs. Required.

^ Back to top

DataCatalogCountryData

The data catalog country entity.

Properties
Property Type Description Rules
Key string The entity key. Required.
Name string? The country name.
Currency string? The currency key.
IsoAlpha2 string? Iso alpha 2.
IsoAlpha3 string? Iso alpha 3.
IsoNumeric string? Iso numeric value.
FipsCode string? The fips value.

^ Back to top

DataCatalogCountryListResponse

The country list response object.

Properties
Property Type Description Rules
Countries System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.DataCatalogCountryData> The list of countries. Required.

^ Back to top

DataCatalogCurrencyData

The data catalog currency entity.

Properties
Property Type Description Rules
Key string The entity key. Required.
IsoCode string? Iso code value.
IsoCodeNum string? Iso code number.
CurrencyName string? Currency name.
CurrencyDescription string? Currency description.
SymbolNative string? Symbol native.
Symbol string? The currency symbol.
DecimalDigits string? Decimal digits.
Rounding string? Rounding number.

^ Back to top

DataCatalogCurrencyListResponse

The currency list response object.

Properties
Property Type Description Rules
Currencies System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.DataCatalogCurrencyData> The list of currencies. Required.

^ Back to top

DataCatalogDistrictData

The data catalog district entity.

Properties
Property Type Description Rules
Key string The entity key. Required.
Name string? The district name.

^ Back to top

DataCatalogDistrictListResponse

The district list response object.

Properties
Property Type Description Rules
Districts System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.DataCatalogDistrictData> The list of districts. Required.

^ Back to top

DataCatalogParishData

The data catalog parish entity.

Properties
Property Type Description Rules
Key string The entity key. Required.
Name string? The parish name.

^ Back to top

DataCatalogParishListResponse

The parishes list response object.

Properties
Property Type Description Rules
Parishes System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.DataCatalogParishData> The list of districts. Required.

^ Back to top

DataCatalogPostalCodeData

The data catalog postal code entity.

Properties
Property Type Description Rules
Key string The entity key. Required.
DistrictKey string? The district key.
DistrictName string? The district name.
RegionKey string? The region key.
RegionName string? The region name.

^ Back to top

DataCatalogRegionData

The data catalog region entity.

Properties
Property Type Description Rules
Key string The entity key. Required.
Name string? The region name.

^ Back to top

DataCatalogRegionListResponse

The region list response object.

Properties
Property Type Description Rules
Regions System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.DataCatalogRegionData> The list of regions. Required.

^ Back to top

DataCatalogTaxJurisdictionServiceData

The data catalog tax jurisdiction service entity.

Properties
Property Type Description Rules
Key string The entity key. Required.
Name string? The tax jurisdiction service name.

^ Back to top

DataCatalogTaxJurisdictionServiceListResponse

The tax jurisdiction services list response object.

Properties
Property Type Description Rules
TaxJurisdictionsServices System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.DataCatalogTaxJurisdictionServiceData> The list of tax jurisdiction services. Required.

^ Back to top

DocumentTypeSeriesData

The document type series data.

Properties
Property Type Description Rules
NumberOfCopies int The number of copies of the document to print.
IsDefault bool Indicates if this is the default serie for the document.
TaxIncluded bool When checked, the document unit prices will include taxes.
IsManual bool When checked, the memo type series is defined as manual. Internally determined.
IsExternal bool When checked, the memo type series is defined as external. Internally determined.
Serie string The range of identification values that group a set of product entities or objects. Required.
CommunicationType Primavera.Lithium.RoseCentral.Client.Rest.Models.CommunicationType The type of comunication to be used. This is applicable only to Portuguese companies.
EconomicActivityClass string? Indicates the company's activity.

^ Back to top

EconomicActivityClassificationData

The Economic Activity Classification represents the company's activity sector.

Properties
Property Type Description Rules
EconomicActivityKey string The economic activity code key. Required.
Description string The EAC's description. EAC is a portuguese legal standard that attributes a 5-digit value to identify a company's specific category of professional activity. Required.

^ Back to top

EconomicActivityClassificationListResponse

A list of economic activity classifications.

Properties
Property Type Description Rules
EconomicActivityClassifications System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.EconomicActivityClassificationData> A list of economic activity classifications. Required.

^ Back to top

EmailData

Describes an email.

Properties
Property Type Description Rules
Email string The email address. Required.
Description string A brief description of the entity. Required.
ManagementReport bool? Indicates if the entity can be included in the management report.

^ Back to top

EntityBase

Describes an entity base model.

Properties
Property Type Description Rules
Id int The entity unique identifier.

^ Back to top

EntityBaseResponse

Common entity base response.

Properties
Property Type Description Rules
Response string A string basic response. Required.

^ Back to top

EntitySystemData

The system data for a particular entity.

Properties
Property Type Description Rules
CreatedBy string The user that created the entity. Required.
CreatedOn System.DateTime The date and time the entity was created on.
ModifiedBy string The user that performed the last modification on the entity. Required.
ModifiedOn System.DateTime The date and time of the last modification of the entity.
Version System.Guid The version of the entity.

^ Back to top

EventLogData

Event log entity.

Properties
Property Type Description Rules
Code string The event log entry code. Required.
SourceSchemaEntity Primavera.Lithium.RoseCentral.Client.Rest.Models.SourceSchemaEntity? The rose central entity schema that envoked the event.
SourceId string? The rose central entity id that originated the log creation.
SourceKey string? The source key.
DestinySchemaEntity Primavera.Lithium.RoseCentral.Client.Rest.Models.DestinySchemaEntity? The entity schema that originated the event.
DestinyId string? The entity id that originated the log creation.
Date System.DateTime The date of the event.
Company string? The company related to the event.
User string The user that fired the event. Required.
UserId string The user identifier. Required.
Message System.Collections.Generic.IList<string> A list of messages. Required.
FriendlyMessage string? An user friendly message to show.
Account string The account parameter. Required.
Subscription string The subscription parameter. Required.
EventLevel Primavera.Lithium.RoseCentral.Client.Rest.Models.EventLevel The log level is state of the log (0 - Information, 1 - Warning, 2 - Error).
IsSystem bool Indicates if message is for debuging purpose only.

^ Back to top

EventLogListResponse

Event log list response.

Properties
Property Type Description Rules
EventsLog System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.EventLogData> A list of event log entries. Required.

^ Back to top

FinancialAccountData

The Financial Account represents accounts of type petty cash and bank account.

Properties
Property Type Description Rules
FinancialAccountKey string The item key. Required.
Description string? The description of the financial account.
AccountNumber string? The account number.
IBAN string? The finacial account's International Bank Account Number.
SWIFT string? The society for Worldwide Interbank Financial Telecommunication number.
Branch string? The branch property.
ValidFrom System.DateTime? The valid from property.
ValidTo System.DateTime? The valid to property.
Responsible string? The responsible property.
CreditorReference string? Reference used for direct debit payment or for bank charges.
PartyCode string? The party code property.
Company string? The company property.
CompanyId string? The company id property.
CompanyDescription string? The company description property.
Country string? The country.
CountryId string? The country id.
CountryDescription string? The country description.
GLAccount string? The GL account of the financial account. Must be from subledger financial accoutns.
GLAccountId string? The GLAccount id property.
GLAccountDescription string? The GLAccount description property.
ChartOfAccount string? The chart of account property.
ChartOfAccountId string? The chart of account id property.
ChartOfAccountDescription string? The chart of account description property.
FinancialAccountType Primavera.Lithium.RoseCentral.Client.Rest.Models.FinancialAccountType The type of account: petty cash or bank account.
FinancialAccountTypeDescription string? The financial account type description property.
FinancialInstitution string? The financial insitution.
FinancialInstitutionId string? The financial institution id.
FinancialInstitutionDescription string? The financial institution description.

^ Back to top

FinancialAccountDeterminationData

The Financial Account Determination represents a general ledger accounts configuration for a chart of account.

Properties
Property Type Description Rules
ChartOfAccount string The chart of accounts. Required.
RoundingGainAccount string The account to be used when occurs a gain in rounding from the settlement process. Required.
RoundingLossAccount string The account to be used when occurs a loss in rounding from the settlement process. Required.
DiscountGivenAccount string The account to be used when the user gives a discount to a customer in the settlement process. Required.
DiscountReceivedAccount string The account to be used when the user receives a discount from a vendor in the settlement process. Required.
ExchRateGainAccount string The account to be used when occurs a gain in exchange rates differences from the settlement process. Required.
ExchRateLossAccount string The account to be used when occurs a loss in exchange rates differences from the settlement process. Required.
YTDNetIncomeAccount string The year to date net income account. Required.
RetainedEarningsAccount string The retained earnings account to be used in the year end process. Required.
AssetAquisitionClearingAccount string? Asset Aquisition Clearing Account.
AssetSaleClearingAccount string? Asset Sale Clearing Account.

^ Back to top

FinancialAccountDeterminationListResponse

A list of items.

Properties
Property Type Description Rules
FinancialAccountDeterminations System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.FinancialAccountDeterminationData> A list of items. Required.

^ Back to top

FinancialAccountListResponse

A list of customer groups.

Properties
Property Type Description Rules
FinancialAccounts System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.FinancialAccountData> A list of financial accounts. Required.

^ Back to top

FinancialCalendarData

The Financial Calendar is used to record information about the financial calendar. The financial calendar consists of twelve operating periods (1-12 represent a calendar month), one opening period (same month as the first period) and up to three closing periods (same month as period 12).

Properties
Property Type Description Rules
CalendarKey string The financial calendar key. Required.
NumberOfClosingPeriods int The number of closing periods.
EndMonth Primavera.Lithium.RoseCentral.Client.Rest.Models.Month The last month of the financial calendar.
EndMonthDescription string The last month desciption of the financial calendar. Required.
Description string? The entity description.
FinancialYearOffset int? The offset of the financial year. Choose if the the company works on the next year at the begining of the financial year or at the previous year at the end of the financial year. Only available if the end month is not december.
FinancialYearOffsetDescription string? The financial calendar year offset description.
FinancialPeriods System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.FinancialPeriod>? The financial calendar periods.

^ Back to top

FinancialCalendarListResponse

Financial calendar list response.

Properties
Property Type Description Rules
FinancialCalendars System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.FinancialCalendarData> A list of financial calendars. Required.

^ Back to top

FinancialConditionData

The Company Financial Condition represents a company with financial and tax information like chart of accounts, ledger and others.

Properties
Property Type Description Rules
CompanyKey string Entity key. Required.
Name string The entity description. Required.
CompanyTaxID string The company's tax identifier. Required.
Country string The company's country. Required.
CountryId string Country id. Required.
CountryDescription string? Country description.
BaseCurrency string The company's base currency. Required.
BaseCurrencyId string Base currency id. Required.
BaseCurrencyDescription string? Base currency description.
IsExternal bool? Is external.
ShowExchangeRateReversed bool? Indicates wheter the exchange rate for the base currency is presented with reversed logic.
SearchTerm string? Search term.
Telephone string? Telephone number.
TeleFax string? TeleFax number.
Mobile string? Mobilçe number.
ElectronicMail string? Email adress.
EquityCapital string? The equity capital is defined as the amount of capital provided by the company's owner(s).
RegistrationOffice string? Registration office.
RegistrationNumber string? Registration number.
BuildingNumber string? Building number.
StreetName string? Street name.
CityName string? City name.
PostalZone string? Postal zone.
Address string Address of company. Required.
Logo string? Company's adress.
ForceFromOrganizationConfiguration bool? Force from organization configuration.
CompanyRegistrationData string Company registration data. Required.
ChartOfAccount string The chart of account the company will be used on creation of the company. Required.
ChartOfAccountId string The accounting group chart of account identifier. Required.
ChartOfAccountDescription string? The accounting group chart of account description.
Ledger string The ledger the company will be used on creation of the company. Required.
LedgerId string The accounting group ledger identifier. Required.
LedgerDescription string? The accounting group ledger description.
FinancialCalendar string The financial calendar the company will be used on creation of the company. Required.
FinancialCalendarId string The accounting group financial calendar identifier. Required.
FinancialCalendarDescription string? The accounting group financial calendar description.
ReportingPeriod Primavera.Lithium.RoseCentral.Client.Rest.Models.ReportingPeriod The reporting period the company will be used on creation of the company.

^ Back to top

FinancialPeriod

A financial calendar period.

Properties
Property Type Description Rules
Period int The period number.
Name string The name of the period. Required.
PeriodType Primavera.Lithium.RoseCentral.Client.Rest.Models.PeriodType The period type (opening, regular, closing).
CalendarMonth Primavera.Lithium.RoseCentral.Client.Rest.Models.Month The calendar month.

^ Back to top

FinancialSetupData

The Financial Setup is used to manage default values for each company, such as the default reciept type or default payment type.

Properties
Property Type Description Rules
Company string The associated setup company key. Required.
CompanyDescription string? The associated setup company description.
ChartOfAccount string? The chart of accounts to be used.
ChartOfAccountDescription string? The chart of accounts description.
GeneralLedger string The default ledger to be used. Required.
GeneralLedgerDescription string? The default ledger description.
FinancialCalendar string? The financial calendar.
FinancialCalendarDescription string? The financial calendar description.
IsNegativePostingAllowed bool Select if negative postings can be used in the journal entry postings.
IsNegativeReversal bool When the journal entry is transformed on reversal the amounts of credit and debit become negative otherwise the debit swap with credit and the credit with debit.
JournalDefaultPostingDate int The journal default posting date define the date of journal entry.
JournalDefaultPostingDateDescription string? The journal default posting date description.
CurrentBudgetLedger string? The current budget ledger to be used for the dashboards process.
CurrentBudgetLedgerDescription string? The current budget ledger description.
EInvoiceCreateParties bool If true the import invoice will create party and associate to the journal entry otherwise uses the one time party.
EInvoicePartyCreationKey int This value list indicate if we want the company tax id or autonumber for the party key.
EInvoicePartyCreationKeyDescription string? This eVoice party creation description.
DefaultReceiptType string? The default receipt's type to be used.
DefaultReceiptTypeDescription string? The default receipt's type description.
DefaultPaymentType string? The default payment’s type to be used.
DefaultPaymentTypeDescription string? The default payment’s type description.
DefaultCreditCashFlowItem string? The default cash flow item’s to be used.
DefaultCreditCashFlowItemDescription string? The default cash flow item’s description.
DefaultDebitCashFlowItem string? The default cash flow item’s to be used for debit movements.
DefaultDebitCashFlowItemDescription string? The default cash flow item’s description.
DefaultBankAccountType string? The default bank account type.
DefaultBankAccountTypeDescription string? The default bank account type description.
BudgetJournalType string? The journal type to be used for the budget process.
BudgetJournalTypeDescription string? The budget journal type description.
OpeningJournalType string? The opening journal type.
OpeningJournalTypeDescription string? The opening journal type description.
TaxSettlementJournalType string? The journal type to be used for the tax settlement process.
TaxSettlementJournalTypeDescription string? The tax settlement journal type description.
DepositSlipJournalType string? The journal type to be used for the deposit slip process.
DepositSlipJournalTypeDescription string? The deposit slip journal type description.
DefaultPaymentMethodPettyCash string? The default payment method petty cash is used on journal entry for load the payment method when the general ledger sub account type is PettyCashes.
DefaultPaymentMethodPettyCashDescription string? The default payment method petty cash description.
DefaultPaymentMethodBankAcc string? The default payment method bank acc is used on journal entry for load the payment method when the general ledger sub account type is FinancialAccounts.
DefaultPaymentMethodBankAccDescription string? The default payment method for bank accounts description.
EInvoiceJournalType string? The journal type to be used for the EInvoice process.
EInvoiceJournalTypeDescription string? The EInvoice journal type description.
EInvoiceSupplierAccount string? The general ledger account to be used for the EInvoice process.
EInvoiceSupplierAccountDescription string? The EInvoice supplier account description.
EInvoiceParty string? The one time party to be used for the EInvoice process.
EInvoicePartyDescription string? The EInvoice party description.
ClosingJournalType string? The journal type to be used for the closing financial year process.
ClosingJournalTypeDescription string? The closing journal type description.

^ Back to top

FinancialStatementAccountData

Financial statement account entity.

Properties
Property Type Description Rules
GLAccount string The GL account. Required.
Credit bool Use the credit balance of the account.
Debit bool Use the debit balance of the account.
ChartOfAccount string The chart of accounts. Required.
ChartOfAccountId string The chart of accounts identifier. Required.
InvertSign bool Select this if the balance values are to be inversed (credit - debit insted of debit - credit).

^ Back to top

FinancialStatementData

The Financial Statements is used to map financial operations (eg balance sheet or profit and loss) that can be viewed in a financial statement report or financial statement by dimension.

Properties
Property Type Description Rules
FinancialStatementKey string The financial statement key. Required.
ChartOfAccount string The chart of accounts. Required.
Purpose Primavera.Lithium.RoseCentral.Client.Rest.Models.FinancialStatementPurpose The purpose of the financial statement (balance sheet or profit and loss).
Description string? The description of the financial statement.
FinancialStatementItems System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.FinancialStatementItemData>? The list of financial statement items.

^ Back to top

FinancialStatementItemData

Financial statement item entity.

Properties
Property Type Description Rules
ItemType Primavera.Lithium.RoseCentral.Client.Rest.Models.FinancialStatementItemType The type of item (text only, account balance or sumatory).
PrintText string? The text to be printed.
FinancialStatementAccounts System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.FinancialStatementAccountData>? The list of financial statement accounts (for account balance item types only).
SumFromLine int? For sumatory item types the start line to sum.
SumToLine int? For sumatory item types the end line to to.
IgnoreIfZeroValue bool? Set on if the item is not to be printed if it has no result.
Line int? The line number (automatically set by the system).
Tag string? The tag is the code of IES (Portugal only).
FinancialStatementTaxonomies System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.FinancialStatementTaxonomyData>? The financial statement taxonomies lines.

^ Back to top

FinancialStatementListResponse

A list of items.

Properties
Property Type Description Rules
FinancialStatements System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.FinancialStatementData> A list of items. Required.

^ Back to top

FinancialStatementTaxonomyData

Financial statement taxonomy data.

Properties
Property Type Description Rules
TaxonomyClass string The taxonomy class is used as key and will be used to filter taxonomies. Required.
Taxonomy string The taxonomy will be used to calculated the financial statement item. Required.
Credit bool? If true will sum all credit amount of the selected taxonomy.
Debit bool? If true will sum all debit amount of the selected taxonomy.
InvertSign bool? If true invert the sign of the taxonomy balance.

^ Back to top

FinancialYearBulkData

The base object for bulk creating a financial year.

Properties
Property Type Description Rules
Account string The target account. Required.
Subscription string The target subscription. Required.
CompanyKey string The company key. Required.
Year int Year used to create a new one.
FinancialYearId string? The financial year id used to remove entity.

^ Back to top

FinancialYearBulkGroupData

Entity containing the list of companies where the financial year will be created.

Properties
Property Type Description Rules
Year int The financial year to be created.
Description string? The financial year description.
FinancialYearBulk System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.FinancialYearBulkData> List of companies where we will opne the financial year. Required.

^ Back to top

FinancialYearData

The Financial Year end point is used to record financial reporting and budgeting by a company or an organization. A financial year is most commonly used for accounting purposes to prepare financial statements. Although a financial ear can start on January 1st and end on December 31st, not all fiscal years correspond with the calendar year. For example, universities often begin and end their fiscal years according to the school year.

Properties
Property Type Description Rules
Year int The financial year.
Company string The company key. Required.
ApplyAutomaticClosingPeriod bool? If true the system will automatically close the period after the number of days selected on number days for automatic closing.
YearType Primavera.Lithium.RoseCentral.Client.Rest.Models.LedgerType Type of Year(Actual or Forecast).
Description string The financial year description. Required.
NumberDaysAutomaticClosingPeriod string? The number days automatic closing period is used to define the number of days the previous period still open.
CopyFrom string? The financial year to copy data from (e.g. Journal Types).
HasClosingDocuments bool? Has Closing Documents.
HasOpeningDocuments bool? Has Opening Documents.
FinancialYearPeriods System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.FinancialYearFinancialYearPeriodsData>? The financial year period lines.

^ Back to top

FinancialYearDocumentBulkGroupData

Entity containing the list of companies where the documents will be created.

Properties
Property Type Description Rules
Operation Primavera.Lithium.RoseCentral.Client.Rest.Models.FinancialYearOperations The operation type.
Documents System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.FinancialYearBulkData> A list of documentos (opening or close). Required.

^ Back to top

FinancialYearDocumentData

The financial year entity with documents information.

Properties
Property Type Description Rules
Document string? The document name.
DocumentKey string? The document key.

^ Back to top

FinancialYearFinancialYearPeriodsData

The financial year period lines.

Properties
Property Type Description Rules
IsClosed bool If true all modules are automatically closed otherwise the property of the module define if is closed.
Purchases bool If true all modules are automatically closed otherwise the property of the module define if is closed.
Sales bool If true the sales module is closed.
AccountsPayable bool If true the accounts payable module is closed.
AccountsReceivable bool If true the accounts receivable module is closed.
Accounting bool If true the accounting module is closed.
Assets bool If true the assets module is closed.
Taxes bool If true the taxes module is closed.
Stocks bool If true the stocks module is closed.
Bank bool If true the bank module is closed.

^ Back to top

FinancialYearListResponse

A list of financial years.

Properties
Property Type Description Rules
FinancialYears System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.FinancialYearData> A list of items. Required.

^ Back to top

FiscalDocumentTypeData

The Fiscal Document Type represents the type of document for the Portuguese Tax Authority (AT).

Properties
Property Type Description Rules
FiscalDocumentTypeKey string The fiscal document's type key. Required.
FiscalUse Primavera.Lithium.RoseCentral.Client.Rest.Models.FiscalUse The fiscal use. Indicates if the fiscal document is a financial, stock or other type of document.
Description string? The fiscal document's type description. Indicates the type of fiscal document.

^ Back to top

FiscalDocumentTypeListResponse

A list of items.

Properties
Property Type Description Rules
FiscalDocumentTypes System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.FiscalDocumentTypeData> A list of items. Required.

^ Back to top

FiscalMemoReasonData

The Fiscal Memo Reason represents the classification of a memo document.

Properties
Property Type Description Rules
FiscalMemoReasonKey string The fiscal memo reason key. Required.
FiscalMemoReasonType Primavera.Lithium.RoseCentral.Client.Rest.Models.FiscalMemoReasonType Fiscal Memo Reason Type.
Description string? The description of the fiscal memo reason.

^ Back to top

FiscalMemoReasonListResponse

A list of items.

Properties
Property Type Description Rules
FiscalMemoReasons System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.FiscalMemoReasonData> A list of items. Required.

^ Back to top

FiscalTimeZoneData

The entity data.

Properties
Property Type Description Rules
Code int The item key.
Name string Entity name. Required.
DisplayName string Entity display name. Required.

^ Back to top

FiscalTimeZoneListResponse

A list of fiscal time zones.

Properties
Property Type Description Rules
FiscalTimeZones System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.FiscalTimeZoneData> A list of items. Required.

^ Back to top

FiscalWithholdingTaxTypeData

The Fiscal WithholdingTaxType represents the fiscal withholding type.

Properties
Property Type Description Rules
FiscalKey string The fiscal's withholding tax type key. Required.
Description string? The fiscal's withholding tax type description.

^ Back to top

FiscalWithholdingTaxTypeListResponse

A list of items.

Properties
Property Type Description Rules
FiscalWithholdingTaxTypes System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.FiscalWithholdingTaxTypeData> A list of items. Required.

^ Back to top

GeneralLedgerAccountData

A General Ledger (GL) Account represents a numerical or alphanumerical account with specific characteristics such as nature (debit or credit), account type or taxonomy and its purpose is to record the company's financial transactions.

Properties
Property Type Description Rules
ChartOfAccount string The chart of accounts of the GL account. Required.
ChartOfAccountId string? The chart of accounts identifier of the GL account.
ChartOfAccountDescription string? The chart of accounts description of the GL account.
GLAccountKey string The general ledger account key. Required.
Description string? The GL account description.
AllowsManualPostings bool Choose if the account can be used directly in the journal editor.
AllowsOtherCurrencies bool Defines if the account allows postings in other currencies than the defined in the currency field.
AllowsTaxes bool Defines if the user can select a tax code key when using the journal editor.
AllowsPostingWithoutTaxes bool Defines if the user can record a transaction without a tax code key associated with the account.
AllowsOtherNature bool Defines whether the GL Account allows postings with other nature than the default. Internally determined by the GL account definition.
AllowsBalOtherNature bool Defines if the account allows balances in other nature than the default.
IsMovement bool For hierarchical accounts the system manages the flag automatically.
ClassType string Defines the position of the account in the balance sheet of profit and loss statement. Required.
ClassTypeId string? The general ledger account class type identifier.
ClassTypeDescription string? The general ledger account class type description.
SubAccountType Primavera.Lithium.RoseCentral.Client.Rest.Models.SubAccountType If the account is a reconciliation account of a subledger (eg. customer) select the sub ledger. In this case the subledger account is required.
SubAccountDescription string Description of sub account type. Required.
Currency string? Some accounts (like bank accounts) have a fixed currency. In this case select the default currency of the account.
AccountingNature Primavera.Lithium.RoseCentral.Client.Rest.Models.AccountingNature Defines the default nature of the account (debit or credit).
TaxonomyClass string? The class of taxonomy to filter the taxonomy key. Defaulted from the chart of accounts.
Taxonomy string? The taxonomy of the GL account. The taxonomy is required for movement accounts if the chart of accounts is assigned to a taxonomy class.
SearchTerm string? Defines a nick name for the account for easy search.
EntityDimensionDetails System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.GeneralLedgerAccountDimensionData>? The set of dimensions used by default for this account.
IsTaxonomyRequired bool? Used on UIRules.
ReversalGLAccount string? An alternative GL account that will be used when journal reversal.
SubclassType string? The subclass type is a complementary classification of the account type. This is used on dashboards.
DynamicValueList string? Dynamic Value.
IsExternal bool? A non-persisted flag indicating if the GL Account is created by an external tool (e.g. SAF-T importer).
AllowsWithholdingTax bool? Allows Withholding Tax.

^ Back to top

GeneralLedgerAccountDimensionData

The set of dimensions used by default for a general ledger account.

Properties
Property Type Description Rules
Dimension string The dimension. Required.
DimensionValue string The dimension value. Required.

^ Back to top

GeneralLedgerAccountListResponse

The general ledger accounts list response object.

Properties
Property Type Description Rules
GeneralLedgerAccounts System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.GeneralLedgerAccountData> The list of general ledger accounts. Required.

^ Back to top

HiringReasonClassificationData

The hiring reasons classification entity.

Properties
Property Type Description Rules
HiringReason string Hiring reason. Required.
HiringReasonId string The hiring reason id. Required.
HiringReasonDescription string The hiring reason description. Required.
SingleReportCode string? Single report code.
SegSocialCode string? Social security.
ConfigurationModuleId string The configuration module identifier. Required.
Index int The index number.

^ Back to top

IdentityUserData

Describes an identity user entity.

Properties
Property Type Description Rules
Id string The user identifier. Required.
Culture string The user culture. Required.
DisplayName string The user display name. Required.
PictureUri string? The user picture URI.
EmailVerified bool If user email is verified.

^ Back to top

IdentityUserInvitationPayloadData

The identity server user invitation payload.

Properties
Property Type Description Rules
Id int The user identifier.
SenderId string The sender identifier. Required.
ReceiverId string The receiver identifier. Required.
ReceiverEmail string The receiver email address. Required.

^ Back to top

IdentityUserInvite

The user invite result entity.

Properties
Property Type Description Rules
ReceiverId string The receiver id. Required.
ReceiverEmail string The receiver email. Required.
SenderId string The sender id. Required.
State string The operation state. Required.

^ Back to top

IdentityUserPayloadData

The identity server user payload.

Properties
Property Type Description Rules
Id string The user identifier. Required.
EmailVerified bool If user email is verified.
Email string The user email. Required.
RecoveryEmail string The recovery email. Required.
RecoveryEmailVerified bool If recovery user email is verified.
RecoveryPhone string The recovery phone number. Required.
RecoveryPhoneVerified bool If user recovery phone is verified.
DisplayName string The user display name. Required.

^ Back to top

IncomingNotification

Defines a notification received by the service.

Properties
Property Type Description Rules
Message System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.MessageItem> Describes the notification messages. Required. NotEmpty.
Context System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.ContextItem>? Describes the notification context.
NotificationType Primavera.Lithium.RoseCentral.Client.Rest.Models.NotificationType Describes the type of the notification.
ExpiresOn System.DateTime? Describes the notification expiration date.
Source string Describes the notification source. Required.
Targets System.Collections.Generic.IList<string> Describes the notification targets. Required. NotEmpty.

^ Back to top

InviteData

The rose user invite entity.

Properties
Property Type Description Rules
Name string The user name. Required.
Email string The user email. Required.
RoleKey string The role key. Required.

^ Back to top

InviteGroupData

Entity with all fields necessary to send an invite.

Properties
Property Type Description Rules
TargetCompany System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.TargetCompanyData> The target company. Required.
Invite Primavera.Lithium.RoseCentral.Client.Rest.Models.InviteData Invite entity. Required.

^ Back to top

InvoiceTypeData

The invoice type data entity.

Properties
Property Type Description Rules
Company string The invoice's type company. The company's code is the central organizational unit within the system. Required.
CompanyId string The invoice's type company. The company's code is the central organizational unit within the system. Required.
TypeKey string The invoice's type key. Required.
CashInvoice bool It is an invoice which also documents an on-time payment receipt in cash, unlike an invoice or a promise of payment.
AccountingSchema Primavera.Lithium.RoseCentral.Client.Rest.Models.AccountingSchema The entity accounting's organization method. This organization can follow the rules of "Cash" or "Accrual".
IsPortugueseCompany bool The invoice type is targeted at a company that is portuguese.
CustomerPostingProfile string The customer posting profile used for customer GL account determination. Required.
SalesAccountDetermination string The sales GL account determinations for line item. Required.
JournalType string The journal type to be used for account posting. Required.
CompanyHasDimensions bool Flag to know if company has dimensions.
Description string? The invoice's type description.
DocumentTypeSeries System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.InvoiceTypeSeriesData>? The memo's type details.
FiscalDocumentType string? The fiscal's document type.
FiscalDocumentTypeId string? The fiscal's document type.
FiscalDocumentTypeDescription string? The fiscal's document type.
DefaultCashFlowItem string? The type of cash flow item to be used when CashInvoice is active.
DefaultCreditMemoType string The type of credit memo type for the invoice type. Required.
DefaultDebitMemoType string? The type of debit memo type for the invoice type.
ContactType string? The contact type for the memo type.
Notification string? The default notification for documents with this memo type.
DimensionCombination string? The dimension combination used for line item dimension determination.
DefaultFinancialAccount string? The default financial account to be used in invoice/receipts.
DocumentNote string? The document note.
DocumentNoteTitle string? The document note title.
FiscalDocumentTypeKey string? The legal fiscal code published by the portuguese tax authority.
FiscalUse Primavera.Lithium.RoseCentral.Client.Rest.Models.FiscalUse? The fical use enumeration.

^ Back to top

InvoiceTypeListResponse

A list of invoice types.

Properties
Property Type Description Rules
InvoiceTypes System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.InvoiceTypeData> A list of items. Required.

^ Back to top

InvoiceTypeSeriesData

Invoice type serie entity.

Properties
Property Type Description Rules
NumberOfCopies int The number of copies of the document to print.
IsDefault bool Indicates if this is the default serie for the document.
TaxIncluded bool When checked, the document unit prices will include taxes.
IsManual bool When checked, the memo type series is defined as manual. Internally determined.
IsExternal bool When checked, the memo type series is defined as external. Internally determined.
Serie string The range of identification values that group a set of product entities or objects. Required.
CommunicationType Primavera.Lithium.RoseCentral.Client.Rest.Models.CommunicationType The type of comunication to be used. This is applicable only to Portuguese companies.
CurrentDate System.DateTime? The current date for the invoice type serie.
CurrentNumber int? The current document's number.
EconomicActivityClass string? Indicates the company's activity.

^ Back to top

ItemAccountTypeData

An Item Account Type represents a classifier used to decode the GL account for a given item.

Properties
Property Type Description Rules
ItemAccountTypeKey string? The item account type key.
Description string? The item account type description.

^ Back to top

ItemAccountTypeListResponse

The item account types list response object.

Properties
Property Type Description Rules
ItemAccountTypes System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.ItemAccountTypeData> The list of item account types. Required.

^ Back to top

ItemTaxSchemaData

An ItemTax Schema represents a tax aggregation and is associated with the item.

Properties
Property Type Description Rules
TaxCodeItemGroupKey string The item tax schema key. Required.
Description string The item tax schema description. The tax schema identifies the group of taxes an item is liable for. Required.
AllowedIn Primavera.Lithium.RoseCentral.Client.Rest.Models.AllowedIn? Indicates if item tax schema is used in sales or purchases.
ItemTaxSchemaLists System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.ItemTaxSchemaListData> The list of item tax schema taxes. Required.

^ Back to top

ItemTaxSchemaListData

The item tax schema list data.

Properties
Property Type Description Rules
TaxTypeCode string The tax type code. Required.

^ Back to top

ItemTaxSchemaListResponse

The item tax schemas list response object.

Properties
Property Type Description Rules
ItemTaxSchemas System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.ItemTaxSchemaData> The list of item tax schemas. Required.

^ Back to top

ItemTaxSchemaMappingData

Describes the mapping between a tax sub class and a item tax schema.

Properties
Property Type Description Rules
Index int Index number.
FiscalType Primavera.Lithium.RoseCentral.Client.Rest.Models.FiscalType? The sales type fiscal type.
FiscalTypeDescription string? Fiscal type description.
TaxSubClass string The tax sub class code. Required.
TaxSubClassId System.Guid The tax sub class unique identifier.
TaxSubClassDescription string? The tax sub class description.
ItemTaxSchema string? The item tax schema.
ItemTaxSchemaId System.Guid? The item tax schema unique identifier.
ItemTaxSchemaDescription string? The item tax schema description.

^ Back to top

ItemTypeMappingData

Describes a mapping between a fiscal type and a item account type.

Properties
Property Type Description Rules
FiscalType Primavera.Lithium.RoseCentral.Client.Rest.Models.FiscalType The sales type fiscal type.
FiscalTypeDescription string? Fiscal type description.
ItemAccountType string? The item account type code.
ItemAccountTypeId System.Guid? The item account type unique identifier.
ItemAccountTypeDescription string? The item account description field.
Index int Index number.

^ Back to top

JournalTypeData

The Journal Type represents a journal document with specific characteristics.

Properties
Property Type Description Rules
JournalTypeKey string The journal type key. Required.
Description string? The journal type description.
CompanyId string? The company identifier of the journal type.
Company string? The company of the journal type.
CompanyDescription string? The company description of the journal type.
JournalNumbering Primavera.Lithium.RoseCentral.Client.Rest.Models.JournalNumbering The type of jounal numbering (monthly or yearly).
JournalNumberingDescription string The description of jounal numbering (monthly or yearly). Required.
TransactionType Primavera.Lithium.RoseCentral.Client.Rest.Models.TransactionType The transaction type define the process where the journal type will be used (1 - Opening, 2- Normal, 3 - Rectification, 4 - Adjustment and 5 - Closing).
TransactionTypeDescription string? The transaction type define the process where the journal type will be used (1 - Opening, 2- Normal, 3 - Rectification, 4 - Adjustment and 5 - Closing).
CheckExistingPosting bool Validate duplicate documents.
ReverseJournalType string? Enter the journal to be used when reversing a transaction.
JournalSeries System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.JournalTypeSeriesData>? The journal series.

^ Back to top

JournalTypeListResponse

The journal types list response object.

Properties
Property Type Description Rules
JournalTypes System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.JournalTypeData> The list of journal types. Required.

^ Back to top

JournalTypeSeriesData

The journal type series.

Properties
Property Type Description Rules
FinancialYear string The financial year of the series. Required.
Ledger string The ledger of the series. By default it's the company's ledger. Required.
CurrentNumber int The current number (on insert it's defaulted to 0).
From int The first number of the series.
To int The last number of the series.
Period int? The financial period of the series (only for monthly series).
JournalNumbering Primavera.Lithium.RoseCentral.Client.Rest.Models.JournalNumbering The journal numbering.

^ Back to top

LedgerData

The Ledger represents business activities and money (received or paid), the ledger can be budget or actual. This service manage the common operations of this entity.

Properties
Property Type Description Rules
LedgerKey string The ledger key. Required.
Description string? The ledger description.
AllowsTaxes bool If true all transactions using this ledger will allow tax posting.
LedgerType Primavera.Lithium.RoseCentral.Client.Rest.Models.LedgerType Select the type of ledger, whether it stores actual figures or budget figures.

^ Back to top

LedgerListResponse

The tax sub classes list response object.

Properties
Property Type Description Rules
Ledgers System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.LedgerData> The list of tax sub classes. Required.

^ Back to top

LegalNatureData

The legel nature entity.

Properties
Property Type Description Rules
Code string The legal nature code. Required.
Description string The entity name. Required.

^ Back to top

LegalNatureListResponse

The legal natures list response object.

Properties
Property Type Description Rules
LegalNatures System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.LegalNatureData> The list of legal natures. Required.

^ Back to top

MaterialAcctDeterminationData

The materials account determinations endpoint is used to store the account types and his determination the a select chart of account.

Properties
Property Type Description Rules
ChartOfAccount string The chart of accounts. Required.
AccountsLines System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.MaterialsAcctDeterminationLineData>? The account determinations lines.
PurchasesAccounts System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.PurchasesGLAccountMaterialsData>? The list of purchase accounts.

^ Back to top

MaterialAcctDeterminationListResponse

A list of items.

Properties
Property Type Description Rules
MaterialAcctDeterminations System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.MaterialAcctDeterminationData> A list of items. Required.

^ Back to top

MaterialsAcctDeterminationLineData

Materials acct determination line entity.

Properties
Property Type Description Rules
ItemAccountType string The item account type. Required.
ItemAccountTypeId string The item account type identifier. Required.
ChartOfAccount string The chart of accounts. Required.
ChartOfAccountId string The chart of accounts identifier. Required.
StockAccount string The stock account item. Required.
StockAccountId string The stock account item identifier. Required.
COGSAccount string The cost of goods sold GL account for the chart of accounts. Required.
COGSAccountId string The cost of goods sold GL account for the chart of accounts identifier. Required.
PriceDifAccount string The price differences GL account for the chart of accounts. Required.
PriceDifAccountId string The price differences GL account for the chart of accounts identifier. Required.
InTransitAccount string? In Transit GL account.
InTransitAccountId string? In Transit GL account identifier.
GRIRAccountDebit string? GRIR GL account debit.
GRIRAccountDebitId string? GRIR GL account debit identifier.
GRIRAccountCredit string? GRIR GL account credit.
GRIRAccountCreditId string? GRIR GL account credit identifier.
Index int? The line index.

^ Back to top

MemoTypeData

The Memo Type represents a sales document with specific characteristics.

Properties
Property Type Description Rules
Company string The memo's type company. The company code is the central organizational unit within the system. Required.
CompanyId string The memo's type company id. The company code is the central organizational unit within the system. Required.
TypeKey string The memo's type key. Required.
AccountingSchema Primavera.Lithium.RoseCentral.Client.Rest.Models.AccountingSchema The entity accounting's organization method. This organization can follow the rules of "Cash" or "Accrual".
IsPortugueseCompany bool The invoice type is targeted at a company that is portuguese.
CustomerPostingProfile string The customer posting profile used for customer GL account determination. Required.
AccountingNature Primavera.Lithium.RoseCentral.Client.Rest.Models.AccountingNature The nature for the memo type. It can be "credit" or "debit".
SalesAccountDetermination string The sales GL account determinations for line item. Required.
JournalType string The journal type to be used for account posting. Required.
GoodsReturn bool Flag to know if is goods return.
CompanyHasDimensions bool Flag to know if company has dimensions.
Description string? The memo's type description.
FiscalDocumentType string? The fiscal's document type.
FiscalDocumentTypeId string? The fiscal's document type.
FiscalDocumentTypeDescription string? The fiscal's document type.
DocumentTypeSeries System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.DocumentTypeSeriesData>? The memo's type details.
ContactType string? The contact type for the memo type.
Notification string? The default notification for documents with this memo type.
DimensionCombination string? The dimension combination used for line item dimension determination.
DocumentNoteTitle string? The document note title.
DocumentNote string? The document note.
FiscalDocumentTypeKey string? The legal fiscal code published by the portuguese tax authority.
FiscalUse Primavera.Lithium.RoseCentral.Client.Rest.Models.FiscalUse? The fical use enumeration.

^ Back to top

MemoTypeListResponse

A list of memo types.

Properties
Property Type Description Rules
MemoTypes System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.MemoTypeData> A list of items. Required.

^ Back to top

The menu data entity.

Properties
Property Type Description Rules
MenuItems System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.MenuItemData>? A list of child menus.
FlatMenu bool If menu is flat.
DefaultActions System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.MenuDefaultActionData> The menu default actions by claim. Required.

^ Back to top

The menu default action data.

Properties
Property Type Description Rules
ContextUri string Menu context uri. Required.
SubscriptionClaims System.Collections.Generic.IList<string> Menu default action subscription claims. Required.
Id int The default action identifier.

^ Back to top

The first level menu entity.

Properties
Property Type Description Rules
Id System.Guid The menu item unique identifier.
ExternalId System.Guid The external unique identifier.
Uri string? The menu uri.
Caption string The menu caption. Required.
CaptionKey string The menu caption key. Required.
Color string The menu color to be used. Required.
IsSelected bool If menu is selected.
IsDefault bool If is the default menu.
UseCustomUri bool If is to use a custom uri.
ExtraClass string? The extra class to use.
Icon string? The icon to be used on menu.
DisplayOrder int The menu display order.
IsSearchable bool If menu is searchable.
IsVisible bool If menu is visible.
Role string Role identification. Required.
MenuItems System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.MenuItemData>? A list of second level menu items.

^ Back to top

MessageItem

Defines the notification message item.

Properties
Property Type Description Rules
Key string The message item key. Required.
Value string The message item value. Required.
Culture string The message item culture. Required.

^ Back to top

ModelWithProperties

The base model for models with Properties.

Properties
Property Type Description Rules
Properties System.Collections.Generic.IDictionary<string, string> The properties dictionary. Required.

^ Back to top

MonitoringData

The monitoring data entity.

Properties

The model has no properties.

^ Back to top

OrganizationData

Describes a organization data.

Properties
Property Type Description Rules
Key string The organization key. Required.
Name string The organization name. Required.
WorkspaceKey string The organization workspace key. Required.
State Primavera.Lithium.RoseCentral.Client.Rest.Models.OrganizationState The organization state.

^ Back to top

PartyAccountTypeData

A Party Account Type represents a classifier used to decode the GL account for a given party.

Properties
Property Type Description Rules
PartyAccountTypeKey string The item key. Required.
Description string? Entities description.

^ Back to top

PartyAccountTypeListResponse

A list of party account types.

Properties
Property Type Description Rules
PartyAccountTypes System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.PartyAccountTypeData> A list of customer sets. Required.

^ Back to top

PartyAddressData

The party's addresses.

Properties
Property Type Description Rules
Country string The country for the party address. Required.
StreetName string? The party main address street's name.
BuildingNumber string? The party main address building's number.
PostalZone string? The party main address postal zone.
CityName string? The party main address city's name.
ContactName string? The party main contact's name.
ContactTitle string? The party main contact's title.

^ Back to top

PartyContactData

The party's contacts.

Properties
Property Type Description Rules
ContactName string The name for the party contact. Required.
ContactType string The contact type for the party contact. Required.
ContactTitle string? The party main contact's title.
ElectronicMail string? The electronic mail for the party.
Mobile string? The mobile for the party.
Telephone string? The telephone for the party.
Culture string? The culture.

^ Back to top

PartyData

A Party represents an entity that provides or consumes services or goods.

Properties
Property Type Description Rules
PartyKey string The key for the party. Uniquely identifies the entity/party within the organization. Required.
Name string? The party name.
IsExternallyManaged bool A flag indicating if the party is externally managed.
OneTimeParty bool A flag indicating if the party has frequent transactions.
Currency string The party's default currency. Required.
CurrencyId string? The party's default currency identifier.
CurrencyDescription string? The party's default currency description.
Country string The party's country. Required.
CountryId string? The party's country identifier.
CountryDescription string? The party's country description.
PartyAccountType string? The type of party for accounting purposes.
PartyAccountTypeId string? The party account type identifier.
PartyAccountTypeDescription string? The party account type description.
IsPerson bool Indicates that this entity is a person.
CompanyTaxID string? The party tax identifier. The unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities.
ElectronicMail string? The electronic mail for the party.
Telephone string? The telephone for the party.
Mobile string? The mobile for the party.
WebsiteUrl string? The website url for the party.
Notes string? The notes for the party.
Picture string? The picture for the party.
StreetName string? The party main address street's name.
BuildingNumber string? The party main address building's number.
PostalZone string? The party main address postal zone.
CityName string? The party main address city's name.
ContactName string? The party main contact's name.
ContactTitle string? The party main contact's title.
Username string? The party's Identity Username.
PartyAddresses System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.PartyAddressData>? The party's alternative addresses.
PartyContacts System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.PartyContactData>? The party's alternative contacts.
Address string? The party's main address.
AddressId string? The party address identifier.
AddressDescription string? The party address description.
Contact string? The party's main contact.
ContactId string? The party contact identifier.
ContactDescription string? The party contact description.
Culture string? The culture for the party.
PartyTypes System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.PartyTypeDetailData>? The list of types that party can assume.
SearchTerm string? The search term.

^ Back to top

PartyListResponse

The parties list response object.

Properties
Property Type Description Rules
Parties System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.PartyData> The list of parties. Required.

^ Back to top

PartySettingsGroupData

Party settings groups entity.

Properties
Property Type Description Rules
PartySettingsGroupKey string The entity key. Required.
Description string A brief description of the entity. Required.
CompanySettingsGroupId int Company settings group unique identifier.
CreateParties bool Indicates if is to create a new party.
SupplierAccountId string? The supplier account identifier.
SupplierAccountKey string? The key of the supplier account.
SupplierAccountDescription string? The description of the supplier account.
IsSystem bool Identifies if entiy is system base.
PartyId string? The party unique identifier.
PartyKey string? The key for the party. Uniquely identifies the entity/party within the organization.
PartyName string? The name for the party.
AtPartyId string? AT party id.
AtPartyKey string? AT party key.
AtPartyDescription string? AT party description.
SsPartyId string? Seg social party id.
SsPartyKey string? Seg social party key.
SsPartyDescription string? Seg social party description.
CreationType Primavera.Lithium.RoseCentral.Client.Rest.Models.CodificationRule Party creation type.

^ Back to top

PartySettingsGroupListResponse

The party settings group list response.

Properties
Property Type Description Rules
PartySettingsGroups System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.PartySettingsGroupData> The list item of party settings group. Required.

^ Back to top

PartyTaxSchemaData

A Party Tax Schema represents a tax aggregation and is associated with the party.

Properties
Property Type Description Rules
TaxCodeGroupKey string The party's tax schema key. Required.
AllowedIn Primavera.Lithium.RoseCentral.Client.Rest.Models.AllowedIn The allowed in flag idicates if the tax schema is to be used in sales or purchases.
Description string? The party's tax schema description. The tax schema identifies the group of taxes a party is liable for. This group usually depends on the company situation or the head office location.
PartyTaxSchemaLists System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.PartyTaxSchemaListData>? The list of taxes.

^ Back to top

PartyTaxSchemaListData

The party tax schema tax list.

Properties
Property Type Description Rules
TaxTypeCode string The tax's type code. Code that identifies the type of tax applied. Required.
IsExempt bool Indicates if is exempt or not. Discharge from payment of certain fees based on the fulfillment of certain attributes.
ExemptionReasonCode string? The exemption reason's code. It represents the reason why a specific operation does not pay taxes.

^ Back to top

PartyTaxSchemaListResponse

A list of items.

Properties
Property Type Description Rules
PartyTaxSchemas System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.PartyTaxSchemaData> A list of items. Required.

^ Back to top

PartyTypeDetailData

The list of types that party can assume.

Properties
Property Type Description Rules
PartyType Primavera.Lithium.RoseCentral.Client.Rest.Models.PartyType The list of types that party can assume.
Enabled bool If true the party has this type.

^ Back to top

PaymentMethodData

A Payment Method represents the number of ways in which merchants can collect payments from their customers.

Properties
Property Type Description Rules
PaymentMethodsKey string The payment method's key. Required.
Description string The payment method's description. Required.
IsAvailableInSales bool Determines if this payment method can be used in sales.
IsAvailableInPurchases bool Determines if this payment method can be used in purchases.
IsAllowedInPettyCash bool Determines if this payment method can be used in petty cash operations.
IsAllowedInFinancialAccount bool Determines if this payment method can be used in bank accounts.
IsAllowedInPaymentBatches bool Determines if this payment method can be used in payment batches.
BalanceManaged bool Indicates whether this payment method is balance managed or not.
IsEft bool Indicates whether the payment method is an Electronic funds transfer.
FiscalClassification string? The associated fiscal classification.
FiscalClassificationId string? Fiscal classification id.
FiscalClassificationDescription string? Fiscal classification description.
Details string The details. Required.
PaymentMethodType Primavera.Lithium.RoseCentral.Client.Rest.Models.PaymentMethodType The payment method type.
ElectronicTransferFileType Primavera.Lithium.RoseCentral.Client.Rest.Models.ElectronicTransferFileType Electronic transfer file type.
ElectronicTransferPurpose Primavera.Lithium.RoseCentral.Client.Rest.Models.ElectronicTransferPurpose Electronic transfer purpose.

^ Back to top

PaymentMethodListResponse

A list of payment methods.

Properties
Property Type Description Rules
PaymentMethods System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.PaymentMethodData> A list of payment methods. Required.

^ Back to top

PaymentTermData

A Payment Term represents the conditions surrounding the payment part of sale, typically specified by the seller to the buyer.

Properties
Property Type Description Rules
PaymentTermKey string Payment term key. Required.
Description string The entity description. Required.
UseInAccountsReceivable bool Indicates whether this payment term can be used in accounts receivable or not.
UseInAccountsPayable bool Indicates whether this payment term can be used in accounts payable or not.
ValidFrom System.DateTime? The start date for validity period.
ValidTo System.DateTime? The end date for validity period.
DaysFromReferenceDate int? Number of days that determine the term for this payment.

^ Back to top

PaymentTermListResponse

A list of payment terms.

Properties
Property Type Description Rules
PaymentTerms System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.PaymentTermData> A list of payment terms. Required.

^ Back to top

PayrollCoreSetupData

The payroll core setup entity.

Properties
Property Type Description Rules
Company string The company key. Required.
CompanyId string The company id. Required.
CompanyDescription string The company description. Required.
JournalType string The journal type key. Required.
JournalTypeId string The journal type id. Required.
JournalTypeDescription string The journal type description. Required.
BaseNonWorkingDays string The base non working days key. Required.
BaseNonWorkingDaysId string The base non working days id. Required.
BaseNonWorkingDaysDescription string The base non working days desciption. Required.
BaseSchedule string The base schedule key. Required.
BaseScheduleId string The base schedule id. Required.
BaseScheduleDescription string The base schedule description. Required.
NaturalKey string The entity natural key. Required.

^ Back to top

PayrollEntityBase

Payroll base entity.

Properties
Property Type Description Rules
Id string The payroll entity unique identifier. Required.
IsSystem bool? Indicate if entity is system.
IsDeleted bool? Indicate if entity is deleted.
IsActive bool? Indicate if entity is active.

^ Back to top

PayrollPropertyData

Payroll core setup property data.

Properties
Property Type Description Rules
Property string The property to be updated. Required.
Value string The value to be updated. Required.

^ Back to top

PayrollPropertyListData

Financial setup list of properties to be updated.

Properties
Property Type Description Rules
Properties System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.PayrollPropertyData> A list of property/value pair to update in entity. Required.

^ Back to top

PayrollStatusData

The payroll statuses entity.

Properties
Property Type Description Rules
Company string The company key. Required.
CompanyId string The company id. Required.
CompanyDescription string The company description. Required.
Country string The country key. Required.
CountryId string The country id. Required.
CountryDescription string The country description. Required.

^ Back to top

PostingCategoryAccountData

The posting category account entity.

Properties
Property Type Description Rules
ChartOfAccount string The chart of accounts. Required.
ChartOfAccountId string The chart of accounts identifier. Required.
GlAccount string? The tax GL account for the chart of accounts and fiscal memo reason.
GlAccountReverseCharge string? The general ledger account reversal for the chart of accounts and fiscal memo reason.
FiscalMemoReason string? The fiscal memo reason (optional).

^ Back to top

PostingCategoryData

The Posting Category represents the decoded gl accounts for the account posting of taxes.

Properties
Property Type Description Rules
PostingCategoryKey string The posting category key. Required.
Description string? The posting category description.
PostingCategoryAccounts System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.PostingCategoryAccountData>? The posting category accounts lines.

^ Back to top

PostingCategoryListResponse

A list of items.

Properties
Property Type Description Rules
PostingCategories System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.PostingCategoryData> A list of items. Required.

^ Back to top

PriceListLineData

The price list line entity.

Properties
Property Type Description Rules
PriceAmount decimal The unit price.
Unit string The price list's line unit. Required.
Currency string The money's unit used by the document. This value is important for currency exchanges or to set the number of decimal places used to represent values. Required.
PriceList string? The pricelist that corresponds to this price list line.

^ Back to top

PropertyData

Property data to be updated.

Properties
Property Type Description Rules
Property string The property to be updated. Required.
Value string The value to be updated. Required.
ArrayValue byte[]? A byte array value (for images).
Id string? An identifier.

^ Back to top

PropertyListData

A list of properties to update.

Properties
Property Type Description Rules
Properties System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.PropertyData> List of properties to update. Required.

^ Back to top

ProvisioningStateData

Describes the data about a particular state of the provisioning operation.

Properties
Property Type Description Rules
Message string The message to display to end user. Required.
State Primavera.Lithium.RoseCentral.Client.Rest.Models.ProvisioningState The current provisioning state.

^ Back to top

PurchasesAcctDeterminationData

The Purchases Account Determination endpoint is used to discover the purchases account in the company chart of account.

Properties
Property Type Description Rules
PurchasesAcctDeterminationKey string The purchases account determination key. Required.
Description string? The description of the posting profile.
PurchasesGLAccounts System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.PurchasesGLAccountData>? The list of GL accounts.

^ Back to top

PurchasesAcctDeterminationListResponse

A list of items.

Properties
Property Type Description Rules
PurchasesAcctDeterminations System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.PurchasesAcctDeterminationData> A list of items. Required.

^ Back to top

PurchasesGLAccountData

The posting category account entity.

Properties
Property Type Description Rules
ChartOfAccount string The chart of accounts. Required.
ChartOfAccountId string The chart of accounts identifier. Required.
PurchaseAccount string The purchases account for the item account type, item tax schema and party tax schema selected. Required.
PurchaseAccountId string The purchases account for the item account type, item tax schema and party tax schema selected identifier. Required.
ItemAccountType string? The item account type.
ItemAccountTypeId string? The item account type identifier.
ItemTaxSchema string The item tax schema. Required.
ItemTaxSchemaId string The item tax schema identifier. Required.
PartyTaxSchema string? The party tax schema.
PartyTaxSchemaId string? The party tax schema identifier.
DiscountAccount string? The discount GL account for the item tax schema and party tax schema and item account type.
DiscountAccountId string? The discount GL account for the item tax schema and party tax schema and item account type identifier.

^ Back to top

PurchasesGLAccountMaterialsData

Purchases GL account entity.

Properties
Property Type Description Rules
PurchaseItemAccountType string The item account type. Required.
PurchaseItemAccountTypeId string The item account type identifier. Required.
PurchasesAccount string The purchases account for the item account type, item tax schema and party tax schema selected. Required.
PurchasesAccountId string The purchases account for the item account type, item tax schema and party tax schema selected identifier. Required.
ChartOfAccount string The chart of accounts. Required.
ChartOfAccountId string The chart of accounts identifier. Required.
ItemTaxSchema string The item tax schema. Required.
ItemTaxSchemaId string The item tax schema identifier. Required.
PartyTaxSchema string? The party tax schema.
PartyTaxSchemaId string? The party tax schema identifier.
PurchasesOffsetAccount string? Purchase offset account.
PurchasesOffsetAccountId string? Purchase offset account identifier.
PurchasesReturnsAccount string? Purchase returns account.
PurchasesReturnsAccountId string? Purchase returns account identifier.
PurchasesReturnsOffsetAccount string? Purchase returns offset account.
PurchasesReturnsOffsetAccountId string? Purchase returns offset account identifier.
Index int? The line index.

^ Back to top

PurchasesImportGroupData

Purchase import group entity.

Properties
Property Type Description Rules
PurchasesImportGroupKey string The entity key. Required.
Description string A brief description of the entity. Required.
CompanySettingsGroupId int Company settings group unique identifier.
JournalTypeId string? The journal type id.
JournalTypeKey string? The journal type key.
JournalTypeDescription string? The journal type description.
IsSystem bool Identifies if entiy is system base.

^ Back to top

PurchasesImportGroupListResponse

The purchase import group list response.

Properties
Property Type Description Rules
PurchasesImportGroups System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.PurchasesImportGroupData> The list of purchase import group. Required.

^ Back to top

QuickMenuData

Quick menu data entity.

Properties
Property Type Description Rules
ExternalId System.Guid The entity external unique identifier.
Color string Item color on menu. Required.
LineOne string Line one captation. Required.
LineTwo string Line two captation. Required.
LineThree string? Line three captation.
Uri string The uri to be used. Required.
Role string The role identification. Required.

^ Back to top

RelatedApplicationData

A related application information.

Properties
Property Type Description Rules
AppInstance string? The application app instance key.
Organization string? The application organization key.
Workspace string? The application workspace key.
ApplicationType Primavera.Lithium.RoseCentral.Client.Rest.Models.ApplicationType? The related application type.

^ Back to top

RoleData

Describes a user role entity.

Properties
Property Type Description Rules
RoleKey string The role unique key. Required.
NaturalKey string? The natural key of the role.
Description string The role description. Required.
IsAdministration bool Indicates if role is for administration.
LocalizableDescription string? Role localizable description.
IsClient bool Indicates if role is a client role.
IsMultiRole bool Indicates if role can be added with other form the same type.
RoleType Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleType The role type.

^ Back to top

RoleGroupData

Describes a group of roles.

Properties
Property Type Description Rules
RoleGroupKey string The role group unique key. Required.
Description string The role group description. Required.
Details string The role group detail information. Required.
Type Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleGroupType The role group type.
Roles System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleSimpleData> The list of roles of the current group. Required.
IsSystem bool Indicates if role is from system and therefore cannot be deleted.
IsMyROSE bool? Identifies a role group that contains roles that can be applied only to my rose subscription.

^ Back to top

RoleGroupListResponse

Describes a group role list response.

Properties
Property Type Description Rules
RoleGroups System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleGroupData> A list of roles groups. Required.

^ Back to top

RoleGroupUsersBulkData

The entity with the list of users to associate with a role group.

Properties
Property Type Description Rules
RoleGroup Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleGroupData The role group info to update. Required.
UserKeys System.Collections.Generic.IList<string> The users unique identifiers. Required.

^ Back to top

RoleListResponse

Describes a user role list response.

Properties
Property Type Description Rules
Roles System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleData> A list of users. Required.

^ Back to top

RoleSimpleData

Describes a role simple entity.

Properties
Property Type Description Rules
Key string The role key. Required.
Description string The role description. Required.
IsClient bool Indicates if it is a client role.
RoleType Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleType The type of role.

^ Back to top

RoseCompanyData

Rose company entity.

Properties
Property Type Description Rules
CompanyKey string Entity key. Required.
Name string The entity description. Required.
CompanyTaxID string The company's tax identifier. Required.
Country string The company's country. Required.
CountryId string Country id. Required.
CountryDescription string? Country description.
BaseCurrency string The company's base currency. Required.
BaseCurrencyId string Base currency id. Required.
BaseCurrencyDescription string? Base currency description.
IsExternal bool? Is external.
ShowExchangeRateReversed bool? Indicates wheter the exchange rate for the base currency is presented with reversed logic.
SearchTerm string? Search term.
Telephone string? Telephone number.
TeleFax string? TeleFax number.
Mobile string? Mobilçe number.
ElectronicMail string? Email adress.
EquityCapital string? The equity capital is defined as the amount of capital provided by the company's owner(s).
RegistrationOffice string? Registration office.
RegistrationNumber string? Registration number.
BuildingNumber string? Building number.
StreetName string? Street name.
CityName string? City name.
PostalZone string? Postal zone.
Address string Address of company. Required.
Logo string? Company's adress.
ForceFromOrganizationConfiguration bool? Force from organization configuration.
CompanyRegistrationData string Company registration data. Required.
AccessClaim string? Access claim.
BlobLogo byte[]? The blob company logo.

^ Back to top

RoseCompanyListResponse

A list of ROSE companies.

Properties
Property Type Description Rules
RoseCompanies System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.RoseCompanyData> A list of items. Required.

^ Back to top

RoseCultureData

The entity data.

Properties
Property Type Description Rules
CultureKey string The culture key. Required.
Name string The culture name. Required.

^ Back to top

RoseCultureListResponse

A list of cultures.

Properties
Property Type Description Rules
Cultures System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.RoseCultureData> A list of items. Required.

^ Back to top

RoseEntityBase

Describes a ROSE entity base model.

Properties
Property Type Description Rules
Id string The entity unique identifier. Required.
IsDeleted bool? Indicate if entity is deleted.
IsActive bool? Indicate if entity is active.
IsSystem bool? Indicate if entity is system.

^ Back to top

RoseEntityBulkListResponse

A bulk list response for ROSE entities.

Properties
Property Type Description Rules
RoseEntityBulkResponse System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.RoseEntityBulkResponse> The bulk response. Required.

^ Back to top

RoseEntityBulkResponse

A bulk response for ROSE entities.

Properties
Property Type Description Rules
Id string The entity identifier. Required.

^ Back to top

RoseRoleData

The user roles entity.

Properties
Property Type Description Rules
RoleKey string The role unique key. Required.
NaturalKey string? The natural key of the role.
Description string The role description. Required.
IsAdministration bool Indicates if role is for administration.
LocalizableDescription string? Role localizavle description.

^ Back to top

RoseRoleListResponse

A list of roles.

Properties
Property Type Description Rules
Roles System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.RoseRoleData> A list of roles. Required.

^ Back to top

RoseUserData

ROSE user entity.

Properties
Property Type Description Rules
UserKey System.Guid The user key.
Name string The user name. Required.
Email string The user email. Required.
Picture string The user picture. Required.
PictureThumbnail string The user picture thumbnail. Required.
DefaultRole string? The use default role.
DefaultRoleId System.Guid? The user default role id.
DefaultRoleDescription string? The user default role description.
Culture string The culture. Required.
CultureId System.Guid The culture id.
CultureDescription string The culture description. Required.
Account string The user account. Required.
Subscription string The user subscription. Required.
Roles System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.RoseRoleData> The user roles. Required.

^ Back to top

RoseUserListResponse

A list of ROSE users.

Properties
Property Type Description Rules
Users System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.RoseUserData> A list of rose users. Required.

^ Back to top

SaftConfiguration

The saft configuration model.

Properties
Property Type Description Rules
GroupByAnonymousCustomer bool Group by anonymous customer.
KeepRecordOfPrivateCustomers bool Keep record of private customers.
CustomerCreationKey int Customer creation key.
Items System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.SaftItems> Sales import group items list. Required.
Taxes System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.SaftTaxes> Sales import group taxes list. Required.

^ Back to top

SaftImportGroupData

The SAFT Import Group is used to manage default values for each type of saft, such as Group By Anonymous Customer, Customer Creation, Item Fiscal Type and Account Type and Taxes.

Properties
Property Type Description Rules
SaftImportGroupKey string The SAFT import group key. Required.
Description string? The description used in the ImportSalesGroup configuration.
GroupByAnonymousCustomer bool? Sets if is group by one-time customer.
KeepRecordOfPrivateCustomers bool? Sets if keep record of private customers.
CreationType Primavera.Lithium.RoseCentral.Client.Rest.Models.CodificationRule The SAFT import group creation type.
ItemTypeMappings System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.SaftItemTypeMappingData>? The SAFT import group item type mappings.
ItemTaxSchemaMappings System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.SaftItemTaxSchemaMappingData>? The SAFT import group item tax schema mappings.

^ Back to top

SaftImportGroupListResponse

The SAFT import group data.

Properties
Property Type Description Rules
SaftImportGroups System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.SaftImportGroupData> A list of SAFT import groups. Required.

^ Back to top

SaftItems

A list of items for a sales import group.

Properties
Property Type Description Rules
FiscalType Primavera.Lithium.RoseCentral.Client.Rest.Models.FiscalType The sales type fiscal type.
ItemAccountTypeKey string? The item account type key.

^ Back to top

SaftItemTaxSchemaMappingData

Describes the mapping between a tax sub class and a item tax schema.

Properties
Property Type Description Rules
TaxSubClass string The tax sub class code. Required.
TaxSubClassId System.Guid The tax sub class unique identifier.
TaxSubClassDescription string The tax sub class description. Required.
ItemTaxSchema string The item tax schema. Required.
ItemTaxSchemaId System.Guid The item tax schema unique identifier.
ItemTaxSchemaDescription string The item tax schema description. Required.
Index int Index number.

^ Back to top

SaftItemTypeMappingData

Describes a mapping between a fiscal type and a item account type.

Properties
Property Type Description Rules
FiscalType Primavera.Lithium.RoseCentral.Client.Rest.Models.FiscalType The sales type fiscal type.
FiscalTypeDescription string Fiscal type description. Required.
ItemAccountType string? The item account type code.
ItemAccountTypeId System.Guid? The item account type unique identifier.
ItemAccountTypeDescription string? The item account description field.
Index int Index number.

^ Back to top

SaftTaxes

A list of taxes for a sales import group.

Properties
Property Type Description Rules
FiscalType Primavera.Lithium.RoseCentral.Client.Rest.Models.FiscalType The sales type fiscal type.
TaxSubClassKey string The tax sub class key. Required.
ItemTaxSchemaKey string The item tax schema key. Required.

^ Back to top

SalesAccountDeterminationData

The Sales Account Profile Determination endpoint is used to discover the sales account in the company chart of account.

Properties
Property Type Description Rules
SalesAccountDeterminationKey string The sales account determination key. Required.
Description string? The description of the posting profile.
SalesGLAccounts System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.SalesGLAccountData>? The list of GL accounts.

^ Back to top

SalesAccountDeterminationListResponse

A list of items.

Properties
Property Type Description Rules
SalesAccountDeterminations System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.SalesAccountDeterminationData> A list of items. Required.

^ Back to top

SalesGLAccountData

The posting category account entity.

Properties
Property Type Description Rules
ChartOfAccount string The chart of accounts. Required.
ChartOfAccountId string The chart of accounts identifier. Required.
SalesAccount string The sales account for the item account type, item tax schema and party tax schema selected. Required.
SalesAccountId string The sales account for the item account type, item tax schema and party tax schema selected identifier. Required.
ItemAccountType string? The item account type.
ItemAccountTypeId string? The item account type identifier.
ItemTaxSchema string The item tax schema. Required.
ItemTaxSchemaId string The item tax schema identifier. Required.
PartyTaxSchema string? The party tax schema.
PartyTaxSchemaId string? The party tax schema identifier.
DiscountAccount string? The discount GL account for the item tax schema and party tax schema and item account type.
DiscountAccountId string? The discount GL account for the item tax schema and party tax schema and item account type identifier.

^ Back to top

SalesImportGroupBulkData

Describes a model used to update, in bulk, a sales import group in multiple companies.

Properties
Property Type Description Rules
Companies Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanyGroupBulkData A list of sales import group bulk data. Required.
SalesImportGroup Primavera.Lithium.RoseCentral.Client.Rest.Models.SalesImportGroupData The sales import group data. Required.

^ Back to top

SalesImportGroupData

Sales import group data entity.

Properties
Property Type Description Rules
SalesImportGroupKey string The user sales import group code. Required.
Description string Sales import group description. Required.
GroupByAnonymousCustomer bool If sales import group should group by anonymous customers.
KeepRecordPrivateCustomers bool Keep record of private customers.
IsSystem bool Identifies if entiy is system base.
CreationType Primavera.Lithium.RoseCentral.Client.Rest.Models.CodificationRule Party creation type.
ItemTaxSchemaMappings System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.ItemTaxSchemaMappingData>? List of tax schema mapping data.
ItemTypeMappings System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.ItemTypeMappingData>? List of sales type mapping data.
CompanyIdModel int Indicates the company that serves as model in the creation of this entity.
IsDefaultModel bool Indicates if this entity is the default entity.
Saving bool? Indicates if the entitiy is saving.
UpdateConfigurations bool? Indicates if configurations should be updated on a new subscription.

^ Back to top

SalesImportGroupListResponse

List of sales import group.

Properties
Property Type Description Rules
SalesImportGroups System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.SalesImportGroupData> List of sales import group. Required.

^ Back to top

SalesItemData

The Sales Item represents a service or product that your company provides.

Properties
Property Type Description Rules
Unit string The unit of measure for the sales item. Required.
ItemTaxSchema string The sales item's tax schema. The tax schema identifies the group of taxes a item is liable for. Required.
Locked bool Defines the entity stat, this is whether the sales item is locked.
ItemKey string? The key for the item. Uniquely identifies the item within the organization.
ItemWithholdingTaxSchema string? The sales item's withholding tax schema. The withholding tax schema identifies the group of withholding taxes a item is liable for.
Description string The description for the item. Required.
IsExternallyManaged bool A flag indicating if the item is externally managed.
BaseUnit string The base unit for the item. Required.
ItemType Primavera.Lithium.RoseCentral.Client.Rest.Models.ItemType The item type for the item.
ItemAccountType string The item type for accounting purposes. Required.
ItemSet string The item set is used to associate the item to a set of items. Required.
ItemAccountTypeId string The item account type identifier. Required.

^ Back to top

SalesItemDimensionData

The sales itme dimensions entity.

Properties
Property Type Description Rules
Dimension string The dimension. Required.
DimensionValue string The dimension value. Required.

^ Back to top

SalesItemListResponse

A list of items.

Properties
Property Type Description Rules
SalesItems System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.SalesItemData> A list of items. Required.

^ Back to top

ScheduleData

The schedule entity.

Properties
Property Type Description Rules
ScheduleKey string The schedule key. Required.
Name string The entity name. Required.
Monday decimal Monday total hours.
Tuesday decimal Tuesday total hours.
Wednesday decimal Wednesday total hours.
Thursday decimal Thursday total hours.
Friday decimal Friday total hours.
Saturday decimal Saturday total hours.
Sunday decimal Sunday total hours.
TotalHours decimal Total schedule hours.

^ Back to top

ScheduleListResponse

The schedules list response object.

Properties
Property Type Description Rules
Schedules System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.ScheduleData> The list of schedules. Required.

^ Back to top

SeedGroupData

Entities needed to seed db.

Properties
Property Type Description Rules
SalesImportGroup Primavera.Lithium.RoseCentral.Client.Rest.Models.SalesImportGroupData Sales import group. Required.
CompanySettingsGroup Primavera.Lithium.RoseCentral.Client.Rest.Models.CompanySettingsGroupData Company settings group. Required.
PartySettingsGroupData Primavera.Lithium.RoseCentral.Client.Rest.Models.PartySettingsGroupData Party settings group data. Required.
PurchasesImportGroup Primavera.Lithium.RoseCentral.Client.Rest.Models.PurchasesImportGroupData Purchases import group. Required.
Roles System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleData> The application roles. Required.
RoleGroups System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleGroupData> The system role groups. Required.

^ Back to top

SupplierGroupData

The Supplier Group represents an aggregation of suppliers that are similar in some way.

Properties
Property Type Description Rules
SupplierGroupKey string Supplier group. Required.
Description string? Supplier group description.
PaymentMethod string Payment method. Required.
PaymentMethodId string Payment method id. Required.
PaymentMethodDescription string Payment method description. Required.
PaymentTerm string Payment term. Required.
PaymentTermId string Payment term id. Required.
PaymentTermDescription string Payment term description. Required.
PartyTaxSchema string The purchases party tax schema. The tax schema identifies the group of taxes a party is liable for. Required.
PartyTaxSchemaId string Party tax schema id. Required.
PartyTaxSchemaDescription string Party tax schema description. Required.
DeliveryMode string? The Delivery mode. (ex: mail).
DeliveryModeId string? The Delivery mode. (ex: mail).
DeliveryModeDescription string? The Delivery mode. (ex: mail).
SettlementDiscountPercent decimal? The settlement's discount percentage.
PartyWithholdingTaxSchema string? The party withholding tax schema. The withholding tax schema identifies the group of withholding taxes a party is liable for.
PartyWithholdingTaxSchemaId string? The withholding tax schema identifies the group of withholding taxes a party is liable for. The withholding tax schema is defined in the customer party.
PartyWithholdingTaxSchemaDescription string? The withholding tax schema identifies the group of withholding taxes a party is liable for. The withholding tax schema is defined in the customer party.
DeliveryTerm string? The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the customer party.
DeliveryTermId string? The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the customer party.
DeliveryTermDescription string? The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the customer party.
IsDefault bool Indicates if this is the default supplier group for new suppliers.

^ Back to top

SupplierGroupListResponse

A list of supplier groups.

Properties
Property Type Description Rules
SupplierGroups System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.SupplierGroupData> A list of items. Required.

^ Back to top

SupplierPartyData

The Supplier Party represents companies or individuals who provide you with products or services.

Properties
Property Type Description Rules
SupplierGroup string Supplier group. Required.
SupplierGroupId string? Supplier group id.
SupplierGroupDescription string? Supplier group description.
PaymentMethod string Payment method. Required.
PaymentMethodId string Payment method id. Required.
PaymentMethodDescription string Payment method description. Required.
PaymentTerm string Payment term. Required.
PaymentTermId string Payment term id. Required.
PaymentTermDescription string Payment term description. Required.
PartyTaxSchema string The purchases party tax schema. The tax schema identifies the group of taxes a party is liable for. Required.
PartyTaxSchemaId string Party tax schema id. Required.
PartyTaxSchemaDescription string Party tax schema description. Required.
Locked bool When checked, the supplier party is locked.
SupplierSet string The supplier set of supplier party. Required.
SupplierSetId string Supplier set id. Required.
SupplierSetDescription string Supplier set description. Required.
DeliveryMode string? The Delivery mode. (ex: mail).
DeliveryModeId string? The Delivery mode. (ex: mail).
DeliveryModeDescription string? The Delivery mode. (ex: mail).
SettlementDiscountPercent decimal? The settlement's discount percentage.
PartyWithholdingTaxSchema string? The withholding tax schema identifies the group of withholding taxes a party is liable for. The withholding tax schema is defined in the customer party.
PartyWithholdingTaxSchemaId string? The party withholding tax schema. The withholding tax schema identifies the group of withholding taxes a party is liable for.
PartyWithholdingTaxSchemaDescription string? The withholding tax schema identifies the group of withholding taxes a party is liable for. The withholding tax schema is defined in the customer party.
DeliveryTerm string? The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the customer party.
DeliveryTermId string? The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the customer party.
DeliveryTermDescription string? The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the customer party.
AccountingParty string? The customer designated in the document as the party to whom the document should be sent for payment. It may or may not be the party to whom the goods or services are delivered.
AccountingPartyId string? The accounting identifier.
AccountingPartyDescription string? The accounting party description.

^ Back to top

SupplierPartyListResponse

A list of suppliers.

Properties
Property Type Description Rules
Suppliers System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.SupplierPartyData> A list of items. Required.

^ Back to top

SupplierPostingProfileData

The Supplier Posting Profile represents a way to discover the customer account in the company chart of account.

Properties
Property Type Description Rules
PostingProfileKey string The posting profile key. Required.
Description string? The description of the posting profile.
SupplierPostProfileAccounts System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.SupplierPostProfileAccountData>? The list of customer posting profile accounts.

^ Back to top

SupplierPostingProfileListResponse

A list of items.

Properties
Property Type Description Rules
SupplierPostingProfiles System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.SupplierPostingProfileData> A list of items. Required.

^ Back to top

SupplierPostProfileAccountData

The supplier profile account entity.

Properties
Property Type Description Rules
ChartOfAccount string The chart of accounts. Required.
ChartOfAccountId string The chart of accounts identifier. Required.
GlAccount string? The tax GL account for the chart of accounts and fiscal memo reason.
PartyAccountType string The party account type. Required.
PartyTaxSchema string The party tax schema (optional). Required.

^ Back to top

SupplierSetData

The Supplier Set represents a company container where supplier are grouped. A supplier can belong to a company or to several.

Properties
Property Type Description Rules
SupplierSetKey string Supplier set key. Required.
Description string? Supplier group description.
IsDefault bool Indicates if this is the default supplier set for new suppliers.

^ Back to top

SupplierSetListResponse

A list of supplier sets.

Properties
Property Type Description Rules
SupplierSets System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.SupplierSetData> A list of items. Required.

^ Back to top

TargetCompanyData

The target company aditional information (used in bulk operations).

Properties
Property Type Description Rules
Account string The target account. Required.
Subscription string The target subscription. Required.
Company string? The target company key.
ChartOfAccount string? The target chart of account key.

^ Back to top

TaxAuthoritySetupPTData

The Tax Authority Setup is used to manage default values for each company, such as the Communication to the Tax Authority and Tax Reporting.

Properties
Property Type Description Rules
Company string The company code is the central organizational unit within the system. Required.
CompanyId string The company code is the central organizational unit within the system (id). Required.
CompanyDescription string? The company code is the central organizational unit within the system (description).
AuthorityCommUserName string? The username of the login that allows the user to communicate with the financial authority.
AuthorityCommPassword string? The password of the login that allows the user to communicate with the financial authority.
AuthorityServiceCode string? Authority service code.
UseTestModeCommunication bool? Use test mode communication.
FinancialCommOption int? Indicates if the communication of financial documents is is done manually or automatically.
FinancialCommOptionDescription string? Financial comm option description.
TransportCommOption int? Indicates if the communication of transport documents is is done manually or automatically.
TransportCommOptionDescription string? Transport comm option description.
MainTaxReport string? Main tax report.
MainTaxReportId string? Main tax report id.
MainTaxReportDescription string? Main tax report description.
Region1TaxReport string? Region 1 tax report.
Region1TaxReportId string? Region 1 tax report id.
Region1TaxReportDescription string? Region 1 tax report description.
Region2TaxReport string? Region 2 tax report.
Region2TaxReportId string? Region 2 tax report id.
Region2TaxReportDescription string? Region 2 tax report description.
Form40TaxReport string? Region 2 tax report description.
Form40TaxReportId string? Form 40 tax report id.
Form40TaxReportDescription string? Form 40 tax report description.
Form41TaxReport string? Form 41 tax report.
Form41TaxReportId string? Form 41 tax report id.
Form41TaxReportDescription string? Form 41 tax report description.
FormA1TaxReport string? Form A1 tax report.
FormA1TaxReportId string? Form A1 tax report id.
FormA1TaxReportDescription string? Form A1 tax report description.
FormA2TaxReport string? Form A2 tax report.
FormA2TaxReportId string? Form A2 tax report id.
FormA2TaxReportDescription string? Form A2 tax report description.

^ Back to top

TaxAuthoritySetupPTListResponse

Tax auth setup PT list response.

Properties
Property Type Description Rules
TaxAuthoritySetupPTs System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.TaxAuthoritySetupPTData> A list of tax auth setup PTs. Required.

^ Back to top

TaxClassData

A Tax Class represents a type of tax e.g VAT.

Properties
Property Type Description Rules
TaxClassKey string The tax's class key. Required.
IsExternallyManaged bool The IsExternally managed flag indicates if the tax class is externally managed.
Description string? The tax's class key description. Identification of the type of tax, for example, Value Added Tax (VAT) or Stamp Tax.
ExternalId string? The external identifier.
ExternalVersion string? The external version.

^ Back to top

TaxClassListResponse

A list of tax classes.

Properties
Property Type Description Rules
TaxClasses System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.TaxClassData> A list of tax classes. Required.

^ Back to top

TaxCodeRateData

The tax code rate.

Properties
Property Type Description Rules
ValidFrom System.DateTime The date from which the rate is valid.
ValidTo System.DateTime The date until which the rate is valid.
Deductible decimal The deductible's percentage. The insurance deductible is the amount of money you will pay in an insurance claim before the insurance coverage starts paying you.
Value decimal The rate's value. Reference value for the calculation of values. percentage or a fraction value when it concerns rates (VAT, Withholding ...).
IsExternallyManaged bool The is externally managed flag indicates if the tax code rate is externally managed.
Description string? The rate's description.
ExternalId string? The external identifier.
ExternalVersion string? The external version.

^ Back to top

TaxDataWorkLocationData

The tax data work location entity.

Properties
Property Type Description Rules
WorkLocationKey string The key of the work location. Required.
BaseEntityKey string The key of the base entity. Required.
NISS string? The niss of tax data work location.
WorkLocationCode string? The code of tax data work location.
Location string The location of tax data work location. Required.
EconomicActivityClassification string The cae of tax data work location. Required.
ActivityStartDate System.DateTime? The start activity date of tax data work location.
SingleReportCode string? The single report code of tax data work location.
IsHeadQuarter bool Indicates if the work location is an headquarter.
Name string The name of the work location. Required.
Country string The country of the work location. Required.
BuildingNumber string The building number of the work location. Required.
StreetName string The street name of the work location. Required.
CityName string The city name of the work location. Required.
PostalZone string The postal zone of the work location. Required.
Company string The company key of the work location. Required.
ContactName string The contact name of the work location. Required.
ContactTitle string The contact title of the work location. Required.
FormattedAddress string The formatted address of the work location. Required.
Address string The address of the work location. Required.

^ Back to top

TaxesSetupData

The Taxes Setup is used to manage default values for each company, such as the fiscal time zone and tax regional area.

Properties
Property Type Description Rules
Company string The company code is the central organizational unit within the system. Required.
CompanyId string The company id is the central organizational unit within the system. Required.
CompanyDescription string The company description. Required.
AccountingSchema Primavera.Lithium.RoseCentral.Client.Rest.Models.AccountingSchema The entity's accounting organization method. This organization can follow the rules of "Cash Accounting" or "Accrual Accounting".
IsPortugueseCompany bool Internal managed flag to indicate if the company is a portuguese company.
SimplifiedInvoiceLimitAmountAmount decimal Simplified Invoice Limit Amount.
Currency string The used currency. Required.
CurrencyId string Currency id. Required.
CurrencyDescription string Currency description. Required.
EconomicActivityClassification string? The CEA's company. A national legal standard that attributes a 5-digit value to identify a company's specific category of professional activity.
EconomicActivityClassificationId string? Economic activity classification id.
EconomicActivityClassificationDescription string? Economic activity classification description.
FiscalTimeZone string The timezone of the company. Required.
FiscalTimeZoneId string? Fiscal time zone id.
FiscalTimeZoneDescription string? Fiscal time zone description.
TaxRegionalArea string The Tax Regional Area indicates the region where the company take place. Required.
TaxRegionalAreaId string? Tax regional area id.
TaxRegionalAreaDescription string? Tax regional area description.
TechnicalAccountantId string The Tax id of Technical account. Required.
TaxReportingPeriods System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.TaxesSetupTaxReportingPeriodData>? The reporting periods for the tax classes.
LegalRepresentativeId string The Tax id of the Legal Representative. Required.

^ Back to top

TaxesSetupListResponse

A list of tax setups.

Properties
Property Type Description Rules
TaxesSetups System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.TaxesSetupData> A list of customer sets. Required.

^ Back to top

TaxesSetupTaxReportingPeriodData

The reporting periods for the tax classes.

Properties
Property Type Description Rules
TaxClass string Tax class. Required.
TaxClassId string Tax class id. Required.
TaxClassDescription string Tax class description. Required.
ReportingPeriod Primavera.Lithium.RoseCentral.Client.Rest.Models.ReportingPeriod The reporting period.
PublicAuthority string Public authority designation. Required.
PublicAuthorityId string Public authority id. Required.
PublicAuthorityDescription string Public authority description. Required.
Index int The item index on list.
TaxesSetupId string Taxes setup id. Required.

^ Back to top

TaxonomyClassData

A Taxonomy Class represents a set of taxonomies which share the same accounting classification such as SNC Micro-entities.

Properties
Property Type Description Rules
TaxonomyClassKey string The taxonomy class key. Required.
Description string? The description of the taxonomy class key.

^ Back to top

TaxonomyClassListResponse

A list of items.

Properties
Property Type Description Rules
TaxonomyClasses System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.TaxonomyClassData> A list of items. Required.

^ Back to top

TaxRegionalAreaData

A Tax Regional Area represents which region the tax type code applies to.

Properties
Property Type Description Rules
TaxRegionalAreaKey string The tax's regional area key. Required.
Description string The tax's regional area description. Geographical area where certain tax rules and requirements are applied. Required.
Region string? The region of the taxes (key).
RegionId string The region of the taxes (id). Required.
RegionDescription string The region description. Required.
Country string The country of the taxes (key). Required.
CountryId string The country of the taxes (id). Required.
CountryDescription string The country description. Required.

^ Back to top

TaxRegionalAreaListResponse

A list of party account types.

Properties
Property Type Description Rules
TaxRegionalAreas System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.TaxRegionalAreaData> A list of items. Required.

^ Back to top

TaxReportFieldData

Tax report field entity.

Properties
Property Type Description Rules
ReportField string The report field. Required.
ReportFieldDescription string The report field description. Small description explaining what the tax is for. Required.
TaxReportFieldType Primavera.Lithium.RoseCentral.Client.Rest.Models.TaxReportFieldType The type of report field.
InvertSign bool If the sign of the amounts is inverted.
TaxTypeCode string? The tax type.
Amount Primavera.Lithium.RoseCentral.Client.Rest.Models.TaxAmount? The type of amount (base or tax) is used.
FiscalMemoReason string? Optional, use only if the amount is only to be added if the transaction was done under the fiscal memo reason.
ChartOfAccount string? Chart of Account.
ChartOfAccountId string The chart of accounts identifier. Required.
GlAccount string? The GLAccount.
TaxReportSummaries System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.TaxReportSummaryData>? The summaries of tax report.
TaxType Primavera.Lithium.RoseCentral.Client.Rest.Models.TaxType? The type of tax.
BalancePeriod Primavera.Lithium.RoseCentral.Client.Rest.Models.BalancePeriod? The balance amount of the period.
AutonomousTaxation string? The Autonomous Taxation used for the portuguese tax declaration M22Q13.
CashFlowItem string? The Cash Flow item used for the portuguese tax declaration IES.
Note string? Extended note when the report field is of type text.

^ Back to top

TaxReportSetupData

The Tax Report Setup is used to manage new reports to send to a specificTax Authority, such as like DPIVA or DPIVA-AC( Portuguese Tax Authority (AT)).

Properties
Property Type Description Rules
TaxReportSetupKey string The tax report key. Required.
TaxClass string The tax class used in the report(ex: IVA). Required.
Description string? The description of the report.
TaxReportFields System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.TaxReportFieldData>? The fields of the tax report.
ChartOfAccount string? Chat of Account.
TaxRegionalArea string? The region where the tax is reported.
TaxReportForm Primavera.Lithium.RoseCentral.Client.Rest.Models.TaxReportForm? The form where the report is reported.

^ Back to top

TaxReportSetupListResponse

A list of items.

Properties
Property Type Description Rules
TaxReportSetups System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.TaxReportSetupData> A list of items. Required.

^ Back to top

TaxReportSummaryData

Tax report summary entity.

Properties
Property Type Description Rules
ReportField string The report field number that will be used in the summary. Required.
InvertSign bool? Invert Sign.

^ Back to top

TaxSubClassData

A Tax Sub Class represents a sub type category for theTax Class, such as exempt or normal.

Properties
Property Type Description Rules
TaxSubClassKey string The tax sub class key. Required.
Description string? The tax's sub class description. Specific subcategory of a tax whose payment is required by the state.
IsExternallyManaged bool The is externally managed flag indicates if the tax code rate is externally managed.
TaxClass string The tax class will be processed. Required.
TaxClassId System.Guid? The tax class identifier.
TaxClassDescription string? The tax class description.

^ Back to top

TaxSubClassListResponse

The tax sub classes list response object.

Properties
Property Type Description Rules
TaxSubClasses System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.TaxSubClassData> The list of tax sub classes. Required.

^ Back to top

TaxTypeCodeData

A Tax Type Code represents one or more Tax Rules to transactions based on various criteria.

Properties
Property Type Description Rules
TaxCodeKey string The tax's code key. Required.
EUSalesList bool Indicates if is a tax for EU.
RoundingOff int Indicates the number of decimal places.
ScaleMethod Primavera.Lithium.RoseCentral.Client.Rest.Models.ScaleMethod Indicates the scale method.
RoundingType Primavera.Lithium.RoseCentral.Client.Rest.Models.RoundingType The type of rounding applicable on withholding tax.
RateType Primavera.Lithium.RoseCentral.Client.Rest.Models.RateType Indicates the rate type.
BaseValue Primavera.Lithium.RoseCentral.Client.Rest.Models.BaseValue Indicates if the value is calculated based on net amount of document or per line.
TaxClass string Identification of the type of tax, for example, Value Added Tax (VAT) or Stamp Tax. Required.
TaxSubClass string The specific subcategory of a tax whose payment is required by the state. Required.
TaxRegionalArea string The geographical area where certain tax rules and requirements are applied. Required.
IsExternallyManaged bool A flag indicating if the tax type code is externally managed.
ReverseCharge bool When the reverse charge is applied the recipent of the goods or services makes the declartion of both their purchases (Input tax) and the supplier's sale (output VAT) in their VAT return.
TaxType Primavera.Lithium.RoseCentral.Client.Rest.Models.TaxType Choose whether the tax is input (purchases) or output (sales).
IsPartyRequired bool Specify if it necessary to have a party.
TaxCodeRates System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.TaxCodeRateData>? The list of tax rates.
Description string? The tax's type description.
PrintCodeText string? The code that will be used in printing.
ExternalId string? The external identifier.
ExternalVersion string? The external version.
IsDeductible bool? Internal flag set if the tax type code is deductible.

^ Back to top

TaxTypeCodeListResponse

A list of items.

Properties
Property Type Description Rules
TaxTypeCodes System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.TaxTypeCodeData> A list of items. Required.

^ Back to top

UserAppInstanceData

Describes a user app instance entity.

Properties
Property Type Description Rules
Account string The app instance account (workspace). Required.
Subscription string The app instance subscription (organization-appinstance). Required.
Description string The subscription description. Required.
AppInstanceKey string? The app instance key.
UserId int The user identifier.
UserKey string The user key. Required.
UserName string? The user name.
IsManager bool If user is the app instance manager.
RoleGroupId int? The role group unique identifier.
Roles System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleSimpleData> The list of roles. Required.
Type Primavera.Lithium.RoseCentral.Client.Rest.Models.UserAppInstanceType The type of instance.
State Primavera.Lithium.RoseCentral.Client.Rest.Models.AppInstanceState The app instance state.

^ Back to top

UserAppInstanceInviteData

The invite complete object.

Properties
Property Type Description Rules
User Primavera.Lithium.RoseCentral.Client.Rest.Models.UserSimpleData The user information. Required.
Targets System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.AppInstanceInviteData> The app instances to give access. Required.

^ Back to top

UserAppInstanceListResponse

A user app instance list response.

Properties
Property Type Description Rules
UserAppInstances System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.UserAppInstanceData> A list of user app instances. Required.

^ Back to top

UserAppInstancePayloadData

Describes the association between a user and an app instance.

Properties
Property Type Description Rules
UserId string The user identifier. Required.
UserEmail string The user email. Required.
Workspace string The app instance workspace. Required.
AppInstance Primavera.Lithium.RoseCentral.Client.Rest.Models.AppInstanceData The app instance data. Required.

^ Back to top

UserAppInstanceUserData

Describes a user app instance and a user data.

Properties
Property Type Description Rules
User Primavera.Lithium.RoseCentral.Client.Rest.Models.UserData Identifies a user. Required.
UserAppInstance Primavera.Lithium.RoseCentral.Client.Rest.Models.UserAppInstanceData Identifies a user app instance. Required.

^ Back to top

UserCompanyData

The user current companies.

Properties
Property Type Description Rules
Id System.Guid The unique identifier.
CompanyKey string The entity key. Required.
Name string The entity name. Required.
NaturalKey string The natural key. Required.
CompanyTaxId string The company tax identification. Required.
SubscriptionId string The subscription identificator. Required.
Logo string The company logo. Required.
LogoThumbnail string The company logo thumbnail. Required.
Account string? The company account.
Subscription string? The company subscription.
PayrollAccount string The payroll account. Required.
PayrollSubscription string The payroll subscription. Required.

^ Back to top

UserCompanyListResponse

The list of current user companies.

Properties
Property Type Description Rules
UserCompanies System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.UserCompanyData> The list of user companies. Required.

^ Back to top

UserData

Describes a user entity.

Properties
Property Type Description Rules
UserKey string? The user key.
Name string The user name. Required.
Email string The user email. Required.
Picture string? The user picture.
PictureThumbnail string? The user picture thumbnail.
Culture string? The culture.
CultureId int The culture id.
CultureDescription string? The culture description.
IsCentralConfigurator bool? Defines if the user is a rose central configurator.
RoleGroupId int? The defaut role group identifier.
DefaultRoles System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.RoleData>? The user default roles.
UserType Primavera.Lithium.RoseCentral.Client.Rest.Models.UserType The user type.

^ Back to top

UserDeletedInstancePayload

Contains information about a deleted user app instance.

Properties
Property Type Description Rules
Subscription string The subscription key. Required.
Type Primavera.Lithium.RoseCentral.Client.Rest.Models.UserAppInstanceType The subscription type.

^ Back to top

UserDeletedPayload

Contains information about a deleted user.

Properties
Property Type Description Rules
SenderId string The user key of the sender. Required.
Source string The Rose Central source subscription. Required.
UserKey string? The user key.
Name string? The user name.
Email string The user email. Required.
Instances System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.UserDeletedInstancePayload> A list of deleted user app instances. Required.

^ Back to top

UserInstancePayload

Contains information about a user's role assignment.

Properties
Property Type Description Rules
Subscription string The target subscription. Required.
IsDeleted bool Whether the subscription access was removed.
Type Primavera.Lithium.RoseCentral.Client.Rest.Models.UserAppInstanceType The subscription type.
Roles System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.UserRoleResourcePayload> A list of roles related to a resource. Required.

^ Back to top

UserInviteData

Entity with invite and roles information.

Properties
Property Type Description Rules
Invites System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.UserAppInstanceInviteData> The invite list. Required.

^ Back to top

UserKeyResponse

Entity with the user key.

Properties
Property Type Description Rules
UserKey string The user key. Required.

^ Back to top

UserListResponse

Describes a user list response.

Properties
Property Type Description Rules
Users System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.UserData> A list of users. Required.

^ Back to top

UserPayload

Contains information about a user.

Properties
Property Type Description Rules
SenderId string The user key of the sender. Required.
Source string The Rose Central source subscription. Required.
UserKey string? The user key.
Name string? The user name.
Email string The user email. Required.
IsCentralConfigurator bool? Defines if the user is a rose central configurator.
UserType Primavera.Lithium.RoseCentral.Client.Rest.Models.UserType The user type.
Instances System.Collections.Generic.IList<Primavera.Lithium.RoseCentral.Client.Rest.Models.UserInstancePayload> A list of user instance roles. Required.

^ Back to top

UserRoleResourcePayload

Contains information about a user's role resource assignment.

Properties
Property Type Description Rules
Resource string The resource key (eg: company key or tax ID ou). Required.
Roles System.Collections.Generic.IList<string> A list of role keys. Required.
PreviousRoles System.Collections.Generic.IList<string>? A list of keys of previous roles.

^ Back to top

UserSimpleData

Describes a user entity.

Properties
Property Type Description Rules
UserKey string? The user key.
Name string The user name. Required.
Email string The user email. Required.
IsCentralConfigurator bool? Defines if the user is a rose central configurator.
RoleGroupId int? The defaut role group identifier.
UserType Primavera.Lithium.RoseCentral.Client.Rest.Models.UserType The user type.

^ Back to top

ValidateSocialSecurityNumberResult

Describes the result of a social security number validation.

Properties
Property Type Description Rules
SocialSecurityNumber string The social security number. Required.
CountryCode string The country code. Required.
ValidationState Primavera.Lithium.RoseCentral.Client.Rest.Models.FiscalNumberValidationState The validation state.

^ Back to top

ValidateVatNumberResult

Describes the result of a vat number validation.

Properties
Property Type Description Rules
VatNumber string The vat number. Required.
CountryCode string The country code. Required.
ValidationState Primavera.Lithium.RoseCentral.Client.Rest.Models.FiscalNumberValidationState The validation state.

^ Back to top

VatNumberInfoData

The vat number information data.

Properties
Property Type Description Rules
VatNumber string The vat number. Required.
CountryCode string The country code. Required.
Owner Primavera.Lithium.RoseCentral.Client.Rest.Models.VatNumberInfoOwnerData The vat number owner. Required.
State Primavera.Lithium.RoseCentral.Client.Rest.Models.FiscalNumberValidationState The fiscal number validation state.

^ Back to top

VatNumberInfoOwnerData

The vat number information owner data.

Properties
Property Type Description Rules
AddressFull string? The full address.
Aliases string? The company aliases.
CAE string? The company activity type.
CAEDescription string? The activity type description.
City string? The city name.
Country string? The country name.
District string? The district name.
DUNS string? The DUNS code.
Email string? The email address.
Fax string? The fax number.
Name string The company name. Required.
Phone string? The phone number.
PostalCode string? The postal code.
PostalTown string? The postal town.
State string? The company state.
Street string? The street name.
StreetNumber string? The street number.
WebSite string? The website address.
StateId Primavera.Lithium.RoseCentral.Client.Rest.Models.FiscalNumberValidationState The company fiscal number validation state.

^ Back to top

VersionData

The version of the entity.

Properties
Property Type Description Rules
Id int The version data identifier.
Version int The version data version.
CoreMigration bool? Whether the core migraton was executed.
ClientAccountingsMigration bool? Whether the client accountings migraton was executed.

^ Back to top

WorkLocationData

The work location entity.

Properties
Property Type Description Rules
WorkLocationKey string The key of the work location. Required.
Country string The country of the work location. Required.
StreetName string The street name of the work location. Required.
BuildingNumber string The building number of the work location. Required.
CityName string The city name of the work location. Required.
PostalZone string The postal zone of the work location. Required.
Company string The company key of the work location. Required.
IsHeadQuarter bool Indicates if the work location is an headquarter.
Name string The name of the work location. Required.
ContactName string The contact name of the work location. Required.
ContactTitle string The contact title of the work location. Required.
FormattedAddress string The formatted address of the work location. Required.
Address string The address of the work location. Required.

^ Back to top

WorkspaceData

Describes a workspace data.

Properties
Property Type Description Rules
Key string The workspace key. Required.
Name string The workspace name. Required.
State Primavera.Lithium.RoseCentral.Client.Rest.Models.WorkspaceState The workspace state.

^ Back to top

Enumerations Classes

AccountingNature

The default nature of the account (debit or credit).

Members
Member Value Description
Debit 1 Debit accounting nature.
Credit 2 Credit accounting nature.

^ Back to top

AccountingSchema

The entity's accounting organization method. This organization can follow the rules of "Cash Accounting" or "Accrual Accounting".

Members
Member Value Description
Accrual 1 Acrrual Accounting Schema.
Cash 2 Cash schema.

^ Back to top

AllowedIn

The item tax schemas allowed in modules.

Members
Member Value Description
Sales 1 The sales module.
Purchases 2 The purchases module.

^ Back to top

AppInstanceState

The organization State enumeration.

Members
Member Value Description
Active 0 The organization active state.
Suspended 1 The organization suspended state.
Closed 2 The organization closed state.
Preparing 3 The app instance preparing state.
Failed 4 The app instance failed state.

^ Back to top

ApplicationType

The application type.

Members
Member Value Description
RoseAccountingServices 0 The Rose Accounting Services type.
RosePayroll 1 The Rose Payroll type.
DigitalArchive 2 The Digital Archive type.

^ Back to top

BalancePeriod

Balance period enum.

Members
Member Value Description
Current 1 The Current.
YearToPrevious 2 The YearToPrevious.
YearToCurrent 3 The YearToCurrent.
Opening 4 The Opening.
FirstToPrevious 5 The FirstToPrevious.
FirstToCurrent 6 The FirstToCurrent.

^ Back to top

BaseValue

BaseValue enum.

Members
Member Value Description
NetAmountPerLine 1 Net Amount Per Line.
NetAmountDocumentTotal 2 Net Amount Document Total.

^ Back to top

ClientAccountingStatus

The company new subscription status.

Members
Member Value Description
Initializing 1 The new subscription is initializing.
Error 2 The new subscription throwed an error.
Ready 3 The new subscription is ready.

^ Back to top

CodificationRule

Types of rules to create a party.

Members
Member Value Description
AutoNumber 0 Sequencial number.
TaxId 1 The company tax id.

^ Back to top

CommunicationType

Communication type.

Members
Member Value Description
WebService 1 Webservice type.
SAFT 2 Saft type.
NoCommunication 3 No communication type.
Manual 4 Manual type.

^ Back to top

CompanyOperationStatus

Describes a company initilization operation status mode.

Members
Member Value Description
Running 0 Indicates that the operation is still running.
CompletedWithError 1 Indicates that the operation has completed with errors.
CompletedWithSuccess 2 Indicates that the operation has completed with success.

^ Back to top

CompanyOperationStatusType

Describes the type of a company initialization operation.

Members
Member Value Description
CreateAccountingAppInstance 0 Indicates that operation is creating rose as app instance.
CreatePayrollAppInstance 1 Indicates that operation is creating payroll app instance.
ManageResponsible 2 Indicates a operation of managing the responsible information.
CheckAccountingUpgrade 3 Describes a checking Rose AS upgrade operation.
CheckPayrollUpgrade 4 Describes a checking Rose Payroll upgrade operation.
ValidateCompanySettingsGroup 38 Describes a company settings group validation operation.
SetBasicSettings 5 Describes a basic settings setting operation.
CreateChartOfAccount 6 Describes a create chart of account operation.
ApplySalesImportGroupConfigurations 7 Describes a sales import group configurations application operation.
CreateCompanySettingsEntities 8 Describes a company settings group entities creation operation.
CreateRoseCompany 9 Describes a rose company creation operation.
CreateJournalTypes 10 Describes the journal types creation operation.
ManageAccess 11 Describes the managing access's operation.
CreateCustomer 12 Describes the customer creation operation.
CreateTaxesEntities 13 Describes the taxes entities creation operation.
ApplyPayrollConfigurations 14 Describes the payroll configurations application operation.
ApplyKeyVaultInformation 15 Describes the key vault information application operation.
UpdateCompanyInformation 16 Describes the company information update operation.
CreateSaftImportConfigurations 17 Describes the saft import configurations creation operation.
CreateFiscalMemoReasons 18 Describes the fiscal memo reasons creation operation.
CreateItemAccountTypes 19 Describes the item account types creation operation.
CreateTaxTypeCodes 20 Describes the tax type codes creation operation.
CreatePartyTaxSchemas 21 Describes the party tax schemas creation operation.
CreatePartyAccountTypes 22 Describes the party account types creation operation.
CreateTaxonomyClasses 23 Describes the taxonomy classes creation operation.
CreateFinancialStatements 24 Describes the financial statements creation operation.
CreateFinancialAccountDeterminations 25 Describes the financial account determinations creation operation.
CreateCustomerPostingProfiles 26 Describes the customer posting profiles creation operation.
CreateSalesAccountDeterminations 27 Describes the sales account determinations creation operation.
CreateSupplierPostingProfiles 28 Describes the supplier posting profiles creation operation.
CreatePurchasesAcctDeterminations 29 Describes the purchases acct determinations creation operation.
CreateMaterialAcctDeterminations 30 Describes the material acct determinations creation operation.
CreatePostingCategories 31 Describes the posting categories creation operation.
CreateTaxReportSetups 32 Describes the tax report setups creation operation.
CreateFiscalWithholdingTaxTypes 33 Describes the fiscal withholding tax types creation operation.
CreateSalesItems 34 Describes the sales items creation operation.
CreateCurrencyPrecisionDigits 35 Describes the currency precision digits creation operation.
CreateSalesImportGroupEntities 36 Describes the sales import groups entities creation operation.
CreateMyRoseSupplier 37 Describes the my rose supplier creation operation.
CreateEmployeeAppInstance 39 Describes the employee instance creation.

^ Back to top

CompanySaveMode

The company save mode.

Members
Member Value Description
Update 0 The update mode.
CreateWithNewAppInstance 1 The create with new app instance mode.
CreateWithExistingAppInstance 2 The create with existing app instance mode.

^ Back to top

CompanyStatus

The company new subscription status.

Members
Member Value Description
Initializing 0 The new subscription is initializing.
Active 1 The new company is ready.
ErrorInSubscription 2 The new subscription throwed an error.
Inactive 3 The company is in an inactive state.
ErrorInCompany 4 The company creation process throwed an error.
ErrorInConfigurations 5 The company configurations applying operation throwed an error.
Closed 6 The subscription related to the company is in closed state.
Canceled 7 Operation canceled by user.

^ Back to top

DateFormat

The date format.

Members
Member Value Description
DefaultDateFormat 1 Default date format.
DDMMYYYYDOT 2 DD.MM.YYYY.
DDMMYYYYSLASH 3 DD/MM/YYYY.
MMDDYYYYSLASH 4 MM/DD/YYYY.
MMDDYYYYHYPHEN 5 MM-DD-YYYY.
YYYYMMDDHYPHEN 6 YYYY-MM-DD.
YYYYMMDDSLASH 7 YYYY/MM/DD.

^ Back to top

DestinySchemaEntity

The end request source.

Members
Member Value Description
JournalType 0 Journal Type.
GeneralLedgerAccount 1 General Ledger Account.
ItemTaxSchema 6 Item Tax Schema.
TaxSubClass 7 Tax Sub Class.
ItemAccountType 8 Item Account Type.
FinancialSetups 2 Financial Setups.
PayrollCoreSetups 3 Payroll Core Setups.
ConfigurationModules 4 Configuration Modules.

^ Back to top

ElectronicTransferFileType

Electronic transfer file type.

Members
Member Value Description
SEPA 1 SEPA type.
SEPADD 2 SEPADD type.
CARRCGD 3 CARRCGD type.
PS2BCP 4 PS2BCP type.

^ Back to top

ElectronicTransferPurpose

Electronic transfer purpose.

Members
Member Value Description
SALA 1 SALA type.
SUPP 2 SUPP type.
OTHR 3 OTHR type.

^ Back to top

EntityStatus

The company new subscription status.

Members
Member Value Description
Saving 0 The creation of the new entity was initialized.
Ready 1 The creation of the new entity is ready.
Error 2 The creation of the new entity throwed an error.

^ Back to top

EventLevel

The event log entry type.

Members
Member Value Description
Information 0 An information type event.
Warning 1 A warning type event.
Error 2 An error type event.

^ Back to top

FinancialAccountType

The financial account type enumeration.

Members
Member Value Description
PettyCash 1 Petty cash.
BankAccount 2 Bank account.

^ Back to top

FinancialStatementItemType

Financial statement item type enum.

Members
Member Value Description
Account 1 Account item.
Summatory 2 Summatory item.
Text 3 Text item.
GrandTotal 4 GrandTotal item.
Header 5 Header item.
Taxonomy 6 Taxonomy item.

^ Back to top

FinancialStatementPurpose

Financial statement item type enum.

Members
Member Value Description
BalanceSheet 1 Balance Sheet item.
ProfitAndLoss 2 Profit And Loss item.

^ Back to top

FinancialYearOperations

The operations regarding documents on a financial year.

Members
Member Value Description
Closing 0 This operation executes the financial year closing process which produces one or more closing documents.
Opening 1 This operation executes the financial year opening process which produces one or more opening documents. The process involves closing the homologous financial year and copying the balances to the new financial year by creating account postings with each account's balance.

^ Back to top

FiscalMemoReasonType

Fiscal Memo Reason Type.

Members
Member Value Description
InputTax 1 Input Tax.
OutputTax 2 Output Tax.
Both 3 Input and output tax.

^ Back to top

FiscalNumberValidationState

The fiscal number validation states.

Members
Member Value Description
Valid 0 The fiscal number is valid.
NotValid 1 The fiscal number is not valid.
NotValidated 2 The fiscal number is not validated.

^ Back to top

FiscalType

The sales type mapping fiscal type.

Members
Member Value Description
Products 1 The products fiscal type.
Services 2 The services fiscal type.
Others 3 The others fiscal type.
ExciseDuties 4 The excise duties fiscal type.
Taxes 5 The taxes fiscal type.

^ Back to top

FiscalUse

Fiscal use.

Members
Member Value Description
Financial 1 Financial fiscal use.
Stock 2 Stock fiscal use.
Other 3 Other fiscal use.

^ Back to top

ItemType

Item type enum.

Members
Member Value Description
Item 1 If item is item.
Service 2 If item is service.

^ Back to top

JournalNumbering

The type of jounal numbering (monthly or yearly).

Members
Member Value Description
Monthly 1 Monthly journal numbering.
Yearly 2 Yearly journal numbering.

^ Back to top

LedgerType

The ledger type enumerator.

Members
Member Value Description
Actual 1 The actual ledger type.
Budget 2 The budget ledger type.
Forecast 3 The forecast ledger type.

^ Back to top

MaritalStatus

The contact’s marital status.

Members
Member Value Description
Single 1 The single marital status.
Married 2 The married marital status.

^ Back to top

Month

The month enumerator.

Members
Member Value Description
January 1 The month of january.
February 2 The month of february.
March 3 The month of march.
April 4 The month of april.
May 5 The month of may.
June 6 The month of june.
July 7 The month of july.
August 8 The month of august.
September 9 The month of september.
October 10 The month of october.
November 11 The month of november.
December 12 The month of december.

^ Back to top

NotificationType

Defines the type of the notifications.

Members
Member Value Description
Info 0 When the notification is a information message.
Success 1 When the notification is a success message.
Warning 2 When the notification is a warning message.
Error 3 When the notification is a error message.

^ Back to top

OrganizationState

The organization State enumeration.

Members
Member Value Description
Active 0 The organization active state.
Suspended 1 The organization suspended state.
Closed 2 The organization closed state.

^ Back to top

PartyType

Types of Party.

Members
Member Value Description
Customer 1 The customer party type.
Supplier 2 The supplier party type.
FinancialInstitution 3 The financial institution party type.
SalesPerson 5 The sales person party type.
OtherPayable 6 The other payable party type.
OtherReceivable 7 The other receivable party type.
PublicAuthority 8 The public authority party type.
Employee 9 The employee party type.

^ Back to top

PaymentMethodType

Payment method type.

Members
Member Value Description
Cash 1 Type cash.
Check 2 Type check.
EletronicTransfer 3 Type eletronic transfer.
Other 4 Type other.

^ Back to top

PayrollEntities

Enumerate all payroll entities.

Members
Member Value Description
ConfigurationModule 0 Identifies an entity of type configuration module.
PayrollCoreSetup 1 Identifies an entity of type payroll core setup.
Schedule 2 Identifies an entity of type schedule.

^ Back to top

PeriodType

The period type (opening, regular, closing).

Members
Member Value Description
Opening 1 Opening period type.
Operating 2 Operating period type.
Closing 3 Closing period type.

^ Back to top

PlanConfiguration

The plan configuration.

Members
Member Value Description
Essentials 0 The Essentials plan.
Vision 1 The Vision plan.
Educa 2 Educa plan.
Other 3 Other plan.

^ Back to top

ProvisioningState

The existing provisioning states.

Members
Member Value Description
Starting 0 Provisioning is starting.
Finished 4 Provisioning is complete.
Error 5 An error has ocurred.

^ Back to top

RateType

Rate type enum.

Members
Member Value Description
PercentageOfNetAmount 1 Percentage Of Net Amount.

^ Back to top

ReportingPeriod

Reporting periods.

Members
Member Value Description
Monthly 1 Monthly period.
Quarterly 2 Quarterly period.
Yearly 3 Yearly period.

^ Back to top

RoleGroupType

The user type.

Members
Member Value Description
AccountingOffice 0 Accounting office group type.
Client 1 Client group type.
Central 2 Rose central group type.

^ Back to top

RoleType

The types of roles.

Members
Member Value Description
Accounting 0 ROSE Accounting Services type of role.
Payroll 1 ROSE Payroll type of role.
Central 3 ROSE Central type of role.

^ Back to top

RoseEntities

Enumerate all rose entities.

Members
Member Value Description
ChartOfAccount 0 Identifies an entity of type chart of account.
FinancialCalendar 1 Identifies an entity of type financial calendar.
FinancialSetup 2 Identifies an entity of type financial setup.
GeneralLedgerAccount 3 Identifies an entity of type general ledger account.
ItemAccountType 4 Identifies an entity of type item account type.
ItemTaxSchema 5 Identifies an entity of type item tax schema.
JournalType 6 Identifies an entity of type journal type.
Ledger 7 Identifies an entity of type ledger.
NonWorkingDay 8 Identifies an entity of type non working day.
Party 9 Identifies an entity of type party.
PaymentMethod 10 Identifies an entity of type payment method.
PaymentTerm 11 Identifies an entity of type payment term.
TaxSubClass 12 Identifies an entity of type tax sub class.
PartyAccountType 13 Identifies an entity of type party account type.
CustomerSet 14 Identifies an entity of type customer set.
CustomerGroup 15 Identifies an entity of type customer group.
TaxClass 16 Identifies an entity of type tax class.
Company 17 The company identifier.

^ Back to top

RoundingType

Rounding type enum.

Members
Member Value Description
Normal 1 Normal type.
RoundUp 2 Round up type.
Downwards 3 Downwards type.

^ Back to top

Salutation

The contact's greeting.

Members
Member Value Description
Mr 1 The Mr. greeting.
Ms 2 The Ms. greeting.
DearSir 3 The Dear Sir greeting.
DearMadam 4 THe Dear Madam greeting.

^ Back to top

ScaleMethod

Scale method enum.

Members
Member Value Description
WholeAmount 1 Whole Amount.

^ Back to top

SourceSchemaEntity

The request source.

Members
Member Value Description
Companies 0 From companies.
CompaniesSettingsGroup 1 From companies settings groups.
PartiesSettingsGroup 2 From parties settings groups.
PurchasesImportGroup 3 Form purchases import groups.
SalesImportGroup 4 From sales import group.
Users 5 From users.
Roles 6 From roles.
UserAppInstances 7 From user app instances.
PublicPlatformCredentials 8 From public platform credentials.
Cultures 9 From cultures.
Migration 10 From migration.
RoseUsers 12 From ROSE users.
FinancialYears 13 From financial years.
Other 11 Other source.
RolesGroups 14 The roles groups entity identifier.

^ Back to top

SubAccountType

Describes a sub account type.

Members
Member Value Description
Customers 1 Defines a sub account as customer.
Suppliers 2 Defines a sub account as supplier.
PettyCashes 3 Defines a sub account as petty cashes.
FinancialAccounts 4 Defines a sub account as financial account.
OtherPayables 5 Defines a sub account as other payables.
OtherReceivables 6 Defines a sub account as other receivables.
PublicAuhtorities 7 Defines a sub account as public authorities.
Assets 8 Defines a sub account as assets.
Employees 9 Defines a sub account as employees.

^ Back to top

SubscriptionType

Types of subscriptions (for closing purposes).

Members
Member Value Description
RoseAccountingServices 0 The ROSE Accounting Services (and related) member.

^ Back to top

TaxAmount

Tax amount enum.

Members
Member Value Description
TaxableAmount 1 The TaxableAmount.
TaxAmount 2 The TaxAmount.
Balance 3 The Balance.
Credit 4 The Credit.
Debit 5 The Debit.
CreditMovements 6 The CreditMovements.
DebitMovements 7 The DebitMovements.

^ Back to top

TaxReportFieldType

Tax report field type enum.

Members
Member Value Description
Undefined 1 The Undefined.
TaxBalance 2 The TaxBalance.
GLAccountBalance 3 The GLAccountBalance.
Summary 4 The Summary.
AutonomousTaxation 5 The AutonomousTaxation.
CashFlow 6 The CashFlow.
BalanceNotes 7 The BalanceNotes.

^ Back to top

TaxReportForm

Teh tax report form enum.

Members
Member Value Description
DPIVAMain 1 The DPIVAMain.
DPIVA40 2 The DPIVA40.
DPIVA41 3 The DPIVA41.
DPIVAA1 4 The DPIVAA1.
DPIVAA2 5 The DPIVAA2.
Model22 6 The Model22.
Model22AD 7 The Model22.
IESAA 8 The IESAA.
IESAI 9 The IESAI.
IESAL 10 The IESAL.

^ Back to top

TaxType

Tax type enum.

Members
Member Value Description
InputTax 1 The input tax.
OutputTax 2 The outpu tax.

^ Back to top

TransactionType

The type of transaction of a journal type.

Members
Member Value Description
Opening 1 Opening transaction type.
Normal 2 Normal transaction type.
Rectification 3 Rectification transaction type.
Adjustment 4 Adjustment transaction type.
Closing 5 Closing transaction type.

^ Back to top

UserAppInstanceType

Defines a type of user app instance.

Members
Member Value Description
Accounting 0 ROSE Accounting Services type.
Central 1 ROSE Central type.

^ Back to top

UserType

The user type.

Members
Member Value Description
AccountingOffice 0 Accounting office user.
Client 1 Client user.

^ Back to top

WorkspaceState

The workspace State enumeration.

Members
Member Value Description
Active 0 The workspace active state.
Suspended 1 The workspace suspended state.
Closed 2 The workspace closed state.

^ Back to top