API reference
Change sets
Several changes as one, all or nothing, and drafts a person reviews and applies in Bizisy.
5 actions · base URL https://api.bizisy.com/v1 · generated from the same definitions as the API.
Apply a change set#
POST/v1/org/changes.applyDestructive
Applies several changes as one: up to 50 operations, in order, each through its own tool with the same checks and approval rules — hire (org_people_hire), move (org_people_move), promote (org_people_promote), mark_leaving (org_people_mark_leaving), create_team (org_units_create), set_team_lead (org_units_set_head), pay (org_pay_add: in the app only), retitle (org_people_change_job with a new title: { person, effective_date, title }), title_update (org_titles_update: { title: id or { name }, family_id, track, level_id, description } — how to suggest families and levels for the job title catalog). Name people as {id}, {email} or {name}, and teams as {id} or {name}; a team created earlier in the same set can be named by later operations. A name that matches several people stops everything with the candidates. All or nothing: if one operation fails, none is applied, and the error says which (details.change). Use dry_run first: results lists each operation's preview and approvals, and fingerprint identifies the data it was planned on; send expect_fingerprint with the real call to make sure nothing changed in between. draft_id applies a saved draft (org_changes_draft) once; its touches_preparer says when it changes the job or pay of the person who prepared it (tell the user: the changes are recorded as theirs), and such a draft is refused over an API key or MCP: a person applies it in the app. Owners, admins and HR; also a custom role with People and jobs at Edit that covers everyone (no people filters), for ops it sends (never draft_id): each operation still needs that role's area for it (pay: Pay at Edit; teams and job titles: Structure at Edit; team leads: never), and one refused operation stops the set.
- Who can call it
- Manage key owner admin hr
- Keys and apps
- Pay changes are refused: save the set with org.changes.draft and a person applies it in the app.
- MCP tool
org_changes_applyon HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key prevents a second run, but the result is never stored (it holds a secret or personal data): a retry gets a 409 that points to Activity
Input
opsobject[]1–50 items.
50 fields (one of several shapes)
Option 1
type"hire"requiredgiven_namestringrequired1–100 characters.
family_namestringrequired1–100 characters.
work_emailstringrequiredUp to 200 characters.
titlestringrequired1–120 characters.
start_datestringrequiredmanagerstring | objectA person id.
3 fields (one of several shapes)
Option 1
idstringrequired
Option 2
emailstringrequired3–200 characters.
Option 3
namestringrequired2–200 characters.
teamstring | objectA team id.
2 fields (one of several shapes)
Option 1
idstringrequired
Option 2
namestringrequired1–100 characters.
employment_type"full_time" | "part_time" | "contractor" | "intern"
Option 2
type"move"requiredpeoplestring | object[]required1–50 items.
3 fields (one of several shapes)
Option 1
idstringrequired
Option 2
emailstringrequired3–200 characters.
Option 3
namestringrequired2–200 characters.
effective_datestringrequiredmanagerstring | objectA person id.
3 fields (one of several shapes)
Option 1
idstringrequired
Option 2
emailstringrequired3–200 characters.
Option 3
namestringrequired2–200 characters.
teamstring | objectA team id.
2 fields (one of several shapes)
Option 1
idstringrequired
Option 2
namestringrequired1–100 characters.
Option 3
type"promote"requiredpersonstring | objectrequiredA person id.
3 fields (one of several shapes)
Option 1
idstringrequired
Option 2
emailstringrequired3–200 characters.
Option 3
namestringrequired2–200 characters.
effective_datestringrequiredtitlestring1–120 characters.
payobject4 fields (one of several shapes)
Option 1
amountnumberrequiredFrom 0 to 100000000.
currencyanyrequiredperiod"year" | "month" | "hour"required
Option 2
percentnumberrequiredFrom -50 to 200.
Option 4
type"mark_leaving"requiredpersonstring | objectrequiredA person id.
3 fields (one of several shapes)
Option 1
idstringrequired
Option 2
emailstringrequired3–200 characters.
Option 3
namestringrequired2–200 characters.
last_daystringrequiredreasonstringUp to 200 characters.
leaving_typestring (enum)One of:
resignation,retirement,dismissal,redundancy,end_of_contract,mutual_agreement,death,other.person_toldbooleanaccess"after_last_day" | "keep"
Option 5
type"create_team"requirednamestringrequired1–100 characters.
parentstring | objectA team id.
2 fields (one of several shapes)
Option 1
idstringrequired
Option 2
namestringrequired1–100 characters.
kind"division" | "department" | "team"
Option 6
type"set_team_lead"requiredteamstring | objectrequiredA team id.
2 fields (one of several shapes)
Option 1
idstringrequired
Option 2
namestringrequired1–100 characters.
personstring | objectrequiredA person id.
3 fields (one of several shapes)
Option 1
idstringrequired
Option 2
emailstringrequired3–200 characters.
Option 3
namestringrequired2–200 characters.
Option 7
type"pay"requiredpersonstring | objectrequiredA person id.
3 fields (one of several shapes)
Option 1
idstringrequired
Option 2
emailstringrequired3–200 characters.
Option 3
namestringrequired2–200 characters.
effective_datestringrequiredamountnumberrequiredFrom 0 to 100000000.
currencyanyrequiredperiod"year" | "month" | "hour"requirednotestringUp to 200 characters.
Option 8
type"retitle"requiredpersonstring | objectrequiredA person id.
3 fields (one of several shapes)
Option 1
idstringrequired
Option 2
emailstringrequired3–200 characters.
Option 3
namestringrequired2–200 characters.
effective_datestringrequiredtitlestringrequiredThe new job title as typed (matched to the catalog, else added when applied).
1–120 characters.
Option 9
type"title_update"requiredtitlestring | objectrequiredA job title id.
2 fields (one of several shapes)
Option 1
idstringrequired
Option 2
namestringrequired1–120 characters.
family_idstring | nulltrack"ic" | "manager"level_idstring | nulldescriptionstring | nullUp to 4000 characters.
draft_idstringexpect_fingerprintstringUp to 64 characters.
Returns
resultsobject[]required6 fields
changeintegerrequiredtypestring (enum)requiredOne of:
hire,move,promote,mark_leaving,create_team,set_team_lead,pay,retitle,title_update.actionstringrequiredcreated_idstring | nullrequiredapprovalobject | nullrequired11 fields
idstringrequiredstatus"pending" | "approved"requiredwaiting_for"manager" | "hr"requiredapproversstring[]requiredautomaticbooleanrequirednote"proposed_by_approver" | "no_other_approver"requiredfallbackbooleanrequiredteam_leadobject | nullrequired3 fields
unit_idstringrequiredunit_namestringrequiredreason"no_manager" | "manager_left"required
team_lead_blockedobject | nullrequired3 fields
unit_idstringrequiredunit_namestringrequiredwhat"lead" | "removed" | "moved" | "archived"required
untrusted"no_login" | "invited_by_proposer"requiredthen"manager" | "hr"required
previewobject | nullrequired4 fields
summarystringrequiredchangesobject[]required6 fields
personobjectrequired2 fields
idstringrequirednamestringrequired
fieldstringrequiredlabelstringrequiredfromstring | nullrequiredtostring | nullrequiredeffectivestringrequired
approvals_neededobject[]required3 fields
personobjectrequired2 fields
idstringrequirednamestringrequired
waiting_for"manager" | "hr"requiredapproversstring[]required
blockedobject[]required2 fields
personobjectrequired2 fields
idstringrequirednamestringrequired
reasonstringrequired
fingerprintstringrequiredappliedbooleanrequireddraft_idstring | nullrequiredtouches_preparer"job" | "pay"[]requiredA saved draft only: it changes the job or pay of the person who prepared it. Tell the user before applying.
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/org/changes.apply \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"ops": [
{
"type": "create_team",
"name": "Platform"
},
{
"type": "move",
"people": [
{
"email": "carl@acme.pt"
}
],
"effective_date": "2026-11-01",
"team": {
"name": "Platform"
},
"manager": {
"name": "Ana Costa"
}
}
],
"expect_fingerprint": "0123456789abcdef"
}'const res = await fetch('https://api.bizisy.com/v1/org/changes.apply', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"ops": [
{
"type": "create_team",
"name": "Platform"
},
{
"type": "move",
"people": [
{
"email": "carl@acme.pt"
}
],
"effective_date": "2026-11-01",
"team": {
"name": "Platform"
},
"manager": {
"name": "Ana Costa"
}
}
],
"expect_fingerprint": "0123456789abcdef"
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/changes.apply",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"ops": [
{
"type": "create_team",
"name": "Platform",
},
{
"type": "move",
"people": [
{
"email": "carl@acme.pt",
},
],
"effective_date": "2026-11-01",
"team": {
"name": "Platform",
},
"manager": {
"name": "Ana Costa",
},
},
],
"expect_fingerprint": "0123456789abcdef",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"results": [
{
"change": 1,
"type": "create_team",
"action": "org.units.create",
"created_id": "u9",
"approval": null,
"preview": null
},
{
"change": 2,
"type": "move",
"action": "org.people.move",
"created_id": null,
"approval": null,
"preview": {
"summary": "1 person moves to Platform from 1 Nov 2026.",
"changes": [],
"approvals_needed": [],
"blocked": []
}
}
],
"fingerprint": "0123456789abcdef",
"applied": false,
"draft_id": null,
"touches_preparer": []
}
}Save a change set for review#
POST/v1/org/changes.draftWrite
Saves a change set (the same ops as org_changes_apply) without applying it, for a person to review and apply in Bizisy — the way to hand over changes you may not apply yourself (pay is applied in the app only) or that the user wants to check first. Every name must already be clear (ambiguous names are refused with the candidates). Returns the draft and its review link (links): show it to the user. Drafts expire after 14 days. Owners, admins and HR.
- Who can call it
- Manage key owner admin hr
- Keys and apps
- Pay amounts are never returned.
- MCP tool
org_changes_drafton HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key prevents a second run, but the result is never stored (it holds a secret or personal data): a retry gets a 409 that points to Activity
Input
opsobject[]required1–50 items.
50 fields (one of several shapes)
Option 1
type"hire"requiredgiven_namestringrequired1–100 characters.
family_namestringrequired1–100 characters.
work_emailstringrequiredUp to 200 characters.
titlestringrequired1–120 characters.
start_datestringrequiredmanagerstring | objectA person id.
3 fields (one of several shapes)
Option 1
idstringrequired
Option 2
emailstringrequired3–200 characters.
Option 3
namestringrequired2–200 characters.
teamstring | objectA team id.
2 fields (one of several shapes)
Option 1
idstringrequired
Option 2
namestringrequired1–100 characters.
employment_type"full_time" | "part_time" | "contractor" | "intern"
Option 2
type"move"requiredpeoplestring | object[]required1–50 items.
3 fields (one of several shapes)
Option 1
idstringrequired
Option 2
emailstringrequired3–200 characters.
Option 3
namestringrequired2–200 characters.
effective_datestringrequiredmanagerstring | objectA person id.
3 fields (one of several shapes)
Option 1
idstringrequired
Option 2
emailstringrequired3–200 characters.
Option 3
namestringrequired2–200 characters.
teamstring | objectA team id.
2 fields (one of several shapes)
Option 1
idstringrequired
Option 2
namestringrequired1–100 characters.
Option 3
type"promote"requiredpersonstring | objectrequiredA person id.
3 fields (one of several shapes)
Option 1
idstringrequired
Option 2
emailstringrequired3–200 characters.
Option 3
namestringrequired2–200 characters.
effective_datestringrequiredtitlestring1–120 characters.
payobject4 fields (one of several shapes)
Option 1
amountnumberrequiredFrom 0 to 100000000.
currencyanyrequiredperiod"year" | "month" | "hour"required
Option 2
percentnumberrequiredFrom -50 to 200.
Option 4
type"mark_leaving"requiredpersonstring | objectrequiredA person id.
3 fields (one of several shapes)
Option 1
idstringrequired
Option 2
emailstringrequired3–200 characters.
Option 3
namestringrequired2–200 characters.
last_daystringrequiredreasonstringUp to 200 characters.
leaving_typestring (enum)One of:
resignation,retirement,dismissal,redundancy,end_of_contract,mutual_agreement,death,other.person_toldbooleanaccess"after_last_day" | "keep"
Option 5
type"create_team"requirednamestringrequired1–100 characters.
parentstring | objectA team id.
2 fields (one of several shapes)
Option 1
idstringrequired
Option 2
namestringrequired1–100 characters.
kind"division" | "department" | "team"
Option 6
type"set_team_lead"requiredteamstring | objectrequiredA team id.
2 fields (one of several shapes)
Option 1
idstringrequired
Option 2
namestringrequired1–100 characters.
personstring | objectrequiredA person id.
3 fields (one of several shapes)
Option 1
idstringrequired
Option 2
emailstringrequired3–200 characters.
Option 3
namestringrequired2–200 characters.
Option 7
type"pay"requiredpersonstring | objectrequiredA person id.
3 fields (one of several shapes)
Option 1
idstringrequired
Option 2
emailstringrequired3–200 characters.
Option 3
namestringrequired2–200 characters.
effective_datestringrequiredamountnumberrequiredFrom 0 to 100000000.
currencyanyrequiredperiod"year" | "month" | "hour"requirednotestringUp to 200 characters.
Option 8
type"retitle"requiredpersonstring | objectrequiredA person id.
3 fields (one of several shapes)
Option 1
idstringrequired
Option 2
emailstringrequired3–200 characters.
Option 3
namestringrequired2–200 characters.
effective_datestringrequiredtitlestringrequiredThe new job title as typed (matched to the catalog, else added when applied).
1–120 characters.
Option 9
type"title_update"requiredtitlestring | objectrequiredA job title id.
2 fields (one of several shapes)
Option 1
idstringrequired
Option 2
namestringrequired1–120 characters.
family_idstring | nulltrack"ic" | "manager"level_idstring | nulldescriptionstring | nullUp to 4000 characters.
notestringUp to 500 characters.
Returns
11 fields
idstringrequiredstatus"pending" | "applied" | "discarded" | "expired"requirednotestring | nullrequiredopsany[]requiredThe changes, as sent (pay amounts only for those who may see pay).
summarystringrequiredlinesstring[]requiredEach change in words, in order, with names (pay amounts only for those who may see pay).
prepared_byobjectrequired3 fields
user_idstringrequirednamestring | nullrequiredmachinebooleanrequired
touches_preparer"job" | "pay"[]requiredWhether the set changes the job or the pay of the person who prepared it (directly or through an AI app they connected). Applying it records the changes as the applier's, so the rules about one's own records check the applier: check these changes with particular care.
created_atstringrequiredexpires_onstringrequiredclosed_atstring | nullrequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/org/changes.draft \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"ops": [
{
"type": "pay",
"person": "p1",
"effective_date": "2026-11-01",
"amount": 3200,
"currency": "EUR",
"period": "month"
}
],
"note": "Annual review"
}'const res = await fetch('https://api.bizisy.com/v1/org/changes.draft', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"ops": [
{
"type": "pay",
"person": "p1",
"effective_date": "2026-11-01",
"amount": 3200,
"currency": "EUR",
"period": "month"
}
],
"note": "Annual review"
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/changes.draft",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"ops": [
{
"type": "pay",
"person": "p1",
"effective_date": "2026-11-01",
"amount": 3200,
"currency": "EUR",
"period": "month",
},
],
"note": "Annual review",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"id": "d1",
"status": "pending",
"note": "Annual review",
"ops": [
{
"type": "pay",
"person": "p1",
"effective_date": "2026-11-01",
"amount": 3200,
"currency": "EUR",
"period": "month"
}
],
"summary": "pay",
"lines": [
"Pay Ana Ferreira 3200 EUR a month from 1 Nov 2026"
],
"prepared_by": {
"user_id": "u1",
"name": "Ana Ferreira",
"machine": true
},
"touches_preparer": [
"pay"
],
"created_at": "2026-10-07T10:00:00.000Z",
"expires_on": "2026-10-21",
"closed_at": null
}
}List change sets to review#
POST/v1/org/changes.listRead
Change sets saved for review (org_changes_draft): pending ones first, then those applied, discarded or expired in the last 30 days. Pay amounts only for owners, admins and HR in the app. Owners, admins and HR.
- Who can call it
- Manage key owner admin hr
- Keys and apps
- Pay amounts are never returned.
- MCP tool
org_changes_liston HR Assistant- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
No input: send {}.
Returns
draftsobject[]required11 fields
idstringrequiredstatus"pending" | "applied" | "discarded" | "expired"requirednotestring | nullrequiredopsany[]requiredThe changes, as sent (pay amounts only for those who may see pay).
summarystringrequiredlinesstring[]requiredEach change in words, in order, with names (pay amounts only for those who may see pay).
prepared_byobjectrequired3 fields
user_idstringrequirednamestring | nullrequiredmachinebooleanrequired
touches_preparer"job" | "pay"[]requiredWhether the set changes the job or the pay of the person who prepared it (directly or through an AI app they connected). Applying it records the changes as the applier's, so the rules about one's own records check the applier: check these changes with particular care.
created_atstringrequiredexpires_onstringrequiredclosed_atstring | nullrequired
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/org/changes.list \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch('https://api.bizisy.com/v1/org/changes.list', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/changes.list",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"drafts": [
{
"id": "d1",
"status": "pending",
"note": "Annual review",
"ops": [
{
"type": "pay",
"person": "p1",
"effective_date": "2026-11-01",
"amount": 3200,
"currency": "EUR",
"period": "month"
}
],
"summary": "pay",
"lines": [
"Pay Ana Ferreira 3200 EUR a month from 1 Nov 2026"
],
"prepared_by": {
"user_id": "u1",
"name": "Ana Ferreira",
"machine": true
},
"touches_preparer": [
"pay"
],
"created_at": "2026-10-07T10:00:00.000Z",
"expires_on": "2026-10-21",
"closed_at": null
}
]
}
}Get a change set draft#
POST/v1/org/changes.getRead
One change set draft: its changes, status (pending, applied, discarded or expired) and who prepared it. Preview it with org_changes_apply (draft_id, dry_run). Pay amounts only for owners, admins and HR in the app. Owners, admins and HR.
- Who can call it
- Manage key owner admin hr
- Keys and apps
- Pay amounts are never returned.
- MCP tool
org_changes_geton HR Assistant- Method
POSTwith a JSON body, orGETwith the input as query parameters
Input
draft_idstringrequired
Returns
11 fields
idstringrequiredstatus"pending" | "applied" | "discarded" | "expired"requirednotestring | nullrequiredopsany[]requiredThe changes, as sent (pay amounts only for those who may see pay).
summarystringrequiredlinesstring[]requiredEach change in words, in order, with names (pay amounts only for those who may see pay).
prepared_byobjectrequired3 fields
user_idstringrequirednamestring | nullrequiredmachinebooleanrequired
touches_preparer"job" | "pay"[]requiredWhether the set changes the job or the pay of the person who prepared it (directly or through an AI app they connected). Applying it records the changes as the applier's, so the rules about one's own records check the applier: check these changes with particular care.
created_atstringrequiredexpires_onstringrequiredclosed_atstring | nullrequired
Errors
validation_failed unauthenticated forbidden not_found rate_limited internal
curl https://api.bizisy.com/v1/org/changes.get \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-d '{"draft_id":"d1"}'const res = await fetch('https://api.bizisy.com/v1/org/changes.get', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"draft_id": "d1"
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/changes.get",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}"},
json={
"draft_id": "d1",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"id": "d1",
"status": "pending",
"note": "Annual review",
"ops": [
{
"type": "pay",
"person": "p1",
"effective_date": "2026-11-01",
"amount": 3200,
"currency": "EUR",
"period": "month"
}
],
"summary": "pay",
"lines": [
"Pay Ana Ferreira 3200 EUR a month from 1 Nov 2026"
],
"prepared_by": {
"user_id": "u1",
"name": "Ana Ferreira",
"machine": true
},
"touches_preparer": [
"pay"
],
"created_at": "2026-10-07T10:00:00.000Z",
"expires_on": "2026-10-21",
"closed_at": null
}
}Discard a change set draft#
POST/v1/org/changes.discardWrite
Discards a pending draft: nothing in it is applied. Owners, admins and HR.
- Who can call it
- Manage key owner admin hr
- MCP tool
org_changes_discardon HR Assistant- Preview
?dry_run=trueruns every check and saves nothing- Retries
- An Idempotency-Key replays the first result
Input
draft_idstringrequired
Returns
11 fields
idstringrequiredstatus"pending" | "applied" | "discarded" | "expired"requirednotestring | nullrequiredopsany[]requiredThe changes, as sent (pay amounts only for those who may see pay).
summarystringrequiredlinesstring[]requiredEach change in words, in order, with names (pay amounts only for those who may see pay).
prepared_byobjectrequired3 fields
user_idstringrequirednamestring | nullrequiredmachinebooleanrequired
touches_preparer"job" | "pay"[]requiredWhether the set changes the job or the pay of the person who prepared it (directly or through an AI app they connected). Applying it records the changes as the applier's, so the rules about one's own records check the applier: check these changes with particular care.
created_atstringrequiredexpires_onstringrequiredclosed_atstring | nullrequired
Errors
validation_failed unauthenticated forbidden not_found conflict rate_limited internal
curl https://api.bizisy.com/v1/org/changes.discard \
-H "Authorization: Bearer $BIZISY_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"draft_id":"d1"}'const res = await fetch('https://api.bizisy.com/v1/org/changes.discard', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.BIZISY_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"draft_id": "d1"
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
console.log(body.data);import os, uuid
import requests
res = requests.post(
"https://api.bizisy.com/v1/org/changes.discard",
headers={"Authorization": f"Bearer {os.environ['BIZISY_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"draft_id": "d1",
},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
print(body["data"]){
"data": {
"id": "d1",
"status": "discarded",
"note": "Annual review",
"ops": [
{
"type": "pay",
"person": "p1",
"effective_date": "2026-11-01",
"amount": 3200,
"currency": "EUR",
"period": "month"
}
],
"summary": "pay",
"lines": [
"Pay Ana Ferreira 3200 EUR a month from 1 Nov 2026"
],
"prepared_by": {
"user_id": "u1",
"name": "Ana Ferreira",
"machine": true
},
"touches_preparer": [
"pay"
],
"created_at": "2026-10-07T10:00:00.000Z",
"expires_on": "2026-10-21",
"closed_at": "2026-10-08T09:00:00.000Z"
}
}Something missing or wrong on this page? Write to hello@bizisy.com.