Skip to content

feat: added documentation for employee invitation_code field #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 24, 2025
Merged

feat: added documentation for employee invitation_code field #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0c7b72a
feat: added documentation for employee invitation_code field
mdamire Mar 28, 2025
af7c0ff
fixup! feat: added documentation for employee invitation_code field
mdamire Apr 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 18 additions & 10 deletions source/includes/_employees.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ and working permits.
"created_at": "2019-05-22T10:32:36.118753Z",
"notified_at": "2019-05-22T10:32:37.846274Z",
"claimed_at": "2019-05-23T11:56:41.123721Z",
"verified_at": "2019-05-23T11:57:03.742345Z"
"verified_at": "2019-05-23T11:57:03.742345Z",
"invitation_code": null
}
```

Expand All @@ -35,6 +36,7 @@ and working permits.
| `notified_at` | Time at which the Employee was notified. Displayed as ISO 8601 string. |
| `claimed_at` | Time at which the Employee consumed the magic link. Displayed as ISO 8601 string. |
| `verified_at` | Time when the Employee was verified. Displayed as ISO 8601 string. |
| `invitation_code` | 8-digit alphanumeric uppercase code available when an employee is invited but not yet claimed. Users can use this code to create a magic link to claim the employee. |



Expand Down Expand Up @@ -84,7 +86,8 @@ fetch("https://api.gigapay.se/v2/employees/", {
"created_at": "2019-05-22T10:32:36.118753Z",
"notified_at": "2019-05-22T10:32:37.846274Z",
"claimed_at": "2019-05-23T11:56:41.123721Z",
"verified_at": "2019-05-23T11:57:03.742345Z"
"verified_at": "2019-05-23T11:57:03.742345Z",
"invitation_code": null
}, {
"id": "1848",
"name": "Joakim Olovsson",
Expand All @@ -94,8 +97,9 @@ fetch("https://api.gigapay.se/v2/employees/", {
"metadata": {},
"created_at": "2019-05-23T14:45:12.545271Z",
"notified_at": "2019-05-23T14:45:13.374627Z",
"claimed_at": "2019-05-23T14:45:37.282819Z",
"verified_at": "2019-05-24T09:47:02.918264Z"
"claimed_at": null,
"verified_at": null,
"invitation_code": "A1B2C3D4"
}
]
}
Expand Down Expand Up @@ -181,11 +185,12 @@ fetch("https://api.gigapay.se/v2/employees/", {
"created_at": "2019-05-22T10:32:36.118753Z",
"notified_at": null,
"claimed_at": null,
"verified_at": null
"verified_at": null,
"invitation_code": "A1B2C3D4"
}
```

This endpoint registers an Employee.
This endpoint registers an Employee. The Employee will be notified with the `invitation_code` that can be used to sign up in Gigapay and accept your invitation.

### HTTP Request

Expand Down Expand Up @@ -250,7 +255,8 @@ fetch("https://api.gigapay.se/v2/employees/1847/", {
"created_at": "2019-05-22T10:32:36.118753Z",
"notified_at": "2019-05-22T10:32:37.846274Z",
"claimed_at": "2019-05-23T11:56:41.123721Z",
"verified_at": "2019-05-23T11:57:03.742345Z"
"verified_at": "2019-05-23T11:57:03.742345Z",
"invitation_code": null
}
```

Expand Down Expand Up @@ -319,7 +325,8 @@ fetch("https://api.gigapay.se/v2/employees/1847/", {
"created_at": "2019-05-22T10:32:36.118753Z",
"notified_at": "2019-05-22T10:32:37.846274Z",
"claimed_at": "2019-05-23T11:56:41.123721Z",
"verified_at": "2019-05-23T11:57:03.742345Z"
"verified_at": "2019-05-23T11:57:03.742345Z",
"invitation_code": null
}
```

Expand Down Expand Up @@ -409,7 +416,8 @@ fetch("https://api.gigapay.se/v2/employees/8472/", {
"created_at": "2019-05-22T10:32:36.118753Z",
"notified_at": null,
"claimed_at": null,
"verified_at": null
"verified_at": null,
"invitation_code": null
}
```

Expand Down Expand Up @@ -526,7 +534,7 @@ fetch("https://api.gigapay.se/v2/employees/1847/resend/", {
> The above command returns an empty response.


This endpoint resends an invitation. After resending, you need to wait at least 24 hours before resending again.
This endpoint resends a notification with an invitation code. After resending, you need to wait at least 24 hours before resending again.

### HTTP Request

Expand Down
3 changes: 2 additions & 1 deletion source/includes/_payouts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -450,7 +450,8 @@ fetch("https://api.gigapay.se/v2/payouts/?expand=employee", {
"created_at": "2019-05-22T10:32:36.118753Z",
"notified_at": null,
"claimed_at": null,
"verified_at": null
"verified_at": null,
"invitation_code": "ABCD1234"
},
"full_salary_specification": true,
"invoice": "c1554d88-b74f-4d6a-bfa6-049c14905dc7",
Expand Down
37 changes: 24 additions & 13 deletions source/index.html.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,8 @@ To change language set the `Accept-Language` header to your preferred language.
"created_at": "2019-05-20T15:33:08.974624Z",
"notified_at": "2019-05-20T15:33:12.581720Z",
"claimed_at": "2019-05-21T09:13:32.575721Z",
"verified_at": "2019-05-21T09:13:48.625263Z"
"verified_at": "2019-05-21T09:13:48.625263Z",
"invitation_code": null
}
```

Expand Down Expand Up @@ -221,8 +222,9 @@ Gigapay-Signature: t=1583327301,v1=ad583e2b2093c8d6fb3b65e04b99fc5988e98c0c31290
},
"created_at": "2019-05-20T15:33:08.974624Z",
"notified_at": "2019-05-20T15:33:12.581720Z",
"claimed_at": "2019-05-21T09:13:32.575721Z"
"verified_at": "2019-05-21T09:13:48.625263Z"
"claimed_at": "2019-05-21T09:13:32.575721Z",
"verified_at": "2019-05-21T09:13:48.625263Z",
"invitation_code": null
}
```

Expand Down Expand Up @@ -312,7 +314,7 @@ The only valid signature scheme is currently `v1`, which is the HMAC algorithm a

To verify signatures using the v1 scheme, extract the timestamp from the Gigapay-Signature header, and the JSON-encoded
notification from the request body. Join these strings with a period, `.`, as a separator. Compute an HMAC with the
SHA256 hash function using the Webhook’s secret key as the key. Lastly ensure that the signature in the header and the
SHA256 hash function using the Webhook's secret key as the key. Lastly ensure that the signature in the header and the
calculated signature matches.

# Errors
Expand Down Expand Up @@ -390,7 +392,8 @@ fetch("https://api.gigapay.se/v2/payouts/9472/?expand=employee", {
"created_at": "2019-05-22T10:32:36.118753Z",
"notified_at": null,
"claimed_at": null,
"verified_at": null
"verified_at": null,
"invitation_code": "ABCD1234"
},
"invoice": "c1554d88-b74f-4d6a-bfa6-049c14905dc7",
"invoiced_amount": "1000.00",
Expand Down Expand Up @@ -460,7 +463,8 @@ fetch("https://api.gigapay.se/v2/employees/?page_size=2&page=2", {
"created_at": "2019-05-20T15:33:08.974624Z",
"notified_at": "2019-05-20T15:33:12.581720Z",
"claimed_at": "2019-05-21T09:13:32.575721Z",
"verified_at": "2019-05-21T09:13:48.625263Z"
"verified_at": "2019-05-21T09:13:48.625263Z",
"invitation_code": null
},
{
"id": "25d2af38-59b9-4f73-9452-51787fed5c84",
Expand All @@ -473,7 +477,8 @@ fetch("https://api.gigapay.se/v2/employees/?page_size=2&page=2", {
"created_at": "2019-05-20T15:33:08.974624Z",
"notified_at": "2019-05-20T15:33:12.581720Z",
"claimed_at": null,
"verified_at": null
"verified_at": null,
"invitation_code": "ABCD1234"
}
]
}
Expand Down Expand Up @@ -586,7 +591,8 @@ fetch("https://api.gigapay.se/v2/employees/?search=skoog", {
"created_at": "2022-04-11T13:05:27.565954Z",
"notified_at": "2022-04-11T13:05:27.565954Z",
"claimed_at": "2022-04-11T13:05:27.565954Z",
"verified_at": "2022-04-11T14:05:27.565954Z"
"verified_at": "2022-04-11T14:05:27.565954Z",
"invitation_code": null
},
{
"id": "481c3138-5710-4086-9237-a082e87d624f",
Expand All @@ -598,7 +604,8 @@ fetch("https://api.gigapay.se/v2/employees/?search=skoog", {
"created_at": "2022-04-11T13:05:27.543935Z",
"notified_at": "2022-04-11T13:05:27.543935Z",
"claimed_at": "2022-04-11T13:05:27.543935Z",
"verified_at": "2022-04-11T14:05:27.543935Z"
"verified_at": "2022-04-11T14:05:27.543935Z",
"invitation_code": null
}
]
}
Expand Down Expand Up @@ -663,7 +670,8 @@ fetch("https://api.gigapay.se/v2/payouts/?search=skoog", {
"created_at": "2022-04-14T08:31:11.741713Z",
"notified_at": "2022-04-14T08:31:11.741713Z",
"claimed_at": "2022-04-14T08:31:11.741713Z",
"verified_at": "2022-04-14T09:31:11.741713Z"
"verified_at": "2022-04-14T09:31:11.741713Z",
"invitation_code": null
},
"invoice": "f4377884-e4c0-4e65-bbd1-24f52973b933",
"full_salary_specification": false
Expand Down Expand Up @@ -691,7 +699,8 @@ fetch("https://api.gigapay.se/v2/payouts/?search=skoog", {
"created_at": "2022-04-14T08:31:11.741713Z",
"notified_at": "2022-04-14T08:31:11.741713Z",
"claimed_at": "2022-04-14T08:31:11.741713Z",
"verified_at": "2022-04-14T09:31:11.741713Z"
"verified_at": "2022-04-14T09:31:11.741713Z",
"invitation_code": null
},
"invoice": "b749b0fd-a82a-4644-a7c8-e89ae891cc23",
"full_salary_specification": false
Expand Down Expand Up @@ -719,7 +728,8 @@ fetch("https://api.gigapay.se/v2/payouts/?search=skoog", {
"created_at": "2022-04-14T08:31:11.707438Z",
"notified_at": "2022-04-14T08:31:11.707438Z",
"claimed_at": "2022-04-14T08:31:11.707438Z",
"verified_at": "2022-04-14T09:31:11.707438Z"
"verified_at": "2022-04-14T09:31:11.707438Z",
"invitation_code": null
},
"invoice": "e5647953-4df7-4166-9066-f9dea11b66f3",
"full_salary_specification": false
Expand Down Expand Up @@ -896,7 +906,8 @@ fetch("https://api.gigapay.se/v2/employees/", {
"created_at": "2019-05-22T10:32:36.118753Z",
"notified_at": null,
"claimed_at": null,
"verified_at": null
"verified_at": null,
"invitation_code": "ABCD1234"
}
```

Expand Down