Skip to content

Get a billing draw

Finance module

GET/billing-draws/{id}billingDraws.get

A client billing draw against the project. Returns one billing draw with its `ETag`. A billing draw the caller may not see returns 404.

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

Path and query parameters

billingDraws.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the billing 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: BillingDraw

billingDraws.get: BillingDraw
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the billing 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.
project_idstring (uuid)YesIdentifier of the project.
draw_numberintegerYesDraw number within the project.Constraints: range 1 to any
period_endstring (date)YesLast day the draw bills for.
amount_requested_minorinteger (int64) | nullYesAmount requested. Integer minor units of the resource currency; null means unpriced, never zero.
currency_codestringYesISO 4217 currency code of every money field on the row.Constraints: pattern ^[A-Z]{3}$
invoice_idstring (uuid) | nullYesIdentifier 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 GET "$XOS_BASE_URL/billing-draws/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.billingDraws.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.billing_draws.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos billing-draws get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f