Create a reconciliation

Places module

POST/reconciliationsreconciliations.create

A reconciliation run of requirements against capabilities. Creates a reconciliation. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requires the capability advancing.reconciliation.write.
OAuth scopes: advancing.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: ReconciliationCreate

reconciliations.create: ReconciliationCreate
Field	Type	Required	Description
project_id	string (uuid)	Yes	Identifier of the project.
note	string \| null	No	Notes on the run.Constraints: length 1 to 20000

{
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "note": "Venue walk."
}

Response 201: Reconciliation

reconciliations.create: Reconciliation
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the reconciliation.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
project_id	string (uuid)	Yes	Identifier of the project.
run_at	string (date-time)	Yes	When the reconciliation ran.
met_count	integer	Yes	Requirements met.Constraints: range 0 to any
gap_count	integer	Yes	Requirements with a gap.Constraints: range 0 to any
unknown_count	integer	Yes	Requirements with an unknown result.Constraints: range 0 to any
note	string \| null	Yes	Notes on the run.Constraints: length 1 to 20000

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "run_at": "2026-10-08T14:30:00Z",
  "met_count": 18,
  "gap_count": 2,
  "unknown_count": 1,
  "note": "Venue walk."
}

Code samples

curl -X POST "$XOS_BASE_URL/reconciliations" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","note":"Venue walk."}'

const { data } = await xos.reconciliations.create({
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "note": "Venue walk."
  });

response = xos.reconciliations.create({"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "note": "Venue walk."})

xos reconciliations create --data '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","note":"Venue walk."}'