Crm.Sales.SalesOrders Entity
Namespace: Crm.Sales
Inherited From: General.Documents
Sales order document headers. Entity: Crm_Sales_Orders
Default Visualization
Default Display Text Format:
{DocumentType.Code}:{DocumentNo} - {DocumentType.TypeName:T}
Default Search Member:
DocumentNo
Aggregate
An aggregate is a cluster of domain objects that can be treated as a single unit.
Aggregate Tree
- Crm.Sales.SalesOrders
- Crm.Sales.SalesOrderLines
- Crm.Sales.SalesOrderPaymentPlans
- Crm.Sales.SalesOrderPromotionalPackages
- General.DocumentAmounts
- General.DocumentComments
- General.DocumentDistributedAmounts
- General.DocumentFileAttachments
- General.DocumentLineAmounts
- General.DocumentPrints
- General.DocumentStateChanges
- General.DocumentVersions
Attributes
| Name | Type | Description |
|---|---|---|
| AdjustmentNumber | int32 | Consecutive number of the correction that this document is applying to the adjusted document. Required Default(0) ReadOnly (Inherited from Documents) |
| AdjustmentTime | datetime nullable | Date/time when the document last has been adjusted by corrective document. ReadOnly (Inherited from Documents) |
| AdjustmentUser | string (64) nullable | The user who adjusted the document. ReadOnly (Inherited from Documents) |
| CompleteTime | datetime nullable | Date and time when the document was completed (State set to Completed). Filter(ge;le) ReadOnly (Inherited from Documents) |
| CreationTime | datetime | Date/Time when the document was created. Required Default(Now) Filter(ge;le) ReadOnly (Inherited from Documents) |
| CreationUser | string (64) | The login name of the user, who created the document. Required Filter(like) ReadOnly (Inherited from Documents) |
| CreditLimitOverride | boolean | Allows the sales order to be released even in the case of violations of credit limit or presence of overdue receivables. Required Default(false) Filter(eq) |
| CustomerPurchaseOrderDate | date nullable | Issue date of the referent customer purchase order. Filter(ge;le) |
| CustomerPurchaseOrderNo | string (20) nullable | Reference number of the customer's purchase order. Filter(eq;like) |
| DeliveryTermsCode | DeliveryTerms nullable | Mode of delivery, like CIF, FOB, etc. Used also in Intrastat reporting. |
| DocumentDate | date | The date on which the document was issued. Required Default(Today) Filter(eq;ge;le) ORD (Inherited from Documents) |
| DocumentNo | string (20) | Document number, unique within Document_Type_Id. Required Filter(eq;like) ORD (Inherited from Documents) |
| DocumentNotes | string (max) nullable | Notes for this Document. (Inherited from Documents) |
| DocumentVersion | int32 | Consecutive version number, starting with 1. Each update produces a new version of the document. Required Default(1) Filter(eq;ge;le) ReadOnly (Inherited from Documents) |
| EntityName | string (64) | The entity name of the document header. Required Filter(eq) ORD ReadOnly (Inherited from Documents) |
| FiscalSalesNumber | string (32) nullable | Unique number of the sale, assigned for fiscal reporting purposes. The format is according to the applicable legislation. null means that there is no requirement for fiscal sales number for this document or it is unknown. Filter(multi eq;like) ReadOnly Introduced in version 19.1 |
| FromDate | date nullable | When selling a service valid only for a period, denotes the beginning of the period. null means that it is unknown or N/A. Introduced in version 20.1 |
| Id | guid | |
| IntrastatTransaction NatureCode |
TransactionNature nullable | Transaction nature; used for Intrastat reporting. |
| IntrastatTransportModeCode | TransportMode nullable | Transport mode; used for Intrastat reporting. |
| IsReleased | boolean | True if the document is not void and its state is released or greater. Required Default(false) Filter(eq) ReadOnly |
| IsSingleExecution | boolean | Specifies whether the document is a single execution of its order document. Required Default(false) Filter(eq) ReadOnly |
| IsValidField | boolean | True when the order is valid (e.g. released and not void). Used for internal processing. Required Default(false) ReadOnly |
| Notes | string (254) nullable | Notes for this SalesOrder. |
| ParentDocument RelationshipType |
ParentDocument RelationshipType nullable |
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'. ReadOnly (Inherited from Documents) |
| PaymentDueDate | datetime nullable | The last term for the payment of the sales order. Filter(ge;le) |
| PaymentDueStartDate | datetime nullable | The date when the payment becomes due for documents with one installment. null when the document is with multiple installments. |
| PlanningOnly | boolean | Indicates that the document is used only for planning (and as consequence its state cannot be greater than Planned). Required Default(false) ReadOnly (Inherited from Documents) |
| ReadOnly | boolean | True - the document is read only; false - the document is not read only. Required Default(false) ReadOnly (Inherited from Documents) |
| ReferenceDate | datetime nullable | The date to which this document refers, i.e. when the action really occurred. If null, Document_Date is taken. Default(Today) Filter(ge;le) (Inherited from Documents) |
| ReferenceDocumentNo | string (20) nullable | 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 Documents) |
| ReleaseTime | datetime nullable | Date and time when the document was released (State set to Released). Filter(ge;le) ReadOnly (Inherited from Documents) |
| RequiredDeliveryDate | date nullable | The required delivery date for all lines in the sales order. Initially calculated, based on either the Ship To Customer or Customer delivery term. Filter(ge;le) |
| State | DocumentState | The current system state of the document. Allowed values: 0=New;5=Corrective;10=Computer Planned;20=Human Planned;30=Released;40=Completed;50=Closed. Required Default(0) Filter(multi eq;ge;le) ReadOnly (Inherited from Documents) |
| ToDate | date nullable | When selling a service valid only for a period, denotes the end of the period. null means that it is unknown or N/A. Introduced in version 20.1 |
| Void | boolean | True if the document is null and void. Required Default(false) Filter(eq) ReadOnly (Inherited from Documents) |
| VoidReason | string (254) nullable | Reason for voiding the document, entered by the user. ReadOnly (Inherited from Documents) |
| VoidTime | datetime nullable | Date/time when the document has become void. ReadOnly (Inherited from Documents) |
| VoidUser | string (64) nullable | The user who voided the document. ReadOnly (Inherited from Documents) |
References
| Name | Type | Description |
|---|---|---|
| AccessKey | AccessKeys (nullable) | The access key, containing the user permissions for this document. null means that all users have unlimited permissions. Filter(multi eq) (Inherited from Documents) |
| AdjustedDocument | Documents (nullable) | The primary document, which the current document adjusts. null when this is not an adjustment document. Filter(multi eq) ReadOnly (Inherited from Documents) |
| AssignedToUser | Users (nullable) | The user to which this document is assigned for handling. null means that the document is not assigned to specific user. Filter(multi eq) (Inherited from Documents) |
| CurrencyDirectory | CurrencyDirectories (nullable) | The currency directory, containing all the convertion rates, used by the document. null means that the document does not need currency convertions. Filter(multi eq) (Inherited from Documents) |
| Customer | Customers | The primary customer, which placed the sales order. Required Filter(multi eq) |
| Deal | Deals (nullable) | The opportunity (deal) on which this order is based. Filter(multi eq) |
| Dealer | Dealers (nullable) | The external dealer, associated with the sales order. Filter(multi eq) |
| DealType | DealTypes (nullable) | Deal type to be passed to the invoice. If deal type in entered then the invoice creates VAT entry for this deal type. Filter(multi eq) |
| DistributionChannel | DistributionChannels (nullable) | The distribution channel, that is used to deliver the products. Filter(multi eq) |
| DocumentCurrency | Currencies | The currency of the document; e.g. the currency of the amounts in the document. Required Filter(multi eq) |
| DocumentType | DocumentTypes | The user defined type of the document. Determines document behaviour, properties, additional amounts, validation, generations, etc. Required Filter(multi eq) (Inherited from Documents) |
| EndCustomerParty | Parties (nullable) | The end customer is the customer of the dealer. It is stored for information purposes only. The end customer may not have customer definition; any party can be used. Filter(multi eq) Introduced in version 20.1 |
| EnterpriseCompany | EnterpriseCompanies | The enterprise company which issued the document. Required Filter(multi eq) (Inherited from Documents) |
| EnterpriseCompanyLocation | CompanyLocations (nullable) | 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. Filter(multi eq) (Inherited from Documents) |
| FiscalPrinterPosDevice | Devices (nullable) | For POS sales, specifies the fiscal printer. null when the sales is not a POS sale. Filter(multi eq) Introduced in version 19.1 |
| FromCompanyDivision | CompanyDivisions (nullable) | The division of the company, issuing the document. null when the document is not issued by any specific division. Filter(multi eq) (Inherited from Documents) |
| FromParty | Parties | The party which issued the document. Required Filter(multi eq) (Inherited from Documents) |
| IntrastatTransportCountry | Countries (nullable) | Country of origin of the transport company; used for Intrastat reporting. Filter(multi eq) |
| MasterDocument | Documents | 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 Filter(multi eq) (Inherited from Documents) |
| Parent | Documents (nullable) | In a multi-document tree, this is the direct parent document. If this is the root it is null. Filter(multi eq) (Inherited from Documents) |
| PaymentAccount | PaymentAccounts (nullable) | When not null, the payment account, where the payment is expected. null=no expectation for account. Filter(multi eq) |
| PaymentType | PaymentTypes (nullable) | When not null specifies the payment type for the sales order. Filter(multi eq) |
| PosLocation | Locations (nullable) | For POS sales, specifies the POS location, in which the sale is performed. null when the sales is not a POS sale. Filter(multi eq) Introduced in version 19.1 |
| PosOperator | Operators (nullable) | For POS sales, specifies the POS operator, who created the sale. null when the sale is not a POS sale. Filter(multi eq) Introduced in version 19.1 |
| PosTerminal | Terminals (nullable) | For POS sales, specifies the POS terminal, on which the sale is entered. null when the sales is not a POS sale. Filter(multi eq) Introduced in version 19.1 |
| PriceList | PriceLists (nullable) | The price list to be used for determining product prices in the lines. Filter(multi eq) |
| PrimeCauseDocument | Documents (nullable) | The document that is the prime cause for creation of the current document. Filter(multi eq) (Inherited from Documents) |
| ResponsiblePerson | Persons (nullable) | The person that is responsible for this order or transaction. It could be the sales person, the orderer, etc. Filter(multi eq) (Inherited from Documents) |
| ReturnForInvoice | Invoices (nullable) | When specified indicates that some of the goods sold in the sales orders invoiced with Return_For_Invoice_Id are returned with the current document. Filter(multi eq) |
| ReturnForSalesOrder | SalesOrders (nullable) | When specified indicates that some of the goods sold in Return_For_Sales_Order_Id are returned with the current document. Filter(multi eq;like) |
| ReverseOfDocument | Documents (nullable) | The document which the current document is reverse of. Filter(multi eq) ReadOnly (Inherited from Documents) |
| SalesPerson | SalesPersons (nullable) | Internal company sales person. Filter(multi eq) |
| Sequence | Sequences (nullable) | The sequence that will be used to give new numbers to the documents of this type. Filter(multi eq) ReadOnly (Inherited from Documents) |
| ShipToCustomer | Customers (nullable) | The customer to whom to ship the sales order. Usually it is a customer entry for a sub-party of the primary customer. Filter(multi eq) |
| ShipToPartyContact Mechanism |
PartyContactMechanisms (nullable) | The contact mechanism (address) to whih to ship the sales order. Filter(multi eq) |
| Store | Stores (nullable) | The store from which to issue the sales order. null means that there is no store associated with the sales order or there are different stores for some of the lines. Filter(multi eq) |
| ToCompanyDivision | CompanyDivisions (nullable) | The division of the company, receiving the document. null when the document is not received by any specific division. Filter(multi eq) (Inherited from Documents) |
| ToParty | Parties (nullable) | The party which should receive the document. Filter(multi eq) (Inherited from Documents) |
| UserStatus | DocumentTypeUserStatuses (nullable) | The user status of this document if applicable for this document type. null means unknown or not yet set. Filter(multi eq) ReadOnly (Inherited from Documents) |
Child Collections
| Name | Type | Description |
|---|---|---|
| Comments | DocumentComments | List of DocumentComment(General.DocumentComments.md) child objects, based on the General.DocumentComment.Document(General.DocumentComments.md#document) back reference (Inherited from Documents) |
| DistributedAmounts | DocumentDistributedAmounts | List of DocumentDistributed<br />Amount(General.DocumentDistributedAmounts.md) child objects, based on the General.DocumentDistributedAmount.Document(General.DocumentDistributedAmounts.md#document) back reference (Inherited from Documents) |
| DocumentAmounts | DocumentAmounts | List of DocumentAmount(General.DocumentAmounts.md) child objects, based on the General.DocumentAmount.Document(General.DocumentAmounts.md#document) back reference (Inherited from Documents) |
| FileAttachments | DocumentFileAttachments | List of DocumentFileAttachment(General.DocumentFileAttachments.md) child objects, based on the General.DocumentFileAttachment.Document(General.DocumentFileAttachments.md#document) back reference (Inherited from Documents) |
| LineAmounts | DocumentLineAmounts | List of DocumentLineAmount(General.DocumentLineAmounts.md) child objects, based on the General.DocumentLineAmount.Document(General.DocumentLineAmounts.md#document) back reference (Inherited from Documents) |
| Lines | SalesOrderLines | List of SalesOrderLine(Crm.Sales.SalesOrderLines.md) child objects, based on the Crm.Sales.SalesOrderLine.SalesOrder(Crm.Sales.SalesOrderLines.md#salesorder) back reference |
| PaymentPlans | SalesOrderPaymentPlans | List of SalesOrderPaymentPlan(Crm.Sales.SalesOrderPaymentPlans.md) child objects, based on the Crm.Sales.SalesOrderPaymentPlan.SalesOrder(Crm.Sales.SalesOrderPaymentPlans.md#salesorder) back reference |
| Prints | DocumentPrints | List of DocumentPrint(General.DocumentPrints.md) child objects, based on the General.DocumentPrint.Document(General.DocumentPrints.md#document) back reference (Inherited from Documents) |
| PromotionalPackages | SalesOrderPromotionalPackages | List of SalesOrderPromotional<br />Package(Crm.Sales.SalesOrderPromotionalPackages.md) child objects, based on the Crm.Sales.SalesOrderPromotional<br />Package.SalesOrder(Crm.Sales.SalesOrderPromotionalPackages.md#salesorder) back reference |
| StateChanges | DocumentStateChanges | List of DocumentStateChange(General.DocumentStateChanges.md) child objects, based on the General.DocumentStateChange.Document(General.DocumentStateChanges.md#document) back reference (Inherited from Documents) |
| Versions | DocumentVersions | List of DocumentVersion(General.DocumentVersions.md) child objects, based on the General.DocumentVersion.Document(General.DocumentVersions.md#document) back reference (Inherited from Documents) |
Attribute Details
AdjustmentNumber
Consecutive number of the correction that this document is applying to the adjusted document. Required Default(0) ReadOnly (Inherited from Documents)
Type: int32
Supported Filters: NotFilterable
Supports Order By: False
Default Value: 0
AdjustmentTime
Date/time when the document last has been adjusted by corrective document. ReadOnly (Inherited from Documents)
Type: datetime nullable
Supported Filters: NotFilterable
Supports Order By: False
AdjustmentUser
The user who adjusted the document. ReadOnly (Inherited from Documents)
Type: string (64) nullable
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 64
CompleteTime
Date and time when the document was completed (State set to Completed). Filter(ge;le) ReadOnly (Inherited from Documents)
Type: datetime nullable
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
CreationTime
Date/Time when the document was created. Required Default(Now) Filter(ge;le) ReadOnly (Inherited from Documents)
Type: datetime
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: CurrentDateTime
CreationUser
The login name of the user, who created the document. Required Filter(like) ReadOnly (Inherited from Documents)
Type: string (64)
Supported Filters: Like
Supports Order By: False
Maximum Length: 64
CreditLimitOverride
Allows the sales order to be released even in the case of violations of credit limit or presence of overdue receivables. Required Default(false) Filter(eq)
Type: boolean
Supported Filters: Equals
Supports Order By: False
Default Value: False
CustomerPurchaseOrderDate
Issue date of the referent customer purchase order. Filter(ge;le)
Type: date nullable
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
CustomerPurchaseOrderNo
Reference number of the customer's purchase order. Filter(eq;like)
Type: string (20) nullable
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 20
DeliveryTermsCode
Mode of delivery, like CIF, FOB, etc. Used also in Intrastat reporting.
Type: DeliveryTerms nullable
Generic enum type for DeliveryTerms properties
Allowed Values (Finance.Intrastat.DeliveryTerms Enum Members)
| Value | Description |
|---|---|
| ExWorks | ExWorks value. Stored as 'EXW'. Database Value: 'EXW' Model Value: 0 Domain API Value: 'ExWorks' |
| FrancoCarrier | FrancoCarrier value. Stored as 'FCA'. Database Value: 'FCA' Model Value: 1 Domain API Value: 'FrancoCarrier' |
| FreeAlongsideShip | FreeAlongsideShip value. Stored as 'FAS'. Database Value: 'FAS' Model Value: 2 Domain API Value: 'FreeAlongsideShip' |
| FreeOnBoard | FreeOnBoard value. Stored as 'FOB'. Database Value: 'FOB' Model Value: 3 Domain API Value: 'FreeOnBoard' |
| CostAndFreightCF | CostAndFreightCF value. Stored as 'CFR'. Database Value: 'CFR' Model Value: 4 Domain API Value: 'CostAndFreightCF' |
| CostInsuranceAndFreight | CostInsuranceAndFreight value. Stored as 'CIF'. Database Value: 'CIF' Model Value: 5 Domain API Value: 'CostInsuranceAndFreight' |
| CarriagePaidTo | CarriagePaidTo value. Stored as 'CPT'. Database Value: 'CPT' Model Value: 6 Domain API Value: 'CarriagePaidTo' |
| CarriageAndInsurancePaidTo | CarriageAndInsurancePaidTo value. Stored as 'CIP'. Database Value: 'CIP' Model Value: 7 Domain API Value: 'CarriageAndInsurancePaidTo' |
| DeliveredAtPlace | DeliveredAtPlace value. Stored as 'DAP'. Database Value: 'DAP' Model Value: 8 Domain API Value: 'DeliveredAtPlace' |
| DeliveredAtTerminal | DeliveredAtTerminal value. Stored as 'DAT'. Database Value: 'DAT' Model Value: 9 Domain API Value: 'DeliveredAtTerminal' |
| DeliveredDutyPaid | DeliveredDutyPaid value. Stored as 'DDP'. Database Value: 'DDP' Model Value: 10 Domain API Value: 'DeliveredDutyPaid' |
| DeliveredAtPlaceUnloaded | DeliveredAtPlaceUnloaded value. Stored as 'DPU'. Database Value: 'DPU' Model Value: 11 Domain API Value: 'DeliveredAtPlaceUnloaded' |
Supported Filters: NotFilterable
Supports Order By: False
Front-End Recalc Expressions:
obj.Lines.Select( c => SalesOrderLinesRepository.DeliveryTermsCodeAttribute.GetUntypedValue( c, False)).Distinct( ).OnlyIfSingle( )
DocumentDate
The date on which the document was issued. Required Default(Today) Filter(eq;ge;le) ORD (Inherited from Documents)
Type: date
Indexed: True
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: True
Default Value: CurrentDate
DocumentNo
Document number, unique within Document_Type_Id. Required Filter(eq;like) ORD (Inherited from Documents)
Type: string (20)
Indexed: True
Supported Filters: Equals, Like
Supports Order By: True
Maximum Length: 20
DocumentNotes
Notes for this Document. (Inherited from Documents)
Type: string (max) nullable
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
DocumentVersion
Consecutive version number, starting with 1. Each update produces a new version of the document. Required Default(1) Filter(eq;ge;le) ReadOnly (Inherited from Documents)
Type: int32
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Default Value: 1
EntityName
The entity name of the document header. Required Filter(eq) ORD ReadOnly (Inherited from Documents)
Type: string (64)
Indexed: True
Supported Filters: Equals
Supports Order By: True
Maximum Length: 64
FiscalSalesNumber
Unique number of the sale, assigned for fiscal reporting purposes. The format is according to the applicable legislation. null means that there is no requirement for fiscal sales number for this document or it is unknown. Filter(multi eq;like) ReadOnly Introduced in version 19.1
Type: string (32) nullable
Supported Filters: Equals, Like, EqualsIn
Supports Order By: False
Maximum Length: 32
FromDate
When selling a service valid only for a period, denotes the beginning of the period. null means that it is unknown or N/A. Introduced in version 20.1
Type: date nullable
Supported Filters: NotFilterable
Supports Order By: False
Front-End Recalc Expressions:
obj.Lines.Select( c => SalesOrderLinesRepository.LineFromDateAttribute.GetUntypedValue( c, False)).Distinct( ).OnlyIfSingle( )
Id
Type: guid
Indexed: True
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
IntrastatTransactionNatureCode
Transaction nature; used for Intrastat reporting.
Type: TransactionNature nullable
Generic enum type for TransactionNature properties
Allowed Values (Finance.Intrastat.TransactionNature Enum Members)
| Value | Description |
|---|---|
| OutrightPurchaseOrSale | OutrightPurchaseOrSale value. Stored as '11'. Database Value: '11' Model Value: 0 Domain API Value: 'OutrightPurchaseOrSale' |
| SupplyForSale | SupplyForSale value. Stored as '12'. Database Value: '12' Model Value: 1 Domain API Value: 'SupplyForSale' |
| BarterTrade | BarterTrade value. Stored as '13'. Database Value: '13' Model Value: 2 Domain API Value: 'BarterTrade' |
| FinancialLeasing | FinancialLeasing value. Stored as '14'. Database Value: '14' Model Value: 3 Domain API Value: 'FinancialLeasing' |
| OtherTransactions | OtherTransactions value. Stored as '19'. Database Value: '19' Model Value: 4 Domain API Value: 'OtherTransactions' |
| ReturnStokilizing | ReturnStokilizing value. Stored as '21'. Database Value: '21' Model Value: 5 Domain API Value: 'ReturnStokilizing' |
| ReplacementFor ReturnedGoods |
ReplacementFor ReturnedGoods value. Stored as '22'. Database Value: '22' Model Value: 6 Domain API Value: 'ReplacementFor ReturnedGoods' |
| ReplacementOfGoods NotBeingReturned |
ReplacementOfGoods NotBeingReturned value. Stored as '23'. Database Value: '23' Model Value: 7 Domain API Value: 'ReplacementOfGoods NotBeingReturned' |
| ReturnOrExchange OfOtherGoods |
ReturnOrExchange OfOtherGoods value. Stored as '29'. Database Value: '29' Model Value: 8 Domain API Value: 'ReturnOrExchange OfOtherGoods' |
| SpecificTransactions | SpecificTransactions value. Stored as '60'. Database Value: '60' Model Value: 9 Domain API Value: 'SpecificTransactions' |
| OperationsOnJointProjects | OperationsOnJointProjects value. Stored as '70'. Database Value: '70' Model Value: 10 Domain API Value: 'OperationsOnJointProjects' |
| TransactionsOf ConstructionMaterials AndEquipment |
TransactionsOf ConstructionMaterials AndEquipment value. Stored as '80'. Database Value: '80' Model Value: 11 Domain API Value: 'TransactionsOf ConstructionMaterials AndEquipment' |
| OtherTransactionsLeasing | OtherTransactionsLeasing value. Stored as '91'. Database Value: '91' Model Value: 12 Domain API Value: 'OtherTransactionsLeasing' |
| OtherTransactionsOther | OtherTransactionsOther value. Stored as '99'. Database Value: '99' Model Value: 13 Domain API Value: 'OtherTransactionsOther' |
| DealsThatInclude PropertyTransfers WithoutFinancial CompensationOr CompensationIn Kind |
DealsThatInclude PropertyTransfers WithoutFinancial CompensationOr CompensationIn Kind value. Stored as '30'. Database Value: '30' Model Value: 14 Domain API Value: 'DealsThatInclude PropertyTransfers WithoutFinancial CompensationOr CompensationIn Kind' |
| GoodsThatAreExpected ToBeReturnedTo Sender |
GoodsThatAreExpected ToBeReturnedTo Sender value. Stored as '41'. Database Value: '41' Model Value: 15 Domain API Value: 'GoodsThatAreExpected ToBeReturnedTo Sender' |
| GoodsThatAreNot ExpectedToBeReturned ToSender |
GoodsThatAreNot ExpectedToBeReturned ToSender value. Stored as '42'. Database Value: '42' Model Value: 16 Domain API Value: 'GoodsThatAreNot ExpectedToBeReturned ToSender' |
| GoodsThatAreReturned ToSender |
GoodsThatAreReturned ToSender value. Stored as '51'. Database Value: '51' Model Value: 17 Domain API Value: 'GoodsThatAreReturned ToSender' |
| GoodsThatAreNot ReturnedToSender |
GoodsThatAreNot ReturnedToSender value. Stored as '52'. Database Value: '52' Model Value: 18 Domain API Value: 'GoodsThatAreNot ReturnedToSender' |
Supported Filters: NotFilterable
Supports Order By: False
Front-End Recalc Expressions:
obj.Lines.Select( c => SalesOrderLinesRepository.IntrastatTransactionNatureCodeAttribute.GetUntypedValue( c, False)).Distinct( ).OnlyIfSingle( )
IntrastatTransportModeCode
Transport mode; used for Intrastat reporting.
Type: TransportMode nullable
Generic enum type for TransportMode properties
Allowed Values (Finance.Intrastat.TransportMode Enum Members)
| Value | Description |
|---|---|
| Shipping | Shipping value. Stored as '1'. Database Value: '1' Model Value: 0 Domain API Value: 'Shipping' |
| RailwayTransport | RailwayTransport value. Stored as '2'. Database Value: '2' Model Value: 1 Domain API Value: 'RailwayTransport' |
| RoadTransport | RoadTransport value. Stored as '3'. Database Value: '3' Model Value: 2 Domain API Value: 'RoadTransport' |
| AirTransport | AirTransport value. Stored as '4'. Database Value: '4' Model Value: 3 Domain API Value: 'AirTransport' |
| Mail value. Stored as '5'. Database Value: '5' Model Value: 4 Domain API Value: 'Mail' |
|
| FixedTransport Installations |
FixedTransport Installations value. Stored as '6'. Database Value: '6' Model Value: 5 Domain API Value: 'FixedTransport Installations' |
| RiverTransport | RiverTransport value. Stored as '7'. Database Value: '7' Model Value: 6 Domain API Value: 'RiverTransport' |
| SelfPropelled | SelfPropelled value. Stored as '8'. Database Value: '8' Model Value: 7 Domain API Value: 'SelfPropelled' |
Supported Filters: NotFilterable
Supports Order By: False
Front-End Recalc Expressions:
obj.Lines.Select( c => SalesOrderLinesRepository.IntrastatTransportModeCodeAttribute.GetUntypedValue( c, False)).Distinct( ).OnlyIfSingle( )
IsReleased
True if the document is not void and its state is released or greater. Required Default(false) Filter(eq) ReadOnly
Type: boolean
Supported Filters: Equals
Supports Order By: False
Default Value: False
IsSingleExecution
Specifies whether the document is a single execution of its order document. Required Default(false) Filter(eq) ReadOnly
Type: boolean
Supported Filters: Equals
Supports Order By: False
Default Value: False
IsValidField
True when the order is valid (e.g. released and not void). Used for internal processing. Required Default(false) ReadOnly
Type: boolean
Supported Filters: NotFilterable
Supports Order By: False
Default Value: False
Notes
Notes for this SalesOrder.
Type: string (254) nullable
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 254
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'. ReadOnly (Inherited from Documents)
Type: ParentDocument
RelationshipType nullable
Relationship between parent and child documents
Allowed Values (General.ParentDocumentRelationshipType Enum Members)
| Value | Description |
|---|---|
| Subtask | The child document is a sub-task of the parent document. (Complete child to complete parent) Database Value: 'S' Model Value: 0 Domain API Value: 'Subtask' |
| NextTask | The child document is next task of the parent document. (Complete parent to complete child) Database Value: 'N' Model Value: 1 Domain API Value: 'NextTask' |
Supported Filters: NotFilterable
Supports Order By: False
PaymentDueDate
The last term for the payment of the sales order. Filter(ge;le)
Type: datetime nullable
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Front-End Recalc Expressions:
obj.DocumentDate.AddDays( Convert( IIF( ( obj.ShipToCustomer.DefaultPaymentTermDays != 0), obj.ShipToCustomer.DefaultPaymentTermDays, obj.Customer.DefaultPaymentTermDays), Double))
PaymentDueStartDate
The date when the payment becomes due for documents with one installment. null when the document is with multiple installments.
Type: datetime nullable
Supported Filters: NotFilterable
Supports Order By: False
Front-End Recalc Expressions:
obj.DocumentDate.AddDays( Convert( IIF( ( obj.ShipToCustomer.DefaultPaymentStartDays != 0), obj.ShipToCustomer.DefaultPaymentStartDays, obj.Customer.DefaultPaymentStartDays), Double))
PlanningOnly
Indicates that the document is used only for planning (and as consequence its state cannot be greater than Planned). Required Default(false) ReadOnly (Inherited from Documents)
Type: boolean
Supported Filters: NotFilterable
Supports Order By: False
Default Value: False
ReadOnly
True - the document is read only; false - the document is not read only. Required Default(false) ReadOnly (Inherited from Documents)
Type: boolean
Supported Filters: NotFilterable
Supports Order By: False
Default Value: False
ReferenceDate
The date to which this document refers, i.e. when the action really occurred. If null, Document_Date is taken. Default(Today) Filter(ge;le) (Inherited from Documents)
Type: datetime nullable
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: CurrentDate
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 Documents)
Type: string (20) nullable
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 20
ReleaseTime
Date and time when the document was released (State set to Released). Filter(ge;le) ReadOnly (Inherited from Documents)
Type: datetime nullable
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
RequiredDeliveryDate
The required delivery date for all lines in the sales order. Initially calculated, based on either the Ship To Customer or Customer delivery term. Filter(ge;le)
Type: date nullable
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Front-End Recalc Expressions:
obj.DocumentDate.AddDays( Convert( IIF( ( obj.ShipToCustomer.DefaultDeliveryTermDays != 0), obj.ShipToCustomer.DefaultDeliveryTermDays, obj.Customer.DefaultDeliveryTermDays), Double))
obj.Lines.Select( c => SalesOrderLinesRepository.RequiredDeliveryDateAttribute.GetUntypedValue( c, False)).Distinct( ).OnlyIfSingle( )
State
The current system state of the document. Allowed values: 0=New;5=Corrective;10=Computer Planned;20=Human Planned;30=Released;40=Completed;50=Closed. Required Default(0) Filter(multi eq;ge;le) ReadOnly (Inherited from Documents)
Type: DocumentState
Enumeration of document system states
Allowed Values (General.DocumentState Enum Members)
| Value | Description |
|---|---|
| New | New document, just created. Can be edited. (Stored as 0). Database Value: 0 Model Value: 0 Domain API Value: 'New' |
| Adjustment | Document which adjusts other released documents. (Stored as 5). Database Value: 5 Model Value: 5 Domain API Value: 'Adjustment' |
| Planned | Planned by the system for future releasing. (Stored as 10). Database Value: 10 Model Value: 10 Domain API Value: 'Planned' |
| FirmPlanned | Planned by operator for future releasing. (Stored as 20). Database Value: 20 Model Value: 20 Domain API Value: 'FirmPlanned' |
| Released | Released document. Changes can be applied only through adjustment documents. (Stored as 30). Database Value: 30 Model Value: 30 Domain API Value: 'Released' |
| Completed | Work has completed. (Stored as 40). Database Value: 40 Model Value: 40 Domain API Value: 'Completed' |
| Closed | The document is audited and closed. Adjustments are not allowed, but reopening is allowed. (Stored as 50). Database Value: 50 Model Value: 50 Domain API Value: 'Closed' |
Supported Filters: Equals, GreaterThanOrLessThan, EqualsIn
Supports Order By: False
Default Value: 0
ToDate
When selling a service valid only for a period, denotes the end of the period. null means that it is unknown or N/A. Introduced in version 20.1
Type: date nullable
Supported Filters: NotFilterable
Supports Order By: False
Front-End Recalc Expressions:
obj.Lines.Select( c => SalesOrderLinesRepository.LineToDateAttribute.GetUntypedValue( c, False)).Distinct( ).OnlyIfSingle( )
Void
True if the document is null and void. Required Default(false) Filter(eq) ReadOnly (Inherited from Documents)
Type: boolean
Indexed: True
Supported Filters: Equals
Supports Order By: False
Default Value: False
VoidReason
Reason for voiding the document, entered by the user. ReadOnly (Inherited from Documents)
Type: string (254) nullable
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 254
VoidTime
Date/time when the document has become void. ReadOnly (Inherited from Documents)
Type: datetime nullable
Supported Filters: NotFilterable
Supports Order By: False
VoidUser
The user who voided the document. ReadOnly (Inherited from Documents)
Type: string (64) nullable
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 64
Reference Details
AccessKey
The access key, containing the user permissions for this document. null means that all users have unlimited permissions. Filter(multi eq) (Inherited from Documents)
Type: AccessKeys (nullable)
Supported Filters: Equals, EqualsIn
AdjustedDocument
The primary document, which the current document adjusts. null when this is not an adjustment document. Filter(multi eq) ReadOnly (Inherited from Documents)
Type: Documents (nullable)
Indexed: True
Supported Filters: Equals, EqualsIn
AssignedToUser
The user to which this document is assigned for handling. null means that the document is not assigned to specific user. Filter(multi eq) (Inherited from Documents)
Type: Users (nullable)
Supported Filters: Equals, EqualsIn
CurrencyDirectory
The currency directory, containing all the convertion rates, used by the document. null means that the document does not need currency convertions. Filter(multi eq) (Inherited from Documents)
Type: CurrencyDirectories (nullable)
Supported Filters: Equals, EqualsIn
Customer
The primary customer, which placed the sales order. Required Filter(multi eq)
Type: Customers
Indexed: True
Supported Filters: Equals, EqualsIn
Deal
The opportunity (deal) on which this order is based. Filter(multi eq)
Type: Deals (nullable)
Supported Filters: Equals, EqualsIn
Dealer
The external dealer, associated with the sales order. Filter(multi eq)
Type: Dealers (nullable)
Supported Filters: Equals, EqualsIn
DealType
Deal type to be passed to the invoice. If deal type in entered then the invoice creates VAT entry for this deal type. Filter(multi eq)
Type: DealTypes (nullable)
Supported Filters: Equals, EqualsIn
Front-End Recalc Expressions:
obj.Lines.Select( c => c.LineDealType).Distinct( ).OnlyIfSingle( )
DistributionChannel
The distribution channel, that is used to deliver the products. Filter(multi eq)
Type: DistributionChannels (nullable)
Supported Filters: Equals, EqualsIn
Front-End Recalc Expressions:
obj.ShipToCustomer.DefaultDistributionChannel.IfNullThen( obj.Customer.DefaultDistributionChannel).IfNullThen( obj.DistributionChannel)
DocumentCurrency
The currency of the document; e.g. the currency of the amounts in the document. Required Filter(multi eq)
Type: Currencies
Supported Filters: Equals, EqualsIn
Back-End Default Expression:
obj.ShipToCustomer.DefaultCurrency.IfNullThen( obj.Customer.DefaultCurrency).IfNullThen( obj.DocumentCurrency).IfNullThen( obj.EnterpriseCompany.BaseCurrency)
Front-End Recalc Expressions:
obj.ShipToCustomer.DefaultCurrency.IfNullThen( obj.Customer.DefaultCurrency).IfNullThen( obj.DocumentCurrency).IfNullThen( obj.EnterpriseCompany.BaseCurrency)
DocumentType
The user defined type of the document. Determines document behaviour, properties, additional amounts, validation, generations, etc. Required Filter(multi eq) (Inherited from Documents)
Type: DocumentTypes
Indexed: True
Supported Filters: Equals, EqualsIn
EndCustomerParty
The end customer is the customer of the dealer. It is stored for information purposes only. The end customer may not have customer definition; any party can be used. Filter(multi eq) Introduced in version 20.1
Type: Parties (nullable)
Supported Filters: Equals, EqualsIn
Front-End Recalc Expressions:
obj.Lines.Select( c => c.LineEndCustomerParty).Distinct( ).OnlyIfSingle( )
EnterpriseCompany
The enterprise company which issued the document. Required Filter(multi eq) (Inherited from Documents)
Type: EnterpriseCompanies
Indexed: True
Supported Filters: Equals, EqualsIn
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. Filter(multi eq) (Inherited from Documents)
Type: CompanyLocations (nullable)
Supported Filters: Equals, EqualsIn
FiscalPrinterPosDevice
For POS sales, specifies the fiscal printer. null when the sales is not a POS sale. Filter(multi eq) Introduced in version 19.1
Type: Devices (nullable)
Supported Filters: Equals, EqualsIn
FromCompanyDivision
The division of the company, issuing the document. null when the document is not issued by any specific division. Filter(multi eq) (Inherited from Documents)
Type: CompanyDivisions (nullable)
Supported Filters: Equals, EqualsIn
FromParty
The party which issued the document. Required Filter(multi eq) (Inherited from Documents)
Type: Parties
Supported Filters: Equals, EqualsIn
IntrastatTransportCountry
Country of origin of the transport company; used for Intrastat reporting. Filter(multi eq)
Type: Countries (nullable)
Supported Filters: Equals, EqualsIn
Front-End Recalc Expressions:
obj.Lines.Select( c => c.IntrastatTransportCountry).Distinct( ).OnlyIfSingle( )
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 Filter(multi eq) (Inherited from Documents)
Type: Documents
Indexed: True
Supported Filters: Equals, EqualsIn
Parent
In a multi-document tree, this is the direct parent document. If this is the root it is null. Filter(multi eq) (Inherited from Documents)
Type: Documents (nullable)
Indexed: True
Supported Filters: Equals, EqualsIn
PaymentAccount
When not null, the payment account, where the payment is expected. null=no expectation for account. Filter(multi eq)
Type: PaymentAccounts (nullable)
Supported Filters: Equals, EqualsIn
Front-End Recalc Expressions:
DeterminePaymentAccount( obj.Transaction, obj.Customer, obj.ShipToCustomer, obj.PaymentType, obj.PaymentAccount)
obj.PaymentPlans.Select( c => c.PaymentAccount).Distinct( ).OnlyIfSingle( )
PaymentType
When not null specifies the payment type for the sales order. Filter(multi eq)
Type: PaymentTypes (nullable)
Supported Filters: Equals, EqualsIn
Front-End Recalc Expressions:
obj.ShipToCustomer.DefaultPaymentType.IfNullThen( obj.Customer.DefaultPaymentType).IfNullThen( obj.PaymentType)
obj.PaymentPlans.Select( c => c.PaymentType).Distinct( ).OnlyIfSingle( )
PosLocation
For POS sales, specifies the POS location, in which the sale is performed. null when the sales is not a POS sale. Filter(multi eq) Introduced in version 19.1
Type: Locations (nullable)
Supported Filters: Equals, EqualsIn
PosOperator
For POS sales, specifies the POS operator, who created the sale. null when the sale is not a POS sale. Filter(multi eq) Introduced in version 19.1
Type: Operators (nullable)
Supported Filters: Equals, EqualsIn
PosTerminal
For POS sales, specifies the POS terminal, on which the sale is entered. null when the sales is not a POS sale. Filter(multi eq) Introduced in version 19.1
Type: Terminals (nullable)
Supported Filters: Equals, EqualsIn
PriceList
The price list to be used for determining product prices in the lines. Filter(multi eq)
Type: PriceLists (nullable)
Supported Filters: Equals, EqualsIn
PrimeCauseDocument
The document that is the prime cause for creation of the current document. Filter(multi eq) (Inherited from Documents)
Type: Documents (nullable)
Indexed: True
Supported Filters: Equals, EqualsIn
ResponsiblePerson
The person that is responsible for this order or transaction. It could be the sales person, the orderer, etc. Filter(multi eq) (Inherited from Documents)
Type: Persons (nullable)
Supported Filters: Equals, EqualsIn
ReturnForInvoice
When specified indicates that some of the goods sold in the sales orders invoiced with Return_For_Invoice_Id are returned with the current document. Filter(multi eq)
Type: Invoices (nullable)
Indexed: True
Supported Filters: Equals, EqualsIn
ReturnForSalesOrder
When specified indicates that some of the goods sold in Return_For_Sales_Order_Id are returned with the current document. Filter(multi eq;like)
Type: SalesOrders (nullable)
Indexed: True
Supported Filters: Equals, Like, EqualsIn
ReverseOfDocument
The document which the current document is reverse of. Filter(multi eq) ReadOnly (Inherited from Documents)
Type: Documents (nullable)
Supported Filters: Equals, EqualsIn
SalesPerson
Internal company sales person. Filter(multi eq)
Type: SalesPersons (nullable)
Indexed: True
Supported Filters: Equals, EqualsIn
Front-End Recalc Expressions:
DetermineSalesPerson( obj.Transaction, obj.EnterpriseCompany, new [] {obj.Customer, obj.ShipToCustomer})
Sequence
The sequence that will be used to give new numbers to the documents of this type. Filter(multi eq) ReadOnly (Inherited from Documents)
Type: Sequences (nullable)
Supported Filters: Equals, EqualsIn
ShipToCustomer
The customer to whom to ship the sales order. Usually it is a customer entry for a sub-party of the primary customer. Filter(multi eq)
Type: Customers (nullable)
Supported Filters: Equals, EqualsIn
Front-End Recalc Expressions:
DetermineShipToCustomer( obj.Transaction, obj.EnterpriseCompany, obj.EnterpriseCompanyLocation, obj.Customer, obj.ShipToCustomer)
ShipToPartyContactMechanism
The contact mechanism (address) to whih to ship the sales order. Filter(multi eq)
Type: PartyContactMechanisms (nullable)
Supported Filters: Equals, EqualsIn
Front-End Recalc Expressions:
obj.ShipToCustomer.Party.DefaultContactMechanism.IfNullThen( obj.Customer.Party.DefaultContactMechanism)
Store
The store from which to issue the sales order. null means that there is no store associated with the sales order or there are different stores for some of the lines. Filter(multi eq)
Type: Stores (nullable)
Supported Filters: Equals, EqualsIn
Front-End Recalc Expressions:
obj.Lines.Select( c => c.LineStore).Distinct( ).OnlyIfSingle( )
ToCompanyDivision
The division of the company, receiving the document. null when the document is not received by any specific division. Filter(multi eq) (Inherited from Documents)
Type: CompanyDivisions (nullable)
Supported Filters: Equals, EqualsIn
ToParty
The party which should receive the document. Filter(multi eq) (Inherited from Documents)
Type: Parties (nullable)
Supported Filters: Equals, EqualsIn
UserStatus
The user status of this document if applicable for this document type. null means unknown or not yet set. Filter(multi eq) ReadOnly (Inherited from Documents)
Type: DocumentTypeUserStatuses (nullable)
Supported Filters: Equals, EqualsIn
API Methods
Methods that can be invoked in public APIs.
ChangeState
Changes the document state to the specified new state (Inherited from Documents)
Return Type: void
Declaring Type: Documents
Domain API Request: POST
Parameters
newState
The desired new state of the document
Type: General.DocumentState
Enumeration of document system states
Allowed Values (General.DocumentState Enum Members)Value Description New New document, just created. Can be edited. (Stored as 0).
Model Value: 0
Domain API Value: 'New'Adjustment Document which adjusts other released documents. (Stored as 5).
Model Value: 5
Domain API Value: 'Adjustment'Planned Planned by the system for future releasing. (Stored as 10).
Model Value: 10
Domain API Value: 'Planned'FirmPlanned Planned by operator for future releasing. (Stored as 20).
Model Value: 20
Domain API Value: 'FirmPlanned'Released Released document. Changes can be applied only through adjustment documents. (Stored as 30).
Model Value: 30
Domain API Value: 'Released'Completed Work has completed. (Stored as 40).
Model Value: 40
Domain API Value: 'Completed'Closed The document is audited and closed. Adjustments are not allowed, but reopening is allowed. (Stored as 50).
Model Value: 50
Domain API Value: 'Closed'userStatus
The desired new user status of the document. Can be null.
Type: DocumentTypeUserStatuses
Optional: True
Default Value: null
The process of changing the document state is very labor intensive and includes validation, generation of sub-documents and some other document-specific tasks. The state changing process might be very time-consuming, usually ranging from 500 to 5000 milliseconds. Document states usually can only be advanced to higher states, but there are exceptions from this rule. Database settings and configuration options might affect the allowed state changes. Numerous kinds of document-specific and generic exceptions can be thrown during the process.
Complete
Changes the document state to Completed with all Release-ed sub-documents (Inherited from Documents)
Return Type: void
Declaring Type: Documents
Domain API Request: POST
Parameters
completion
How the sub-documents will be completed, if at all
Type: General.DocumentCompletion
Determines how Document will be completed
Allowed Values (General.DocumentCompletion Enum Members)Value Description OnlyDocument Only the document will be completed
Model Value: 0
Domain API Value: 'OnlyDocument'WithAllChildren The document, along with is sub-documents, will be completed
Model Value: 1
Domain API Value: 'WithAllChildren'WithReleasedChildren The document, along with its Release-ed sub-documents, will be completed
Model Value: 2
Domain API Value: 'WithReleasedChildren'
The process of changing the document state is very labor intensive and includes validation, generation of sub-documents and some other document-specific tasks. The state changing process might be very time-consuming, usually ranging from 500 to 5000 milliseconds. Document states usually can only be advanced to higher states, but there are exceptions from this rule. Database settings and configuration options might affect the allowed state changes. Numerous kinds of document-specific and generic exceptions can be thrown during the process.
MakeVoid
Makes the document void. The operation is irreversible. (Inherited from Documents)
Return Type: void
Declaring Type: Documents
Domain API Request: POST
Parameters
reason
The reason for voiding the document.
Type: stringvoidType
The type of void operation to execute.
Type: General.DocumentsRepositoryBase.VoidType
Specifies the type of void operation
Allowed Values (General.DocumentsRepositoryBase.VoidType Enum Members)Value Description VoidDocument Void only the document. If there are sub-documents, the operation might fail.
Model Value: 0
Domain API Value: 'VoidDocument'VoidWithSubDocuments Void the document and its non-released sub-documents. If there are released sub-documents, the operation might fail.
Model Value: 1
Domain API Value: 'VoidWithSubDocuments'VoidWithReleased
SubDocumentsVoid the document and all of its sub-documents, even the released ones.
Model Value: 2
Domain API Value: 'VoidWithReleased
SubDocuments'Optional: True
Default Value: VoidDocument
GetPrintout
Gets a document printout as a file. The returned value is Base64 string representation of the file contents. (Inherited from Documents)
Return Type: string
Declaring Type: Documents
Domain API Request: POST
Parameters
fileFormat
The file format: pdf, html, xlsx, xls, docx, txt and png. The default format is 'pdf'.
Type: string
Optional: True
Default Value: pdfprintout
The printout defined for the document type of the document. If null the default printout of the document type is used.
Type: Printouts
Optional: True
Default Value: null
Recalculate
The document and all of its owned objects will be altered to become valid. (Inherited from Documents)
Return Type: void
Declaring Type: Documents
Domain API Request: POST
In some cases the objects in child collection of the document depend on values from other child objects. This method ensures that all child objects are properly validated. The changes are only in memory and are not committed to the server.
GetAllParentDocuments
Gets all parent documents, traversing the parent document chain by using the Parent property. (Inherited from Documents)
Return Type: Collection Of Documents
Declaring Type: Documents
Domain API Request: GET
Parameters
- includeSelf
if set to true the current document is included.
Type: boolean
Optional: True
Default Value: False
Business Rules
Front-End Business Rules
None
Generations
- CRM0104 Create issue Store orders for products that aren't shipped
- CRM0106 Create Shipment Orders
- CRM0109 Create Invoice orders (with references to the store transactions)
- CRM0110 Create receipt Store Orders for returning of products
- CRM0113 Create Payment orders
- CRM0115 Create Purchase Orders
- CRM0116 Create issue Store orders for products that are stocked
API
Domain API Query: https://demodb.my.erp.net/api/domain/odata/Crm_Sales_SalesOrders?$top=10
Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Crm_Sales_SalesOrders?$top=10