Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CreateCustomerReturn

Create a return order from an existing sales order (OrderID).

When a TargetOrderID has been specified, newly created lines are added to that specific order. When omitted, the lines are either added to the existing, original order (in case that is still permitted) or a new order is created automatically.

Returns information on the (newly created?) return order.

Hierarchy

  • CreateCustomerReturn

Index

Properties

Optional AmountToRefund

AmountToRefund: undefined | number

When a ReturnWithoutProducts is done, but not the full amount should be refunded, a different amount can be provided - cannot exceed the worth of the returned products

Optional BackendID

BackendID: undefined | string

Optional, attached to a possible newly created (return) order - requires BackendSystemID

Optional BackendSystemID

BackendSystemID: undefined | string

Optional, attached to a possible newly created (return) order - requires BackendID

Optional CreateInOriginalOrganizationUnit

CreateInOriginalOrganizationUnit: undefined | false | true

Attach the order to the same OrganizationUnit as the returned order

default

false

Lines

Lines to return

OrderID

OrderID: number

Entity type: Order

Optional RefundCorrectionReasonID

RefundCorrectionReasonID: undefined | number

When not the whole amount is refunded, a reason for this correction can be set. This will only have an affect if AmountToRefund is lower than the total amount of this return. Entity type: RefundCorrectionReason

Optional ReturnWithoutProducts

ReturnWithoutProducts: undefined | false | true

The products will not be returned, so the return order will be shipped immediately and the stock will be corrected

Optional SecurityCode

SecurityCode: undefined | string

User is allowed to create return order when a valid security code is provided. The user has to have the ReturnWithoutSecurityCode role when omitted. CRM:Return:RequiresOrderSecurityCode needs to be enabled.

Optional StockOrganizationUnitID

StockOrganizationUnitID: undefined | number

When the stock should be returned to a specific OrganizationUnit (see GetReturnableStatusForOrder.StockOrganizationUnits) Entity type: OrganizationUnit

Optional TargetOrderID

TargetOrderID: undefined | number

Entity type: Order