Skip to content

Get a contingency draw

Finance module

GET/contingency-draws/{id}contingencyDraws.get

A draw from a contingency line onto another budget line. Returns one contingency draw with its `ETag`. A contingency draw the caller may not see returns 404.

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

Path and query parameters

contingencyDraws.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the contingency draw.
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: ContingencyDraw

contingencyDraws.get: ContingencyDraw
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the contingency draw.
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.
from_budget_line_idstring (uuid)YesIdentifier of the contingency budget line.
to_budget_line_idstring (uuid)YesIdentifier of the receiving budget line.
amount_minorinteger (int64) | nullYesAmount drawn. Integer minor units of the resource currency; null means unpriced, never zero.
reasonstringYesWhy contingency is drawn.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",
  "from_budget_line_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "to_budget_line_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "amount_minor": 250000,
  "reason": "Added wind bracing after the engineering review."
}

Code samples

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