meteo/Sentri-docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

travel reimbursement documentation updated

Browse Source
This commit is contained in:
Marco Mooij | DigiState
2026-07-09 10:33:45 +02:00
parent 3bfccab663
commit 295b86a3c3
7 changed files with 73 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
API/v1/office/travel-reimburse/GET Travel reimbursement.md
View File

@@ -9,6 +9,8 @@ This will get travel reimbursement entries from the database.
#### Permissions required
`office-travel-reimburse` RO
>[!note]
>You can only get the travel reimbursements of your user.
#### Body parameters
| Parameter | Type | Required | Description |
| ---------------------- | ------ | -------- | ------------------------- |

15
API/v1/office/travel-reimburse/POST Travel reimbursement.md
View File

@@ -9,27 +9,30 @@ This API call adds a entry for the travel reimbursement
#### Permissions required
`office-travel-reimburse` RW
>[!note]
>You can only post the travel reimbursements on your user.
#### Body parameters
| Parameter | Type | Required | Description |
| -------------------- | ------- | --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| user_uuid | uuid | yes | Unique id of the user to add the reimbursement to |
| ----------------------------------- | ------- | --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| departure_postcode | string | yes | Postcode of the departure point |
| destination_postcode | string | yes | Postcode of the destination point |
| travel_date | date | yes | The date of the travel (YYYY-MM-DD) |
| travel_distance | integer | yes | The travel distance |
| travel_description | string | no | Description of the travel |
| company_uuid | uuid | yes, if customers module enabled | *Only when the Customers modules is enabled* The company uuid that the travel is linked to. Set the home/work travel company in system settings |
| company_name | string | yes, if customers module disabled | *Only when the Customers module is disabled* The that the travel is linked to. Set the home/work travel company in system settings |
| office_travelreimburse_company_uuid | uuid | yes, if customers module enabled | *Only when the Customers modules is enabled* The company uuid that the travel is linked to. Set the home/work travel company in system settings |
| office_travelreimburse_company_name | string | yes, if customers module disabled | *Only when the Customers module is disabled* The that the travel is linked to. Set the home/work travel company in system settings |
| homework | int | 1 or 0 | Set to 1 if the travel entry is home-work travel. |
### Example Body (json)
```json
{
"user_uuid": "5219edbb-512d-11f1-8bac-bc2411125ba4",
"departure_postcode": "3448BT",
"destination_postcode": "3433AA",
"travel_date": "2026-06-21",
"travel_distance": "56",
"travel_description": "Example description",
"company_uuid": "0f6a9c83-809b-4d54-8b16-a8197ac64ab4"
"office_travelreimburse_company_uuid": "0f6a9c83-809b-4d54-8b16-a8197ac64ab4",
"homework": 1
}
```

13
API/v1/office/travel-reimburse/PUT Travel reimbursement.md
View File

@@ -9,28 +9,33 @@ This PUT modifies an existing reimbursement item.
#### Permissions required
`office-travel-reimburse` RW
>[!note]
>You can only update the travel reimbursements on your user.
#### Body parameters
| Parameter | Type | Required | Description |
| -------------------- | ------- | -------- | -------------------------------------------------------------- |
| ----------------------------------- | ------- | --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| reimburse_uuid | uuid | yes | Unique id of the reimburse to edit |
| departure_postcode | string | yes | Postcode of the departure point |
| destination_postcode | string | yes | Postcode of the destination point |
| travel_date | date | yes | The date of the travel (YYYY-MM-DD) |
| travel_distance | integer | yes | The travel distance |
| travel_description | string | no | Description of the travel |
| company_uuid | uuid | no | The company uuid if the travel is linked to a certain company. |
| office_travelreimburse_company_uuid | uuid | yes, if customers module enabled | *Only when the Customers modules is enabled* The company uuid that the travel is linked to. Set the home/work travel company in system settings |
| office_travelreimburse_company_name | string | yes, if customers module disabled | *Only when the Customers module is disabled* The that the travel is linked to. Set the home/work travel company in system settings |
| homework | int | 1 or 0 | Set to 1 if the travel entry is home-work travel. |
### Example Body (json)
```json
{
"reimburse_uuid": "1c0b5323-6d79-11f1-8c62-bc2411125ba4",
"user_uuid": "5219edbb-512d-11f1-8bac-bc2411125ba4",
"departure_postcode": "3448BT",
"destination_postcode": "3433AA",
"travel_date": "2026-06-21",
"travel_distance": "56",
"travel_description": "Example description",
"company_uuid": "0f6a9c83-809b-4d54-8b16-a8197ac64ab4"
"office_travelreimburse_company_uuid": "0f6a9c83-809b-4d54-8b16-a8197ac64ab4",
"homework": 1
}
```

5
API/v1/office/travel-reimburse/configure/PUT Global travel reimbursements settings.md
View File

@@ -16,8 +16,6 @@ This PUT call configures the global Sentri settings for the Travel reimbursement
| office_travelreimburse_cents_homework_excl | int | yes | The cents per km for home/work travel with taxes excluded. |
| office_travelreimburse_cents_business_incl | int | yes | The cents per km for business travel with taxes included. |
| office_travelreimburse_cents_business_excl | int | yes | The cents per km for business travel with taxes excluded. |
| office_travelreimburse_howework_company_uuid | uuid | yes, if customers module enabled | *Only when the Customers modules is enabled* The company uuid that the travel is linked to. Set the home/work travel company in system settings |
| office_travelreimburse_howework_company_name | string | yes, if customers module disabled | *Only when the Customers module is disabled* The that the travel is linked to. Set the home/work travel company in system settings |
### Example Body (json)
```json
@@ -26,8 +24,7 @@ This PUT call configures the global Sentri settings for the Travel reimbursement
"office_travelreimburse_cents_homework_incl": 23,
"office_travelreimburse_cents_homework_excl": 23,
"office_travelreimburse_cents_business_incl": 23,
"office_travelreimburse_cents_business_excl": 23,
office_travelreimburse_howework_company_uuid: "0f6a9c83-809b-4d54-8b16-a8197ac64ab4"
"office_travelreimburse_cents_business_excl": 23
}
```

27
Modules/Office/Travel Reimbursement.md
View File

@@ -0,0 +1,27 @@
# Travel Reimbursement
The travel reimbursement feature allows users to enter information about the distance they have traveled, enabling the system to calculate and send an reimburse invoice of the associated travel costs to the user.
Users can open a calendar month and set their default travel information. By clicking on a day in the calendar, users can create a travel entry. These travel entries are then aggregated, and the total travel costs are calculated based on the cost settings configured by the administrator.
## Using Travel Reimbursement
Permissions required: `office-travel-reimburse` RW.
To use travel reimbursement, navigate to _Travel Reimbursement_ and configure your default travel information above the calendar. These defaults will be applied automatically when creating new travel entries. Click **Save** to store the defaults for future use.
To create a travel entry, click on the date for which you want to add a travel reimbursement. Multiple travel entries can be added to the same day. Click on an existing entry to edit its details, such as adding a description. From the same menu, you can also choose to delete the entry.
To send the invoice, click the **Mail travel reimbursement** button below the calendar. The invoice will be send to your email address.
## Configuring Travel Reimbursement
Permissions required: `admin-portalsettings` RW.
To configure the travel Travel Reimbursement settings go to *portal-management* > *Modules* > *configure Office* > *Travel Reimbursement*.
Here you can configure the following:
- Cents per/km home-work incl. VAT
- Cents per/km home-work excl. VAT
- Cents per/km business incl. VAT
- Cents per/km business excl. VAT

6
Release notes.md
View File

@@ -14,6 +14,12 @@
- [b31185c2e9](https://gitea.mooij.me/meteo/Sentri/commit/b31185c2e92945fa06ca223d6b0ac95b5cd1180d) Login without username/password now shows error on login page.
- [f94bafb25d](https://gitea.mooij.me/meteo/Sentri/commit/f94bafb25dd1ba17ba59b5114a9b0dff6d687f8c) Server overview wont hide last modify column.
- [fa3515625b](https://gitea.mooij.me/meteo/Sentri/commit/fa3515625b7ff5e80e3737c5feb5fbcd7a2b6cbe) No response toast anymore when saving something
### Known issues
- Problem with deleting the last travel imbursement of the month. Caused by Fullcalendar.js error.
- Error in posting server data when server_state is not given.
- Return url of portal-management forms still go to /systemconfig/.
## v.1.2.4
`21-06-2026`

6
index.md
View File

@@ -1,4 +1,5 @@
# Welcome to the Sentri docs!
>[!note]
>The making of the this documentation is still in progress.
# What is Sentri
@@ -18,7 +19,12 @@ The following CRM customer sources are currently available:
- [[Inserve|Inserve]]
## Module: Office
### Stompjes
This module currently provides a feature that lets you “stomp” a colleague. It can be used to keep track of things such as counting your mom jokes or other actions between team members. These events are counted and visualized through a simple graph.
### Travel reimbursement
Another feature is the travel reimbursement feature. This allows users to enter information about the distance they have traveled, enabling the system to calculate and send an reimburse invoice of the associated travel costs to the user.
## Module: Servers
The Servers module is designed to help you keep track of all servers you manage. It centralizes key information such as assigned resources, configured backups, used licenses, and more.