Connectors Reference

Elfsquad Product Configurator

The Elfsquad Product Configurator enables sellers, or even end-customers to configure complex products. Create error-free quotations within minutes. Elfsquad uses Power Automate to sync with other applications. E.g. Sync contacts and quotes to CRM, Bill of Materials (BOM) to ERP and fill parametric models in CAD.

 

Status: Preview

Tier: Premium

Version: v2

 

Actions:

Name

Summary

Categories_Get ()

Get categories

Categories_Post ([Optional]Category entity)

Create category

Categories_Update ([Optional]Category entity)

Update category

Categories_Subcategories_GetById (string id)

Retrieve subcategories

Categories_DeleteById (string id)

Delete category

Categories_GetById (string id)

Get category by id

Categories_Patch ([Optional]array patchDocument, string id)

Patch category

CrmAccounts_Get ()

Get CRM Accounts

CrmAccounts_Post ([Optional]CrmAccount entity)

Create new CRM Account

CrmAccounts_Update ([Optional]CrmAccount entity)

Update CRM Account

CrmAccounts_DeleteById (string id)

Delete CRM Account

CrmAccounts_GetById (string id)

Get CRM Account by id

CrmAccounts_Patch ([Optional]array patchDocument, string id)

Patch CRM Account

CrmContacts_Get ()

Get CRM Contacts

CrmContacts_Post ([Optional]CrmContact entity)

Create new CRM Contact

CrmContacts_Update ([Optional]CrmContact entity)

Update CRM Contact

CrmContacts_DeleteById (string id)

Delete CRM Contact

CrmContacts_GetById (string id)

Get CRM Contact by id

CrmContacts_Patch ([Optional]array patchDocument, string id)

Patch CRM Contact

FeatureHasProperties_Get ()

Get feature has properties

FeatureHasProperties_Post ([Optional]FeatureHasFeatureProperty entity)

Create a relationship between feature and property

FeatureHasProperties_Update ([Optional]FeatureHasFeatureProperty entity)

Update a relationship between feature and property

FeatureHasProperties_Delete (string id)

Delete a feature has property relationship

FeatureHasProperties_Patch ([Optional]array patchDocument, string id)

Patch a relationship between feature and property

FeatureModels_Get ()

Get feature models

FeatureModels_Post ([Optional]FeatureModel entity)

Create feature model

FeatureModels_Update ([Optional]FeatureModel entity)

Update feature model

FeatureModels_DeleteById (string id)

Delete feature model

FeatureModels_GetById (string id)

Get feature model by id

FeatureModels_Patch ([Optional]array patchDocument, string id)

Patch feature model

FeaturesProperties_Get ()

Get feature properties

FeaturesProperties_Post ([Optional]FeatureProperty entity)

Create new feature property

FeaturesProperties_Update ([Optional]FeatureProperty entity)

Update a feature property

FeaturesProperties_Delete (string id)

Delete feature property

FeaturesProperties_GetById (string id)

Get feature property by id

FeaturesProperties_Patch ([Optional]array patchDocument, string id)

Patch a feature property

Features_Get ()

Get features

Features_Post ([Optional]Feature feature)

Create new feature

Features_Update ([Optional]Feature feature)

Update feature

Features_Copy ([Optional]array features)

Copy features

Features_DeleteById (string id)

Delete feature

Features_GetById (string id)

Get feature by id

Features_Patch ([Optional]array patchDocument, string id)

Patch feature

Files_Post (file File)

Upload a new file

Notifications_Send ([Optional]NotificationViewModel notification)

Open a prompt dialog for a specific user

OrgSellsFeature_Get ()

Get OrganizationSellsFeatures

OrgSellsFeature_Post ([Optional]OrganizationSellsFeature entity)

Create a OrganizationSellsFeature relationship

OrgSellsFeature_Update ([Optional]OrganizationSellsFeature entity)

Update OrganizationSellsFeature relationship

OrgSellsFeature_GetByFeatureId (string id)

Retrieve OrganizationSellsFeature relationships by feature id

OrgSellsFeature_Delete (string id)

Delete OrganizationSellsFeature relationship

OrgSellsFeature_GetById (string id)

Retrieve OrganizationSellsFeature relationship by id

OrgSellsFeature_Patch ([Optional]array patchDocument, string id)

Patch OrganizationSellsFeature relationship

QuotationProperties_Get55 ()

Get quotation properties

QuotationProperties_Post ([Optional]QuotationProperty entity)

Create quotation property

QuotationProperties_Update ([Optional]QuotationProperty entity)

Update quotation property

QuotationProperties_Get (string id)

Delete quotation property

QuotationProperties_GetById (string id)

Get quotation property by id

QuotationProperties_Patch ([Optional]array patchDocument, string id)

Patch quotation property

QuotationPropertyFields_Get ()

Get quotation property fields

QuotationPropertyFields_Delete (string id)

Delete quotation property field

Quotations_Get ()

Get quotations

Quotations_Post ([Optional]Quotation entity)

Create new quotation

Quotations_Update ([Optional]Quotation quotation)

Update a quotation

Quotations_Patch_Bulk ([Optional]BulkJsonPatchDocument[Quotation] patchDocument)

Patch multiple quotations

Quotations_DeleteById (string id)

Delete quotation

Quotations_GetById (string id, [internal]string include)

Get quotation by id

Quotations_Patch ([Optional]array patchDocument, string id)

Patch a quotation

Quotations_AddConfigurations (string id, [Optional]array configurationIds)

Add configurations to a quotation

Quotations_AddFile (string id, file File)

Add file to quotation

Quotations_Copy (string id)

Copy quotation

Quotations_GetPdf (string id)

Generate quotation PDF

Quotations_Revise (string id)

Create quotation revision

Steps_Get ()

Get steps

Steps_Post ([Optional]Step entity)

Create new step

Steps_Update ([Optional]Step entity)

Update step

Steps_DeleteById (string id)

Delete step

Steps_GetById (string id)

Get step by id

Steps_Patch ([Optional]array patchDocument, string id)

Patch step

 

Triggers:

Name

Summary

Webhooks_Custom (Webhooks_CustomParameterWebHooksSubscription webHooksSubscription, string identifier)

Custom trigger

Webhooks_QuotationAccepted (Webhooks_QuotationAcceptedParameterWebHooksSubscription webHooksSubscription)

When a quotation is accepted

Webhooks_QuotationConfigurationAdded (Webhooks_QuotationConfigurationAddedParameterWebHooksSubscription webHooksSubscription)

When a configuration is added to a quotation

Webhooks_QuotationDenied (Webhooks_QuotationDeniedParameterWebHooksSubscription webHooksSubscription)

When a quotation is declined

Webhooks_QuotationRequested (Webhooks_QuotationRequestedParameterWebHooksSubscription webHooksSubscription)

When a quotation is requested

Webhooks_QuotationRevised (Webhooks_QuotationRevisedParameterWebHooksSubscription webHooksSubscription)

When a quotation is revised

Webhooks_QuotationSubmitted (Webhooks_QuotationSubmittedParameterWebHooksSubscription webHooksSubscription)

When a quotation is submitted

Webhooks_QuotationVerified (Webhooks_QuotationVerifiedParameterWebHooksSubscription webHooksSubscription)

When a quotation is verified

 

Objects:

Name

Summary

AssociatedFeatureProperty

 

BulkJsonPatchDocument[Quotation]

 

Category

 

CategoryText

 

CrmAccount

 

CrmContact

 

Feature

 

FeatureHasFeatureProperty

 

FeatureModel

 

FeatureModelAttachmentNode

 

FeatureModelDynamicGroup

 

FeatureModelDynamicGroupFilter

 

FeatureModelNode

 

FeatureModelRelationship

 

FeatureProperty

 

FeatureText

 

file

File

FileEntity

 

JsonPatchDocument[Quotation]

 

NotificationViewModel

 

Operation

 

Operation[Quotation]

 

OrganizationSellsFeature

 

Quotation

 

QuotationFile

 

QuotationLine

 

QuotationProperty

 

QuotationPropertyField

 

QuotationPropertyFieldText

 

Step

 

StepText

 

UnitOfMeasurement

 

Webhooks_CustomParameterWebHooksSubscription

 

Webhooks_QuotationAcceptedParameterWebHooksSubscription

 

Webhooks_QuotationConfigurationAddedParameterWebHooksSubscription

 

Webhooks_QuotationDeniedParameterWebHooksSubscription

 

Webhooks_QuotationRequestedParameterWebHooksSubscription

 

Webhooks_QuotationRevisedParameterWebHooksSubscription

 

Webhooks_QuotationSubmittedParameterWebHooksSubscription

 

Webhooks_QuotationVerifiedParameterWebHooksSubscription

 

 

Actions:

Categories_Get

Summary: Get categories

Description: Retrieves a list of all available categories

 

Syntax:

ElfsquadProductConfigurator.Categories_Get ()

 

Returns:

          Type:array of (Category)

 

Categories_Post

Summary: Create category

Description: Create a new category

 

Syntax:

ElfsquadProductConfigurator.Categories_Post ([Optional]Category entity)

 

Parameters:

Name

Type

Summary

Required

Related Action

entity

Category

 

 

False

 

Returns:

          Type:Category

 

Categories_Update

Summary: Update category

Description: Update a category

 

Syntax:

ElfsquadProductConfigurator.Categories_Update ([Optional]Category entity)

 

Parameters:

Name

Type

Summary

Required

Related Action

entity

Category

 

 

False

 

Returns:

          Type:Category

 

Categories_Subcategories_GetById

Summary: Retrieve subcategories

Description: Retrieve a list of available subcategories for a given category

 

Syntax:

ElfsquadProductConfigurator.Categories_Subcategories_GetById (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string(uuid)

(Id)

Identifier of the category

True

 

Returns:

          Type:array of (Category)

 

Categories_DeleteById

Summary: Delete category

Description: Delete a category by its identifier

 

Syntax:

ElfsquadProductConfigurator.Categories_DeleteById (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string(uuid)

(Id)

Category identifier

True

 

Returns:

 

Categories_GetById

Summary: Get category by id

Description: Retrieve a category by its identifier

 

Syntax:

ElfsquadProductConfigurator.Categories_GetById (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string(uuid)

(Id)

Category identifier

True

 

Returns:

          Type:Category

 

Categories_Patch

Summary: Patch category

Description: Update a category

 

Syntax:

ElfsquadProductConfigurator.Categories_Patch ([Optional]array patchDocument, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

patchDocument

array of (Operation)

 

 

False

id

string(uuid)

(Id)

Category identifier

True

 

Returns:

          Type:Category

 

CrmAccounts_Get

Summary: Get CRM Accounts

Description: Retrieves a list of all avaible CRM Accounts

 

Syntax:

ElfsquadProductConfigurator.CrmAccounts_Get ()

 

Returns:

          Type:array of (CrmAccount)

 

CrmAccounts_Post

Summary: Create new CRM Account

Description: Create new CRM Account

 

Syntax:

ElfsquadProductConfigurator.CrmAccounts_Post ([Optional]CrmAccount entity)

 

Parameters:

Name

Type

Summary

Required

Related Action

entity

CrmAccount

 

 

False

 

Returns:

          Type:CrmAccount

 

CrmAccounts_Update

Summary: Update CRM Account

Description: Update a CRM Account

 

Syntax:

ElfsquadProductConfigurator.CrmAccounts_Update ([Optional]CrmAccount entity)

 

Parameters:

Name

Type

Summary

Required

Related Action

entity

CrmAccount

 

 

False

 

Returns:

          Type:CrmAccount

 

CrmAccounts_DeleteById

Summary: Delete CRM Account

Description: Delete a CRM Account by it's id

 

Syntax:

ElfsquadProductConfigurator.CrmAccounts_DeleteById (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string(uuid)

(Id)

Identifier of the CRM Account

True

 

Returns:

 

CrmAccounts_GetById

Summary: Get CRM Account by id

Description: Retrieves a CRM Account by its identifier

 

Syntax:

ElfsquadProductConfigurator.CrmAccounts_GetById (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string(uuid)

(Id)

Identifier of the CRM Account

True

 

Returns:

          Type:CrmAccount

 

CrmAccounts_Patch

Summary: Patch CRM Account

Description: Update a CRM Account

 

Syntax:

ElfsquadProductConfigurator.CrmAccounts_Patch ([Optional]array patchDocument, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

patchDocument

array of (Operation)

 

 

False

id

string(uuid)

(Id)

Identifier of the CRM Account

True

 

Returns:

          Type:CrmAccount

 

CrmContacts_Get

Summary: Get CRM Contacts

Description: Retrieves a list of all avaible CRM Contacts

 

Syntax:

ElfsquadProductConfigurator.CrmContacts_Get ()

 

Returns:

          Type:array of (CrmContact)

 

CrmContacts_Post

Summary: Create new CRM Contact

Description: Create new CRM Contact

 

Syntax:

ElfsquadProductConfigurator.CrmContacts_Post ([Optional]CrmContact entity)

 

Parameters:

Name

Type

Summary

Required

Related Action

entity

CrmContact

 

 

False

 

Returns:

          Type:CrmContact

 

CrmContacts_Update

Summary: Update CRM Contact

Description: Update a CRM Contact

 

Syntax:

ElfsquadProductConfigurator.CrmContacts_Update ([Optional]CrmContact entity)

 

Parameters:

Name

Type

Summary

Required

Related Action

entity

CrmContact

 

 

False

 

Returns:

          Type:CrmContact

 

CrmContacts_DeleteById

Summary: Delete CRM Contact

Description: Delete a CRM Contact by it's id

 

Syntax:

ElfsquadProductConfigurator.CrmContacts_DeleteById (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string(uuid)

(Id)

Identifier of the CRM Contact

True

 

Returns:

 

CrmContacts_GetById

Summary: Get CRM Contact by id

Description: Retrieves a CRM Contact by its identifier

 

Syntax:

ElfsquadProductConfigurator.CrmContacts_GetById (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string(uuid)

(Id)

Identifier of the CRM Contact

True

 

Returns:

          Type:CrmContact

 

CrmContacts_Patch

Summary: Patch CRM Contact

Description: Update a CRM Contact

 

Syntax:

ElfsquadProductConfigurator.CrmContacts_Patch ([Optional]array patchDocument, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

patchDocument

array of (Operation)

 

 

False

id

string(uuid)

(Id)

Identifier of the CRM Contact

True

 

Returns:

          Type:CrmContact

 

FeatureHasProperties_Get

Summary: Get feature has properties

Description: Retrieves a list of all relationships between features and properties

 

Syntax:

ElfsquadProductConfigurator.FeatureHasProperties_Get ()

 

Returns:

          Type:array of (FeatureHasFeatureProperty)

 

FeatureHasProperties_Post

Summary: Create a relationship between feature and property

Description: Creates a relationship between feature and property

 

Syntax:

ElfsquadProductConfigurator.FeatureHasProperties_Post ([Optional]FeatureHasFeatureProperty entity)

 

Parameters:

Name

Type

Summary

Required

Related Action

entity

FeatureHasFeatureProperty

 

 

False

 

Returns:

          Type:FeatureHasFeatureProperty

 

FeatureHasProperties_Update

Summary: Update a relationship between feature and property

Description: Updates a relationship between feature and property

 

Syntax:

ElfsquadProductConfigurator.FeatureHasProperties_Update ([Optional]FeatureHasFeatureProperty entity)

 

Parameters:

Name

Type

Summary

Required

Related Action

entity

FeatureHasFeatureProperty

 

 

False

 

Returns:

          Type:FeatureHasFeatureProperty

 

FeatureHasProperties_Delete

Summary: Delete a feature has property relationship

Description: Deletes a relationship between a feature a feature property

 

Syntax:

ElfsquadProductConfigurator.FeatureHasProperties_Delete (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string(uuid)

(Id)

Identifier

True

 

Returns:

 

FeatureHasProperties_Patch

Summary: Patch a relationship between feature and property

Description: Updates a relationship between feature and property

 

Syntax:

ElfsquadProductConfigurator.FeatureHasProperties_Patch ([Optional]array patchDocument, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

patchDocument

array of (Operation)

 

 

False

id

string(uuid)

(Id)

Identifier

True

 

Returns:

          Type:FeatureHasFeatureProperty

 

FeatureModels_Get

Summary: Get feature models

Description: Retrieve a list of all available feature models

 

Syntax:

ElfsquadProductConfigurator.FeatureModels_Get ()

 

Returns:

          Type:array of (FeatureModel)

 

FeatureModels_Post

Summary: Create feature model

Description: Creates a feature model

 

Syntax:

ElfsquadProductConfigurator.FeatureModels_Post ([Optional]FeatureModel entity)

 

Parameters:

Name

Type

Summary

Required

Related Action

entity

FeatureModel

 

 

False

 

Returns:

          Type:FeatureModel

 

FeatureModels_Update

Summary: Update feature model

Description: Updates a feature model

 

Syntax:

ElfsquadProductConfigurator.FeatureModels_Update ([Optional]FeatureModel entity)

 

Parameters:

Name

Type

Summary

Required

Related Action

entity

FeatureModel

 

 

False

 

Returns:

          Type:FeatureModel

 

FeatureModels_DeleteById

Summary: Delete feature model

Description: Deletes a feature model by its identifier

 

Syntax:

ElfsquadProductConfigurator.FeatureModels_DeleteById (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string(uuid)

(Id)

Identifier of the feature model to remove

True

 

Returns:

 

FeatureModels_GetById

Summary: Get feature model by id

Description: Retrieves a feature model its identifier

 

Syntax:

ElfsquadProductConfigurator.FeatureModels_GetById (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string(uuid)

(Id)

Feature model identifier

True

 

Returns:

          Type:FeatureModel

 

FeatureModels_Patch

Summary: Patch feature model

Description: Updates a feature model

 

Syntax:

ElfsquadProductConfigurator.FeatureModels_Patch ([Optional]array patchDocument, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

patchDocument

array of (Operation)

 

 

False

id

string(uuid)

(Id)

Feature model identifier

True

 

Returns:

          Type:FeatureModel

 

FeaturesProperties_Get

Summary: Get feature properties

Description: Retrieves a list of all available feature properties

 

Syntax:

ElfsquadProductConfigurator.FeaturesProperties_Get ()

 

Returns:

          Type:array of (FeatureProperty)

 

FeaturesProperties_Post

Summary: Create new feature property

Description: Creates a new feature property

 

Syntax:

ElfsquadProductConfigurator.FeaturesProperties_Post ([Optional]FeatureProperty entity)

 

Parameters:

Name

Type

Summary

Required

Related Action

entity

FeatureProperty

 

 

False

 

Returns:

          Type:FeatureProperty

 

FeaturesProperties_Update

Summary: Update a feature property

Description: Updates a feature property

 

Syntax:

ElfsquadProductConfigurator.FeaturesProperties_Update ([Optional]FeatureProperty entity)

 

Parameters:

Name

Type

Summary

Required

Related Action

entity

FeatureProperty

 

 

False

 

Returns:

          Type:FeatureProperty

 

FeaturesProperties_Delete

Summary: Delete feature property

Description: Deletes a feature property by its identifier

 

Syntax:

ElfsquadProductConfigurator.FeaturesProperties_Delete (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string(uuid)

(Id)

Identifier of the property to delete

True

 

Returns:

 

FeaturesProperties_GetById

Summary: Get feature property by id

Description: Retrieves a feature property by its identifier

 

Syntax:

ElfsquadProductConfigurator.FeaturesProperties_GetById (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string(uuid)

(Id)

Identifier of the feature property

True

 

Returns:

          Type:FeatureProperty

 

FeaturesProperties_Patch

Summary: Patch a feature property

Description: Updates a feature property

 

Syntax:

ElfsquadProductConfigurator.FeaturesProperties_Patch ([Optional]array patchDocument, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

patchDocument

array of (Operation)

 

 

False

id

string(uuid)

(Id)

Identifier of the feature property

True

 

Returns:

          Type:FeatureProperty

 

Features_Get

Summary: Get features

Description: Retrieves a list of all available features

 

Syntax:

ElfsquadProductConfigurator.Features_Get ()

 

Returns:

          Type:array of (Feature)

 

Features_Post

Summary: Create new feature

Description: Creates a new feature

 

Syntax:

ElfsquadProductConfigurator.Features_Post ([Optional]Feature feature)

 

Parameters:

Name

Type

Summary

Required

Related Action

feature

Feature

 

 

False

 

Returns:

          Type:Feature

 

Features_Update

Summary: Update feature

Description: Update a feature

 

Syntax:

ElfsquadProductConfigurator.Features_Update ([Optional]Feature feature)

 

Parameters:

Name

Type

Summary

Required

Related Action

feature

Feature

 

 

False

 

Returns:

          Type:Feature

 

Features_Copy

Summary: Copy features

Description: Copies multiple features and returns the newly created features

 

Syntax:

ElfsquadProductConfigurator.Features_Copy ([Optional]array features)

 

Parameters:

Name

Type

Summary

Required

Related Action

features

array of (Feature)

 

 

False

 

Returns:

          Type:array of (Feature)

 

Features_DeleteById

Summary: Delete feature

Description: Deletes a feature by its identifier

 

Syntax:

ElfsquadProductConfigurator.Features_DeleteById (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string(uuid)

(Id)

Feature identifier

True

 

Returns:

 

Features_GetById

Summary: Get feature by id

Description: Gets a feature by its identifier

 

Syntax:

ElfsquadProductConfigurator.Features_GetById (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string(uuid)

(Id)

Feature identifier

True

 

Returns:

          Type:Feature

 

Features_Patch

Summary: Patch feature

Description: Update a feature

 

Syntax:

ElfsquadProductConfigurator.Features_Patch ([Optional]array patchDocument, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

patchDocument

array of (Operation)

 

 

False

id

string(uuid)

(Id)

Feature identifier

True

 

Returns:

          Type:Feature

 

Files_Post

Summary: Upload a new file

Description: Uploads a new file and returns its url

 

Syntax:

ElfsquadProductConfigurator.Files_Post (file File)

 

Parameters:

Name

Type

Summary

Required

Related Action

File

file

(File)

Upload file

True

 

Returns:

 

Notifications_Send

Summary: Open a prompt dialog for a specific user

Description: If the user is logged in, open a prompt dialog

 

Syntax:

ElfsquadProductConfigurator.Notifications_Send ([Optional]NotificationViewModel notification)

 

Parameters:

Name

Type

Summary

Required

Related Action

notification

NotificationViewModel

 

 

False

 

Returns:

          Type:boolean

 

OrgSellsFeature_Get

Summary: Get OrganizationSellsFeatures

Description: Retrieves OrganizationSellsFeatures relationships

 

Syntax:

ElfsquadProductConfigurator.OrgSellsFeature_Get ()

 

Returns:

          Type:array of (OrganizationSellsFeature)

 

OrgSellsFeature_Post

Summary: Create a OrganizationSellsFeature relationship

Description: Creates a OrganizationSellsFeature relationship

 

Syntax:

ElfsquadProductConfigurator.OrgSellsFeature_Post ([Optional]OrganizationSellsFeature entity)

 

Parameters:

Name

Type

Summary

Required

Related Action

entity

OrganizationSellsFeature

 

 

False

 

Returns:

          Type:OrganizationSellsFeature

 

OrgSellsFeature_Update

Summary: Update OrganizationSellsFeature relationship

Description: Updates a OrganizationSellsFeature relationship

 

Syntax:

ElfsquadProductConfigurator.OrgSellsFeature_Update ([Optional]OrganizationSellsFeature entity)

 

Parameters:

Name

Type

Summary

Required

Related Action

entity

OrganizationSellsFeature

 

 

False

 

Returns:

          Type:OrganizationSellsFeature

 

OrgSellsFeature_GetByFeatureId

Summary: Retrieve OrganizationSellsFeature relationships by feature id

Description: Retrieves OrganizationSellsFeature relationships by feature id

 

Syntax:

ElfsquadProductConfigurator.OrgSellsFeature_GetByFeatureId (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string(uuid)

(Id)

Feature identifier

True

 

Returns:

 

OrgSellsFeature_Delete

Summary: Delete OrganizationSellsFeature relationship

Description: Deletes a OrganizationSellsFeature relationship

 

Syntax:

ElfsquadProductConfigurator.OrgSellsFeature_Delete (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string(uuid)

(Id)

Identifier of OrganizationSellsFeature relationship

True

 

Returns:

 

OrgSellsFeature_GetById

Summary: Retrieve OrganizationSellsFeature relationship by id

Description: Retrieves a OrganizationSellsFeature relationship by its identifier

 

Syntax:

ElfsquadProductConfigurator.OrgSellsFeature_GetById (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string(uuid)

(Id)

Identifier of OrganizationSellsFeature relationship

True

 

Returns:

          Type:OrganizationSellsFeature

 

OrgSellsFeature_Patch

Summary: Patch OrganizationSellsFeature relationship

Description: Updates a OrganizationSellsFeature relationship

 

Syntax:

ElfsquadProductConfigurator.OrgSellsFeature_Patch ([Optional]array patchDocument, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

patchDocument

array of (Operation)

 

 

False

id

string(uuid)

(Id)

Identifier of OrganizationSellsFeature relationship

True

 

Returns:

          Type:OrganizationSellsFeature

 

QuotationProperties_Get55

Summary: Get quotation properties

Description: Retrieves a list of all available quotation properties

 

Syntax:

ElfsquadProductConfigurator.QuotationProperties_Get55 ()

 

Returns:

          Type:array of (QuotationProperty)

 

QuotationProperties_Post

Summary: Create quotation property

Description: Creates a new quotation property

 

Syntax:

ElfsquadProductConfigurator.QuotationProperties_Post ([Optional]QuotationProperty entity)

 

Parameters:

Name

Type

Summary

Required

Related Action

entity

QuotationProperty

 

 

False

 

Returns:

          Type:QuotationProperty

 

QuotationProperties_Update

Summary: Update quotation property

Description: Updates a quotation property

 

Syntax:

ElfsquadProductConfigurator.QuotationProperties_Update ([Optional]QuotationProperty entity)

 

Parameters:

Name

Type

Summary

Required

Related Action

entity

QuotationProperty

 

 

False

 

Returns:

          Type:QuotationProperty

 

QuotationProperties_Get

Summary: Delete quotation property

Description: Deletes a quotation by property by id

 

Syntax:

ElfsquadProductConfigurator.QuotationProperties_Get (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string(uuid)

(Id)

Identifier of the quotation property

True

 

Returns:

 

QuotationProperties_GetById

Summary: Get quotation property by id

Description: Retrieves a quotation property by its identifier

 

Syntax:

ElfsquadProductConfigurator.QuotationProperties_GetById (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string(uuid)

(Id)

Identifier of the quotation property

True

 

Returns:

          Type:QuotationProperty

 

QuotationProperties_Patch

Summary: Patch quotation property

Description: Updates a quotation property

 

Syntax:

ElfsquadProductConfigurator.QuotationProperties_Patch ([Optional]array patchDocument, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

patchDocument

array of (Operation)

 

 

False

id

string(uuid)

(Id)

Identifier of the quotation property

True

 

Returns:

          Type:QuotationProperty

 

QuotationPropertyFields_Get

Summary: Get quotation property fields

Description: Retrieves a list of all available quotation property fields

 

Syntax:

ElfsquadProductConfigurator.QuotationPropertyFields_Get ()

 

Returns:

          Type:array of (QuotationPropertyField)

 

QuotationPropertyFields_Delete

Summary: Delete quotation property field

Description: Deletes a quotation property fields by its id

 

Syntax:

ElfsquadProductConfigurator.QuotationPropertyFields_Delete (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string(uuid)

(Id)

Identifier of the quotation property

True

 

Returns:

 

Quotations_Get

Summary: Get quotations

Description: Retrieves a list of all available quotations

 

Syntax:

ElfsquadProductConfigurator.Quotations_Get ()

 

Returns:

          Type:array of (Quotation)

 

Quotations_Post

Summary: Create new quotation

Description: Creates a new quotation

 

Syntax:

ElfsquadProductConfigurator.Quotations_Post ([Optional]Quotation entity)

 

Parameters:

Name

Type

Summary

Required

Related Action

entity

Quotation

 

 

False

 

Returns:

          Type:Quotation

 

Quotations_Update

Summary: Update a quotation

Description: Updates a quotation

 

Syntax:

ElfsquadProductConfigurator.Quotations_Update ([Optional]Quotation quotation)

 

Parameters:

Name

Type

Summary

Required

Related Action

quotation

Quotation

 

 

False

 

Returns:

          Type:Quotation

 

Quotations_Patch_Bulk

Summary: Patch multiple quotations

Description: Updates multiple quotations

 

Syntax:

ElfsquadProductConfigurator.Quotations_Patch_Bulk ([Optional]BulkJsonPatchDocument[Quotation] patchDocument)

 

Parameters:

Name

Type

Summary

Required

Related Action

patchDocument

BulkJsonPatchDocument[Quotation]

 

 

False

 

Returns:

          Type:Quotation

 

Quotations_DeleteById

Summary: Delete quotation

Description: Deletes a quotation by its identifier

 

Syntax:

ElfsquadProductConfigurator.Quotations_DeleteById (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string(uuid)

(Id)

Identifier of quotation to delete

True

 

Returns:

 

Quotations_GetById

Summary: Get quotation by id

Description: Retrieves a quotation by its identifier

 

Syntax:

ElfsquadProductConfigurator.Quotations_GetById (string id, [internal]string include)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string(uuid)

(Id)

Identifier of the quotation

True

include

string

 

 

True

 

Returns:

          Type:Quotation

 

Quotations_Patch

Summary: Patch a quotation

Description: Updates a quotation

 

Syntax:

ElfsquadProductConfigurator.Quotations_Patch ([Optional]array patchDocument, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

patchDocument

array of (Operation)

 

 

False

id

string(uuid)

(Id)

Identifier of the quotation

True

 

Returns:

          Type:Quotation

 

Quotations_AddConfigurations

Summary: Add configurations to a quotation

Description: Adds multiple configurations to a quotation

 

Syntax:

ElfsquadProductConfigurator.Quotations_AddConfigurations (string id, [Optional]array configurationIds)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string(uuid)

(Id)

Quotation identifier

True

configurationIds

array of (string(uuid))

 

 

False

 

Returns:

 

Quotations_AddFile

Summary: Add file to quotation

Description: Adds a file to a quotation

 

Syntax:

ElfsquadProductConfigurator.Quotations_AddFile (string id, file File)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string(uuid)

(Id)

Identifier of the quotation

True

File

file

(File)

Upload file

True

 

Returns:

 

Quotations_Copy

Summary: Copy quotation

Description: Copies an existing quotation

 

Syntax:

ElfsquadProductConfigurator.Quotations_Copy (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string(uuid)

(Id)

The identifier

True

 

Returns:

          Type:Quotation

 

Quotations_GetPdf

Summary: Generate quotation PDF

Description: Generates a PDF of a quotation

 

Syntax:

ElfsquadProductConfigurator.Quotations_GetPdf (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string(uuid)

(Id)

Identifier of the quotation

True

 

Returns:

 

Quotations_Revise

Summary: Create quotation revision

Description: Create a revision of a existing quotation

 

Syntax:

ElfsquadProductConfigurator.Quotations_Revise (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string(uuid)

(Id)

The identifier

True

 

Returns:

          Type:Quotation

 

Steps_Get

Summary: Get steps

Description: Retrieves a list of all available steps

 

Syntax:

ElfsquadProductConfigurator.Steps_Get ()

 

Returns:

          Type:array of (Step)

 

Steps_Post

Summary: Create new step

Description: Creates a new step

 

Syntax:

ElfsquadProductConfigurator.Steps_Post ([Optional]Step entity)

 

Parameters:

Name

Type

Summary

Required

Related Action

entity

Step

 

 

False

 

Returns:

          Type:Step

 

Steps_Update

Summary: Update step

Description: Update a step

 

Syntax:

ElfsquadProductConfigurator.Steps_Update ([Optional]Step entity)

 

Parameters:

Name

Type

Summary

Required

Related Action

entity

Step

 

 

False

 

Returns:

          Type:Step

 

Steps_DeleteById

Summary: Delete step

Description: Deletes a step by its identifier

 

Syntax:

ElfsquadProductConfigurator.Steps_DeleteById (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string(uuid)

(Id)

Step identifier

True

 

Returns:

 

Steps_GetById

Summary: Get step by id

Description: Gets a step by its identifier

 

Syntax:

ElfsquadProductConfigurator.Steps_GetById (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string(uuid)

(Id)

Step identifier

True

 

Returns:

          Type:Step

 

Steps_Patch

Summary: Patch step

Description: Update a step

 

Syntax:

ElfsquadProductConfigurator.Steps_Patch ([Optional]array patchDocument, string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

patchDocument

array of (Operation)

 

 

False

id

string(uuid)

(Id)

Step identifier

True

 

Returns:

          Type:Step

 

Triggers:

Trigger Webhooks_Custom

Summary: Custom trigger

Description: Create your own custom triggers

 

Syntax:

ElfsquadProductConfigurator.Webhooks_Custom (Webhooks_CustomParameterWebHooksSubscription webHooksSubscription, string identifier)

 

Parameters:

Name

Type

Summary

Required

Related Action

webHooksSubscription

Webhooks_CustomParameterWebHooksSubscription

 

 

True

identifier

string

(Identifier)

Identifier

True

 

Returns:

 

Trigger Webhooks_QuotationAccepted

Summary: When a quotation is accepted

Description: Triggered when a quotation is accepted

 

Syntax:

ElfsquadProductConfigurator.Webhooks_QuotationAccepted (Webhooks_QuotationAcceptedParameterWebHooksSubscription webHooksSubscription)

 

Parameters:

Name

Type

Summary

Required

Related Action

webHooksSubscription

Webhooks_QuotationAcceptedParameterWebHooksSubscription

 

 

True

 

Returns:

 

Trigger Webhooks_QuotationConfigurationAdded

Summary: When a configuration is added to a quotation

Description: Triggered when a configuration is added to a quotation

 

Syntax:

ElfsquadProductConfigurator.Webhooks_QuotationConfigurationAdded (Webhooks_QuotationConfigurationAddedParameterWebHooksSubscription webHooksSubscription)

 

Parameters:

Name

Type

Summary

Required

Related Action

webHooksSubscription

Webhooks_QuotationConfigurationAddedParameterWebHooksSubscription

 

 

True

 

Returns:

 

Trigger Webhooks_QuotationDenied

Summary: When a quotation is declined

Description: Triggered when a quotation is declined

 

Syntax:

ElfsquadProductConfigurator.Webhooks_QuotationDenied (Webhooks_QuotationDeniedParameterWebHooksSubscription webHooksSubscription)

 

Parameters:

Name

Type

Summary

Required

Related Action

webHooksSubscription

Webhooks_QuotationDeniedParameterWebHooksSubscription

 

 

True

 

Returns:

 

Trigger Webhooks_QuotationRequested

Summary: When a quotation is requested

Description: Triggered when a quotation is requested

 

Syntax:

ElfsquadProductConfigurator.Webhooks_QuotationRequested (Webhooks_QuotationRequestedParameterWebHooksSubscription webHooksSubscription)

 

Parameters:

Name

Type

Summary

Required

Related Action

webHooksSubscription

Webhooks_QuotationRequestedParameterWebHooksSubscription

 

 

True

 

Returns:

 

Trigger Webhooks_QuotationRevised

Summary: When a quotation is revised

Description: Triggered when a quotation is revised

 

Syntax:

ElfsquadProductConfigurator.Webhooks_QuotationRevised (Webhooks_QuotationRevisedParameterWebHooksSubscription webHooksSubscription)

 

Parameters:

Name

Type

Summary

Required

Related Action

webHooksSubscription

Webhooks_QuotationRevisedParameterWebHooksSubscription

 

 

True

 

Returns:

 

Trigger Webhooks_QuotationSubmitted

Summary: When a quotation is submitted

Description: Triggered when a quotation is submitted

 

Syntax:

ElfsquadProductConfigurator.Webhooks_QuotationSubmitted (Webhooks_QuotationSubmittedParameterWebHooksSubscription webHooksSubscription)

 

Parameters:

Name

Type

Summary

Required

Related Action

webHooksSubscription

Webhooks_QuotationSubmittedParameterWebHooksSubscription

 

 

True

 

Returns:

 

Trigger Webhooks_QuotationVerified

Summary: When a quotation is verified

Description: Triggered when a quotation is verified

 

Syntax:

ElfsquadProductConfigurator.Webhooks_QuotationVerified (Webhooks_QuotationVerifiedParameterWebHooksSubscription webHooksSubscription)

 

Parameters:

Name

Type

Summary

Required

Related Action

webHooksSubscription

Webhooks_QuotationVerifiedParameterWebHooksSubscription

 

 

True

 

Returns:

 


 

AssociatedFeatureProperty

Summary:

Description:

 

          Properties:

Name

Type

Summary

createdDate

string(date-time)

Created Date

 

feature

Feature

 

 

featureId

string(uuid)

Feature Id

 

featurePropertyId

string(uuid)

Feature Property Id

 

id

string(uuid)

Id

 

organizationId

string(uuid)

Organization Id

 

reference

string

Reference

 

synced

boolean

Synced

 

updatedDate

string(date-time)

Updated Date

 


 

BulkJsonPatchDocument[Quotation]

Summary:

Description:

 

          Properties:

Name

Type

Summary

ids

array of (string(uuid))

Ids

 

operations

array of (Operation[Quotation])

Operations

 

patchDocuments

array of (JsonPatchDocument[Quotation])

Patch Documents

 


 

Category

Summary:

Description:

 

          Properties:

Name

Type

Summary

createdDate

string(date-time)

Created Date

 

id

string(uuid)

Id

 

linkedFeatures

integer(int32)

Linked Features

 

name

string

Name

 

order

integer(int32)

Order

 

organizationId

string(uuid)

Organization Id

 

parentId

string(uuid)

Parent Id

 

reference

string

Reference

 

synced

boolean

Synced

 

texts

array of (CategoryText)

Texts

 

updatedDate

string(date-time)

Updated Date

 


 

CategoryText

Summary:

Description:

 

          Properties:

Name

Type

Summary

categoryId

string(uuid)

Category Id

 

createdDate

string(date-time)

Created Date

 

id

string(uuid)

Id

 

languageIso

string

Language Iso

 

organizationId

string(uuid)

Organization Id

 

reference

string

Reference

 

synced

boolean

Synced

 

updatedDate

string(date-time)

Updated Date

 

value

string

Value

 


 

CrmAccount

Summary:

Description:

 

          Properties:

Name

Type

Summary

city

string

City

 

cocNumber

string

C O C Number

 

companyName

string

Company Name

 

contacts

array of (CrmContact)

Contacts

 

country

string

Country

 

countryIso

string

Country Iso

 

createdDate

string(date-time)

Created Date

 

customerReference

string

Customer Reference

 

defaultContact

CrmContact

 

 

defaultContactId

string(uuid)

Default Contact Id

 

defaultVatId

string(uuid)

Default Vat Id

 

email

string

Email

 

firstName

string

First Name

 

fullLastName

string

Full Last Name

 

fullName

string

Full Name

 

houseNumber

string

House Number

 

iban

string

I B A N

 

id

string(uuid)

Id

 

lastName

string

Last Name

 

lastNamePrefix

string

Last Name Prefix

 

organizationId

string(uuid)

Organization Id

 

phone1

string

Phone1

 

phone2

string

Phone2

 

postalCode

string

Postal Code

 

reference

string

Reference

 

salutation

string

Salutation

 

shoeSize

integer(int32)

Shoe Size

 

streetName

string

Street Name

 

synced

boolean

Synced

 

type

integer(int32)

Type

Values: [, , ]

updatedDate

string(date-time)

Updated Date

 

vatNumber

string

V A T Number

 


 

CrmContact

Summary:

Description:

 

          Properties:

Name

Type

Summary

city

string

City

 

companyName

string

Company Name

 

contactReference

string

Contact Reference

 

countryIso

string

Country Iso

 

createdDate

string(date-time)

Created Date

 

crmAccountId

string(uuid)

Crm Account Id

 

email

string

Email

 

firstName

string

First Name

 

fullLastName

string

Full Last Name

 

fullName

string

Full Name

 

houseNumber

string

House Number

 

id

string(uuid)

Id

 

lastName

string

Last Name

 

lastNamePrefix

string

Last Name Prefix

 

organizationId

string(uuid)

Organization Id

 

phone1

string

Phone1

 

phone2

string

Phone2

 

postalCode

string

Postal Code

 

reference

string

Reference

 

salutation

string

Salutation

 

streetName

string

Street Name

 

synced

boolean

Synced

 

updatedDate

string(date-time)

Updated Date

 

useParentAddress

boolean

Use Parent Address

 


 

Feature

Summary:

Description:

 

          Properties:

Name

Type

Summary

articleCode

string

Article Code

 

cardImageUrl

string

Card Image Url

 

category

Category

 

 

categoryId

string(uuid)

Category Id

 

createdDate

string(date-time)

Created Date

 

disallowDiscount

boolean

Disallow Discount

 

hiddenThreeDModelItems

array of (string)

Hidden Three D Model Items

 

id

string(uuid)

Id

 

marginPct

number(double)

Margin Pct

 

maxValue

number(double)

Max Value

 

minValue

number(double)

Min Value

 

name

string

Name

 

organizationId

string(uuid)

Organization Id

 

packingUnit

number(double)

Packing Unit

 

reference

string

Reference

 

salesPrice

number(double)

Sales Price

 

salesPriceLabel

string

Sales Price Label

 

stepValue

number(double)

Step Value

 

subcategoryIds

array of (string(uuid))

Subcategory Ids

 

synced

boolean

Synced

 

tags

array of (string)

Tags

 

texts

array of (FeatureText)

Texts

 

threeDModelItems

array of (string)

Three D Model Items

 

type

integer(int32)

Type

Values: [, , ]

unitOfMeasurement

UnitOfMeasurement

 

 

unitOfMeasurementId

string(uuid)

Unit Of Measurement Id

 

updatedDate

string(date-time)

Updated Date

 

vatId

string(uuid)

V A T Id

 


 

FeatureHasFeatureProperty

Summary:

Description:

 

          Properties:

Name

Type

Summary

associatedFeatureId

string(uuid)

Associated Feature Id

 

createdDate

string(date-time)

Created Date

 

featureId

string(uuid)

Feature Id

 

featurePropertyId

string(uuid)

Feature Property Id

 

id

string(uuid)

Id

 

organizationId

string(uuid)

Organization Id

 

reference

string

Reference

 

synced

boolean

Synced

 

textValue

string

Text Value

 

updatedDate

string(date-time)

Updated Date

 

value

number(double)

Value

 


 

FeatureModel

Summary:

Description:

 

          Properties:

Name

Type

Summary

attachmentNodes

array of (FeatureModelAttachmentNode)

Attachment Nodes

 

createdDate

string(date-time)

Created Date

 

displayPrices

boolean

Display Prices

 

dynamicGroups

array of (FeatureModelDynamicGroup)

Dynamic Groups

 

id

string(uuid)

Id

 

nodes

array of (FeatureModelNode)

Nodes

 

order

integer(int32)

Order

 

organizationId

string(uuid)

Organization Id

 

reference

string

Reference

 

relationships

array of (FeatureModelRelationship)

Relationships

 

revisionOf

string(uuid)

Revision Of

 

rootFeatureId

string(uuid)

Root Feature Id

 

status

integer(int32)

Status

Values: [, ]

synced

boolean

Synced

 

updatedDate

string(date-time)

Updated Date

 


 

FeatureModelAttachmentNode

Summary:

Description:

 

          Properties:

Name

Type

Summary

createdDate

string(date-time)

Created Date

 

featureModelId

string(uuid)

Feature Model Id

 

id

string(uuid)

Id

 

name

string

Name

 

organizationId

string(uuid)

Organization Id

 

reference

string

Reference

 

rotation

number(double)

Rotation

 

synced

boolean

Synced

 

updatedDate

string(date-time)

Updated Date

 

x

number(double)

X

 

y

number(double)

Y

 

z

number(double)

Z

 


 

FeatureModelDynamicGroup

Summary:

Description:

 

          Properties:

Name

Type

Summary

createdDate

string(date-time)

Created Date

 

featureModelId

string(uuid)

Feature Model Id

 

featureModelNodeId

string(uuid)

Feature Model Node Id

 

filters

array of (FeatureModelDynamicGroupFilter)

Filters

 

hideInConfigurator

boolean

Hide In Configurator

 

hideInOrderEntry

boolean

Hide In Order Entry

 

hideInQuotation

boolean

Hide In Quotation

 

id

string(uuid)

Id

 

orderByFeatureProperty

string(uuid)

Order By Feature Property

 

orderByPrice

boolean

Order By Price

 

organizationId

string(uuid)

Organization Id

 

reference

string

Reference

 

relationshipType

integer(int32)

Relationship Type

Values: [, , , , , , ]

synced

boolean

Synced

 

updatedDate

string(date-time)

Updated Date

 


 

FeatureModelDynamicGroupFilter

Summary:

Description:

 

          Properties:

Name

Type

Summary

associatedFeature

string(uuid)

Associated Feature

 

associatedFeatureParentId

string(uuid)

Associated Feature Parent Id

 

createdDate

string(date-time)

Created Date

 

featureModelDynamicGroupFilterValueType

integer(int32)

Feature Model Dynamic Group Filter Value Type

Values: [, , ]

featureModelDynamicGroupId

string(uuid)

Feature Model Dynamic Group Id

 

featurePropertyId

string(uuid)

Feature Property Id

 

id

string(uuid)

Id

 

organizationId

string(uuid)

Organization Id

 

reference

string

Reference

 

synced

boolean

Synced

 

updatedDate

string(date-time)

Updated Date

 

value

number(double)

Value

 

valueFeatureModelNodeId

string(uuid)

Value Feature Model Node Id

 


 

FeatureModelNode

Summary:

Description:

 

          Properties:

Name

Type

Summary

createdDate

string(date-time)

Created Date

 

defaultValue

number(double)

Default Value

 

divergentPrice

number(double)

Divergent Price

 

divergentPriceExpressionId

string(uuid)

Divergent Price Expression Id

 

featureId

string(uuid)

Feature Id

 

featureModelId

string(uuid)

Feature Model Id

 

hiddenThreeDModelItems

array of (string)

Hidden Three D Model Items

 

hideInConfigurator

boolean

Hide In Configurator

 

hideInOrderEntry

boolean

Hide In Order Entry

 

hideInQuotation

boolean

Hide In Quotation

 

id

string(uuid)

Id

 

infoField

string

Info Field

 

isMandatory

boolean

Is Mandatory

 

isPhantom

boolean

Is Phantom

 

isPreconfiguration

boolean

Is Preconfiguration

 

isQuotationGroup

boolean

Is Quotation Group

 

maxValueExpressionId

string(uuid)

Max Value Expression Id

 

organizationId

string(uuid)

Organization Id

 

reference

string

Reference

 

synced

boolean

Synced

 

threeDModelItems

array of (string)

Three D Model Items

 

totalPriceExVAT

number(double)

Total Price Ex V A T

 

totalPriceExVATLabel

string

Total Price Ex V A T Label

 

totalPriceIncVAT

number(double)

Total Price Inc V A T

 

totalPriceIncVATLabel

string

Total Price Inc V A T Label

 

unitPriceExVAT

number(double)

Unit Price Ex V A T

 

unitPriceExVATExExchangeRate

number(double)

Unit Price Ex V A T Ex Exchange Rate

 

unitPriceExVATLabel

string

Unit Price Ex V A T Label

 

unitPriceIncVAT

number(double)

Unit Price Inc V A T

 

unitPriceIncVATLabel

string

Unit Price Inc V A T Label

 

updatedDate

string(date-time)

Updated Date

 


 

FeatureModelRelationship

Summary:

Description:

 

          Properties:

Name

Type

Summary

createdDate

string(date-time)

Created Date

 

default

boolean

Default

 

displaySeperateBlade

boolean

Display Seperate Blade

 

displayType

integer(int32)

Display Type

Values: [, , , , ]

expressionId

string(uuid)

Expression Id

 

featureModelDynamicGroupFromId

string(uuid)

Feature Model Dynamic Group From Id

 

featureModelDynamicGroupToId

string(uuid)

Feature Model Dynamic Group To Id

 

featureModelId

string(uuid)

Feature Model Id

 

fromNodeId

string(uuid)

From Node Id

 

hideExcludeInView

boolean

Hide Exclude In View

 

id

string(uuid)

Id

 

impliesExpression

string

Implies Expression

 

impliesFromValue

number(double)

Implies From Value

 

impliesRoundingType

integer(int32)

Implies Rounding Type

Values: [, , ]

impliesToValue

number(double)

Implies To Value

 

impliesType

integer(int32)

Implies Type

Values: [, , ]

isDefaultSelector

boolean

Is Default Selector

 

order

integer(int32)

Order

 

organizationId

string(uuid)

Organization Id

 

reference

string

Reference

 

synced

boolean

Synced

 

toNodeId

string(uuid)

To Node Id

 

type

integer(int32)

Type

Values: [, , , , , , ]

updatedDate

string(date-time)

Updated Date

 


 

FeatureProperty

Summary:

Description:

 

          Properties:

Name

Type

Summary

associatedFeatures

array of (AssociatedFeatureProperty)

Associated Features

 

createdDate

string(date-time)

Created Date

 

id

string(uuid)

Id

 

name

string

Name

 

organizationId

string(uuid)

Organization Id

 

reference

string

Reference

 

single

boolean

Single

 

synced

boolean

Synced

 

type

integer(int32)

Type

Values: [, , ]

updatedDate

string(date-time)

Updated Date

 


 

FeatureText

Summary:

Description:

 

          Properties:

Name

Type

Summary

createdDate

string(date-time)

Created Date

 

featureId

string(uuid)

Feature Id

 

id

string(uuid)

Id

 

languageIso

string

Language Iso

 

organizationId

string(uuid)

Organization Id

 

reference

string

Reference

 

synced

boolean

Synced

 

type

integer(int32)

Type

Values: [, , , , , ]

updatedDate

string(date-time)

Updated Date

 

value

string

Value

 


 

file

Summary: File

Description: Upload file

 

          Properties:

Name

Type

Summary


 

FileEntity

Summary:

Description:

 

          Properties:

Name

Type

Summary

createdDate

string(date-time)

Created Date

 

id

string(uuid)

Id

 

name

string

Name

 

organizationId

string(uuid)

Organization Id

 

reference

string

Reference

 

synced

boolean

Synced

 

updatedDate

string(date-time)

Updated Date

 

url

string

Url

 


 

JsonPatchDocument[Quotation]

Summary:

Description:

 

          Properties:

Name

Type

Summary

operations

array of (Operation[Quotation])

Operations

 


 

NotificationViewModel

Summary:

Description:

 

          Properties:

Name

Type

Summary

cancelText

string

Cancel Text

 

confirmText

string

Confirm Text

 

content

string

Content

 

title

string

Title

 

userId

string(uuid)

User Id

 


 

Operation

Summary:

Description:

 

          Properties:

Name

Type

Summary

from

string

From

 

op

string

Op

 

path

string

Path

 

value

Value

Value

 

 

Value

Summary: Value

Description:

 

          Properties:

Name

Type

Summary

 


 

Operation[Quotation]

Summary:

Description:

 

          Properties:

Name

Type

Summary

from

string

From

 

op

string

Op

 

path

string

Path

 

value

Value

Value

 

 

Value

Summary: Value

Description:

 

          Properties:

Name

Type

Summary

 


 

OrganizationSellsFeature

Summary:

Description:

 

          Properties:

Name

Type

Summary

allowedToSell

boolean

Allowed To Sell

 

createdDate

string(date-time)

Created Date

 

featureId

string(uuid)

Feature Id

 

id

string(uuid)

Id

 

organizationId

string(uuid)

Organization Id

 

purchaseDiscountPct

number(double)

Purchase Discount Pct

 

reference

string

Reference

 

synced

boolean

Synced

 

upValuePct

number(double)

Up Value Pct

 

updatedDate

string(date-time)

Updated Date

 


 

Quotation

Summary:

Description:

 

          Properties:

Name

Type

Summary

createdDate

string(date-time)

Created Date

 

currencyIso

string

Currency Iso

 

customerReference

string

Customer Reference

 

debtorContactId

string(uuid)

Debtor Contact Id

 

debtorId

string(uuid)

Debtor Id

 

deliverydate

string(date-time)

Deliverydate

 

expiresDate

string(date-time)

Expires Date

 

files

array of (QuotationFile)

Files

 

formattedVerifiedDate

string

Formatted Verified Date

 

id

string(uuid)

Id

 

isExpired

boolean

Is Expired

 

isVerified

boolean

Is Verified

 

languageIso

string

Language Iso

 

leaseTermAmount

integer(int32)

Lease Term Amount

 

leaseTermType

integer(int32)

Lease Term Type

Values: [, , , ]

lines

array of (QuotationLine)

Lines

 

margin

number(double)

Margin

 

organizationId

string(uuid)

Organization Id

 

quotationNumber

integer(int64)

Quotation Number

 

quotationReference

string

Quotation Reference

 

quotationTemplateId

string(uuid)

Quotation Template Id

 

reference

string

Reference

 

remarks

string

Remarks

 

revisionOfId

string(uuid)

Revision Of Id

 

sellerContactId

string(uuid)

Seller Contact Id

 

sellerId

string(uuid)

Seller Id

 

shipToContactId

string(uuid)

Ship To Contact Id

 

shipToId

string(uuid)

Ship To Id

 

status

integer(int32)

Status

Values: [, , , , , , , ]

statusDescription

string

Status Description

 

subTotalExclPrice

number(double)

Sub Total Excl Price

 

subTotalExclPriceLabel

string

Sub Total Excl Price Label

 

subTotalInclPrice

number(double)

Sub Total Incl Price

 

subTotalInclPriceLabel

string

Sub Total Incl Price Label

 

subject

string

Subject

 

synced

boolean

Synced

 

totalDiscountAmntLabel

string

Total Discount Amnt Label

 

totalDiscountAmt

number(double)

Total Discount Amt

 

totalDiscountPct

number(double)

Total Discount Pct

 

totalExclPrice

number(double)

Total Excl Price

 

totalInclPrice

number(double)

Total Incl Price

 

totalPriceExclVATLabel

string

Total Price Excl V A T Label

 

totalPriceInclVAT

number(double)

Total Price Incl V A T

 

totalPriceInclVATLabel

string

Total Price Incl V A T Label

 

updatedDate

string(date-time)

Updated Date

 

verifiedBy

string(uuid)

Verified By

 

verifiedDate

string(date-time)

Verified Date

 

versionNumber

integer(int32)

Version Number

 


 

QuotationFile

Summary:

Description:

 

          Properties:

Name

Type

Summary

createdDate

string(date-time)

Created Date

 

file

FileEntity

 

 

fileId

string(uuid)

File Id

 

id

string(uuid)

Id

 

organizationId

string(uuid)

Organization Id

 

quotationId

string(uuid)

Quotation Id

 

reference

string

Reference

 

synced

boolean

Synced

 

updatedDate

string(date-time)

Updated Date

 


 

QuotationLine

Summary:

Description:

 

          Properties:

Name

Type

Summary

addedFromConfiguration

boolean

Added From Configuration

 

articleCode

string

Article Code

 

basePrice

number(double)

Base Price

 

cardImageUrl

string

Card Image Url

 

configurationId

string(uuid)

Configuration Id

 

createdDate

string(date-time)

Created Date

 

defaultPurchasePriceDiscountPct

number(double)

Default Purchase Price Discount Pct

 

deliverydate

string(date-time)

Deliverydate

 

description

string

Description

 

discountPct

number(double)

Discount Pct

 

extendedDescription

string

Extended Description

 

featureId

string(uuid)

Feature Id

 

featureModelNodeId

string(uuid)

Feature Model Node Id

 

groupAdditionalExclPrice

number(double)

Group Additional Excl Price

 

groupAdditionalExclPriceLabel

string

Group Additional Excl Price Label

 

groupAdditionalInclPrice

number(double)

Group Additional Incl Price

 

groupAdditionalInclPriceLabel

string

Group Additional Incl Price Label

 

groupBaseExclPrice

number(double)

Group Base Excl Price

 

groupBaseExclPriceDiscountExclVat

number(double)

Group Base Excl Price Discount Excl Vat

 

groupBaseInclPrice

number(double)

Group Base Incl Price

 

groupDefaultExclPriceExclDiscountLabel

string

Group Default Excl Price Excl Discount Label

 

groupDefaultExclPriceLabel

string

Group Default Excl Price Label

 

groupDefaultInclPriceLabel

string

Group Default Incl Price Label

 

groupDiscountPct

number(double)

Group Discount Pct

 

groupExclMarginLabel

string

Group Excl Margin Label

 

groupId

string(uuid)

Group Id

 

groupMargin

number(double)

Group Margin

 

groupOrder

integer(int32)

Group Order

 

groupPriceExclLabel

string

Group Price Excl Label

 

groupPriceInclLabel

string

Group Price Incl Label

 

groupPurchasePrice

number(double)

Group Purchase Price

 

groupPurchasePriceLabel

string

Group Purchase Price Label

 

groupTitle

string

Group Title

 

groupTotalExclPrice

number(double)

Group Total Excl Price

 

groupTotalExclPriceLabel

string

Group Total Excl Price Label

 

groupTotalInclPrice

number(double)

Group Total Incl Price

 

groupTotalInclPriceLabel

string

Group Total Incl Price Label

 

groupedRootLine

boolean

Grouped Root Line

 

hidden

boolean

Hidden

 

id

string(uuid)

Id

 

lineNumber

integer(int32)

Line Number

 

marginPct

number(double)

Margin Pct

 

moreInfo

string

More Info

 

organizationId

string(uuid)

Organization Id

 

originalUnitPrice

number(double)

Original Unit Price

 

parentLineId

string(uuid)

Parent Line Id

 

purchasePrice

number(double)

Purchase Price

 

purchasePriceDiscountPct

number(double)

Purchase Price Discount Pct

 

purchasePriceLabel

string

Purchase Price Label

 

quantityAmount

number(double)

Quantity Amount

 

quantityFormatted

string

Quantity Formatted

 

quotationId

string(uuid)

Quotation Id

 

quotationText

string

Quotation Text

 

reference

string

Reference

 

synced

boolean

Synced

 

tenantPurchasePrice

number(double)

Tenant Purchase Price

 

textValue

string

Text Value

 

totalExclMargin

number(double)

Total Excl Margin

 

totalExclMarginLabel

string

Total Excl Margin Label

 

totalExclPrice

number(double)

Total Excl Price

 

totalExclPriceExclDiscount

number(double)

Total Excl Price Excl Discount

 

totalExclPriceExclDiscountLabel

string

Total Excl Price Excl Discount Label

 

totalInclMargin

number(double)

Total Incl Margin

 

totalInclMarginLabel

string

Total Incl Margin Label

 

totalInclPrice

number(double)

Total Incl Price

 

totalPriceExclLabel

string

Total Price Excl Label

 

totalPriceInclLabel

string

Total Price Incl Label

 

unitPrice

number(double)

Unit Price

 

unitPriceLabel

string

Unit Price Label

 

uom

string

Uom

 

updatedDate

string(date-time)

Updated Date

 

vatId

string(uuid)

V A T Id

 


 

QuotationProperty

Summary:

Description:

 

          Properties:

Name

Type

Summary

createdDate

string(date-time)

Created Date

 

description

string

Description

 

fields

array of (QuotationPropertyField)

Fields

 

id

string(uuid)

Id

 

isRequired

boolean

Is Required

 

organizationId

string(uuid)

Organization Id

 

reference

string

Reference

 

synced

boolean

Synced

 

updatedDate

string(date-time)

Updated Date

 


 

QuotationPropertyField

Summary:

Description:

 

          Properties:

Name

Type

Summary

code

string

Code

 

createdDate

string(date-time)

Created Date

 

description

string

Description

 

id

string(uuid)

Id

 

organizationId

string(uuid)

Organization Id

 

quotationPropertyId

string(uuid)

Quotation Property Id

 

reference

string

Reference

 

synced

boolean

Synced

 

texts

array of (QuotationPropertyFieldText)

Texts

 

updatedDate

string(date-time)

Updated Date

 


 

QuotationPropertyFieldText

Summary:

Description:

 

          Properties:

Name

Type

Summary

createdDate

string(date-time)

Created Date

 

id

string(uuid)

Id

 

languageIso

string

Language Iso

 

organizationId

string(uuid)

Organization Id

 

quotationPropertyFieldId

string(uuid)

Quotation Property Field Id

 

reference

string

Reference

 

synced

boolean

Synced

 

updatedDate

string(date-time)

Updated Date

 

value

string

Value

 


 

Step

Summary:

Description:

 

          Properties:

Name

Type

Summary

backgroundUrl

string

Background Url

 

createdDate

string(date-time)

Created Date

 

featureModelId

string(uuid)

Feature Model Id

 

iconUrl

string

Icon Url

 

id

string(uuid)

Id

 

listviewEnabled

boolean

Listview Enabled

 

mainCameraPositionId

string(uuid)

Main Camera Position Id

 

order

integer(int32)

Order

 

organizationId

string(uuid)

Organization Id

 

reference

string

Reference

 

requiredHotspots

boolean

Required Hotspots

 

synced

boolean

Synced

 

texts

array of (StepText)

Texts

 

type

integer(int32)

Type

Values: [, , , , , ]

updatedDate

string(date-time)

Updated Date

 

visibleNodes

array of (string(uuid))

Visible Nodes

 


 

StepText

Summary:

Description:

 

          Properties:

Name

Type

Summary

createdDate

string(date-time)

Created Date

 

id

string(uuid)

Id

 

languageIso

string

Language Iso

 

organizationId

string(uuid)

Organization Id

 

reference

string

Reference

 

stepId

string(uuid)

Step Id

 

synced

boolean

Synced

 

updatedDate

string(date-time)

Updated Date

 

value

string

Value

 


 

UnitOfMeasurement

Summary:

Description:

 

          Properties:

Name

Type

Summary

code

string

Code

 

createdDate

string(date-time)

Created Date

 

description

string

Description

 

id

string(uuid)

Id

 

organizationId

string(uuid)

Organization Id

 

reference

string

Reference

 

synced

boolean

Synced

 

updatedDate

string(date-time)

Updated Date

 


 

Webhooks_CustomParameterWebHooksSubscription

Summary:

Description:

 

          Properties:

Name

Type

Summary

callbackUrl

string

Callback Url

 


 

Webhooks_QuotationAcceptedParameterWebHooksSubscription

Summary:

Description:

 

          Properties:

Name

Type

Summary

callbackUrl

string

Callback Url

 


 

Webhooks_QuotationConfigurationAddedParameterWebHooksSubscription

Summary:

Description:

 

          Properties:

Name

Type

Summary

callbackUrl

string

Callback Url

 


 

Webhooks_QuotationDeniedParameterWebHooksSubscription

Summary:

Description:

 

          Properties:

Name

Type

Summary

callbackUrl

string

Callback Url

 


 

Webhooks_QuotationRequestedParameterWebHooksSubscription

Summary:

Description:

 

          Properties:

Name

Type

Summary

callbackUrl

string

Callback Url

 


 

Webhooks_QuotationRevisedParameterWebHooksSubscription

Summary:

Description:

 

          Properties:

Name

Type

Summary

callbackUrl

string

Callback Url

 


 

Webhooks_QuotationSubmittedParameterWebHooksSubscription

Summary:

Description:

 

          Properties:

Name

Type

Summary

callbackUrl

string

Callback Url

 


 

Webhooks_QuotationVerifiedParameterWebHooksSubscription

Summary:

Description:

 

          Properties:

Name

Type

Summary

callbackUrl

string

Callback Url