Create a tax form

Módulo Gateway

POST/tax-formstaxForms.create

A tax form. Restricted and encrypted; only the last four digits of the identifier are ever displayed. Creates a tax form. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requiere la capacidad me.work_details.write.
Alcances de OAuth: me.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: TaxFormCreate

taxForms.create: TaxFormCreate
Campo	Tipo	Obligatorio	Descripción
foreign_performer_withholding	boolean	No	Foreign performer withholding flag.
organization_id	string (uuid) \| null	No	Identifier of the payee external account.
form_kind	"W-9" \| "W-8BEN" \| "W-8BEN-E"	Sí	Tax form.
tax_identifier	string	Sí	Tax identifier. Write-only: it is encrypted and never returned.Restricciones: length 4 to 64

{
  "foreign_performer_withholding": false,
  "organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "form_kind": "W-9",
  "tax_identifier": "123456789"
}

Respuesta 201: TaxForm

taxForms.create: 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 POST "$XOS_BASE_URL/tax-forms" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"foreign_performer_withholding":false,"organization_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","form_kind":"W-9","tax_identifier":"123456789"}'

const { data } = await xos.taxForms.create({
    "foreign_performer_withholding": false,
    "organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "form_kind": "W-9",
    "tax_identifier": "123456789"
  });

response = xos.tax_forms.create({"foreign_performer_withholding": False, "organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "form_kind": "W-9", "tax_identifier": "123456789"})

xos tax-forms create --data '{"foreign_performer_withholding":false,"organization_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","form_kind":"W-9","tax_identifier":"123456789"}'