---
updatedAt: 2026-04-27T16:09:54.000Z
agentTools:
  projectIndex: https://developer.deputy.com/llms.txt
---

# Fetch a summary by filtering timesheets given filters

Fetch a summary by filtering timesheets given filters.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Deputy V2 API",
    "version": "1.0",
    "description": "\n\nFiltered to publicly-authenticated routes only (APIAuthenticator). Scoped-OAuth routes and internal JWT routes are excluded — see the separate \"Deputy V2 Scoped API\" spec for scoped endpoints."
  },
  "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)"
        }
      }
    }
  ],
  "components": {
    "schemas": {
      "SummaryFiltersEmployeeSelectionMode": {
        "type": "string",
        "enum": [
          "EMPLOYEE_SELECTION_MODE_UNKNOWN",
          "INCLUDE",
          "EXCLUDE"
        ],
        "default": "EMPLOYEE_SELECTION_MODE_UNKNOWN"
      },
      "TimesheetExportSummaryRequest": {
        "type": "object",
        "properties": {
          "filters": {
            "$ref": "#/components/schemas/modelSummaryFilters"
          },
          "bulkSelection": {
            "$ref": "#/components/schemas/modelSummaryBulkSelection"
          }
        }
      },
      "TimesheetExportSummaryResponse": {
        "type": "object",
        "properties": {
          "totalEmployees": {
            "type": "integer",
            "format": "int32"
          },
          "totalTimesheets": {
            "type": "integer",
            "format": "int32"
          },
          "totalHours": {
            "type": "string"
          },
          "totalCost": {
            "type": "string",
            "title": "Total cost formatted as 123.4567"
          },
          "summarizedTimesheets": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/modelSummarizedTimesheet"
            }
          },
          "summarizedPayCycles": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/modelSummarizedTimesheet"
            }
          },
          "startDate": {
            "type": "string",
            "title": "Start Date - YYYY-MM-DD"
          },
          "endDate": {
            "type": "string",
            "title": "End Date - YYYY-MM-DD"
          }
        }
      },
      "modelCompanyPeriods": {
        "type": "object",
        "properties": {
          "companyPeriodIds": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int32"
            },
            "title": "Company Period IDs"
          }
        }
      },
      "modelDateRange": {
        "type": "object",
        "properties": {
          "startDate": {
            "type": "string",
            "title": "Start Date - YYYY-MM-DD"
          },
          "endDate": {
            "type": "string",
            "title": "End Date - YYYY-MM-DD"
          }
        }
      },
      "modelLocations": {
        "type": "object",
        "properties": {
          "locationIds": {
            "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"
          }
        }
      },
      "modelPayCenters": {
        "type": "object",
        "properties": {
          "payCenterIds": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int32"
            }
          }
        }
      },
      "modelSummarizedTimesheet": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "modifiedTimestamp": {
            "type": "string",
            "title": "Modified Timestamp - YYYY-MM-DD HH:MM:SS"
          },
          "employeeId": {
            "type": "integer",
            "format": "int32",
            "title": "Employee ID"
          }
        }
      },
      "modelSummaryBulkSelection": {
        "type": "object",
        "properties": {
          "timesheetIds": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int32"
            }
          },
          "payCycleIds": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int32"
            }
          }
        }
      },
      "modelSummaryFilters": {
        "type": "object",
        "properties": {
          "companyPeriods": {
            "$ref": "#/components/schemas/modelCompanyPeriods"
          },
          "payCalendar": {
            "$ref": "#/components/schemas/modelPayCalendarOption"
          },
          "dateRange": {
            "$ref": "#/components/schemas/modelDateRange"
          },
          "locations": {
            "$ref": "#/components/schemas/modelLocations"
          },
          "payCenters": {
            "$ref": "#/components/schemas/modelPayCenters"
          },
          "employeeIds": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int32"
            }
          },
          "employeeSelectionMode": {
            "$ref": "#/components/schemas/SummaryFiltersEmployeeSelectionMode"
          }
        }
      }
    },
    "securitySchemes": {
      "ApiToken": {
        "type": "apiKey",
        "in": "header",
        "name": "OAuth"
      }
    }
  },
  "paths": {
    "/timesheet-export/v2/summary:get": {
      "post": {
        "summary": "Fetch a summary by filtering timesheets given filters",
        "operationId": "TimesheetExportV2Controller_getSummary",
        "responses": {
          "200": {
            "description": "A successful response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TimesheetExportSummaryResponse"
                }
              }
            }
          }
        },
        "tags": [
          "Timesheets"
        ],
        "description": "Fetch a summary by filtering timesheets given filters.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TimesheetExportSummaryRequest"
              }
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "ApiToken": []
    }
  ]
}
```