BillOS v1
Console llms.txt OpenAPI
POST/businesses/{bid}/parties/find-or-create

Find a party or create it

POST /businesses/{bid}/parties/find-or-create

Requires the businesses scope.

Matches an existing party by phone (last nine digits) and then by exact name; creates one otherwise. 201 when created, 200 when found; created says which.

Path parameters

NameTypeDescription
bidstringrequiredBusiness id, from POST /businesses.

Body

FieldTypeDescription
kindstringOne of: customer, supplier, both. Default customer.
namestringrequired
taxIdstring
phonestring
emailstring
addressobject

Response

201: { "ok": true, … }

FieldTypeDescription
okbooleanrequired
partyPartyrequiredA saved customer. Optional: a document may carry an inline party instead.
createdbooleanTrue when this call created the party.

Errors: 400, 401, 403, 404, 429. Every failure answers { "error": …, "reason": … }. Branch on reason.

PreviousRecord digital-document consent NextList documents
On this page
Path parametersBodyResponse
POST /businesses/{bid}/parties/find-or-create 
curl -X POST "$BASE/businesses/$BID/parties/find-or-create" \
  -H "X-Api-Key: $KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "דנה לוי"
  }'
const res = await fetch(`${BASE}/businesses/${BID}/parties/find-or-create`, {
  method: 'POST',
  headers: {
    'X-Api-Key': KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "דנה לוי"
  }),
})
const data = await res.json()
if (!data.ok) throw new Error(data.reason)
import requests
res = requests.post(
    f"{BASE}/businesses/{BID}/parties/find-or-create",
    headers={"X-Api-Key": KEY},
    json={
      "name": "דנה לוי"
    },
)
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.