Order

vPlan has five types of orders; Sales, Quotation, Purchase, Production and Project:

Sales Order represents a sale, i.e. a product or service delivered to a relation.

Quotation Order represents a quotation, i.e. an offer for goods or services to a relation.

Purchase Order represents a purchase, i.e. a product or service acquired from a relation.

Production Order represents a production, i.e. a product is produced.

Project Order represents a project, i.e. umbrella of activities performed for a relation.

WARNING

A customer cannot maintain Orders within vPlan. It should be maintained by the integrations that created them. And they are only visible as integration data via a Collection.

Order affiliation to Collection

An order is a helper object for creating a collection.

Its purpose is to give an integration the option to maintain data consistency,
while giving the customer a way to manually add or change the details of a collection.

On creation of an order, a collection is automatically created.
That collection could, depending on the settings, be automatically planned via an asynchronous process.
This process uses the promised date of order.

On update of an order, a collection is automatically synchronized via an asynchronous process.

The collection will be constructed using the following data if available:

Collection	Order	On Create	On update
name	code	initial value	updated if not manually changed
description	quantity and description	initial value	updated if not manually changed
due_date	promised_date or else desired_date	initial value	updated if not manually changed ¹

meta
- order_type	type	initial value	updated
- order_status	status	initial value	updated
- address	order.address	initial value	updated
- relation	relation.name	initial value	updated
- project	project.name	initial value	updated
- promised_date	promised_date	initial value	updated ¹
- desired_date	desired_date	initial value	updated ¹

activities	rows
- id	activity.id	initial value	only updated for the backlog
- time	unit * quantity ²	initial value	only updated for the backlog

¹: Dates changed in the Order will not affect the actual planning, it could give a warning icon within the current plan boards.

²: Time is calculated to minutes based on the unit and quantity, and rounded to a whole number:
unit time
minutes quantity
hours 60 * quantity
days 3600 * quantity
[other] 0

unit	time
minutes	quantity
hours	60 * quantity
days	3600 * quantity
[other]	0

Order

string <uuid>

read-onlyoptional

Unique identifier

project_id

string <uuid> | null

optional

<= 36 characters

Default:

NULL

warehouse_id

string <uuid> | null

optional

<= 36 characters

Default:

NULL

relation_id

string <uuid> | null

optional

<= 36 characters

Default:

NULL

item_id

string <uuid> | null

optional

<= 36 characters

Default:

NULL

address_id

string <uuid> | null

optional

<= 36 characters

Default:

NULL

collection_id

string <uuid>

optional

Unique identifier of the Collection

Order affiliation to Collection#

Order affiliation to Collection