payroll.getPeriod

The shop's pay period setting (weekly, biweekly, semimonthly or monthly) and the current period's dates. Weekly from Monday until the owner or office set it.


Who	Agents can call this
REST	`GET /v1/payroll/period`
MCP tool	`payroll_getPeriod`
Writes	no
Area	Shop

When to use it

The shop's pay period setting (weekly, biweekly, semimonthly or monthly) and the current period's dates. Weekly from Monday until the owner or office set it.

What to tell the owner

Tell them what you found in plain words. Don't read back raw fields.

Input

Field	Type	Required
`shop_id`	string (uuid)	yes

Example

GET https://doingwork.work/v1/payroll/period?shop_id=00000000-0000-4000-8000-000000000000

Output

Field	Type	Always there
`setting`	object	yes
`setting.shop_id`	string (uuid)	yes
`setting.frequency`	string	yes
`setting.anchor_date`	string (date)	yes
`setting.is_default`	boolean	yes
`setting.updated_by`	['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']	yes
`setting.updated_at`	['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']	yes
`period_start`	string (date)	yes
`period_end`	string (date)	yes

{
  "setting": {
    "shop_id": "00000000-0000-4000-8000-000000000000",
    "frequency": "...",
    "anchor_date": "...",
    "is_default": true,
    "updated_by": "00000000-0000-4000-8000-000000000000",
    "updated_at": "..."
  },
  "period_start": "...",
  "period_end": "..."
}

Errors

Code	Status	What to do
`invalid_input`, `invalid_token`, `rate_limited`		Can happen on any call. See errors.