vPlan
  1. Order Data
vPlan
  • General
    • Structure
    • Synchronize Data
    • Pagination
    • Sorting
    • Filtering
    • Show & Hide
    • Eager Loading
    • Deep Insertion
    • Deprecated
    • External Reference
    • Rate Limits
    • Authentication
      • Authentication
        • Get authorization
        • Token Exchange
      • Me
        • Retrieve information about current authentication
    • Errors
      • Empty values in created object
      • Memory Exhausted
      • Report an issue
      • Service Unavailable
      • Retrieve Api Messages
  • Endpoints
    • Base Data
      • Board
        • Label
        • Status
        • Capacity
          • Capacity Stage
          • Capacity Resource Type Stage
          • Capacity Resource
          • Capacity Group
        • View
          • Create New BoardView
        • Retrieve Board List
        • Create New Board
        • Retrieve Single Board
        • Update Single Board
        • Remove Single Board
      • Stage
        • Retrieve Stage List
        • Create New Stage
        • Retrieve Single Stage
        • Update Single Stage
        • Remove Single Stage
      • Activity
        • Retrieve Activity List
        • Create New Activity
        • Retrieve Single Activity
        • Update Single Activity
        • Remove Single Activity
      • Resource
        • Schedule
        • Schedule Deviation
          • Retrieve Deviation List
          • Create New Schedule Deviation
          • Retrieve Single Schedule Deviation
          • Update Single Schedule Deviation
          • Remove Single Schedule Deviation
        • Retrieve Resource List
        • Create New Resource
        • Retrieve Single Resource
        • Update Single Resource
        • Remove Single Resource
      • Schedule
        • Retrieve Schedule List
        • Retrieve Schedule Year
        • Retrieve Schedule Month
        • Schedule Retrieve Day
      • Group
        • Retrieve Group List
        • Create New Group
        • Retrieve Single Group
        • Update Single Group
        • Remove Single Group
      • User
        • Invite User
        • Retrieve User List
        • Retrieve Single User
        • Update Single User
      • Space
        • Retrieve Space List
        • Create New Space
        • Retrieve Single Space
        • Update Single Space
        • Remove Single Space
    • Card Data
      • Collection
        • Custom Fields
          • Update Custom Field By Name
          • Delete Custom Field By Name
        • Retrieve Collection List
        • Create New Collection
        • Retrieve Single Collection
        • Update Single Collection
        • Remove Single Collection
        • Move Collection to Board
        • Move Collection to Backlog
      • Card
        • Custom Field
          • Update Custom Field By Name
          • Delete Custom Field By Name
        • Retrieve Card List
        • Create New Card
        • Retrieve Single Card
        • Update Single Card
        • Remove Single Card
        • Split Card
        • All Cards List
      • Attachment
        • Retrieve Attachment List
        • Upload New Attachment
        • Add New Attachment Link
        • Retrieve Single Attachment
        • Remove Single Attachment
      • Comment
        • Retrieve Comment List
        • Create New Comment
        • Retrieve Single Comment
        • Update Single Comment
        • Remove Single Comment
      • Checklist
        • Collection
          • Retrieve Collection Checklist List
          • Create New Collection Checklist
          • Retrieve Single Collection Checklist
          • Update Single Collection Checklist
          • Remove Single Collection Checklist
        • Card
          • Retrieve Card Checklist List
          • Create New Card Checklist
          • Retrieve Single Card Checklist
          • Update Single Card Checklist
          • Remove Single Card Checklist
      • Time Tracking
        • Retrieve TimeTracking List
        • Create New TimeTracking
        • Retrieve Single TimeTracking
        • Update Single TimeTracking
        • Remove Single TimeTracking
        • Export TimeTracking
      • Relations between cards
        • Retrieve CardRelation List
        • Create New CardRelation
        • Retrieve Single CardRelation
        • Remove Single CardRelation
      • Card Relation
    • Order Data
      • Address
      • Order
        • Retrieve Order List
        • Create New Order
        • Retrieve Single Order
        • Update Single Order
        • Remove Single Order
      • Row
        • Retrieve OrderRow List
        • Create New OrderRow
        • Retrieve Single OrderRow
        • Update Single OrderRow
        • Remove Single OrderRow
      • Item
        • Retrieve Item List
        • Create New Item
        • Retrieve Single Item
        • Update Single Item
        • Remove Single Item
      • Project
        • Retrieve Project List
        • Create New Project
        • Retrieve Single Project
        • Update Single Project
        • Remove Single Project
      • Relation
        • Retrieve Relation List
        • Create New Relation
        • Retrieve Single Relation
        • Update Single Relation
        • Remove Single Relation
      • Warehouse
        • Retrieve Warehouse List
        • Create New Warehouse
        • Retrieve Single Warehouse
        • Update Single Warehouse
        • Remove Single Warehouse
    • Webhook
      • Payload send to webhook url
        • Normal Object
        • Nested Object
        • Nested Object with Pivot
      • Retrieve Webhook List
      • Create New Webhook
      • Retrieve Single Webhook
      • Update Single Webhook
      • Remove Single Webhook
  1. Order Data

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:
CollectionOrderOn CreateOn update
namecodeinitial valueupdated if not manually changed
descriptionquantity and descriptioninitial valueupdated if not manually changed
due_datepromised_date or else desired_dateinitial valueupdated if not manually changed ¹
meta
- order_typetypeinitial valueupdated
- order_statusstatusinitial valueupdated
- addressorder.addressinitial valueupdated
- relationrelation.nameinitial valueupdated
- projectproject.nameinitial valueupdated
- promised_datepromised_dateinitial valueupdated ¹
- desired_datedesired_dateinitial valueupdated ¹
activitiesrows
- idactivity.idinitial valueonly updated for the backlog
- timeunit * quantity ²initial valueonly 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:
unittime
minutesquantity
hours60 * quantity
days3600 * quantity
[other]0
Order

Modified at 2025-07-24 09:40:18
Previous
Address
Next
Retrieve Order List
Built with