Create an org legal entity
Settings module
POST/org-legal-entitiesorgLegalEntities.create
A legal entity of the organization with its fiscal settings. Creates an org legal entity. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability org.legal_entities.write.
- OAuth scopes: org.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: OrgLegalEntityCreate
| Field | Type | Required | Description |
|---|---|---|---|
| legal_name | string | Yes | Legal name.Constraints: length 1 to 300 |
| country_code | string | Yes | ISO 3166-1 alpha-2 country code.Constraints: pattern ^[A-Z]{2}$ |
| tax_identifier | string | null | No | Tax identifier.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| fiscal_year_start_month | integer | Yes | Fiscal year start month.Constraints: range 1 to any |
| base_currency | string | Yes | Base currency.Constraints: pattern ^[A-Z]{3}$ |
| is_primary | boolean | No | True for the org's primary entity, printed on generated documents. The first entity is primary; marking another moves the mark. |
{
"legal_name": "Northwind Live LLC",
"country_code": "US",
"tax_identifier": "123456789",
"fiscal_year_start_month": 1,
"base_currency": "USD",
"is_primary": true
}Response 201: OrgLegalEntity
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the org legal entity. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| legal_name | string | Yes | Legal name.Constraints: length 1 to 300 |
| country_code | string | Yes | ISO 3166-1 alpha-2 country code.Constraints: pattern ^[A-Z]{2}$ |
| tax_identifier | string | Masked | null | Yes | |
| fiscal_year_start_month | integer | Yes | Fiscal year start month.Constraints: range 1 to any |
| base_currency | string | Yes | Base currency.Constraints: pattern ^[A-Z]{3}$ |
| is_primary | boolean | Yes | 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 | Yes | Last four characters of the tax identifier.Constraints: 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"
}Code samples
curl -X POST "$XOS_BASE_URL/org-legal-entities" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"legal_name":"Northwind Live LLC","country_code":"US","tax_identifier":"123456789","fiscal_year_start_month":1,"base_currency":"USD","is_primary":true}'const { data } = await xos.orgLegalEntities.create({
"legal_name": "Northwind Live LLC",
"country_code": "US",
"tax_identifier": "123456789",
"fiscal_year_start_month": 1,
"base_currency": "USD",
"is_primary": true
});response = xos.org_legal_entities.create({"legal_name": "Northwind Live LLC", "country_code": "US", "tax_identifier": "123456789", "fiscal_year_start_month": 1, "base_currency": "USD", "is_primary": True})xos org-legal-entities create --data '{"legal_name":"Northwind Live LLC","country_code":"US","tax_identifier":"123456789","fiscal_year_start_month":1,"base_currency":"USD","is_primary":true}'