Org Rate Config Repository
API Contract
REST
/api/v1/org-rate-configs
5 endpoints
GET
/api/v1/org-rate-configs/api/v1/org-rate-configs
List rate configurations across all organisations (admin view).
Public
Response Example
{
"data": [
{
"org_id": "org_xyz789",
"rate_per_km": 0.45,
"approval_threshold_km": 50,
"currency": "EUR",
"locale": "en-IE",
"effective_from": "2026-01-01",
"updated_at": "2026-01-15T10:00:00Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 1
}
}
GET
/api/v1/org-rate-configs/api/v1/org-rate-configs/:orgId
Fetch the active rate configuration for a specific organisation.
Public
Response Example
{
"org_id": "org_xyz789",
"rate_per_km": 0.45,
"approval_threshold_km": 50,
"currency": "EUR",
"locale": "en-IE",
"effective_from": "2026-01-01",
"updated_at": "2026-01-15T10:00:00Z"
}
POST
/api/v1/org-rate-configs/api/v1/org-rate-configs
Create a new org rate configuration.
Public
Request Example
{
"org_id": "org_xyz789",
"rate_per_km": 0.45,
"approval_threshold_km": 50,
"currency": "EUR",
"locale": "en-IE",
"effective_from": "2026-01-01"
}
Response Example
{
"org_id": "org_xyz789",
"rate_per_km": 0.45,
"approval_threshold_km": 50,
"currency": "EUR",
"locale": "en-IE",
"effective_from": "2026-01-01",
"updated_at": "2026-03-25T10:00:00Z"
}
PUT
/api/v1/org-rate-configs/api/v1/org-rate-configs/:orgId
Update an org's rate or approval threshold (e.g. new mileage rate from April).
Public
Request Example
{
"rate_per_km": 0.48,
"approval_threshold_km": 60,
"effective_from": "2026-04-01"
}
Response Example
{
"org_id": "org_xyz789",
"rate_per_km": 0.48,
"approval_threshold_km": 60,
"currency": "EUR",
"locale": "en-IE",
"effective_from": "2026-04-01",
"updated_at": "2026-03-25T11:30:00Z"
}
DELETE
/api/v1/org-rate-configs/api/v1/org-rate-configs/:orgId
Remove an org's rate configuration (use with caution — blocks claim submission for that org).
Public
Response Example
{
"org_id": "org_xyz789",
"deleted": true,
"deleted_at": "2026-03-25T16:00:00Z"
}