Input objects
DeleteAllPaymentsBySalesOrderIdCommandRequestInput
Deletes all payments that are directly linked to a sales order. Payments that are only linked via a sales invoice associated with the sales order are deleted only if IncludeInvoicePayments is true. Either all payments are deleted or none of them (all-or-nothing); if not all payments could be deleted, the request fails and none are deleted. - Request
input
DeleteAllPaymentsBySalesOrderIdCommandRequestInputFields
salesOrderId
ID!
required
The ID of the sales order whose payments should be deleted.
includeInvoicePayments
Boolean
Specifies whether the payments for the invoices associated with the specified sales order should also be deleted. Defaults to false when omitted.
Was this page helpful?