AddRow

Command, Introduced in version 2.18

POST https://localhost:8001/sv/001.1/api/v1/Sales/CustomerOrders/AddRow

Adds row to customer order.

Returns EntityCommandResponse

The root entity id of the response is the business key identifier of the customer order that the row was added to. References CustomerOrders

The entity id of the response is the business key identifier of the added customer order row. References CustomerOrderRows

Required permission

Modify customer order

Properties

Name Type Summary Introduced in
CustomerOrderId Int64 The business key identifier of the customer order to add a row to.

References CustomerOrders

  • Mandatory
PartId Int64? The business key identifier of the part to set for the row.

References Parts
PartConfigurationSessionId Guid? The session id of the part configuration to apply for the customer order row.
 Introduced in version 2.33
AdditionalPartCode String The additional part code to set for the row.

  • Max length is 20
PartDescription String The part description to set for the row.

  • Max length is 80
  • The part description by default
TextRowData String The text row data to set for the row.

  • Max length is 0
OrderedQuantity Decimal The quantity to set for the row either in the unit specified by UnitId or the part's customer order unit.
Price Decimal? The unit price to set for the row.

  • Calculated by MONITOR by default
SetupPrice Decimal? The setup price to set for the row.

  • Calculated by MONITOR by default
WarehouseId Int64? The business key identifier of the warehouse to set for the row.

References Warehouses

  • Sames as the customer order by default
OrderRowType Int32 The order row type to set for the row.

  • Part: 1
  • Additional: 2
  • Sum: 3
  • FreeText: 4

  • Mandatory
DeliveryDate DateTimeOffset? The delivery date to set for the row.
DesiredDeliveryDate DateTimeOffset? The desired delivery date to set for the row.
Discount Decimal? The discount to set for the row.

  • Calculated by MONITOR by default
SubRowContent String Creates a free text row as a child of this row with the specified content if set.

  • Max length is 0
InsertRowBeforeId Int64? The Id of the order row you want to insert before. If null the row will be added last.

References CustomerOrderRows.
 Introduced in version 2.22
InsertRowAfterId Int64? The Id of the order row you want to insert after. If null the row will be added last.

References CustomerOrderRows.
 Introduced in version 2.22
Dock String The dock to set for the row.

  • Max length is 35
 Introduced in version 2.31
DockName String The dock name to set for the row.

  • Max length is 80
 Introduced in version 2.31
Storage String The storage to set for the row.

  • Max length is 35
 Introduced in version 2.31
KanbanNumber String The kanban number to set for the row.

  • Max length is 80
 Introduced in version 2.31
WeightPerUnit Decimal? The weight per unit of the row.
 Introduced in version 2.36
ShowFreeTextIn Int32? The text type to set for the row.

  • None: 0
  • Quote: 1
  • Acknowledgement: 2
  • DeliveryNote: 4
  • Invoice: 8
  • ProFormaInvoice: 16

  • Calculated by MONITOR by default
 Introduced in version 2.35.3
CustomerCommitmentLevel Int32? The customer commitment level of the row.

  • FixedOrder: 1
  • Manufacture: 2
  • BuyMaterial: 3
  • Forecast: 4

  • FixedOrder (1) by default
 Introduced in version 2.37
SubRows AddRow[] Specifies the sub rows of type free text to add to this row.

  • None by default
 Introduced in version 2.37
UnitId Int64? The business key identifier of the unit to set for the row.

References Units

  • Default unit on the part when the row type is part(1) by default
 Introduced in version 2.39
StandardPrice NotNullDecimalInput The standard price for the customer order row.

  • Standard price of part when a part is present by default
 Introduced in version 2.40
RowsGoodsLabel String The goods label to set for the customer order row.

  • Max length is 80
 Introduced in version 2.45
ReferenceNumberDelivery String The delivery reference number to set for the customer order row.

  • Max length is 80
 Introduced in version 2.45
ReferenceNumberManufacturing String The manufacturing reference number to set for the customer order row.

  • Max length is 80
 Introduced in version 2.45
AlternatePreparationCode String The alternate preparation code to set for the row.

  • Max length is 200
 Introduced in version 2.46
IsIncludedInPaymentPlan Boolean? If the customer order row is to be included in payment plan.

  • Calculated by MONITOR by default
 Introduced in version 2.48
CodingRows SetProductGroupCodingRow[] Set coding rows on the customer order row's coding.

 Introduced in version 2.51
VatRateId Int64? The business key identifier of the row's VAT rate.

  • Calculated by MONITOR by default
  • References VatRates
 Introduced in version 2.51
SumRowDetail SumRowDetail The sum row details to set for the row.

  • Mandatory (If the row type is sum)
 Introduced in version 22.4
CustomerOrderRowPosition String The customer's order row position for the row.

  • Max length is 15
 Introduced in version 22.6
CustomerOrderNumber String The customer's order number of the order.

  • Max length is 35
 Introduced in version 22.6
PartConfigurationIdInRemoteCompany Int64? The business key identifier of the row's part configuration in the remote company.

 Introduced in version 23.2
RemotePartConfigurationRows SetRemotePartConfigurationRow[] The remote configuration result price definition rows that belong to the order row. Should only be specified when PartConfigurationIdInRemoteCompany is provided.

 Introduced in version 24.8
CreateManufacturingOrder Boolean? If a manufacturing order linked to this row should be created.

  • Calculated by MONITOR by default
 Introduced in version 23.6
PriceLockedFromAutomaticChanges Boolean? If the rows price is locked from automatic changes.

  • Calculated by MONITOR by default
 Introduced in version 24.2
UpdateLinkedOrders Boolean? If the orders linked to this customer order should be updated.

This have no fuction when used in a create command.

  • True by default
 Introduced in version 24.4
RevisionId Int64? The business key identifier of the revision to set for the row.

  • The active revision on the part by default
 Introduced in version 24.6
CreatePurchaseOrder Boolean? If a purchase order linked to this row should be created.

  • Calculated by MONITOR by default
 Introduced in version 24.7
StatisticalGoodsCodeId Int64? The business key identifier of the row's statistical goods code.

References
Introduced in version 25.1

Example

{
  "CustomerOrderId": 0,
  "PartId": null,
  "PartConfigurationSessionId": null,
  "AdditionalPartCode": null,
  "PartDescription": null,
  "TextRowData": null,
  "OrderedQuantity": 0.0,
  "Price": null,
  "SetupPrice": null,
  "WarehouseId": null,
  "OrderRowType": 0,
  "DeliveryDate": null,
  "DesiredDeliveryDate": null,
  "Discount": null,
  "SubRowContent": null,
  "InsertRowBeforeId": null,
  "InsertRowAfterId": null,
  "Dock": null,
  "DockName": null,
  "Storage": null,
  "KanbanNumber": null,
  "WeightPerUnit": null,
  "ShowFreeTextIn": null,
  "CustomerCommitmentLevel": null,
  "SubRows": null,
  "UnitId": null,
  "StandardPrice": null,
  "RowsGoodsLabel": null,
  "ReferenceNumberDelivery": null,
  "ReferenceNumberManufacturing": null,
  "AlternatePreparationCode": null,
  "IsIncludedInPaymentPlan": null,
  "CodingRows": null,
  "VatRateId": null,
  "SumRowDetail": null,
  "CustomerOrderRowPosition": null,
  "CustomerOrderNumber": null,
  "PartConfigurationIdInRemoteCompany": null,
  "RemotePartConfigurationRows": null,
  "CreateManufacturingOrder": null,
  "PriceLockedFromAutomaticChanges": null,
  "UpdateLinkedOrders": null,
  "RevisionId": null,
  "CreatePurchaseOrder": null,
  "StatisticalGoodsCodeId": null
}