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 |
| ---------------------- | ------ | -------- | ------------------------- |

27
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 |
| Parameter | Type | Required | Description |
| ----------------------------------- | ------- | --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| 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 |
| 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
}
```

27
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. |
| 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 |
| 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
}
```