Skip to content

Create a contingency draw

Finance module

POST/contingency-drawscontingencyDraws.create

A draw from a contingency line onto another budget line. Creates a contingency draw. 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 finance.budget.approve.
  • OAuth scopes: finance.
  • 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: ContingencyDrawCreate

contingencyDraws.create: ContingencyDrawCreate
FieldTypeRequiredDescription
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)YesAmount drawn. Integer minor units of the document currency.Constraints: range 1 to any
reasonstringYesWhy contingency is drawn.Constraints: length 1 to 20000
{
  "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."
}

Response 201: ContingencyDraw

contingencyDraws.create: 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 POST "$XOS_BASE_URL/contingency-draws" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"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."}'
const { data } = await xos.contingencyDraws.create({
    "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."
  });
response = xos.contingency_draws.create({"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."})
xos contingency-draws create --data '{"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."}'