Almost every object relevant for integrations has a property named external_ref.In principal this is not a field vPlan uses itself. However, if it has a value the vPlan frontend will block certain manual changes for its users.The main goal for this property is to provide integrations with a location to store the unique identifier of the source object.Unique Constraint#
The external_ref has the requirement that it must be unique, within that object.
If you try to create an object with an already existing external_ref the vPlan API give an error "HTTP 422 Unprocessable entity", with a description stating "Duplicate entry".For Orders the unique key is external_ref combined with type and sub_type.Objects which have the archive feature will, per default, not return archived objects.Archived objects are not separate from unarchived objects, as such, unique constraints still apply, i.e. an "active" or "unarchived" object cannot have the same value for a unique constraint as an archived object
If an order type or sub_type is given the value null the unique constraint will not be triggered. Use the value none instead.
