openapi: 3.2.0 info: title: Deputy Timesheet Export API version: '1.0' description: 'Operations tagged TimesheetExport across 2 of this provider''s published API definitions: deputy-v1-resource-api-openapi.yml, deputy-v2-api-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy - url: https://{subdomain}.{region}.deputy.com/api description: Deputy tenant variables: subdomain: default: your-subdomain description: Your Deputy tenant subdomain region: default: deputy enum: - au - eu - na - deputy description: 'Deputy region: au, eu, na, or deputy (AU default)' tags: - name: TimesheetExport description: Operations on the TimesheetExport resource paths: /resource/TimesheetExport: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy get: tags: - TimesheetExport summary: List TimesheetExport records description: Returns TimesheetExport records the authenticated caller is permitted to see. For large tables prefer POST /QUERY with pagination. operationId: listTimesheetExport responses: '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/TimesheetExport' '400': description: Bad request '401': description: Authentication required or invalid token '403': description: Forbidden — token lacks access to this resource '404': description: Resource not found security: - BearerAuth: [] - OAuth2: [] /resource/TimesheetExport/INFO: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy get: tags: - TimesheetExport summary: Get field metadata for TimesheetExport description: Returns the field list, types, and associations for this resource. Useful when building integrations that need to know which fields are queryable. operationId: infoTimesheetExport responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Authentication required or invalid token '403': description: Forbidden — token lacks access to this resource '404': description: Resource not found security: - BearerAuth: [] - OAuth2: [] /resource/TimesheetExport/PREDICT: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy post: tags: - TimesheetExport summary: Predict-match a TimesheetExport record description: Returns the closest matching existing record for a partial payload. Used by upsert-style integrations to find an existing row before creating. operationId: predictTimesheetExport requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TimesheetExport' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TimesheetExport' '400': description: Bad request '401': description: Authentication required or invalid token '403': description: Forbidden — token lacks access to this resource '404': description: Resource not found security: - BearerAuth: [] - OAuth2: [] /resource/TimesheetExport/QUERY: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy post: tags: - TimesheetExport summary: Search TimesheetExport description: 'Flexible search endpoint. Body supports `search`, `sort`, `start`, `max`, and `join` clauses. Example: `{"search": {"s1": {"field": "Id", "data": 1, "type": "eq"}}}`.' operationId: searchTimesheetExport requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/QueryRequest' responses: '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/TimesheetExport' '400': description: Bad request '401': description: Authentication required or invalid token '403': description: Forbidden — token lacks access to this resource '404': description: Resource not found security: - BearerAuth: [] - OAuth2: [] /resource/TimesheetExport/{id}: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy get: tags: - TimesheetExport summary: Get a TimesheetExport by id operationId: getTimesheetExportById parameters: - name: id in: path required: true schema: type: integer description: Numeric id of the resource responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TimesheetExport' '400': description: Bad request '401': description: Authentication required or invalid token '403': description: Forbidden — token lacks access to this resource '404': description: Resource not found security: - BearerAuth: [] - OAuth2: [] /resource/TimesheetExport/{id}/COMMENTS: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy get: tags: - TimesheetExport summary: List comments on a TimesheetExport operationId: getCommentsTimesheetExport parameters: - name: id in: path required: true schema: type: integer description: Numeric id of the resource responses: '200': description: Success content: application/json: schema: type: array items: type: object properties: Id: type: integer Comment: type: string Creator: type: integer Created: type: string format: date-time '400': description: Bad request '401': description: Authentication required or invalid token '403': description: Forbidden — token lacks access to this resource '404': description: Resource not found security: - BearerAuth: [] - OAuth2: [] post: tags: - TimesheetExport summary: Add a comment to a TimesheetExport operationId: addCommentTimesheetExport parameters: - name: id in: path required: true schema: type: integer description: Numeric id of the resource requestBody: required: true content: application/json: schema: type: object properties: Comment: type: string required: - Comment responses: '200': description: Success content: application/json: schema: type: object '400': description: Bad request '401': description: Authentication required or invalid token '403': description: Forbidden — token lacks access to this resource '404': description: Resource not found security: - BearerAuth: [] - OAuth2: [] /resource/TimesheetExport/{id}/COMMENTS/{commentId}: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy delete: tags: - TimesheetExport summary: Delete a comment on a TimesheetExport operationId: deleteCommentTimesheetExport parameters: - name: id in: path required: true schema: type: integer description: Numeric id of the resource - name: commentId in: path required: true schema: type: integer responses: '200': description: Success content: application/json: schema: type: object properties: success: type: boolean '400': description: Bad request '401': description: Authentication required or invalid token '403': description: Forbidden — token lacks access to this resource '404': description: Resource not found security: - BearerAuth: [] - OAuth2: [] /resource/TimesheetExport/{id}/HISTORY: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy get: tags: - TimesheetExport summary: Get change history for a TimesheetExport operationId: historyTimesheetExport parameters: - name: id in: path required: true schema: type: integer description: Numeric id of the resource responses: '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/TimesheetExport' '400': description: Bad request '401': description: Authentication required or invalid token '403': description: Forbidden — token lacks access to this resource '404': description: Resource not found security: - BearerAuth: [] - OAuth2: [] /resource/TimesheetExport/{id}/HISTORY/travel/{timestamp}: servers: - url: https://{subdomain}.{region}.deputy.com/api/v1 description: Deputy tenant variables: subdomain: default: your-subdomain region: default: deputy enum: - au - eu - na - deputy get: tags: - TimesheetExport summary: Get a TimesheetExport as it existed at a prior time operationId: historyTimesheetExportTravel parameters: - name: id in: path required: true schema: type: integer description: Numeric id of the resource - name: timestamp in: path required: true schema: type: integer format: int64 description: Unix epoch seconds responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TimesheetExport' '400': description: Bad request '401': description: Authentication required or invalid token '403': description: Forbidden — token lacks access to this resource '404': description: Resource not found security: - BearerAuth: [] - OAuth2: [] /timesheet-export/v2/config: servers: - url: https://{subdomain}.{region}.deputy.com/api description: Deputy tenant variables: subdomain: default: your-subdomain description: Your Deputy tenant subdomain region: default: deputy enum: - au - eu - na - deputy description: 'Deputy region: au, eu, na, or deputy (AU default)' get: operationId: TimesheetExportV2Controller_getConfig responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/TimesheetExportGetConfigResponse' tags: - TimesheetExport summary: Get config description: Get config. security: - ApiToken: [] /timesheet-export/v2/feature-status: servers: - url: https://{subdomain}.{region}.deputy.com/api description: Deputy tenant variables: subdomain: default: your-subdomain description: Your Deputy tenant subdomain region: default: deputy enum: - au - eu - na - deputy description: 'Deputy region: au, eu, na, or deputy (AU default)' get: summary: Get status of the timesheet export feature (enabled/disabled) operationId: TimesheetExportV2Controller_getFeatureStatus responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/TimesheetExportGetFeatureStatusResponse' tags: - TimesheetExport description: Get status of the timesheet export feature (enabled/disabled). security: - ApiToken: [] /timesheet-export/v2/filters/employee:refresh: servers: - url: https://{subdomain}.{region}.deputy.com/api description: Deputy tenant variables: subdomain: default: your-subdomain description: Your Deputy tenant subdomain region: default: deputy enum: - au - eu - na - deputy description: 'Deputy region: au, eu, na, or deputy (AU default)' post: summary: Refresh the employee filter options operationId: TimesheetExportV2Controller_refreshEmployeeFilterOptions responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/TimesheetExportRefreshEmployeeFilterOptionsResponse' tags: - TimesheetExport description: Refresh the employee filter options. security: - ApiToken: [] /timesheet-export/v2/filters/location:refresh: servers: - url: https://{subdomain}.{region}.deputy.com/api description: Deputy tenant variables: subdomain: default: your-subdomain description: Your Deputy tenant subdomain region: default: deputy enum: - au - eu - na - deputy description: 'Deputy region: au, eu, na, or deputy (AU default)' post: summary: Refresh the location filter options operationId: TimesheetExportV2Controller_refreshLocationFilterOptions responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/TimesheetExportRefreshFilterOptionsResponse' tags: - TimesheetExport description: Refresh the location filter options. security: - ApiToken: [] /timesheet-export/v2/filters/pay-center:refresh: servers: - url: https://{subdomain}.{region}.deputy.com/api description: Deputy tenant variables: subdomain: default: your-subdomain description: Your Deputy tenant subdomain region: default: deputy enum: - au - eu - na - deputy description: 'Deputy region: au, eu, na, or deputy (AU default)' post: summary: Refresh the pay center filter options operationId: TimesheetExportV2Controller_refreshPayCenterFilter responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/TimesheetExportRefreshPayCenterFilterResponse' tags: - TimesheetExport description: Refresh the pay center filter options. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TimesheetExportRefreshFilterOptionsRequest' security: - ApiToken: [] /timesheet-export/v2/filters/pay-period: servers: - url: https://{subdomain}.{region}.deputy.com/api description: Deputy tenant variables: subdomain: default: your-subdomain description: Your Deputy tenant subdomain region: default: deputy enum: - au - eu - na - deputy description: 'Deputy region: au, eu, na, or deputy (AU default)' get: summary: Get options to populate the pay period filters operationId: TimesheetExportV2Controller_getPayPeriodFilterOptions responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/TimesheetExportGetPayPeriodFilterOptionsResponse' tags: - TimesheetExport description: Get options to populate the pay period filters. security: - ApiToken: [] components: schemas: TimesheetExportConfigFilters: type: object properties: locationType: $ref: '#/components/schemas/modelLocationTypeFilterOption' dateRangeType: $ref: '#/components/schemas/modelDateRangeTypeFilterOption' modelLocationTypeFilterOption: type: string enum: - LOCATION_TYPE_FILTER_OPTION_UNKNOWN - NONE - PAY_CENTER - LOCATION default: LOCATION_TYPE_FILTER_OPTION_UNKNOWN title: Location Type Filter Option TimesheetExportGetConfigResponse: type: object properties: success: type: boolean filters: $ref: '#/components/schemas/TimesheetExportConfigFilters' modelPayPeriodFilterOption: type: object properties: id: type: integer format: int32 title: Pay Period ID name: type: string title: Pay Period Name payCycles: type: array items: $ref: '#/components/schemas/modelPayCycleFilterOption' title: Pay Cycles TimesheetExport: type: object properties: Id: type: integer Label: type: string maxLength: 64 Company: type: integer CompanyPeriod: type: integer ExportData: type: string Creator: type: integer Created: type: string format: date-time Modified: type: string CompanyObject: type: object CompanyPeriodObject: type: object required: - Id - Label - Company - Modified tenanttimesheetv2modelEmployee: type: object properties: id: type: integer format: int32 firstName: type: string lastName: type: string displayName: type: string modelPayCycleFilterOption: type: object properties: startDate: type: string title: Pay Cycle Start Date as YYYY-MM-DD endDate: type: string title: Pay Cycle End Date as YYYY-MM-DD companyPeriodIds: type: array items: type: integer format: int32 title: Company Period IDs modelDateRangeTypeFilterOption: type: string enum: - DATE_RANGE_TYPE_FILTER_OPTION_UNKNOWN - CUSTOM - PAY_PERIOD_AND_CUSTOM - PAY_CALENDAR_AND_CUSTOM - PAY_CALENDAR default: DATE_RANGE_TYPE_FILTER_OPTION_UNKNOWN title: Date Range Filter Option TimesheetExportRefreshEmployeeFilterOptionsResponse: type: object properties: success: type: boolean employeeIds: type: array items: type: integer format: int32 employees: type: array items: $ref: '#/components/schemas/tenanttimesheetv2modelEmployee' pagination: $ref: '#/components/schemas/modelPaginationInfo' TimesheetExportGetFeatureStatusResponse: type: object properties: success: type: boolean enabled: type: boolean modelDateRange: type: object properties: startDate: type: string title: Start Date - YYYY-MM-DD endDate: type: string title: End Date - YYYY-MM-DD TimesheetExportRefreshFilterOptionsResponse: type: object properties: success: type: boolean locationIds: type: array items: type: integer format: int32 modelPaginationInfo: type: object properties: nextCursor: type: string totalCount: type: integer format: int32 modelCompanyPeriods: type: object properties: companyPeriodIds: type: array items: type: integer format: int32 title: Company Period IDs QueryRequest: type: object description: V1 Resource search payload. All fields optional; an empty body returns the first page of results. properties: search: type: object description: Map of search clauses keyed by an arbitrary id (e.g. `s1`, `s2`). Each clause filters one field. additionalProperties: type: object required: - field - data - type properties: field: type: string description: Field name to filter on (e.g. `Id`, `Employee`). data: description: Comparison value. Type depends on the field. type: type: string description: Comparison operator. enum: - eq - ne - gt - lt - ge - le - is - is not - in - not in - starts - contains sort: type: object description: Map of field name → `asc` or `desc`. additionalProperties: type: string enum: - asc - desc start: type: integer minimum: 0 default: 0 description: Pagination offset (0-indexed). max: type: integer minimum: 1 maximum: 500 default: 100 description: Max records per page (server caps at 500). join: type: array items: type: string description: Related ORMs to expand inline (e.g. `["EmployeeObject"]`). example: search: s1: field: Id data: 1 type: ge max: 100 TimesheetExportGetPayPeriodFilterOptionsResponse: type: object properties: success: type: boolean payPeriods: type: array items: $ref: '#/components/schemas/modelPayPeriodFilterOption' TimesheetExportRefreshFilterOptionsRequest: type: object properties: companyPeriods: $ref: '#/components/schemas/modelCompanyPeriods' title: Company Periods payCalendar: $ref: '#/components/schemas/modelPayCalendarOption' title: Pay calendar dateRange: $ref: '#/components/schemas/modelDateRange' title: Start & End Date TimesheetExportRefreshPayCenterFilterResponse: type: object properties: success: type: boolean payCenterIds: type: array items: type: integer format: int32 modelPayCalendarOption: type: object properties: id: type: integer format: int32 title: Pay Calendar ID startDate: type: string title: Start Date - YYYY-MM-DD endDate: type: string title: End Date - YYYY-MM-DD securitySchemes: BearerAuth: type: http scheme: bearer description: OAuth 2.0 access token or Deputy Permanent Token. OAuth2: type: oauth2 flows: authorizationCode: authorizationUrl: https://once.deputy.com/my/oauth/login tokenUrl: https://once.deputy.com/my/oauth/access_token scopes: longlife_refresh_token: Extended session ApiToken: type: apiKey in: header name: OAuth x-refined-from: - deputy-v1-resource-api-openapi.yml - deputy-v2-api-openapi.yml x-provenance: method: searched source: https://developer.deputy.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://developer.deputy.com/reference/addalocation.md - https://developer.deputy.com/reference/addalocationagainstanemployee.md - https://developer.deputy.com/reference/addanemployee.md - https://developer.deputy.com/reference/addasaletosalesmetrics.md - https://developer.deputy.com/reference/addawebhookurl.md - https://developer.deputy.com/reference/addleaveforaemployee.md - https://developer.deputy.com/reference/addnewworkplace.md - https://developer.deputy.com/reference/addunavailabilitydetailsforaemployee.md - https://developer.deputy.com/reference/archivealocation.md - https://developer.deputy.com/reference/copyaroster.md - https://developer.deputy.com/reference/create-a-memo.md - https://developer.deputy.com/reference/createadepartment.md - https://developer.deputy.com/reference/createmultipledepartments.md - https://developer.deputy.com/reference/deletealocation.md - https://developer.deputy.com/reference/deleteanemployeesaccountindeputy.md - https://developer.deputy.com/reference/deleteasingleoperationalunit.md - https://developer.deputy.com/reference/discardaroster.md - https://developer.deputy.com/reference/doatask.md - https://developer.deputy.com/reference/example-searchforemployeesfromalocation.md - https://developer.deputy.com/reference/findanemployeesleave.md - https://developer.deputy.com/reference/findoutanemployeesstatus.md - https://developer.deputy.com/reference/getagreedhoursbyemployeeid.md - https://developer.deputy.com/reference/getalistofrostersfromlast12hoursandforward36hours.md - https://developer.deputy.com/reference/getalocationssettings.md - https://developer.deputy.com/reference/getawardslibrarylist.md - https://developer.deputy.com/reference/getdetailsforaemployeebyid.md - https://developer.deputy.com/reference/getdetailsforallemployees.md - https://developer.deputy.com/reference/getlocationbyid.md - https://developer.deputy.com/reference/getlocations.md - https://developer.deputy.com/reference/getmyindividualtimesheet.md - https://developer.deputy.com/reference/getmynewsfeed.md - https://developer.deputy.com/reference/getmynotifications.md - https://developer.deputy.com/reference/getmysubordinatecontactdetails.md - https://developer.deputy.com/reference/getmytasks.md - https://developer.deputy.com/reference/getmytimesheets.md - https://developer.deputy.com/reference/getmytraining.md - https://developer.deputy.com/reference/getoperationalunits.md - https://developer.deputy.com/reference/getrostersavailableforswap.md - https://developer.deputy.com/reference/getsimplifiedlocationlist.md - https://developer.deputy.com/reference/getsuggestionsforrosterbyid.md - https://developer.deputy.com/reference/getunavailabilitydetailsforaemployee.md - https://developer.deputy.com/reference/inviteemployeetodeputy.md - https://developer.deputy.com/reference/modifysettingsinalllocations.md - https://developer.deputy.com/reference/modifysettingsinasinglelocation.md - https://developer.deputy.com/reference/myaddressonfile.md - https://developer.deputy.com/reference/myaddressonfileincludingemergency.md - https://developer.deputy.com/reference/myleaverequests.md - https://developer.deputy.com/reference/pauseorunpauseemployeestimesheettakeabreakfinishbreak.md - https://developer.deputy.com/reference/postajournal.md - https://developer.deputy.com/reference/publisharoster.md - https://developer.deputy.com/reference/re-activateaterminatedemployee.md - https://developer.deputy.com/reference/removealocationfromanemployee.md - https://developer.deputy.com/reference/retrievecurrentsystemtime.md - https://developer.deputy.com/reference/retrievecurrentsystemtimeofalocation.md - https://developer.deputy.com/reference/retrievesalesdata.md - https://developer.deputy.com/reference/setawardforemployee.md - https://developer.deputy.com/reference/startanemployeestimesheetclockon.md - https://developer.deputy.com/reference/stopanemployeestimesheetclockoff.md - https://developer.deputy.com/reference/terminateanemployee.md - https://developer.deputy.com/reference/updatealocation.md - https://developer.deputy.com/reference/updateanexistingemployee.md - https://developer.deputy.com/reference/updateasingleoperationalunit.md - https://developer.deputy.com/reference/updatemyaddress.md - https://developer.deputy.com/reference/viewatimesheetbyid.md - https://developer.deputy.com/reference/whatlocationscaniworkin.md - https://developer.deputy.com/reference/whenaminextworking.md - https://developer.deputy.com/reference/whenamiunavailable.md - https://developer.deputy.com/reference/wherecaniworkwhatdoido.md - https://developer.deputy.com/reference/whodoiworkwith.md merge: pages: 69 deduped: 70 conflicts_kept_first: 0