{ "opencollection": "1.0.0", "info": { "name": "Optibus Operations Driver Absences Payroll API", "version": "2.8.17" }, "items": [ { "info": { "name": "Payroll", "type": "folder" }, "items": [ { "info": { "name": "Fetch payroll", "type": "http" }, "http": { "method": "GET", "url": "https://YOUR-OPTIBUS-ACCOUNT.api.ops.optibus.co/v2/payroll", "params": [ { "name": "depotId", "value": "", "type": "query", "description": "- Optional. The ID of a specific depot for which payroll is to be retrieved." }, { "name": "driverIds", "value": "", "type": "query", "description": "- Optional. An array of driver IDs for whom payroll is to be retrieved." }, { "name": "startDate", "value": "", "type": "query", "description": "- The start date of the payroll period" }, { "name": "endDate", "value": "", "type": "query", "description": "- The end date of the payroll period" }, { "name": "paycodes", "value": "", "type": "query", "description": "- Optional. An array of paycodes to filter the payroll values by. If not provided, all paycodes are returned." }, { "name": "shouldUseCache", "value": "", "type": "query", "description": "- Optional. Will attempt to retreive the data from the cache if true. If false, will always calculate the data." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves payroll values for depots within a specified date range and for specified driver IDs or by depotId.\nThere is a limit of 204k work-entities calculation per request to avoid timeouts. This limit enables, for example,\na calculation of 100 drivers for 30 days with 100 daily work-entities defined. In case the limit is exceeded, a 413 error code will be returned, together with the allowed amount of drivers for the existing configuration.\n\nThis endpoint is only available if the `Use Payroll V" } ] } ], "bundled": true }