Get a billing draw

Módulo Finance

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.

Requiere la capacidad finance.invoice.read.
Alcances de OAuth: finance.
Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

billingDraws.get: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the billing draw.
fields	Fields	No	Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_](,[a-z_][a-z0-9_])*$

Respuesta 200: BillingDraw

billingDraws.get: BillingDraw
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the billing draw.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
project_id	string (uuid)	Sí	Identifier of the project.
draw_number	integer	Sí	Draw number within the project.Restricciones: range 1 to any
period_end	string (date)	Sí	Last day the draw bills for.
amount_requested_minor	integer (int64) \| null	Sí	Amount requested. Integer minor units of the resource currency; null means unpriced, never zero.
currency_code	string	Sí	ISO 4217 currency code of every money field on the row.Restricciones: pattern ^[A-Z]{3}$
invoice_id	string (uuid) \| null	Sí	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"
}

Ejemplos de código

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