Skip to content

Get a reconciliation line

Places module

GET/reconciliation-lines/{id}reconciliationLines.get

One requirement's reconciliation result. Returns one reconciliation line with its `ETag`. A reconciliation line the caller may not see returns 404.

  • Requires the capability advancing.packet.read.
  • OAuth scopes: advancing.
  • Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.

Path and query parameters

reconciliationLines.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the reconciliation line.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Response 200: ReconciliationLine

reconciliationLines.get: ReconciliationLine
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the reconciliation line.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
reconciliation_idstring (uuid)YesIdentifier of the reconciliation.
requirement_idstring (uuid)YesIdentifier of the requirement.
capability_idstring (uuid) | nullYesIdentifier of the matching capability.
resultReconciliationResultYesRequirement against capability result. Unknown against a critical requirement is a gap at gate 3.Constraints: one of "Met", "Gap", "Unknown"
{
  "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",
  "reconciliation_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "requirement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "capability_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "result": "Met"
}

Code samples

curl -X GET "$XOS_BASE_URL/reconciliation-lines/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.reconciliationLines.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.reconciliation_lines.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos reconciliation-lines get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f