Delete Payee

Soft deletes a payee by setting deletedAt and deletedBy timestamps. The payee will no longer be returned in list or get operations.

Deletion is blocked if the payee has associated transactions.

Required permission: company.payee:create

DELETE /api/external/companies/{companyId}/payees/{payeeId}

Delete Payee

cURL

curl --request DELETE \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/payees/{payeeId} \
  --header 'Authorization: <api-key>'

200

success

{
  "id": "550e8400-e29b-41d4-a716-446655440001",
  "deleted": true
}

Authorizations

Authorization · string · header · required

API key authentication. Include your API key in the Authorization header.

Path Parameters

companyId · string<uuid> · required

Company identifier

payeeId · string<uuid> · required

Payee identifier

Response

200

application/json

Payee deleted successfully

id · string<uuid>

The ID of the deleted payee

deleted · boolean

Confirmation that the payee was deleted