Update a billing draw
Finance module
PATCH/billing-draws/{id}billingDraws.update
A client billing draw against the project. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.
- Requires the capability finance.invoice.write.
- OAuth scopes: finance.
- Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
- Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the billing draw. |
Request body: BillingDrawUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| draw_number | integer | No | Draw number within the project.Constraints: range 1 to any |
| period_end | string (date) | No | Last day the draw bills for. |
| amount_requested_minor | integer (int64) | No | Amount requested. Integer minor units of the document currency.Constraints: range 0 to any |
| currency_code | string | No | ISO 4217 currency code of every money field on the row.Constraints: pattern ^[A-Z]{3}$ |
{
"draw_number": 1,
"period_end": "2026-10-08",
"amount_requested_minor": 5000000,
"currency_code": "USD"
}Response 200: BillingDraw
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the billing draw. |
| 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. |
| draw_number | integer | Yes | Draw number within the project.Constraints: range 1 to any |
| period_end | string (date) | Yes | Last day the draw bills for. |
| amount_requested_minor | integer (int64) | null | Yes | Amount requested. Integer minor units of the resource currency; null means unpriced, never zero. |
| currency_code | string | Yes | ISO 4217 currency code of every money field on the row.Constraints: pattern ^[A-Z]{3}$ |
| invoice_id | string (uuid) | null | Yes | Identifier of the receivable invoice of the draw. |
{
"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",
"draw_number": 1,
"period_end": "2026-10-08",
"amount_requested_minor": 5000000,
"currency_code": "USD",
"invoice_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X PATCH "$XOS_BASE_URL/billing-draws/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H 'If-Match: W/"etag-from-your-last-read"' \
-H "Content-Type: application/json" \
-d '{"draw_number":1,"period_end":"2026-10-08","amount_requested_minor":5000000,"currency_code":"USD"}'const { data, etag } = await xos.billingDraws.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"draw_number": 1,
"period_end": "2026-10-08",
"amount_requested_minor": 5000000,
"currency_code": "USD"
}, { ifMatch: etag });response = xos.billing_draws.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"draw_number": 1, "period_end": "2026-10-08", "amount_requested_minor": 5000000, "currency_code": "USD"}, if_match=etag)xos billing-draws update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"draw_number":1,"period_end":"2026-10-08","amount_requested_minor":5000000,"currency_code":"USD"}' --if-match auto