Skip to content

Mileage Reimbursements — Proposed Guide

Planned API — Reference Only

Mileage Reimbursements: A mileage claim would document distance, trip purpose and a proposed rate basis. Creating a claim is separate from validating…

Overview

A mileage claim would document distance, trip purpose and a proposed rate basis. Creating a claim is separate from validating eligibility, approving it or paying it.

Key concepts

Use an explicit distance unit, trip date and policy reference. Document how rate precision and monetary rounding are handled.

Implementation considerations

No rate is promised and no reimbursement occurs. Avoid publishing detailed personal travel locations beyond the approved finance use case.

Proposed API behavior

POST /v1/fleet/mileage-claims is an illustrative design for this topic. Path and field names may change before implementation. Access would require an authorized organization context and operation-specific permission; no public API or authorization grant is available here.

Illustrative request fields
NameTypeDescription
user_idstringStable fictional user reference; not a secret and not evidence that a resource exists.
vehicle_idstringStable fictional vehicle reference; not a secret and not evidence that a resource exists.
distancenumberSynthetic trip distance interpreted using distance_unit.
distance_unitstringDistance unit kept explicit to prevent mile/kilometer conversion errors.
incurred_onstring (date)Synthetic calendar date in YYYY-MM-DD form; period inclusivity must be defined by the future contract.
policy_idstringStable fictional policy reference; not a secret and not evidence that a resource exists.

Static example requests

Proposed, non-executing request examples
# Proposed request text only; this reserved host is not a live API.
curl -X POST 'https://api.remizen.example/v1/fleet/mileage-claims' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{
  "user_id": "usr_example_123",
  "vehicle_id": "veh_example_123",
  "distance": 18.5,
  "distance_unit": "mile",
  "incurred_on": "2026-01-15",
  "policy_id": "policy_example_123"
}'

Fictional response example

201 (proposed example)Static response fixture

Fictional documentation data only. No request was sent, record created, review performed, payment initiated or provider connection activated.

JSON
{
  "data": {
    "vehicle_id": "veh_example_123",
    "distance": 18.5,
    "distance_unit": "mile",
    "incurred_on": "2026-01-15",
    "policy_id": "policy_example_123",
    "id": "fleet_example_123",
    "organization_id": "org_example_123"
  },
  "meta": {
    "request_id": "req_example_123",
    "reference_only": true
  }
}

Illustrative error case

Review this failure case in context: No rate is promised and no reimbursement occurs. Avoid publishing detailed personal travel locations beyond the approved finance use case.

422 (illustrative; final error contracts are undecided)Proposed error fixture

Synthetic diagnostic example. Human-readable messages must not be used as stable programmatic contracts.

JSON
{
  "error": {
    "code": "validation_error",
    "message": "The proposed mileage reimbursements operation requires review of its input or authorization.",
    "request_id": "req_example_123"
  }
}

Proposed data types

Illustrative field dictionary
NameTypeDescription
user_idstringStable fictional user reference; not a secret and not evidence that a resource exists.
vehicle_idstringStable fictional vehicle reference; not a secret and not evidence that a resource exists.
distancenumberSynthetic trip distance interpreted using distance_unit.
distance_unitstringDistance unit kept explicit to prevent mile/kilometer conversion errors.
incurred_onstring (date)Synthetic calendar date in YYYY-MM-DD form; period inclusivity must be defined by the future contract.
policy_idstringStable fictional policy reference; not a secret and not evidence that a resource exists.