Create

Command, Introduced in version 24.5

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

Creates a new sales agreement.

Returns EntityCommandResponse

The root entity id of the response is the business key identifier of the sales agreement. References SalesAgreements

The entity id of the response is the same as the root entity id.

Required permission

Create agreement

Properties

Name Type Summary Introduced in
CustomerId Int64 The business key identifier of the customer to create an agreement for.
OrderTypeId Int64? The business key identifier of the agreements type.
OrderNumber String The human readable identifier of the agreement.

  • Generated from number series and sales agreement type (OrderTypeId) by default
  • Max length is 15
PeriodStart DateTimeOffset? The start period of the agreement.

  • Calculated by MONITOR by default
PeriodEnd DateTimeOffset? The end period of the agreement.
UpdateStatusAutomatically Boolean? Indicates if agreement status should be updated automatically.

  • From sales agreement type by default
InvoicingInterval Int32? The invoicing interval of the agreement.

  • Monthly: 1
  • EveryOtherMonth: 2
  • Quarterly: 3
  • FourMonthly: 4
  • SemiAnnually: 5
  • Annually: 6

  • From the sales agreement type by default
PriceDefinition Int32? The price definition of the agreement.

  • AccordingToInvoicingInterval: 0
  • Day: 1
  • Week: 2
  • Month: 3
  • TwoMonths: 4
  • Quarter: 5
  • FourMonths: 6
  • SixMonths: 7
  • Annual: 8

  • No(0) by default
IsAccrual Boolean? Indicates if the agreement is accrual.

  • False by default
AccrualAccountId Int64? The business key identifier of the agreements accrual account.

  • Mandatory (If IsAccrual is true)
  • References Accounts
Rows AddRow[] Specifies the sales agreement rows to add to the new agreement.

Example

{
  "CustomerId": 0,
  "OrderTypeId": null,
  "OrderNumber": null,
  "PeriodStart": null,
  "PeriodEnd": null,
  "UpdateStatusAutomatically": null,
  "InvoicingInterval": null,
  "PriceDefinition": null,
  "IsAccrual": null,
  "AccrualAccountId": null,
  "Rows": null
}