AddRow

Command, Introduced in version 24.4

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

Adds a row to a sales agreement.

Returns EntityCommandResponse

The root entity id of the response is the business key identifier of the sales agreement that the row was added to. References SalesAgreements

The entity id of the response is the business key identifier of the added sales agreement row. References SalesAgreementRows

Required permission

Modify agreement

Properties

Name Type Summary Introduced in
SalesAgreementId Int64 The business key identifier of the sales agreement to add a row to.
OrderRowType Int32 The order row type of the row.

Note: type Sum(3) is not valid for sales agreement.

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

  • Mandatory
PartId Int64? The business key identifier of the rows part.

  • Mandatory (If OrderRowType is Part(1))
QuantityInOrderUnit Decimal The quantity in the unit of the row.

  • Mandatory
EntityIdentityString String The entity identity string of the row's part number if the order row type is Additional(2).

  • Max length is 20
AdditionalRowDescription String The additional row description of the row.
TextRowData String The text row data for order row type FreeText(4) to set for the row.

  • Max length is 100000
Price Decimal? The price of the row.

  • Calculated by MONITOR by default
Discount Decimal? The discount of the row.

  • Calculated by MONITOR by default
FutureValidFrom DateTimeOffset? The future valid from of the row.
FutureQuantityInOrderUnit Decimal? The future quantity in the unit of the row.
FuturePriceAmount Decimal? The future price amount of the row.
FutureDiscount Decimal? The future discount of the row.
ValidFrom DateTimeOffset? The valid from date of the row.

  • From the sales agreement by default
ValidTo DateTimeOffset? The valid to date of the row.

  • From the sales agreement by default
ShowFreeTextIn Int32? Specifies which documents the free text data of the row should be projected on.

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

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

  • Max length is 0
 Introduced in version 24.8

Example

{
  "SalesAgreementId": 0,
  "OrderRowType": 0,
  "PartId": null,
  "QuantityInOrderUnit": 0.0,
  "EntityIdentityString": null,
  "AdditionalRowDescription": null,
  "TextRowData": null,
  "Price": null,
  "Discount": null,
  "FutureValidFrom": null,
  "FutureQuantityInOrderUnit": null,
  "FuturePriceAmount": null,
  "FutureDiscount": null,
  "ValidFrom": null,
  "ValidTo": null,
  "ShowFreeTextIn": null,
  "SubRowContent": null
}