Skip to content
ShiftSync Developers

Expected pay

Estimates expected pay over a date range by applying the user’s pay settings and enhancement rules to their shifts. Optionally restrict to specific templates.

GET
/v1/reports/expected-pay
curl --request GET \
  --url 'https://api.shiftsync.app/v1/reports/expected-pay?startDate=2026-04-15T12%3A00%3A00Z&endDate=2026-04-15T12%3A00%3A00Z' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
startDate
required
string format: date-time
endDate
required
string format: date-time
templateId
string

Responses

Section titled “Responses”

200

Section titled “200”

Expected pay in the range

Media typeapplication/json
object
item
required
object
currency
required
string
totalMinor
required
integer
>= -9007199254740991 <= 9007199254740991
baseMinor
required
integer
>= -9007199254740991 <= 9007199254740991
enhancementMinor
required
integer
>= -9007199254740991 <= 9007199254740991
totalHours
required
number
shiftCount
required
integer
>= -9007199254740991 <= 9007199254740991
unratedShiftCount
required
integer
>= -9007199254740991 <= 9007199254740991
byTemplate
required
Array<object>
object
templateId
required
integer
>= -9007199254740991 <= 9007199254740991
hours
required
number
payMinor
required
integer
>= -9007199254740991 <= 9007199254740991
byRule
required
Array<object>
object
ruleId
required
integer
nullable >= -9007199254740991 <= 9007199254740991
name
required
string
hours
required
number
enhancementMinor
required
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "item": {
    "currency": "string",
    "totalMinor": 0,
    "baseMinor": 0,
    "enhancementMinor": 0,
    "totalHours": 0,
    "shiftCount": 0,
    "unratedShiftCount": 0,
    "byTemplate": [
      {
        "templateId": 0,
        "hours": 0,
        "payMinor": 0
      }
    ],
    "byRule": [
      {
        "ruleId": 0,
        "name": "string",
        "hours": 0,
        "enhancementMinor": 0
      }
    ]
  }
}