Get a tax form

Módulo Gateway

GET/tax-forms/{id}taxForms.get

A tax form. Restricted and encrypted; only the last four digits of the identifier are ever displayed. Returns one tax form with its `ETag`. A tax form the caller may not see returns 404.

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

Parámetros de ruta y de consulta

taxForms.get: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the tax form.
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: TaxForm

taxForms.get: TaxForm
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the tax form.
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.
tin_last4	string	Sí	Last four digits of the tax identifier.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
foreign_performer_withholding	boolean	Sí	Foreign performer withholding flag.
person_id	string (uuid) \| null	Sí	Identifier of the payee person, set from the session.
organization_id	string (uuid) \| null	Sí	Identifier of the payee external account.
form_kind	"W-9" \| "W-8BEN" \| "W-8BEN-E"	Sí	Tax form.
signed_at	string (date-time)	Sí	When the payee signed the form, set by the database.

{
  "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",
  "tin_last4": "6789",
  "foreign_performer_withholding": false,
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "form_kind": "W-9",
  "signed_at": "2026-10-08T14:30:00Z"
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/tax-forms/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"

const { data, etag } = await xos.taxForms.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");

response = xos.tax_forms.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")

xos tax-forms get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f