68 lines
3.4 KiB
Markdown
68 lines
3.4 KiB
Markdown
# POST Travel reimbursement
|
|
This API call adds a entry for the travel reimbursement
|
|
|
|
#### Location
|
|
```
|
|
/api/v1/office/travel-reimburse/
|
|
```
|
|
|
|
#### Permissions required
|
|
`office-travel-reimburse` RW
|
|
|
|
#### 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 |
|
|
### 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"
|
|
}
|
|
```
|
|
|
|
### Example Request
|
|
```php
|
|
$curl = curl_init();
|
|
|
|
curl_setopt_array($curl, [
|
|
CURLOPT_URL => $baseUrl . '/api/v1/office/travel-reimburse/',
|
|
CURLOPT_RETURNTRANSFER => true,
|
|
CURLOPT_POST => true,
|
|
CURLOPT_POSTFIELDS => $json_payload,
|
|
CURLOPT_HTTPHEADER => [
|
|
'Authorization: Bearer ' . $token,
|
|
'Content-Type: application/json',
|
|
],
|
|
]);
|
|
|
|
$response = curl_exec($curl);
|
|
$httpCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);
|
|
|
|
if ($response === false) {
|
|
echo curl_error($curl);
|
|
}
|
|
|
|
curl_close($curl);
|
|
```
|
|
|
|
### Example Response
|
|
```json
|
|
"Travel reimburse added."
|
|
```
|
|
|
|
#### Known errors or issues.
|
|
None are known at the time
|
|
If you do encounter issues and get an http code in return, check the response codes on this page. |