CreateSalesAgreement

Command, Introduced in version 25.4

POST https://localhost:8001/sv/001.1/api/v1/Sales/FormReports/CreateSalesAgreement

Creates a sales agreement document.

Returns FormReportData

Required permission

Show agreement

Properties

Name Type Summary Introduced in
SalesAgreementId Int64 The business key identifier of the sales agreement to create the document for.
IncludeExternalDocuments Boolean Specifies if external documents should be included with the agreement.

  • Mandatory
PrintoutDate DateTimeOffset? The printout date on the agreement.

  • Current date by default
ShowPrice Boolean Specifies if the price should be visible on the agreement.

  • Mandatory
PriceViewAlternative Int32 Specifies the agreements price view alternative.

  • PricePerInvoicingInterval: 1
  • Price: 2

  • Mandatory
ShowTotalAmount Boolean Specifies if the total amount should be visible on the agreement.

  • Mandatory
ShowFullyReleasedRows Boolean Specifies if fully released rows should be included in the agreement.

  • Mandatory
ShowOneTimeCosts Boolean Specifies if one time costs should be visible on the agreement.

  • Mandatory
ShowDescription Boolean Specifies if the description should be visible on the agreement.

  • Mandatory
ShowActivities Boolean Specifies if the activities should be visible on the agreement.

  • Mandatory
FormReportConfigurationId Int64? The business key identifier of the form report configuration to apply for the agreement.

Example

{
  "SalesAgreementId": 0,
  "IncludeExternalDocuments": false,
  "PrintoutDate": null,
  "ShowPrice": false,
  "PriceViewAlternative": 0,
  "ShowTotalAmount": false,
  "ShowFullyReleasedRows": false,
  "ShowOneTimeCosts": false,
  "ShowDescription": false,
  "ShowActivities": false,
  "FormReportConfigurationId": null
}