travel reimbursement documentation updated
This commit is contained in:
@@ -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
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user