Delete a party

DELETE /businesses/{bid}/parties/{id}

Requires the businesses scope.

For a card nothing in the books points at (a duplicate, a typo). A party with a document, a quote, a recurring plan or an expense is part of the record and is refused with 409 conflict naming what holds it: hide such a card with PATCH { "active": false }. Its contacts are deleted with it.

Path parameters

Name	Type		Description
`bid`	string	required	Business id, from `POST /businesses`.
`id`	string	required	Party id.

Response

200: { "ok": true, … }

Field	Type		Description
`ok`	boolean
`deleted`	string		The party id.

Errors: 400, 401, 403, 404, 409, 429. Every failure answers { "error", "reason", "hint", "param", "doc_url", "retryable", "request_id" }: branch on reason, and read hint for what to change (https://docs.billos.co.il/errors.md).

On this page

Path parameters Response

DELETE /businesses/{bid}/parties/{id}

curl -X DELETE "$BASE/businesses/$BID/parties/$DOC_ID" \
  -H "X-Api-Key: $KEY"

const res = await fetch(`${BASE}/businesses/${BID}/parties/${DOC_ID}`, {
  method: 'DELETE',
  headers: {
    'X-Api-Key': KEY,
  },
})
const data = await res.json()
if (!data.ok) throw new Error(data.reason)

import requests
res = requests.delete(
    f"{BASE}/businesses/{BID}/parties/{DOC_ID}",
    headers={"X-Api-Key": KEY},
)
data = res.json()

Set BASE to https://api.billos.co.il/v1 and KEY to your bk_live_… key, or a bk_test_… key to run it against the sandbox.

Manage your businesses, keys and webhooks in the BillOS Console.