{"openapi":"3.1.0","info":{"title":"GET /api/v1/mileage","version":"1.0.0","description":"List mileage trips"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/mileage":{"get":{"tags":["mileage"],"summary":"List mileage trips","description":"Trips with totals, optionally filtered by year, dates, customer, project or billable.","operationId":"list_mileage_trips","parameters":[{"name":"year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Calendar year.","title":"Year"},"description":"Calendar year."},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date From"}},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date To"}},{"name":"customer_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id"}},{"name":"project_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project Id"}},{"name":"billable","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Billable"}},{"name":"include_inactive","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Inactive"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_MileageTripsListResponse_"}}}},"401":{"description":"Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business","content":{"application/json":{"example":{"error":"unauthorized","message":"Authentication required","code":"AUTH_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"error":"forbidden","message":"You don't have permission to access this resource","code":"AUTH_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"validation_error","message":"Validation failed: amount: Input should be a valid integer","errors":{"amount":"Input should be a valid integer"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}}},"x-fastapi-operation-id":"list_mileage_trips_api_v1_mileage_get"}}},"components":{"schemas":{"MileageTotals":{"properties":{"trip_count":{"type":"integer","title":"Trip Count","default":0},"total_miles":{"type":"number","title":"Total Miles","default":0},"billable_miles":{"type":"number","title":"Billable Miles","default":0},"total_deductible":{"type":"integer","title":"Total Deductible","description":"Cents.","default":0},"unposted_deductible":{"type":"integer","title":"Unposted Deductible","description":"Cents on trips not yet on a report or posted.","default":0}},"type":"object","title":"MileageTotals","description":"Roll-up of the trips matching the current filters."},"MileageTripResponse":{"properties":{"id":{"type":"string","title":"Id"},"business_id":{"type":"string","title":"Business Id"},"trip_date":{"type":"string","format":"date","title":"Trip Date"},"miles":{"type":"number","title":"Miles"},"purpose":{"type":"string","title":"Purpose"},"start_location":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Location"},"end_location":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Location"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id"},"customer_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Name"},"project_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project Id"},"project_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project Name"},"class_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Class Id"},"billable":{"type":"boolean","title":"Billable"},"rate_cents_per_mile":{"type":"number","title":"Rate Cents Per Mile"},"deductible_amount":{"type":"integer","title":"Deductible Amount","description":"Deductible amount in cents.","default":0},"status":{"type":"string","title":"Status","description":"open, on_report or posted."},"expense_report_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Expense Report Id"},"journal_entry_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Journal Entry Id"},"posted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Posted At"},"is_active":{"type":"boolean","title":"Is Active"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","business_id","trip_date","miles","purpose","billable","rate_cents_per_mile","status","is_active","created_at","updated_at"],"title":"MileageTripResponse","description":"A trip with its computed deductible amount and booking state."},"MileageTripsListResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/MileageTripResponse"},"type":"array","title":"Items"},"totals":{"$ref":"#/components/schemas/MileageTotals"}},"type":"object","required":["items","totals"],"title":"MileageTripsListResponse","description":"Trips plus totals for the same filter set."},"SuccessEnvelope_MileageTripsListResponse_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/MileageTripsListResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[MileageTripsListResponse]"},"ErrorResponse":{"title":"ErrorResponse","type":"object","description":"Envelope returned by every non-2xx response. Branch on `code` (stable) rather than `message` (human-readable, may change).","required":["error","message","code"],"properties":{"error":{"type":"string","description":"Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`."},"message":{"type":"string","description":"Human-readable explanation, safe to show to end users."},"code":{"type":"string","description":"Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`)."},"request_id":{"type":"string","description":"Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied."},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"Field-level validation messages keyed by field name. Present on 400/422 validation failures only."}}}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}