Get a mileage rate
Returns one mileage rate's configuration by its integer ID — any legal entity, active or inactive.
Resolves the MileageRateID of a mileage registration to its name, unit, reimbursement currency, salary codes and finance account. Unlike the list, there is no legal-entity or active filter. The rate amounts (per-unit cost, sales price, reimbursement) are not part of the response — see GET /v1/mileage-rate.
Use it to:
- Resolve MileageRateID on a mileage registration for payroll export (SalaryCodeTaxFree / SalaryCodeTaxable)
Not for:
- Rate amounts per km (not exposed)
Behaviour:
- Idempotent.
- Safe to retry.
- Changes are visible to the next read immediately.
Call first: GET /v1/mileage-rate
See also: GET /v1/mileage-registration/{mileageRegistrationID}
curl -X GET "https://app3.timelog.com/your-account/api/v1/mileage-rate/123" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://app3.timelog.com/your-account/api/v1/mileage-rate/123"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://app3.timelog.com/your-account/api/v1/mileage-rate/123", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://app3.timelog.com/your-account/api/v1/mileage-rate/123", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://app3.timelog.com/your-account/api/v1/mileage-rate/123')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
response = http.request(request)
puts response.body
{
"Properties": {
"ID": "55155105-2780-4969-abfd-80f6cfd59b0c",
"MileageRateID": 1,
"Name": "Default mileage rate",
"IsActive": true,
"SalaryCodeTaxFree": "",
"SalaryCodeTaxable": null,
"AccountNumber": "123456",
"IsDefaultForPrivateCar": false,
"HasReimbursement": false,
"UnitType": 1,
"ReimbursementCurrencyID": 9,
"LegalEntityID": 1
},
"Links": [
{
"Href": "https://app{server-number}.timelog.com/{account}/api/v1/mileage-rate/1",
"Rel": "self"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
{
"Code": 100,
"Details": [],
"Message": "Unknown error occur in system, please contact system administrator.",
"Parameters": "mileageRateID: 99999999",
"Url": "https://app{server-number}.timelog.com/{account}/api/v1/mileage-rate/99999999"
}
/v1/mileage-rate/{mileageRateID}Target server for requests. Edit to use your own host.
OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. JWT and reference tokens are both accepted. The token must carry the required scope (default tlp).
The token's sub claim is the acting user. A token WITHOUT sub (client-credentials) acts as the system service user. If the sub user cannot log in (inactive, locked, deleted), the request is rejected with 401 — it is no longer let through without a user.
> Not yet documented: how to obtain a token.
> Not yet documented: token lifetime.
Authorization: Bearer <token>. JWT and reference tokens are both accepted. The token must carry the required scope (default tlp).
The token's sub claim is the acting user. A token WITHOUT sub (client-credentials) acts as the system service user. If the sub user cannot log in (inactive, locked, deleted), the request is rejected with 401 — it is no longer let through without a user.
> Not yet documented: how to obtain a token.
> Not yet documented: token lifetime.Integer ID of the rate (MileageRateRead.MileageRateID).
Refers to MileageRateRead.MileageRateID. Look up valid values with GET /v1/mileage-rate.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. JWT and reference tokens are both accepted. The token must carry the required scope (default tlp).
The token's sub claim is the acting user. A token WITHOUT sub (client-credentials) acts as the system service user. If the sub user cannot log in (inactive, locked, deleted), the request is rejected with 401 — it is no longer let through without a user.
Not yet documented: how to obtain a token.
Not yet documented: token lifetime.
Path Parameters
Integer ID of the rate (MileageRateRead.MileageRateID).
Refers to MileageRateRead.MileageRateID. Look up valid values with GET /v1/mileage-rate.
Responses
A mileage rate's configuration: name, distance unit, reimbursement currency, finance account and payroll codes, and whether it is reimbursed and preselected for private cars. A rate belongs to ONE legal entity. The per-unit amounts (cost, sales price, reimbursement, tax-free share) are effective-dated rate periods that this model does not carry — TimeLog applies the period covering the trip date when a mileage registration is saved.
Not yet documented: description.