openapi: 3.2.0 info: description: Rollee Company API allows to use our services with a REST API title: Company Fleet endpoints API contact: {} version: '0.5' servers: - url: https://api.getrollee.com/api/company/v0.5 tags: - name: Fleet endpoints paths: /company_accounts/{id}/activity: get: description: Get activity informations of a company account tags: - Fleet endpoints summary: Get company activity parameters: - description: company id name: id in: path required: true schema: type: string - description: user account id, if we are interested on a specific user name: user_account in: query schema: type: string - description: query data filtering by a date range that starts at this time (unix timestamp). The default value is 30 days ago. name: start_date in: query schema: type: number - description: query data filtering by a date range that ends at this time (unix timestamp). The default value is the current day. name: end_date in: query schema: type: number - description: Bearer name: Authorization in: header required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/models.AccountActivityResponseStruct' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/models.ServerError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/models.ServerError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/models.ServerError' operationId: getCompanyAccountsByIdActivity x-operation-id-source: derived /company_accounts/{id}/banking_info: get: description: Get bank informations of a company account tags: - Fleet endpoints summary: Get company banking_info parameters: - description: company id name: id in: path required: true schema: type: string - description: user account id, if we are interested on a specific user name: user_account in: query schema: type: string - description: query data filtering by a date range that starts at this time (unix timestamp). The default value is 30 days ago. name: start_date in: query schema: type: number - description: query data filtering by a date range that ends at this time (unix timestamp). The default value is the current day. name: end_date in: query schema: type: number - description: Bearer name: Authorization in: header required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/models.CompanyAccountsBanking' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/models.ServerError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/models.ServerError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/models.ServerError' operationId: getCompanyAccountsByIdBankingInfo x-operation-id-source: derived /company_accounts/{id}/documents: get: description: Get documents of a company account. All user documents are contained in a single list tags: - Fleet endpoints summary: Get company documents parameters: - description: company id name: id in: path required: true schema: type: string - description: Bearer name: Authorization in: header required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/models.CompanyAccountsDocuments' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/models.ServerError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/models.ServerError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/models.ServerError' operationId: getCompanyAccountsByIdDocuments x-operation-id-source: derived /company_accounts/{id}/employment: get: description: Get employment informations of a company account tags: - Fleet endpoints summary: Get company employments parameters: - description: company id name: id in: path required: true schema: type: string - description: user account id, if we are interested on a specific user name: user_account in: query schema: type: string - description: query data filtering by a date range that starts at this time (unix timestamp). The default value is 30 days ago. name: start_date in: query schema: type: number - description: query data filtering by a date range that ends at this time (unix timestamp). The default value is the current day. name: end_date in: query schema: type: number - description: Bearer name: Authorization in: header required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/models.CompanyAccountsEmployment' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/models.ServerError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/models.ServerError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/models.ServerError' operationId: getCompanyAccountsByIdEmployment x-operation-id-source: derived /company_accounts/{id}/income: get: description: Get income informations of a company account tags: - Fleet endpoints summary: Get company income parameters: - description: company id name: id in: path required: true schema: type: string - description: user account id, if we are interested on a specific user name: user_account in: query schema: type: string - description: query data filtering by a date range that starts at this time (unix timestamp). The default value is 30 days ago. name: start_date in: query schema: type: number - description: query data filtering by a date range that ends at this time (unix timestamp). The default value is the current day. name: end_date in: query schema: type: number - description: Bearer name: Authorization in: header required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/models.AccountIncomeResponseStruct' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/models.ServerError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/models.ServerError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/models.ServerError' operationId: getCompanyAccountsByIdIncome x-operation-id-source: derived /company_accounts/{id}/performance: get: description: Get performance informations of a company account tags: - Fleet endpoints summary: Get company performance parameters: - description: company id name: id in: path required: true schema: type: string - description: user account id, if we are interested on a specific user name: user_account in: query schema: type: string - description: query data filtering by a date range that starts at this time (unix timestamp). The default value is 30 days ago. name: start_date in: query schema: type: number - description: query data filtering by a date range that ends at this time (unix timestamp). The default value is the current day. name: end_date in: query schema: type: number - description: Bearer name: Authorization in: header required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/models.CompanyAccountsPerformance' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/models.ServerError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/models.ServerError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/models.ServerError' operationId: getCompanyAccountsByIdPerformance x-operation-id-source: derived /company_accounts/{id}/profiles: get: description: Get profile informations of a company account tags: - Fleet endpoints summary: Get company profiles parameters: - description: company id name: id in: path required: true schema: type: string - description: user account id, if we are interested on a specific user name: user_account in: query schema: type: string - description: query data filtering by a date range that starts at this time (unix timestamp). The default value is 30 days ago. name: start_date in: query schema: type: number - description: query data filtering by a date range that ends at this time (unix timestamp). The default value is the current day. name: end_date in: query schema: type: number - description: Bearer name: Authorization in: header required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/models.CompanyAccountsProfiles' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/models.ServerError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/models.ServerError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/models.ServerError' operationId: getCompanyAccountsByIdProfiles x-operation-id-source: derived /company_accounts/{id}/trips: get: description: Get trips of a company account tags: - Fleet endpoints summary: Get company trips parameters: - description: company id name: id in: path required: true schema: type: string - description: user account id, if we are interested on a specific user name: user_account in: query schema: type: string - description: query data filtering by a date range that starts at this time (unix timestamp). The default value is 30 days ago. name: start_date in: query schema: type: number - description: query data filtering by a date range that ends at this time (unix timestamp). The default value is the current day. name: end_date in: query schema: type: number - description: Bearer name: Authorization in: header required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/models.CompanyAccountsTrips' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/models.ServerError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/models.ServerError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/models.ServerError' operationId: getCompanyAccountsByIdTrips x-operation-id-source: derived /company_accounts/{id}/vehicles: get: description: Get vehicles informations of a company account tags: - Fleet endpoints summary: Get company vehicles parameters: - description: company id name: id in: path required: true schema: type: string - description: user account id, if we are interested on a specific user name: user_account in: query schema: type: string - description: query data filtering by a date range that starts at this time (unix timestamp). The default value is 30 days ago. name: start_date in: query schema: type: number - description: query data filtering by a date range that ends at this time (unix timestamp). The default value is the current day. name: end_date in: query schema: type: number - description: Bearer name: Authorization in: header required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/models.CompanyAccountsVehicles' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/models.ServerError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/models.ServerError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/models.ServerError' operationId: getCompanyAccountsByIdVehicles x-operation-id-source: derived /company_accounts/{id}/wallet: get: description: Get wallet informations of a company account tags: - Fleet endpoints summary: Get company wallet parameters: - description: company id name: id in: path required: true schema: type: string - description: user account id, if we are interested on a specific user name: user_account in: query schema: type: string - description: query data filtering by a date range that starts at this time (unix timestamp). The default value is 30 days ago. name: start_date in: query schema: type: number - description: query data filtering by a date range that ends at this time (unix timestamp). The default value is the current day. name: end_date in: query schema: type: number - description: Bearer name: Authorization in: header required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/models.CompanyAccountsWallet' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/models.ServerError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/models.ServerError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/models.ServerError' operationId: getCompanyAccountsByIdWallet x-operation-id-source: derived components: schemas: std_models.Time20060102150405: type: object properties: inner: type: string handlers.AccountDataResponse-array_std_models_Vehicle: type: object properties: endpoint_data: type: array items: type: array items: $ref: '#/components/schemas/std_models.Vehicle' user_account_id: type: string user_id: type: string handlers.AccountDataResponse-std_models_Document: type: object properties: endpoint_data: type: array items: $ref: '#/components/schemas/std_models.Document' user_account_id: type: string user_id: type: string handlers.AccountDataResponse-std_models_BankAccount: type: object properties: endpoint_data: type: array items: $ref: '#/components/schemas/std_models.BankAccount' user_account_id: type: string user_id: type: string std_models.Vehicle: type: object properties: color: type: string license_plate: type: string make: type: string model: type: string status: type: string vehicle_type: type: string vin: type: string year: type: integer std_models.Document: type: object properties: data: $ref: '#/components/schemas/models.Metadata' document_date: type: string document_expire_date: type: string document_id: type: string document_name: type: string document_number: type: string document_type: type: string issued_date: type: string link: type: string retrieved_date: type: string std_models.PeriodType: type: string enum: - daily - weekly - monthly - yearly - custom x-enum-varnames: - Daily - Weekly - Monthly - Yearly - Custom handlers.AccountDataResponse-std_models_Trip: type: object properties: endpoint_data: type: array items: $ref: '#/components/schemas/std_models.Trip' user_account_id: type: string user_id: type: string handlers.AccountDataResponse-std_models_Performance: type: object properties: endpoint_data: type: array items: $ref: '#/components/schemas/std_models.Performance' user_account_id: type: string user_id: type: string std_models.TripDuration: type: object properties: hours: type: integer inner: type: integer minutes: type: integer seconds: type: integer models.Metadata: type: object additionalProperties: {} models.CompanyAccountsVehicles: type: object properties: size: type: integer users_data: type: array items: $ref: '#/components/schemas/handlers.AccountDataResponse-array_std_models_Vehicle' std_models.Employment: type: object properties: contract_type: type: string currency: type: string duration_days: type: integer employment_type: type: string end_date: description: of format YYYY-MM-DD type: string income: type: number income_description: type: string organization_address: type: string organization_fiscal_id: type: string organization_name: type: string organization_sector: type: string retrieved_date: type: string start_date: description: 'of format "YYYY-MM-DD" # !TODO ?' type: string status: type: string title: type: string worker_id: type: string handlers.AccountDataResponse-std_models_Employment: type: object properties: endpoint_data: type: array items: $ref: '#/components/schemas/std_models.Employment' user_account_id: type: string user_id: type: string handlers.ActivityResponse: type: object properties: daily: type: array items: $ref: '#/components/schemas/std_models.Activity' monthly: type: array items: $ref: '#/components/schemas/std_models.Activity' user_account_id: type: string user_id: type: string weekly: type: array items: $ref: '#/components/schemas/std_models.Activity' handlers.AccountSingleDataResponse-std_models_Profile: type: object properties: endpoint_data: $ref: '#/components/schemas/std_models.Profile' user_account_id: type: string user_id: type: string models.AccountIncomeResponseStruct: type: object properties: size: type: integer users_data: type: array items: $ref: '#/components/schemas/handlers.IncomeResponse' std_models.JSON: type: object additionalProperties: {} models.CompanyAccountsWallet: type: object properties: size: type: integer users_data: type: array items: $ref: '#/components/schemas/handlers.AccountDataResponse-std_models_Wallet' std_models.Activity: type: object properties: acceptance_rate: type: number afternoon_trips_total: type: number afternoon_trips_total_perc: type: number cancellation_rate: type: number currency: type: string distance_per_trip: type: number distance_total: type: number hours_most_active: type: string morning_trips_total: type: number morning_trips_total_perc: type: number night_trips_total: type: number night_trips_total_perc: type: number online_duration: description: of format "HHMMSS" or "DD days, HHMMSS" type: string organization_id: type: string organization_name: type: string price_per_driving_hour: type: number price_per_km: type: number price_per_online_hour: description: deprecated type: number price_per_trip: type: number price_total: type: number ranking_average: type: number ranking_average_global: type: number time_on_trips: type: string time_period_end_date: $ref: '#/components/schemas/std_models.Time20060102' time_period_start_date: description: of format "YYYY-MM-DD" not null allOf: - $ref: '#/components/schemas/std_models.Time20060102' time_period_type: description: ', on of [daily, weekly, monthly, yearly, custom] not null' allOf: - $ref: '#/components/schemas/std_models.PeriodType' trips_per_hour: type: number trips_total: type: integer models.CompanyAccountsPerformance: type: object properties: size: type: integer users_data: type: array items: $ref: '#/components/schemas/handlers.AccountDataResponse-std_models_Performance' models.CompanyAccountsBanking: type: object properties: size: type: integer users_data: type: array items: $ref: '#/components/schemas/handlers.AccountDataResponse-std_models_BankAccount' dyndpoint.DynamicDataPointResult: type: object properties: error: type: string name: type: string result: type: string models.CompanyAccountsProfiles: type: object properties: size: type: integer users_data: type: array items: $ref: '#/components/schemas/handlers.AccountSingleDataResponse-std_models_Profile' handlers.AccountDataResponse-std_models_Wallet: type: object properties: endpoint_data: type: array items: $ref: '#/components/schemas/std_models.Wallet' user_account_id: type: string user_id: type: string models.AccountActivityResponseStruct: type: object properties: size: type: integer users_data: type: array items: $ref: '#/components/schemas/handlers.ActivityResponse' models.CompanyAccountsDocuments: type: object properties: size: type: integer users_data: type: array items: $ref: '#/components/schemas/handlers.AccountDataResponse-std_models_Document' std_models.Profile: type: object properties: birth_country: type: string birth_place: type: string birth_postal_code: type: string city: type: string country: type: string country_phone_code: type: string date_of_birth: type: string driver_rating: type: number email: type: string first_name: type: string fiscal_id: type: string full_name: type: string gender: type: string last_name: type: string licence_expire_dt: type: string licence_number: type: string marital_status: type: string married_name: type: string nationality: type: string number_of_dependents: type: integer personal_public_service_number: type: string phone: type: string social_security_number: type: string state: type: string street: type: string subscription_date: type: string url: type: string zip: type: string models.CompanyAccountsTrips: type: object properties: size: type: integer users_data: type: array items: $ref: '#/components/schemas/handlers.AccountDataResponse-std_models_Trip' std_models.Wallet: type: object properties: balance: type: number currency: type: string retrieved_ts: description: of format "YYYY-MM-DD HH:MM:SS" allOf: - $ref: '#/components/schemas/std_models.Time20060102150405' retrieved_tz: type: string std_models.Income: type: object properties: advertisement_bonus: type: number airport_surcharge: type: number bonus_amount: type: number bonus_amount_details: $ref: '#/components/schemas/std_models.JSON' cancellation_fee: type: number card_earnings: type: number cash_earnings: type: number contribution_base: type: number contribution_days: type: number currency: type: string dynamic_data_points: type: array items: $ref: '#/components/schemas/dyndpoint.DynamicDataPointResult' earnings_guarantee: type: number earnings_info: type: string electric_mobility_fee: type: number employer_fiscal_id: type: string employment_classification: type: string employment_subtype: type: string employment_type: type: string expenses: type: number fare: type: number french_gross_earnings: type: number gross_earnings: type: number gross_fare: type: number income_tax_basis: type: string income_tax_paid: type: number kept_by_uber: type: number material_fee: type: number net_amount: type: number net_amount_after_vat: type: number net_fare: type: number net_income_details: $ref: '#/components/schemas/std_models.JSON' ni_paid: type: number organization_id: type: string organization_name: type: string other_amount: type: number other_fees: type: number pay_frequency: type: string payouts: type: number platform_fee: type: number reimbursements: type: number rider_fare: type: number social_net_amount: type: number tax_rate: type: number tax_year: type: number taxes: type: number time_period_start_date: description: of format "YYYY-MM-DD" allOf: - $ref: '#/components/schemas/std_models.Time20060102' time_period_type: description: ', one of [daily, weekly, monthly, yearly, custom]' allOf: - $ref: '#/components/schemas/std_models.PeriodType' tips: type: number tolls: type: number usc_status: type: string variable_amount: type: number waiting_time_fee: type: number std_models.Time20060102: type: object properties: inner: type: string std_models.Trip: type: object properties: airport_surcharge: type: number bonus: type: number cash_collected: type: number currency: type: string distance: type: number distance_measure: type: string driver_total_earnings_per_trip_distance: type: number driver_total_earnings_per_trip_minute: type: number duration: description: of format "HH:MM:SS" allOf: - $ref: '#/components/schemas/std_models.TripDuration' end_location: type: string fare: type: number fare_without_vat: type: number fees: type: number gross_fare: type: number kept_by_uber: type: number list_of_order_ids: type: array items: type: string migration_trip_id: type: string net_fare: type: number number_of_orders: type: integer organization_id: type: string organization_name: type: string other: type: number payment_type: type: string pickup_location_name: type: string recipient_address: type: string recipient_is_company: type: boolean recipient_name: type: string recipient_reg_code: type: string recipient_vat_code: type: string refunded_fees: type: number ride_duration: $ref: '#/components/schemas/std_models.TripDuration' ride_type: type: string rider_fare: type: number rider_promotions: type: number start_location: type: string stop_fare: type: number surge_fare: type: number taxes: type: number timezone: type: string tips: type: number tolls: type: number trip_begin_ts: description: of format "YYYY-MM-DD HH:MM:SS" allOf: - $ref: '#/components/schemas/std_models.Time20060102150405' trip_end_ts: description: of format "YYYY-MM-DD HH:MM:SS" allOf: - $ref: '#/components/schemas/std_models.Time20060102150405' trip_id: type: string trip_status: type: string trip_ts: description: of format "YYYY-MM-DD HH:MM:SS" allOf: - $ref: '#/components/schemas/std_models.Time20060102150405' trip_ts_local: $ref: '#/components/schemas/std_models.Time20060102150405' trip_type: type: string tz: type: string models.CompanyAccountsEmployment: type: object properties: size: type: integer users_data: type: array items: $ref: '#/components/schemas/handlers.AccountDataResponse-std_models_Employment' std_models.BankAccount: type: object properties: account_number: type: string account_type: type: string iban: type: string recipient: type: string swift: type: string models.ServerError: type: object properties: error: type: string std_models.Performance: type: object properties: acceptance_rate: type: number cancellation_rate: type: number completition_rate: type: number driver_rating: type: number driver_score: type: number online_hours: type: number price_per_driving_hour: type: number price_per_online_hour: type: number time_period_end_date: description: of format "YYYY-MM-DD" not null allOf: - $ref: '#/components/schemas/std_models.Time20060102' time_period_start_date: description: of format "YYYY-MM-DD" not null allOf: - $ref: '#/components/schemas/std_models.Time20060102' time_period_type: description: ', on of [daily, weekly, monthly, yearly, custom] not null' allOf: - $ref: '#/components/schemas/std_models.PeriodType' handlers.IncomeResponse: type: object properties: daily: type: array items: $ref: '#/components/schemas/std_models.Income' monthly: type: array items: $ref: '#/components/schemas/std_models.Income' user_account_id: type: string user_id: type: string weekly: type: array items: $ref: '#/components/schemas/std_models.Income' x-provenance: method: searched source: https://developers.getrollee.com/reference harvested: '2026-10-14' tool: harvest-readme-openapi.py note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored. assembled_from: - https://developers.getrollee.com/reference/delete_companies-id.md - https://developers.getrollee.com/reference/get_companies-id-company-accounts.md - https://developers.getrollee.com/reference/get_companies-id.md - https://developers.getrollee.com/reference/get_companies.md - https://developers.getrollee.com/reference/get_company-accounts-id-absences.md - https://developers.getrollee.com/reference/get_company-accounts-id-activity.md - https://developers.getrollee.com/reference/get_company-accounts-id-banking-info.md - https://developers.getrollee.com/reference/get_company-accounts-id-documents.md - https://developers.getrollee.com/reference/get_company-accounts-id-employees.md - https://developers.getrollee.com/reference/get_company-accounts-id-employment.md - https://developers.getrollee.com/reference/get_company-accounts-id-income.md - https://developers.getrollee.com/reference/get_company-accounts-id-performance.md - https://developers.getrollee.com/reference/get_company-accounts-id-profiles.md - https://developers.getrollee.com/reference/get_company-accounts-id-trips.md - https://developers.getrollee.com/reference/get_company-accounts-id-vehicles.md - https://developers.getrollee.com/reference/get_company-accounts-id-wallet.md - https://developers.getrollee.com/reference/get_company-accounts-id.md - https://developers.getrollee.com/reference/get_token-refresh.md - https://developers.getrollee.com/reference/get_users-id.md - https://developers.getrollee.com/reference/get_webhooks-1.md - https://developers.getrollee.com/reference/post_companies.md - https://developers.getrollee.com/reference/post_company-accounts-id-reconnect.md - https://developers.getrollee.com/reference/post_sessions-session-refresh.md - https://developers.getrollee.com/reference/put_company-v0-5-webhooks-accounts.md - https://developers.getrollee.com/reference/put_company-v0-5-webhooks-endpoints.md - https://developers.getrollee.com/reference/put_company-v0-5-webhooks-multi-endpoints.md - https://developers.getrollee.com/reference/put_users-id.md merge: pages: 27 deduped: 49 conflicts_kept_first: 0