DELETE
Cancel a customer payment
Company space Cannot be undone For: Cashier and seller, Manager, Accountant · Permission: customer_credit_payments.delete Conditions
  • the call must come from a cashier whose register is open
  • the refund lines must add up to the gross amount received
  • refused while a cheque of this payment has been handed over to the organization
What else happens
  • the money is paid back through the register payment methods given, and the refund is posted in the accounts
  • the orders this payment had settled are reopened for the same amounts
  • what the customer owes goes back up by the payment amount
  • the payment no longer appears in the list
Part of Collect customer credit.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customerCreditPayment
string
required

Identifier of the customer payment.

Query Parameters

accounting_date
string<date-time> | null

Date of the refund in the accounts. Today when left out.

cash_register_id
string

Not accepted: the refund is paid from the register of the cashier making the call.

refund_payments
object[]

How the money goes back to the customer: one or more lines, each with register_payment_method_id (a method of the cashier's register that accepts outgoing money), amount in minor units and optionally actual_fee_amount. Their total must equal the gross amount that was received.

response
enum<string>
default:none

Response mode. Default none; none answers 204 No Content.

Available options:
none

Response

No Content (response mode none).