Create a billing draw
Finance module
POST/billing-drawsbillingDraws.create
A client billing draw against the project. Creates a billing 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.invoice.write.
- 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: BillingDrawCreate
| Field | Type | Required | Description |
|---|---|---|---|
| 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) | Yes | Amount requested. Integer minor units of the document currency.Constraints: range 0 to any |
| currency_code | string | Yes | ISO 4217 currency code of every money field on the row.Constraints: pattern ^[A-Z]{3}$ |
{
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"draw_number": 1,
"period_end": "2026-10-08",
"amount_requested_minor": 5000000,
"currency_code": "USD"
}Response 201: 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 POST "$XOS_BASE_URL/billing-draws" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","draw_number":1,"period_end":"2026-10-08","amount_requested_minor":5000000,"currency_code":"USD"}'const { data } = await xos.billingDraws.create({
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"draw_number": 1,
"period_end": "2026-10-08",
"amount_requested_minor": 5000000,
"currency_code": "USD"
});response = xos.billing_draws.create({"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "draw_number": 1, "period_end": "2026-10-08", "amount_requested_minor": 5000000, "currency_code": "USD"})xos billing-draws create --data '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","draw_number":1,"period_end":"2026-10-08","amount_requested_minor":5000000,"currency_code":"USD"}'