Delete a Counterparty - Bookeeping.ai Docs

DELETE

counterparties

{id}

Delete a Counterparty

curl --request DELETE \
  --url https://api.bookeeping.ai/public-api/v1/counterparties/{id} \
  --header 'Authorization: Bearer <token>'

{
  "message": "<string>",
  "metaData": {
    "warnings": [
      "<string>"
    ]
  },
  "data": {}
}

Authorization

string

header

required

API key for authentication. Get your key from the Dashboard > Settings > API Access.

string

required

The id of the counterparty. Expected to be a valid object id like 666666666666666666666666

Delete a Counterparty executed successfully

message

string

Success message

metaData

object

Show child attributes

metaData.warnings

string[]

Any validation warnings

data

object

⌘I

Delete a Counterparty

curl --request DELETE \
  --url https://api.bookeeping.ai/public-api/v1/counterparties/{id} \
  --header 'Authorization: Bearer <token>'

{
  "message": "<string>",
  "metaData": {
    "warnings": [
      "<string>"
    ]
  },
  "data": {}
}