Create a reconciliation

Módulo Places

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.

Requiere la capacidad advancing.reconciliation.write.
Alcances de OAuth: advancing.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: ReconciliationCreate

reconciliations.create: ReconciliationCreate
Campo	Tipo	Obligatorio	Descripción
project_id	string (uuid)	Sí	Identifier of the project.
note	string \| null	No	Notes on the run.Restricciones: length 1 to 20000

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

Respuesta 201: Reconciliation

reconciliations.create: Reconciliation
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the reconciliation.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
project_id	string (uuid)	Sí	Identifier of the project.
run_at	string (date-time)	Sí	When the reconciliation ran.
met_count	integer	Sí	Requirements met.Restricciones: range 0 to any
gap_count	integer	Sí	Requirements with a gap.Restricciones: range 0 to any
unknown_count	integer	Sí	Requirements with an unknown result.Restricciones: range 0 to any
note	string \| null	Sí	Notes on the run.Restricciones: 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."
}

Ejemplos de código

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."}'