Shipment Properties |
The Shipment type exposes the following members.
Name | Description | |
---|---|---|
![]() | AccessKey | The access key, containing the user permissions for this document. null means that all users have unlimited permissions (Inherited from Document.) |
![]() | AdjustedDocument | The primary document, which the current document adjusts. null when this is not an adjustment document (Inherited from Document.) |
![]() | AdjustmentNumber | Consecutive number of the correction that this document is applying to the adjusted document. [Required] (Inherited from Document.) |
![]() | AdjustmentTime | Date/time when the document last has been adjusted by corrective document (Inherited from Document.) |
![]() | AdjustmentUser | The user who adjusted the document (Inherited from Document.) |
![]() | AssignedToUser | The user to which this document is assigned for handling. null means that the document is not assigned to specific user (Inherited from Document.) |
![]() | ChangingAttributes |
Gets the attributes that are currently changing. Can be used in attribute change event handler to prevent stack overflow.
(Inherited from EditableDomainObject.) |
![]() | Comments | List of DocumentComment child objects, based on the DocumentComment.Document back reference (Inherited from Document.) |
![]() | CompleteTime | Exact time, when the document was last completed[Filter(ge;le)] (Inherited from Document.) |
![]() | CreationTime | Date/Time when the document was created [Required][Filter(ge;le)] (Inherited from Document.) |
![]() | CreationUser | The login name of the user, who created the document [Required][Filter(like)] (Inherited from Document.) |
![]() | CurrencyDirectory | The currency directory, containing all the convertion rates, used by the document. null means that the document does not need currency convertions (Inherited from Document.) |
![]() | CustomProperties |
Gets the custom properties of the object.
(Inherited from EnterpriseOneEntityObject.) |
![]() | DistributedAmounts | List of DocumentDistributedAmount child objects, based on the DocumentDistributedAmount.Document back reference (Inherited from Document.) |
![]() | DistributedAmountsFromOtherDocuments |
Gets the distributed amounts where this document is referenced.
(Inherited from LogisticsDocument.) |
![]() | DocumentAmounts | List of DocumentAmount child objects, based on the DocumentAmount.Document back reference (Inherited from LogisticsDocument.) |
![]() | DocumentCurrency |
Gets or sets the currency of the amounts in logistics documents.
Some logistics documents do not support currency.
(Inherited from LogisticsDocument.) |
![]() | DocumentDate | The date on which the document was issued [Required][Filter(eq;ge;le)][ORD] (Inherited from Document.) |
![]() | DocumentId |
Gets the Id of the document row, related to the domain object
(Inherited from Document.) |
![]() | DocumentNo | Document number, unique within Document_Type_Id [Required][Filter(eq;like)][ORD] (Inherited from Document.) |
![]() | DocumentNotes | Notes for this Document (Inherited from Document.) |
![]() | DocumentText |
Gets the document display text ({DocumentTypeName} {DocumentNo}).
(Inherited from Document.) |
![]() | DocumentType | The user defined type of the document. Determines document behaviour, properties, additional amounts, validation, generations, etc. [Required] (Inherited from Document.) |
![]() | DocumentVersion | [Filter(eq;ge;le)] (Inherited from Document.) |
![]() | EnterpriseCompany | The enterprise company which issued the document [Required] (Inherited from Document.) |
![]() | EnterpriseCompanyLocation | The enterprise company location which issued the document. null means that there is only one location within the enterprise company and locations are not used (Inherited from Document.) |
![]() | EntityName | The entity name of the document equal to the entity name of the document type.[Filter(eq)] [ORD] (Inherited from Document.) |
![]() | ExtendedProperties |
Extended properties contain temporary (not persisted) values in the object instance.
(Inherited from EntityObject.) |
![]() | FileAttachments | List of DocumentFileAttachment child objects, based on the DocumentFileAttachment.Document back reference (Inherited from Document.) |
![]() | FromCompanyDivision | The division of the company, issuing the document. null when the document is not issued by any specific division (Inherited from Document.) |
![]() | FromParty | The party which issued the document [Required] (Inherited from Document.) |
![]() | Id |
The unique Id of the entity object
(Inherited from EntityObject.) |
![]() | IsAdjustingDocument |
Gets a value indicating whether this instance is adjusting document.
(Inherited from Document.) |
![]() | IsGhost |
Returns true when the object is a ghost object
(Inherited from EntityObject.) |
![]() | IsLoaded | Gets a value indicating whether the associated data for this domain object is loaded. (Overrides DocumentIsLoaded.) |
![]() | IsReleased | True if the document is not void and its state is released or greater. [Required] [Default(false)] [Filter(eq)] [ReadOnly] |
![]() | IsSingleExecution | Specifies whether the document is a single execution of its order document. [Required] [Default(false)] [Filter(eq)] [ReadOnly] |
![]() | IssuedByPerson | The person who signed for the shipment. [Filter(multi eq)] |
![]() | ItemString |
Gets or sets the value of a data attribute
(Inherited from DomainObject.) |
![]() | ItemIDataAttribute |
Gets or sets the value of a data attribute
(Inherited from DomainObject.) |
![]() | LineAmounts | List of DocumentLineAmount child objects, based on the DocumentLineAmount.Document back reference (Inherited from Document.) |
![]() | Lines | List of ShipmentLine child objects, based on the Logistics.Shipment.ShipmentLine.Shipment back reference |
![]() | LogisticsLines |
Gets the logistics lines of the document.
(Overrides LogisticsDocumentLogisticsLines.) |
![]() | LogisticsLinesCollections |
Gets the logistics lines collections.
Some documents have more than one child collection with logistics lines.
(Inherited from LogisticsDocument.) |
![]() | MasterDocument | In a multi-document tree, this is the root document, that created the whole tree. If this is the root it is equal to Id [Required] (Inherited from Document.) |
![]() | NoEvents |
Turns on "No events" mode and returns a class, that will turn it off when Disposed. See remarks for more info.
(Inherited from DomainObject.) |
![]() | ObjectState | Gets the state of the domain object. (Overrides DocumentObjectState.) |
![]() | Parent | In a multi-document tree, this is the direct parent document. If this is the root it is null (Inherited from Document.) |
![]() | ParentDocumentRelationshipType | Type of relationship between the current document and the parent document(s). Affects the constraints for execution/completion for the documents. Possible values: 'S' = 'Subtask', 'N' = 'Next task'. (Inherited from Document.) |
![]() | PlanningOnly | Indicates that the document is used only for planning (and as consequence its state cannot be greater than Planned) [Required] (Inherited from Document.) |
![]() | PrimeCauseDocument | The document that is the prime cause for creation of the current document (Inherited from Document.) |
![]() | Prints | List of DocumentPrint child objects, based on the DocumentPrint.Document back reference (Inherited from Document.) |
![]() | ReadOnly | True - the document is read only; false - the document is not read only [Required] (Inherited from Document.) |
![]() | ReceivedByPerson | The person who received the goods for/from the shipment . [Filter(multi eq)] |
![]() | ReferenceDate | The date to which this document refers, i.e. when the action really occurred. If null, Document_Date is taken [Filter(ge;le)] (Inherited from Document.) |
![]() | ReferenceDocumentNo | The number of the document (issued by the other party), which was the reason for the creation of the current document. The numebr should be unique within the party documents [Filter(eq;like)] (Inherited from Document.) |
![]() | ReleaseTime | Exact time, when the document was first released [Filter(ge;le)] (Inherited from Document.) |
![]() | Repository | Provides access to ShipmentsRepository repository methods |
![]() | RequiredDeliveryDate | Required delivery date. Depending on the shipment route travel time, the shipment should be released accordingly. When null means that the required delivery date is unknown or the document contains many required delivery dates (e.g. in the lines). [Filter(ge;le)] |
![]() | ResponsiblePerson | The person that is responsible for this order or transaction. It could be the sales person, the orderer, etc. (Inherited from Document.) |
![]() | ReverseOfDocument | The document which the current document is reverse of (Inherited from Document.) |
![]() | Sequence | The sequence that will be used to give new numbers to the documents of this type (Inherited from Document.) |
![]() | ShipFromStore | The store from which the shipment should be effected. [Required] [Filter(multi eq)] |
![]() | ShipToPartyContactMechanism | Destination address where the goods should be shipped. [Required] [Filter(multi eq)] |
![]() | State | 0=New;5=Corrective;10=Computer Planned;20=Human Planned;30=Released;40=Completed;50=Closed [Required][Filter(eq;ge;le)] (Inherited from Document.) |
![]() | StateChanges | List of DocumentStateChange child objects, based on the DocumentStateChange.Document back reference (Inherited from Document.) |
![]() | Store |
Gets or sets the store of the logistics document. Some logistics documents do not support store.
(Inherited from LogisticsDocument.) |
![]() | SupportsDocumentAmounts |
Gets a value indicating whether the document supports document amounts.
(Inherited from LogisticsDocument.) |
![]() | SupportsDocumentCurrency |
Gets a value indicating whether the document supports document currency.
(Inherited from LogisticsDocument.) |
![]() | SupportsStore |
Gets a value indicating whether the document supports store.
(Inherited from LogisticsDocument.) |
![]() | ToCompanyDivision | The division of the company, receiving the document. null when the document is not received by any specific division (Inherited from Document.) |
![]() | ToParty | The party which should receive the document (Inherited from Document.) |
![]() | Transaction |
The EnterpriseOne transaction to which this object is attached.
(Inherited from EnterpriseOneEntityObject.) |
![]() | UserStatus | The user status of this document if applicable for this document type. null means unknown or not yet set (Inherited from Document.) |
![]() | Versions | List of DocumentVersion child objects, based on the DocumentVersion.Document back reference (Inherited from Document.) |
![]() | Void | True if the document is null and void [Required][Filter(eq)] (Inherited from Document.) |
![]() | VoidReason | Reason for voiding the document, entered by the user (Inherited from Document.) |
![]() | VoidTime | Date/time when the document has become void (Inherited from Document.) |
![]() | VoidUser | The user who voided the document (Inherited from Document.) |