Skip to content

Commit f5b83e5

Browse files
gabrielsecogabrielseco
authored
docs(onboarding) - add docs about v2 notice period (#810)
* add docs * move files * updates to contract details * update docs
1 parent 605ce39 commit f5b83e5

21 files changed

Lines changed: 845 additions & 3 deletions

File tree

‎docs/schema-changes/SCHEMA_CHANGES.md‎

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,37 @@ Schema versions for the Basic Information step in employee onboarding flows.
3030

3131
## Contract Details (EOR)
3232

33-
_Coming soon_
33+
Schema versions for the Contract Details step in employee onboarding flows.
34+
35+
**Important:** Contract details schemas vary by country. Version 2 introduces notice_period handling, but the specific implementation differs per country.
36+
37+
**See country-specific documentation:** [View all countries →](./eor/contract-details/countries/README.md)
38+
39+
### Version Availability
40+
41+
- **v2** - Available for 18 countries (SDK 1.23.0+)
42+
- Belarus, China, Switzerland, Czech Republic, Hong Kong, Iceland, Jamaica, Kenya, Lebanon, Mauritius, Malaysia, Nigeria, Norway, New Zealand, Saudi Arabia, Singapore, Serbia, Sweden
43+
- **v1** - Default for all other countries (SDK 1.0.0+)
44+
45+
**Quick Start (v2 example for Switzerland):**
46+
47+
```tsx
48+
<OnboardingFlow
49+
options={{
50+
jsonSchemaVersionByCountry: {
51+
CHE: { contract_details: 2 },
52+
},
53+
}}
54+
/>
55+
```
3456

3557
## Version Support Matrix
3658

3759
Track which schema versions are supported by each SDK version.
3860
| SDK Version | Basic Information | Contract Details |
3961
|-------------|-------------------|------------------|
40-
| 1.23.0+ | v3 (recommended) | _TBD_ |
41-
| 1.0.0+ | v1 (legacy) | _TBD_ |
62+
| 1.23.0+ | v3 (recommended) | v2 (18 countries) |
63+
| 1.0.0+ | v1 (legacy) | v1 (default) |
4264

4365
**Legend:**
4466

‎docs/schema-changes/eor/contract-details/countries/BLR.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Belarus (BLR)
2+
3+
Schema versions for employee onboarding in Belarus.
4+
5+
## Current Version
6+
7+
**Contract Details:** v2 (Since SDK 1.23.0)
8+
9+
## Contract Details
10+
11+
### v2 - Current (Since SDK 1.23.0, March 2026)
12+
13+
**What changed:**
14+
15+
- Added `notice_period` component
16+
- Handles country-specific notice period rules automatically
17+
- Unit, minimum, and maximum values are country-specific
18+
- Added `notice_period_choice` field for policy-based configurations
19+
- Old `notice_period_[unit]` field removed from required fields
20+
- Component manages validation based on employment type and local regulations
21+
22+
**Migration:**
23+
24+
```tsx
25+
<OnboardingFlow
26+
options={{
27+
jsonSchemaVersionByCountry: {
28+
BLR: { contract_details: 2 },
29+
},
30+
}}
31+
/>
32+
```
33+
34+
---
35+
36+
### v1 (SDK 1.0.0)
37+
38+
Initial version with basic contract details fields.

‎docs/schema-changes/eor/contract-details/countries/CHE.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Switzerland (CHE)
2+
3+
Schema versions for employee onboarding in Switzerland.
4+
5+
## Current Version
6+
7+
**Contract Details:** v2 (Since SDK 1.23.0)
8+
9+
## Contract Details
10+
11+
### v2 - Current (Since SDK 1.23.0, March 2026)
12+
13+
**What changed:**
14+
15+
- Added `notice_period` component
16+
- Handles country-specific notice period rules automatically
17+
- Unit, minimum, and maximum values are country-specific
18+
- Added `notice_period_choice` field for policy-based configurations
19+
- Old `notice_period_[unit]` field removed from required fields
20+
- Component manages validation based on employment type and local regulations
21+
22+
**Migration:**
23+
24+
```tsx
25+
<OnboardingFlow
26+
options={{
27+
jsonSchemaVersionByCountry: {
28+
CHE: { contract_details: 2 },
29+
},
30+
}}
31+
/>
32+
```
33+
34+
---
35+
36+
### v1 (SDK 1.0.0)
37+
38+
Initial version with basic contract details fields.

‎docs/schema-changes/eor/contract-details/countries/CHN.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# China (CHN)
2+
3+
Schema versions for employee onboarding in China.
4+
5+
## Current Version
6+
7+
**Contract Details:** v2 (Since SDK 1.23.0)
8+
9+
## Contract Details
10+
11+
### v2 - Current (Since SDK 1.23.0, March 2026)
12+
13+
**What changed:**
14+
15+
- Added `notice_period` component
16+
- Handles country-specific notice period rules automatically
17+
- Unit, minimum, and maximum values are country-specific
18+
- Added `notice_period_choice` field for policy-based configurations
19+
- Old `notice_period_[unit]` field removed from required fields
20+
- Component manages validation based on employment type and local regulations
21+
22+
**Migration:**
23+
24+
```tsx
25+
<OnboardingFlow
26+
options={{
27+
jsonSchemaVersionByCountry: {
28+
CHN: { contract_details: 2 },
29+
},
30+
}}
31+
/>
32+
```
33+
34+
---
35+
36+
### v1 (SDK 1.0.0)
37+
38+
Initial version with basic contract details fields.

‎docs/schema-changes/eor/contract-details/countries/CZE.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Czech Republic (CZE)
2+
3+
Schema versions for employee onboarding in Czech Republic.
4+
5+
## Current Version
6+
7+
**Contract Details:** v2 (Since SDK 1.23.0)
8+
9+
## Contract Details
10+
11+
### v2 - Current (Since SDK 1.23.0, March 2026)
12+
13+
**What changed:**
14+
15+
- Added `notice_period` component
16+
- Handles country-specific notice period rules automatically
17+
- Unit, minimum, and maximum values are country-specific
18+
- Added `notice_period_choice` field for policy-based configurations
19+
- Old `notice_period_[unit]` field removed from required fields
20+
- Component manages validation based on employment type and local regulations
21+
22+
**Migration:**
23+
24+
```tsx
25+
<OnboardingFlow
26+
options={{
27+
jsonSchemaVersionByCountry: {
28+
CZE: { contract_details: 2 },
29+
},
30+
}}
31+
/>
32+
```
33+
34+
---
35+
36+
### v1 (SDK 1.0.0)
37+
38+
Initial version with basic contract details fields.

‎docs/schema-changes/eor/contract-details/countries/HKG.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Hong Kong (HKG)
2+
3+
Schema versions for employee onboarding in Hong Kong.
4+
5+
## Current Version
6+
7+
**Contract Details:** v2 (Since SDK 1.23.0)
8+
9+
## Contract Details
10+
11+
### v2 - Current (Since SDK 1.23.0, March 2026)
12+
13+
**What changed:**
14+
15+
- Added `notice_period` component
16+
- Handles country-specific notice period rules automatically
17+
- Unit, minimum, and maximum values are country-specific
18+
- Added `notice_period_choice` field for policy-based configurations
19+
- Old `notice_period_[unit]` field removed from required fields
20+
- Component manages validation based on employment type and local regulations
21+
22+
**Migration:**
23+
24+
```tsx
25+
<OnboardingFlow
26+
options={{
27+
jsonSchemaVersionByCountry: {
28+
HKG: { contract_details: 2 },
29+
},
30+
}}
31+
/>
32+
```
33+
34+
---
35+
36+
### v1 (SDK 1.0.0)
37+
38+
Initial version with basic contract details fields.

‎docs/schema-changes/eor/contract-details/countries/ISL.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Iceland (ISL)
2+
3+
Schema versions for employee onboarding in Iceland.
4+
5+
## Current Version
6+
7+
**Contract Details:** v2 (Since SDK 1.23.0)
8+
9+
## Contract Details
10+
11+
### v2 - Current (Since SDK 1.23.0, March 2026)
12+
13+
**What changed:**
14+
15+
- Added `notice_period` component
16+
- Handles country-specific notice period rules automatically
17+
- Unit, minimum, and maximum values are country-specific
18+
- Added `notice_period_choice` field for policy-based configurations
19+
- Old `notice_period_[unit]` field removed from required fields
20+
- Component manages validation based on employment type and local regulations
21+
22+
**Migration:**
23+
24+
```tsx
25+
<OnboardingFlow
26+
options={{
27+
jsonSchemaVersionByCountry: {
28+
ISL: { contract_details: 2 },
29+
},
30+
}}
31+
/>
32+
```
33+
34+
---
35+
36+
### v1 (SDK 1.0.0)
37+
38+
Initial version with basic contract details fields.

‎docs/schema-changes/eor/contract-details/countries/JAM.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Jamaica (JAM)
2+
3+
Schema versions for employee onboarding in Jamaica.
4+
5+
## Current Version
6+
7+
**Contract Details:** v2 (Since SDK 1.23.0)
8+
9+
## Contract Details
10+
11+
### v2 - Current (Since SDK 1.23.0, March 2026)
12+
13+
**What changed:**
14+
15+
- Added `notice_period` component
16+
- Handles country-specific notice period rules automatically
17+
- Unit, minimum, and maximum values are country-specific
18+
- Added `notice_period_choice` field for policy-based configurations
19+
- Old `notice_period_[unit]` field removed from required fields
20+
- Component manages validation based on employment type and local regulations
21+
22+
**Migration:**
23+
24+
```tsx
25+
<OnboardingFlow
26+
options={{
27+
jsonSchemaVersionByCountry: {
28+
JAM: { contract_details: 2 },
29+
},
30+
}}
31+
/>
32+
```
33+
34+
---
35+
36+
### v1 (SDK 1.0.0)
37+
38+
Initial version with basic contract details fields.

‎docs/schema-changes/eor/contract-details/countries/KEN.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Kenya (KEN)
2+
3+
Schema versions for employee onboarding in Kenya.
4+
5+
## Current Version
6+
7+
**Contract Details:** v2 (Since SDK 1.23.0)
8+
9+
## Contract Details
10+
11+
### v2 - Current (Since SDK 1.23.0, March 2026)
12+
13+
**What changed:**
14+
15+
- Added `notice_period` component
16+
- Handles country-specific notice period rules automatically
17+
- Unit, minimum, and maximum values are country-specific
18+
- Added `notice_period_choice` field for policy-based configurations
19+
- Old `notice_period_[unit]` field removed from required fields
20+
- Component manages validation based on employment type and local regulations
21+
22+
**Migration:**
23+
24+
```tsx
25+
<OnboardingFlow
26+
options={{
27+
jsonSchemaVersionByCountry: {
28+
KEN: { contract_details: 2 },
29+
},
30+
}}
31+
/>
32+
```
33+
34+
---
35+
36+
### v1 (SDK 1.0.0)
37+
38+
Initial version with basic contract details fields.

‎docs/schema-changes/eor/contract-details/countries/LBN.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Lebanon (LBN)
2+
3+
Schema versions for employee onboarding in Lebanon.
4+
5+
## Current Version
6+
7+
**Contract Details:** v2 (Since SDK 1.23.0)
8+
9+
## Contract Details
10+
11+
### v2 - Current (Since SDK 1.23.0, March 2026)
12+
13+
**What changed:**
14+
15+
- Added `notice_period` component
16+
- Handles country-specific notice period rules automatically
17+
- Unit, minimum, and maximum values are country-specific
18+
- Added `notice_period_choice` field for policy-based configurations
19+
- Old `notice_period_[unit]` field removed from required fields
20+
- Component manages validation based on employment type and local regulations
21+
22+
**Migration:**
23+
24+
```tsx
25+
<OnboardingFlow
26+
options={{
27+
jsonSchemaVersionByCountry: {
28+
LBN: { contract_details: 2 },
29+
},
30+
}}
31+
/>
32+
```
33+
34+
---
35+
36+
### v1 (SDK 1.0.0)
37+
38+
Initial version with basic contract details fields.

0 commit comments

Comments
 (0)