Sign in

v1

latestOpenAPI 3.0.12026-08-041753011.2 MB
Shared Report

Create a shared report

Saves shared report with name, options and report filter.

Shared report data on FREE subscription plan is limited to a maximum interval length of one month (31 days).

post/v1/workspaces/{workspaceId}/shared-reports

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:60f91b3ffdaf031696ecxxxx

Request body

fixedDateboolean

Indicates whether the shared report has a fixed date range.

isPublicboolean

Indicates whether the shared report is public or not

namestring

Represents a shared report's name

type'DETAILED' | 'WEEKLY' | 'SUMMARY' | 'SCHEDULED' | 'EXPENSE_DETAILED' | 'EXPENSE_RECEIPT' | 'PTO_REQUESTS' | 'PTO_BALANCE' | 'ATTENDANCE' | 'INVOICE_EXPENSE' | 'INVOICE_TIME' | 'PROJECT' | 'TEAM_FULL' | 'TEAM_LIMITED' | 'TEAM_GROUPS' | 'INVOICES' | 'KIOSK_PIN_LIST' | 'KIOSK_ASSIGNEES' | 'USER_DATA_EXPORT'

Represent the type of shared report.

visibleToUserGroupsstring[]

Represents user group ids.

visibleToUsersstring[]

Represents user ids.

Example request

{
  "filter": {
    "amountShown": "COST",
    "amounts": [
      "[EARNED, COST]"
    ],
    "approvalState": "APPROVED",
    "attendanceFilter": {
      "balanceFilters": [
        {
          "value": "150"
        }
      ],
      "breakFilters": [
        {
          "value": "50"
        }
      ],
      "capacityFilters": [
        {
          "value": "750"
        }
      ],
      "endFilters": [
        {
          "value": "17:00"
        }
      ],
      "hasTimeOff": true,
      "overtimeFilters": [
        {
          "value": "150"
        }
      ],
      "startFilters": [
        {
          "value": "15:00"
        }
      ],
      "undertimeFilters": [
        {
          "value": "150"
        }
      ],
      "workFilters": [
        {
          "value": "750"
        }
      ]
    },
    "billable": true,
    "clients": {
      "contains": "CONTAINS",
      "ids": [
        "5b715448b079875110792222",
        "5b715448b079875110791111"
      ],
      "status": "ACTIVE"
    },
    "currency": {
      "contains": "CONTAINS",
      "ids": [
        "5b715448b079875110792222",
        "5b715448b079875110791111"
      ],
      "status": "ACTIVE"
    },
    "customFields": [
      {
        "id": "5b71544ab0798751107918b3",
        "numberCondition": "EQUAL",
        "type": "NUMBER"
      }
    ],
    "dateFormat": "2018-11-01",
    "dateRangeEnd": "2018-11-30T23:59:59.999",
    "dateRangeStart": "2018-11-01T00:00:00",
    "dateRangeType": "LAST_MONTH",
    "description": "some description keyword",
    "detailedFilter": {
      "auditFilter": {
        "duration": 2,
        "withoutTask": true
      },
      "options": {
        "totals": "CALCULATE"
      },
      "page": 1,
      "pageSize": 20,
      "sortColumn": "ID"
    },
    "exportType": "JSON",
    "invoicingState": "INVOICED",
    "projects": {
      "contains": "CONTAINS",
      "ids": [
        "5b715448b079875110792222",
        "5b715448b079875110791111"
      ],
      "status": "ACTIVE"
    },
    "sortOrder": "ASCENDING",
    "summaryFilter": {
      "groups": [
        "\"[5b715448b07987511071111\", \"5b715448b079875110792222\"]"
      ],
      "sortColumn": "GROUP",
      "summaryChartType": "PROJECT"
    },
    "tags": {
      "containedInTimeentry": "CONTAINS_ONLY",
      "contains": "CONTAINS",
      "ids": [
        "5b715448b079875110792222",
        "5b715448b079875110791111"
      ],
      "status": "ACTIVE"
    },
    "tasks": {
      "contains": "CONTAINS",
      "ids": [
        "5b715448b079875110792222",
        "5b715448b079875110791111"
      ],
      "status": "ACTIVE"
    },
    "timeFormat": "T00:00:00",
    "timeZone": "Europe/Belgrade",
    "userCustomFields": [
      {
        "id": "5b71544ab0798751107918b3",
        "numberCondition": "EQUAL",
        "type": "NUMBER"
      }
    ],
    "userGroups": {
      "contains": "CONTAINS",
      "ids": [
        "5b715448b079875110792222",
        "5b715448b079875110791111"
      ],
      "status": "ACTIVE"
    },
    "userLocale": "en",
    "users": {
      "contains": "CONTAINS",
      "ids": [
        "5b715448b079875110792222",
        "5b715448b079875110791111"
      ],
      "status": "ACTIVE"
    },
    "weekStart": "MONDAY",
    "weeklyFilter": {
      "group": "5b715448b079875110791111",
      "subgroup": "5b715448b079875110792222"
    },
    "zoomLevel": "WEEK"
  },
  "name": "Weekly 1",
  "type": "WEEKLY",
  "visibleToUserGroups": [
    "\"[5b715448b079875110792222\", \"5b715448b079875110791111\"]"
  ],
  "visibleToUsers": [
    "5b715448b079875110791234",
    "5b715448b079875110791432",
    "5b715448b079875110791324"
  ]
}

Response

OK