Skip to main content
DELETE
Delete Sales Invoice Payments

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-companyid
string

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

invoiceId
string<uuid>
required
Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

Response

Returns whether all payments of the invoice were successfully deleted.

Deletes all payments directly connected to the given invoice. This is an all-or-nothing operation - either all payments are deleted, or none are. After successfully deleting all payments, the invoice's payment status is updated accordingly. - Response

deleted
boolean

True if all payments were deleted. False if no payments were deleted (e.g., none existed or deletion failed atomically).