Mutation
mutation DeleteAllPaymentsBySalesOrderId($request: DeleteAllPaymentsBySalesOrderIdCommandRequestInput!) {
DeleteAllPaymentsBySalesOrderId(request: $request) {
deleted
}
}Variables
{
"request": {
"salesOrderId": "id"
}
}Response
{
"data": {
"DeleteAllPaymentsBySalesOrderId": {
"deleted": true
}
}
}Mutations
DeleteAllPaymentsBySalesOrderId
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.
MUTATION
DeleteAllPaymentsBySalesOrderId(request: DeleteAllPaymentsBySalesOrderIdCommandRequestInput!): DeleteAllPaymentsBySalesOrderIdCommandResponse!Arguments
request
deleted
Boolean!
True if all payments were deleted. False if there was no payment to delete - invoice payments only count when IncludeInvoicePayments is set.
Mutation
mutation DeleteAllPaymentsBySalesOrderId($request: DeleteAllPaymentsBySalesOrderIdCommandRequestInput!) {
DeleteAllPaymentsBySalesOrderId(request: $request) {
deleted
}
}Variables
{
"request": {
"salesOrderId": "id"
}
}Response
{
"data": {
"DeleteAllPaymentsBySalesOrderId": {
"deleted": true
}
}
}Was this page helpful?