ExpensesGet a mileage rate

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"
{
  "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"
    }
  ]
}
GET
/v1/mileage-rate/{mileageRateID}
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

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.

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

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

header
Authorizationstring
Required

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

mileageRateIDinteger
Required

Integer ID of the rate (MileageRateRead.MileageRateID).

Refers to MileageRateRead.MileageRateID. Look up valid values with GET /v1/mileage-rate.

Responses

Propertiesobject

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.

Linksarray
Actionsobject[]