Get an org legal entity

Módulo Settings

GET/org-legal-entities/{id}orgLegalEntities.get

A legal entity of the organization with its fiscal settings. Returns one org legal entity with its `ETag`. A org legal entity the caller may not see returns 404.

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

Parámetros de ruta y de consulta

orgLegalEntities.get: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the org legal entity.
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: OrgLegalEntity

orgLegalEntities.get: OrgLegalEntity
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the org legal entity.
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.
legal_name	string	Sí	Legal name.Restricciones: length 1 to 300
country_code	string	Sí	ISO 3166-1 alpha-2 country code.Restricciones: pattern ^[A-Z]{2}$
tax_identifier	string \| Masked \| null	Sí
fiscal_year_start_month	integer	Sí	Fiscal year start month.Restricciones: range 1 to any
base_currency	string	Sí	Base currency.Restricciones: pattern ^[A-Z]{3}$
is_primary	boolean	Sí	True for the org's primary entity, printed on generated documents. The first entity is primary; marking another moves the mark.
tax_identifier_last4	string \| null	Sí	Last four characters of the tax identifier.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$

{
  "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",
  "legal_name": "Northwind Live LLC",
  "country_code": "US",
  "tax_identifier": "123456789",
  "fiscal_year_start_month": 1,
  "base_currency": "USD",
  "is_primary": true,
  "tax_identifier_last4": "6789"
}

Ejemplos de código

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

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

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

xos org-legal-entities get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f