Cancel PaymentPlan Rows

CancelPaymentPlanRows

Use this method to lower the outstanding contract balance of a delivered payment plan order. The lowered amount is specified by the given list of CancellationRows. A CancellationRow is parsed differently depending on whether the RowNumber attribute is set or not:

• If the RowNumber attribute is set:
  The outstanding contract balance is lowered by the corresponding original order row amount. The other attributes in the CancellationRow are ignored. (The original order row will show up as cancelled in the Webpay Admin UI.)

• If the RowNumber attribute is not set:
  A new row will be created using the attributes AmountInclVAT, VATPercent, and Description. The outstanding contract balance is lowered by the given AmountInclVAT. (The new order row will be associated with the contract and will show up in the Webpay Admin UI.)

Note:
If you need to specify an amount that exceeds the outstanding contract balance (i.e. by more than what is left to pay on the contract), you will need to activate a feature. To activate this feature for the client in question, please contact Svea Payments's support.

---

Input

CancelPaymentPlanRowsRequest

Field	R	Type	Description
ContractNumber	*	long	The payment plan contract number.
ClientId	*	long	The webpay client ID.
CancellationRows	*	List of CancellationRow	See CancellationRow

Note: You are not allowed to send in an ExternalCustomerId by default. To activate this for your account, please contact Svea Payments's support.

---

Output

CancelPaymentPlanRowsResponse

Field	R	Type	Description
(Empty)	-	-

---

Structures

CancellationRow

Field	R	Type	Description
AmountInclVat	*	Decimal	Amount including VAT to lower the outstanding amount of the contract by.
VatPercent	*	Decimal	VAT rate in percent.
Description	*	String	Text associated with the resulting row.
RowNumber	-	Integer	Number corresponding to an original payment plan order row. If set, the other cancellation row attributes are ignored.