Project

Name Description Type Additional information

addressDelivery

Delivery address for the products of the project.

string

addressExecution

Execution address for the products of the project. E.g. where window products need to be installed or floor products need to be laid.

string

affiliateDomain

Affiliate domain.

string

applicationId

Unique application id. (Every WT has a unique application id.)

integer

cityDelivery

Delivery city for the products of the project.

string

cityExecution

Execution city for the products of the project. E.g. where window products need to be installed or floor products need to be laid.

string

coupons

Coupons are smaller pieces of a larger whole who all share the same material. E.g. for multiple pieces of carpet.

Array<Coupon>

customerId

Id of the customer for this project.

integer

deliveryCountryId

Delivery country id for the products of the project.

integer

deliveryDate

Delivery date and time for the products of the project.

date

deliveryRef

Reference to the delivery location (== licensee code)

string

description

Memo field for internal use by dealers. E.g. this can be used by dealers as a lookup field when searching for projects.

string

documentations

A list of all Documentations for the project.

Array<Documentation>

executionDate

Execution date and time for the products of the project. E.g. when window products need to be installed or floor products need to be laid.

date

extraFields

A list of all ExtraFields for the project.

Array<ExtraField>

groups

A list of all groups for the project.

Array<Group>

id

The project id.

integer

Identity (Unique)

isArchived

?

boolean

?

isDefaultDeliveryOverRuled

?

boolean

?

isDeleted

The project has been deleted by the dealer. When retrieving sent projects, this value should always be false.

boolean

isOrder

The project has been made definitive by the dealer.

boolean

isPaid

The project has been paid by customer.

boolean

isPurchaseOrder

The dealer has created the project while working in purchase mode. This means the purchase data (e.g. prices) have been used for this project.

boolean

isReadOnly

The project can not be edited. This happens when projects have been made definitive to prevent users from editing projects that are already being produced.

boolean

isSent

The project has been sent to the supplier.

boolean

isTemporary

Project is temporary.

boolean

?

lastModified

Date and time when the project was last modified.

date

lastOpened

Date and time when the project was last opened.

date

nameDelivery

Name of the person who the delivery is addressed to.

string

parentProjectId

Id of the parent project.

?

priceArticles

List of physical articles with their prices that exist within the entire project.

Array<PriceArticle>

priceCodeExceptions

?

?

priceCodes

Price codes that have been applied for the entire project. E.g. one delivery price for all products combined.

string

priceElements

All price additions and wage prices that are available within the project.

Array<PriceElement>

prjDate

Date and time when the project was created.

date

prjNumber

Unique number for the project. E.g. 0001.00024, where the "0001" is a check code that is unique for the dealer and the "00024" is an auto-incremented number and states that this is the 24th project the dealer has made.

string

projectMaterialPrices

List of all material/fabric prices that have been manually adjusted for the specific project.

Array<ProjectMaterialPrice>

projectMaterials

List of all unique materials within the project.

Array<ProjectMaterial>

projectPriceCodes

List of all price codes that have been used within the project.

Array<ProjectPriceCode>

projectStatusRemarks

?

?

?

promotionAmount

The promotion amount for the entire project.

decimal number

promotions

List of all promotions for the project.

Array<Promotion>

reference

Can be used by dealers to create their own reference. When communicating to the supplier for instance, this field can be used to refer to the project instead of only the project number.

string

remarks

Remarks made for the project.

?

salesMan

When multiple users login with one and the same credentials than this field contains the initials or name from the employee that created the project. This field is by standard not used and instead the Creator employee should normally be used.

string

? Creator employee missing

scene

?

string

?

sentDateTime

Date and time when the project was sent (ordered).

date

sentFilename

Path and name of the order file that has been created when the project was sent (ordered).

string

summaryFileName

Path and name of the overview PDF that has been created when the project was completed (not yet sent). This PDF is available in WoonTotaal within the section "REVIEW ORDERS AND/OR SEND IT" and is used to check an project before finally ordering it.

string

supplierId

Id of the main supplier of the project.

integer

Foreign key

supplierInterfaceId

Id of the interface that the dealer is attached to. SupplierInterfaces (or just interfaces) are used to exclude options that are not available for a certain dealer.

integer

Foreign key

usePolygonGrouping

When multiple polygons (order lines) within a project are to be treated as groups and not solitarily. This also means that polygons are treated as individual orders.

boolean

useWizard

?

boolean

?

versionNumber

Version number of the project.

integer

Reserved

zipDelivery

Delivery zip code (or postal code) for the project.

string

zipExecution

Execution zip code (or postal code) for the products of the project. E.g. where window products need to be installed or floor products need to be laid.

string


Group

Name Description Type Additional information

description

Description of the group.

string

rooms

List of attached rooms.

Array<Room>

id

The group id.

integer

Identity (Unique)


Room

Name Description Type Additional information

description

Description for the room. Not to be confused with the polygon description.

string

polygons

List of attached polygons (order lines within the project).

Array<Polygon>

id

The room id.

integer

Identity (Unique)


Polygon

Name Description Type Additional information

additionalPrice

Additional polygon prices.

decimal number

area

The calculated area of the polygon.

decimal number

categoryFavoriteId

CategoryFavorite id.

integer

Foreign key

categoryGroupId

CategoryGroup id.

integer

Foreign key

circumference

The calculated circumference of the polygon.

decimal number

combinedImageString

In WT the images shown for polygons exists out of multiple png files that lay on top of each other. The source to locate these files seperately is put in a semicolon seperated string and the result is also placed in this field.

string

description

This field contains the description of the room. E.g. living room or bedroom.

string

discountPrice

Price after subtraction of the discount.

decimal number

executionTime

The calculated time for manufacturing the polygon.

decimal number

favorite

CategoryFavorite code.

string

generateLatitudinalSeams

When seams are necessary because of material width restrictions. Used for floor polygons only.

boolean

groupNumber

?

string

hasNeededDimensions

All dimensions that are required for the polygon have been entered.

boolean

height

The polygon height or polygon length.

decimal number

id

The Polygon id.

integer

Identity (Unique)

isCalculable

?

boolean

isClosed

?

boolean

isDeleted

When a polygon is deleted it normally will not be saved in the database. However, when a project has to be edited after it has already been sent, the project can be reopend by the supplier. When a polygon within the project is then deleted it will be flagged as deleted so the supplier will know a product does not need to be manufactured anymore.

boolean

isDescriptionEnabled

?

boolean

isInvalidated

?

boolean

isLayDirectionCalculated

For floors the lay direction is always calculated in the most efficient way. When this field is true, the user has not adjusted this.

boolean

isLocked

When a project has been sent, the polygon is locked so it cannot be adjusted anymore.

boolean

isManual

?

boolean

isMeasure

The measure app or measure module has been used to determine the dimensions of the polygon.

boolean

isModifiedByApp

The measure app or measure module has been used to modify polygon.

boolean

isSent

The order has been sent to the Supplier.

boolean

isTemporary

?

boolean

kind

?

integer

layDirection

Lay direction of the polygon. Is used for floor polygons.

decimal number

leadTime

The initial time for delivering.

decimal number

lineNumber

Line number of the polygon within the project.

integer

manAreaNet

?

decimal number

manCircumference

?

decimal number

manCornersIn

?

integer

manCornersOut

?

integer

manDoorsLength

?

decimal number

manDoorsNum

?

integer

manSeams

?

decimal number

materialPrice

The total material price for the polygon.

decimal number

modelId

?

?

perDescription

?

?

polIndex

The index of the polygon within all polygons of the database. Based upon the moment of creation. (Only used when Project.usePolygonGrouping is true.)

integer

polNumber

Generated unique number. (Only used when Project.usePolygonGrouping is true.)

string

Identity (Unique)

polNumberGrouped

When multiple polygons within a project are to be treated as groups and not solitarily (Project.usePolygonGrouping), this is the shared polygon number. This number is the same as the main polygon in the group. (Only used when Project.usePolygonGrouping is true.)

string

polygonParentId

Within some modules (e.g. the floor module) it is possible to have multiple products within one polygon. The products are shown in one polygon in WT, but are actually stored as multiple polygons with one parent.

integer

polygonProjectMaterials

A list of all materials for this polygon. E.g. a curtain with main fabric and lining or a pleated blind with different fabrics for the top and the bottom.

Array<PolygonProjectMaterial>

polygonQuantity

The quantity within a polygon.

decimal number

polygonSeams

A list of seams used within a polygon.

Array<PolygonSeam>

polygonStatuses

A list of attached statuses for this polygon.

Array<PolygonStatus>

polygonTexts

Additional texts (comments) entered by the dealer.

Array<PolygonText>

polygonVisualGroups

VisualGroups attached to this polygon.

Array<PolygonVisualGroup>

priceTotal

The total price for this polygon.

integer

printData

?

?

productCategoryId

Id of the category of the main product.

integer

productionMethod

Code for the production method that is chosen from the Product menu in WT. This code is used internally and does not necessarily corresponds with codes from the Supplier.

string

productionMethodDescription

Description for the production method that is chosen from the Product menu in WT.

string

productionMethodDescriptionCalc

Alternative generated description for the production method.

string

purchaseNumber

Purchase number.

string

questionnairePath

The combined codes of answers given by the dealer in the order the questions were asked. Questionnaires can be used when category favorites are actived. (Piping symbol seperated string.)

string

side

?

integer

status

The id of the current main status of the polygon. There is a difference between main statuses and sub-statuses. E.g. a main status can be "Ordered" or "Paid" while "Order is printed" can be more of a sub-status. (So this could be slightly different from polygonStatuses.)

integer

statusDateTime

The date and time when the current status has been set.

date

statusDescription

A description of the current status.

string

statusValue

A value of the main current status

integer

subkind

?

integer

vertices

?

Array<Vertice>

wagePrice

The total wage price for the polygon.

decimal number

width

The polygon width.

decimal number


PolygonProjectMaterial

Name Description Type Additional information

calcQuantity

The gross calculated quantity.

decimal number

calcQuantityNet

The net calculated quantity.

decimal number

id

The PolygonProjectMaterial id.

integer

Identity (Unique)

isEnabled

Enabled or not.

boolean

isInvalidated

?

boolean

layDirection

The direction the user wants the material to be laid in. (Is used for floors.)

decimal number

layDirectionCalc

The calculated direction the material is most efficiently laid in. (Is used for floors.)

boolean

matGridStartX

?

decimal number

matGridStartY

?

decimal number

messages

?

Array<Message>

oversizeDiagonal

Oversize needed diagonally.

decimal number

oversizeSeam

Oversize needed for seam.

decimal number

oversizeStandard

Oversize standard.

decimal number

oversizeWidth

Oversize needed widthwise.

decimal number

polygonProjectMaterialProperties

A list of all properties for the PolygonProjectMaterial.

Array<PolygonProjectMaterialProperty>

polygonProjectMaterialStatuses

A list of all statuses for the PolygonProjectMaterial.

Array<PolygonProjectMaterialStatus>

projectMaterialId

The ProjectMaterial id.

integer

Foreign key

propertyValuesSet

?

boolean

purchaseQuantity

The purchase quantity.

decimal number

redistributionInfo

Information about the redistribution (sharing remaining material) of the material of this polygon to another polygon and the materials of other polygons to this polygon. (Uses polygon line numbers with arrows to identify the different polygons. E.g. " -> 2 " or " <- 1 ".

?

requiredFabricLength

The required fabric length.

integer

requiredFabricQuantity

The required fabric quantity.

integer

salePrice

The sale price.

decimal number

saleQuantity

The gross sale quantity.

decimal number

saleQuantityNet

The net sale quantity.

decimal number


PolygonProjectMaterialProperty

Name Description Type Additional information

displayOrder

Order in which the properties are displayed in WT.

integer

id

The PolygonProjectMaterialProperty id.

integer

Identity (Unique)

isCalculation

The value of the property has been calculated.

boolean

isDisplayable

The property is present in the layout of the WoonTotaal property display or in other words it has coordinates to be shown in WoonTotaal.

boolean

isInvalidated

?

boolean

Reserved

isModified

The property has been modified by the user.

boolean

isModifiedByApp

The property has been modified by the application, because of conditions.

boolean

isReadOnly

Unmodifiable property for displaying purposes.

boolean

isVisible

The property is visible to the user.

boolean

modified

The property has been modified by the user.

boolean

Skip; duplicates "isModified"

propertyDescription

The property description.

string

propertyId

The property id.

integer

Foreign key

propertyValue

The value of the property.

string

visible

The property is visible to the user.

boolean

Skip; duplicates "isVisible"