PaySpace MCP by usefulapi
Read PaySpace employees, organization, payroll runs, payslips and leave records. Read-only.
使うべきか
品質と安全性
検出事項(10)
- LOWpayspace_list_employee_positions 内
- LOWpayspace_list_employment_statuses 内
- LOWpayspace_list_organization_units 内
- LOWpayspace_list_organization_positions 内
- LOWpayspace_list_payroll_frequencies 内
- LOWpayspace_list_payroll_components 内
- LOWpayspace_list_recurring_components 内
- LOWpayspace_list_leave_applications 内
- LOWpayspace_list_leave_adjustments 内
- LOWpayspace_list_leave_entitlements 内
ツール定義とプロトコルへの準拠に関する自動分析に基づいています。
コンテキストコスト
これは、サーバーのツールがモデルのコンテキストに読み込まれるたびに消費されるおおよそのトークン数です。数が多いほど、ほかのタスクに使える注意が減ります。
インストール
ワンクリックインストール
これを `claude_desktop_config.json` ファイルに追加してください:
{
"mcpServers": {
"payspace": {
"url": "https://payspace.usefulapi.io/mcp"
}
}
}リモートエンドポイント
https://payspace.usefulapi.io/mcpstreamable-httpできること
ツール一覧
ツール(21)
🟢payspace_list_companies
List the companies (id, code, name, group) the API credentials can access. Company ids go into the company_id argument of the other tools. From the token reply of POST /connect/token.
入力スキーマ
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢payspace_list_employees(company_id, top, skip, count, filter, ...)
List active employees of a company with their biographical details (name, employee number, contact, dates). Personal data. GET /odata/v2.0/{company}/Employee. Use payspace_list_all_employees to include terminated employees.
入力スキーマ
{
"type": "object",
"properties": {
"company_id": {
"description": "PaySpace company id or company code. Optional when the credentials give access to exactly one company; call payspace_list_companies to see them.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,49}$"
},
"top": {
"description": "Page size ($top, default and maximum 100).",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"skip": {
"description": "Records to skip ($skip), for paging: page 2 of size 100 is skip=100.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"count": {
"description": "Include the total number of matching records as @odata.count.",
"type": "boolean"
},
"filter": {
"description": "OData $filter, for example `EmployeeNumber eq 'E001'` or `contains(LastName,'Smith')`. Field names: see the vendor docs for the entity.",
"type": "string",
"maxLength": 1000
},
"orderby": {
"description": "OData $orderby, for example `LastName asc`.",
"type": "string",
"maxLength": 200
},
"select": {
"description": "OData $select: comma-separated field names to return (smaller replies).",
"type": "string",
"maxLength": 500
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢payspace_list_all_employees(company_id, top, skip, count, filter, ...)
List all employees of a company including terminated ones. Personal data. GET /odata/v2.0/{company}/Employee/all.
入力スキーマ
{
"type": "object",
"properties": {
"company_id": {
"description": "PaySpace company id or company code. Optional when the credentials give access to exactly one company; call payspace_list_companies to see them.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,49}$"
},
"top": {
"description": "Page size ($top, default and maximum 100).",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"skip": {
"description": "Records to skip ($skip), for paging: page 2 of size 100 is skip=100.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"count": {
"description": "Include the total number of matching records as @odata.count.",
"type": "boolean"
},
"filter": {
"description": "OData $filter, for example `EmployeeNumber eq 'E001'` or `contains(LastName,'Smith')`. Field names: see the vendor docs for the entity.",
"type": "string",
"maxLength": 1000
},
"orderby": {
"description": "OData $orderby, for example `LastName asc`.",
"type": "string",
"maxLength": 200
},
"select": {
"description": "OData $select: comma-separated field names to return (smaller replies).",
"type": "string",
"maxLength": 500
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢payspace_get_employee(company_id, employee_id)
Get one employee's biographical record by EmployeeId (the numeric id from payspace_list_employees). Personal data. GET /odata/v2.0/{company}/Employee({id}).
入力スキーマ
{
"type": "object",
"properties": {
"company_id": {
"description": "PaySpace company id or company code. Optional when the credentials give access to exactly one company; call payspace_list_companies to see them.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,49}$"
},
"employee_id": {
"type": "string",
"pattern": "^[0-9]{1,15}$",
"description": "EmployeeId, a whole number"
}
},
"required": [
"employee_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢payspace_list_employee_positions(company_id, top, skip, count, filter, ...)
List employee position records (job, organization unit, grade, manager, effective dates). GET /odata/v2.0/{company}/EmployeePosition.
入力スキーマ
{
"type": "object",
"properties": {
"company_id": {
"description": "PaySpace company id or company code. Optional when the credentials give access to exactly one company; call payspace_list_companies to see them.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,49}$"
},
"top": {
"description": "Page size ($top, default and maximum 100).",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"skip": {
"description": "Records to skip ($skip), for paging: page 2 of size 100 is skip=100.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"count": {
"description": "Include the total number of matching records as @odata.count.",
"type": "boolean"
},
"filter": {
"description": "OData $filter, for example `EmployeeNumber eq 'E001'` or `contains(LastName,'Smith')`. Field names: see the vendor docs for the entity.",
"type": "string",
"maxLength": 1000
},
"orderby": {
"description": "OData $orderby, for example `LastName asc`.",
"type": "string",
"maxLength": 200
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢payspace_list_employment_statuses(company_id, top, skip, count, filter, ...)
List employee employment status records (hire, termination, reason, dates). GET /odata/v2.0/{company}/EmployeeEmploymentStatus.
入力スキーマ
{
"type": "object",
"properties": {
"company_id": {
"description": "PaySpace company id or company code. Optional when the credentials give access to exactly one company; call payspace_list_companies to see them.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,49}$"
},
"top": {
"description": "Page size ($top, default and maximum 100).",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"skip": {
"description": "Records to skip ($skip), for paging: page 2 of size 100 is skip=100.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"count": {
"description": "Include the total number of matching records as @odata.count.",
"type": "boolean"
},
"filter": {
"description": "OData $filter, for example `EmployeeNumber eq 'E001'` or `contains(LastName,'Smith')`. Field names: see the vendor docs for the entity.",
"type": "string",
"maxLength": 1000
},
"orderby": {
"description": "OData $orderby, for example `LastName asc`.",
"type": "string",
"maxLength": 200
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢payspace_list_suspensions(company_id, top, skip, count, filter, ...)
List employee suspension records. GET /odata/v2.0/{company}/EmployeeSuspension.
入力スキーマ
{
"type": "object",
"properties": {
"company_id": {
"description": "PaySpace company id or company code. Optional when the credentials give access to exactly one company; call payspace_list_companies to see them.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,49}$"
},
"top": {
"description": "Page size ($top, default and maximum 100).",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"skip": {
"description": "Records to skip ($skip), for paging: page 2 of size 100 is skip=100.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"count": {
"description": "Include the total number of matching records as @odata.count.",
"type": "boolean"
},
"filter": {
"description": "OData $filter, for example `EmployeeNumber eq 'E001'` or `contains(LastName,'Smith')`. Field names: see the vendor docs for the entity.",
"type": "string",
"maxLength": 1000
},
"orderby": {
"description": "OData $orderby, for example `LastName asc`.",
"type": "string",
"maxLength": 200
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢payspace_list_organization_units(company_id, top, skip, count, filter, ...)
List the organization hierarchy units (departments, divisions, cost centres) of a company. GET /odata/v2.0/{company}/OrganizationUnit.
入力スキーマ
{
"type": "object",
"properties": {
"company_id": {
"description": "PaySpace company id or company code. Optional when the credentials give access to exactly one company; call payspace_list_companies to see them.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,49}$"
},
"top": {
"description": "Page size ($top, default and maximum 100).",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"skip": {
"description": "Records to skip ($skip), for paging: page 2 of size 100 is skip=100.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"count": {
"description": "Include the total number of matching records as @odata.count.",
"type": "boolean"
},
"filter": {
"description": "OData $filter, for example `EmployeeNumber eq 'E001'` or `contains(LastName,'Smith')`. Field names: see the vendor docs for the entity.",
"type": "string",
"maxLength": 1000
},
"orderby": {
"description": "OData $orderby, for example `LastName asc`.",
"type": "string",
"maxLength": 200
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢payspace_list_organization_positions(company_id, top, skip, count, filter, ...)
List the organization positions (position details) defined for a company. GET /odata/v2.0/{company}/OrganizationPositionDetail.
入力スキーマ
{
"type": "object",
"properties": {
"company_id": {
"description": "PaySpace company id or company code. Optional when the credentials give access to exactly one company; call payspace_list_companies to see them.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,49}$"
},
"top": {
"description": "Page size ($top, default and maximum 100).",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"skip": {
"description": "Records to skip ($skip), for paging: page 2 of size 100 is skip=100.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"count": {
"description": "Include the total number of matching records as @odata.count.",
"type": "boolean"
},
"filter": {
"description": "OData $filter, for example `EmployeeNumber eq 'E001'` or `contains(LastName,'Smith')`. Field names: see the vendor docs for the entity.",
"type": "string",
"maxLength": 1000
},
"orderby": {
"description": "OData $orderby, for example `LastName asc`.",
"type": "string",
"maxLength": 200
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢payspace_list_jobs(company_id, top, skip, count, filter, ...)
List the jobs defined in job management for a company. GET /odata/v2.0/{company}/JobManagement.
入力スキーマ
{
"type": "object",
"properties": {
"company_id": {
"description": "PaySpace company id or company code. Optional when the credentials give access to exactly one company; call payspace_list_companies to see them.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,49}$"
},
"top": {
"description": "Page size ($top, default and maximum 100).",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"skip": {
"description": "Records to skip ($skip), for paging: page 2 of size 100 is skip=100.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"count": {
"description": "Include the total number of matching records as @odata.count.",
"type": "boolean"
},
"filter": {
"description": "OData $filter, for example `EmployeeNumber eq 'E001'` or `contains(LastName,'Smith')`. Field names: see the vendor docs for the entity.",
"type": "string",
"maxLength": 1000
},
"orderby": {
"description": "OData $orderby, for example `LastName asc`.",
"type": "string",
"maxLength": 200
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢payspace_list_regions(company_id, top, skip, count, filter, ...)
List the company's regions. GET /odata/v2.0/{company}/CompanyRegion.
入力スキーマ
{
"type": "object",
"properties": {
"company_id": {
"description": "PaySpace company id or company code. Optional when the credentials give access to exactly one company; call payspace_list_companies to see them.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,49}$"
},
"top": {
"description": "Page size ($top, default and maximum 100).",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"skip": {
"description": "Records to skip ($skip), for paging: page 2 of size 100 is skip=100.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"count": {
"description": "Include the total number of matching records as @odata.count.",
"type": "boolean"
},
"filter": {
"description": "OData $filter, for example `EmployeeNumber eq 'E001'` or `contains(LastName,'Smith')`. Field names: see the vendor docs for the entity.",
"type": "string",
"maxLength": 1000
},
"orderby": {
"description": "OData $orderby, for example `LastName asc`.",
"type": "string",
"maxLength": 200
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢payspace_list_payroll_frequencies(company_id, top, skip, count, filter, ...)
List the payroll frequencies of a company (the CompanyFrequency lookup). A value goes into the frequency argument of payspace_list_payroll_components, payspace_list_payroll_runs and payspace_list_recurring_components. GET /odata/v2.0/{company}/Lookup/CompanyFrequency.
入力スキーマ
{
"type": "object",
"properties": {
"company_id": {
"description": "PaySpace company id or company code. Optional when the credentials give access to exactly one company; call payspace_list_companies to see them.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,49}$"
},
"top": {
"description": "Page size ($top, default and maximum 100).",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"skip": {
"description": "Records to skip ($skip), for paging: page 2 of size 100 is skip=100.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"count": {
"description": "Include the total number of matching records as @odata.count.",
"type": "boolean"
},
"filter": {
"description": "OData $filter, for example `EmployeeNumber eq 'E001'` or `contains(LastName,'Smith')`. Field names: see the vendor docs for the entity.",
"type": "string",
"maxLength": 1000
},
"orderby": {
"description": "OData $orderby, for example `LastName asc`.",
"type": "string",
"maxLength": 200
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢payspace_list_payroll_runs(company_id, top, skip, count, filter, ...)
List the payroll runs (periods) of a company for one frequency (the CompanyRun lookup). A value goes into the period argument of payspace_list_payroll_components and payspace_list_recurring_components. GET /odata/v2.0/{company}/Lookup/CompanyRun?frequency=.
入力スキーマ
{
"type": "object",
"properties": {
"company_id": {
"description": "PaySpace company id or company code. Optional when the credentials give access to exactly one company; call payspace_list_companies to see them.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,49}$"
},
"top": {
"description": "Page size ($top, default and maximum 100).",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"skip": {
"description": "Records to skip ($skip), for paging: page 2 of size 100 is skip=100.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"count": {
"description": "Include the total number of matching records as @odata.count.",
"type": "boolean"
},
"filter": {
"description": "OData $filter, for example `EmployeeNumber eq 'E001'` or `contains(LastName,'Smith')`. Field names: see the vendor docs for the entity.",
"type": "string",
"maxLength": 1000
},
"orderby": {
"description": "OData $orderby, for example `LastName asc`.",
"type": "string",
"maxLength": 200
},
"frequency": {
"type": "string",
"pattern": "^[A-Za-z0-9 _.-]{1,50}$",
"description": "Payroll frequency, required by PaySpace. A value from payspace_list_payroll_frequencies (the CompanyFrequency lookup)."
}
},
"required": [
"frequency"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢payspace_list_payroll_components(company_id, top, skip, count, filter, ...)
List the company's payroll components (earnings, deductions, contributions) with their codes, for one payroll frequency and run. Get frequency from payspace_list_payroll_frequencies and period from payspace_list_payroll_runs. GET /odata/v2.0/{company}/ComponentCompany?frequency=&period=.
入力スキーマ
{
"type": "object",
"properties": {
"company_id": {
"description": "PaySpace company id or company code. Optional when the credentials give access to exactly one company; call payspace_list_companies to see them.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,49}$"
},
"top": {
"description": "Page size ($top, default and maximum 100).",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"skip": {
"description": "Records to skip ($skip), for paging: page 2 of size 100 is skip=100.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"count": {
"description": "Include the total number of matching records as @odata.count.",
"type": "boolean"
},
"filter": {
"description": "OData $filter, for example `EmployeeNumber eq 'E001'` or `contains(LastName,'Smith')`. Field names: see the vendor docs for the entity.",
"type": "string",
"maxLength": 1000
},
"orderby": {
"description": "OData $orderby, for example `LastName asc`.",
"type": "string",
"maxLength": 200
},
"frequency": {
"type": "string",
"pattern": "^[A-Za-z0-9 _.-]{1,50}$",
"description": "Payroll frequency, required by PaySpace. A value from payspace_list_payroll_frequencies (the CompanyFrequency lookup)."
},
"period": {
"type": "string",
"pattern": "^[A-Za-z0-9 _.-]{1,50}$",
"description": "Payroll run (period), required by PaySpace. A value from payspace_list_payroll_runs (the CompanyRun lookup) for the chosen frequency."
}
},
"required": [
"frequency",
"period"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢payspace_list_recurring_components(company_id, top, skip, count, orderby, ...)
List the recurring payroll components (EmployeeComponent) or loans (EmployeeLoan) of ONE employee for a payroll frequency and run. Personal data (pay). Get frequency from payspace_list_payroll_frequencies and period from payspace_list_payroll_runs. GET /odata/v2.0/{company}/{entity}?frequency=&period=&$filter=EmployeeNumber eq '...'.
入力スキーマ
{
"type": "object",
"properties": {
"company_id": {
"description": "PaySpace company id or company code. Optional when the credentials give access to exactly one company; call payspace_list_companies to see them.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,49}$"
},
"top": {
"description": "Page size ($top, default and maximum 100).",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"skip": {
"description": "Records to skip ($skip), for paging: page 2 of size 100 is skip=100.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"count": {
"description": "Include the total number of matching records as @odata.count.",
"type": "boolean"
},
"orderby": {
"description": "OData $orderby, for example `LastName asc`.",
"type": "string",
"maxLength": 200
},
"entity": {
"type": "string",
"enum": [
"EmployeeComponent",
"EmployeeLoan"
],
"description": "EmployeeComponent (recurring components) or EmployeeLoan (loans)."
},
"frequency": {
"type": "string",
"pattern": "^[A-Za-z0-9 _.-]{1,50}$",
"description": "Payroll frequency, required by PaySpace. A value from payspace_list_payroll_frequencies (the CompanyFrequency lookup)."
},
"period": {
"type": "string",
"pattern": "^[A-Za-z0-9 _.-]{1,50}$",
"description": "Payroll run (period), required by PaySpace. A value from payspace_list_payroll_runs (the CompanyRun lookup) for the chosen frequency."
},
"employee_number": {
"type": "string",
"pattern": "^[A-Za-z0-9._-]{1,50}$",
"description": "Employee number (the EmployeeNumber field of payspace_list_employees). PaySpace requires this filter for recurring components."
}
},
"required": [
"entity",
"frequency",
"period",
"employee_number"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢payspace_list_payslips(company_id, top, skip, count, filter, ...)
List employee payslips (totals per employee) for a calendar year and month. Personal data (pay). GET /odata/v2.0/{company}/EmployeePayslip/{year}/{month}.
入力スキーマ
{
"type": "object",
"properties": {
"company_id": {
"description": "PaySpace company id or company code. Optional when the credentials give access to exactly one company; call payspace_list_companies to see them.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,49}$"
},
"top": {
"description": "Page size ($top, default and maximum 100).",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"skip": {
"description": "Records to skip ($skip), for paging: page 2 of size 100 is skip=100.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"count": {
"description": "Include the total number of matching records as @odata.count.",
"type": "boolean"
},
"filter": {
"description": "OData $filter, for example `EmployeeNumber eq 'E001'` or `contains(LastName,'Smith')`. Field names: see the vendor docs for the entity.",
"type": "string",
"maxLength": 1000
},
"orderby": {
"description": "OData $orderby, for example `LastName asc`.",
"type": "string",
"maxLength": 200
},
"year": {
"type": "integer",
"minimum": 1990,
"maximum": 2100,
"description": "Year, for example 2026."
},
"month": {
"type": "integer",
"minimum": 1,
"maximum": 12,
"description": "Month, 1 to 12."
}
},
"required": [
"year",
"month"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢payspace_list_payslip_lines(company_id, top, skip, count, filter, ...)
List the payslip lines (one per component per employee: code, description, amount) for a calendar year and month. Personal data (pay). GET /odata/v2.0/{company}/EmployeePayslipLine/{year}/{month}.
入力スキーマ
{
"type": "object",
"properties": {
"company_id": {
"description": "PaySpace company id or company code. Optional when the credentials give access to exactly one company; call payspace_list_companies to see them.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,49}$"
},
"top": {
"description": "Page size ($top, default and maximum 100).",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"skip": {
"description": "Records to skip ($skip), for paging: page 2 of size 100 is skip=100.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"count": {
"description": "Include the total number of matching records as @odata.count.",
"type": "boolean"
},
"filter": {
"description": "OData $filter, for example `EmployeeNumber eq 'E001'` or `contains(LastName,'Smith')`. Field names: see the vendor docs for the entity.",
"type": "string",
"maxLength": 1000
},
"orderby": {
"description": "OData $orderby, for example `LastName asc`.",
"type": "string",
"maxLength": 200
},
"year": {
"type": "integer",
"minimum": 1990,
"maximum": 2100,
"description": "Year, for example 2026."
},
"month": {
"type": "integer",
"minimum": 1,
"maximum": 12,
"description": "Month, 1 to 12."
}
},
"required": [
"year",
"month"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢payspace_list_leave_applications(company_id, top, skip, count, filter, ...)
List employee leave applications (type, dates, days, status). Give year and month together to restrict to a period. Personal data (absence). GET /odata/v2.0/{company}/EmployeeLeaveApplication[/{year}/{month}].
入力スキーマ
{
"type": "object",
"properties": {
"company_id": {
"description": "PaySpace company id or company code. Optional when the credentials give access to exactly one company; call payspace_list_companies to see them.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,49}$"
},
"top": {
"description": "Page size ($top, default and maximum 100).",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"skip": {
"description": "Records to skip ($skip), for paging: page 2 of size 100 is skip=100.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"count": {
"description": "Include the total number of matching records as @odata.count.",
"type": "boolean"
},
"filter": {
"description": "OData $filter, for example `EmployeeNumber eq 'E001'` or `contains(LastName,'Smith')`. Field names: see the vendor docs for the entity.",
"type": "string",
"maxLength": 1000
},
"orderby": {
"description": "OData $orderby, for example `LastName asc`.",
"type": "string",
"maxLength": 200
},
"year": {
"type": "integer",
"minimum": 1990,
"maximum": 2100,
"description": "Year, for example 2026."
},
"month": {
"type": "integer",
"minimum": 1,
"maximum": 12,
"description": "Month, 1 to 12."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢payspace_list_leave_adjustments(company_id, top, skip, count, filter, ...)
List employee leave adjustments (manual changes to leave balances). Personal data. GET /odata/v2.0/{company}/EmployeeLeaveAdjustment.
入力スキーマ
{
"type": "object",
"properties": {
"company_id": {
"description": "PaySpace company id or company code. Optional when the credentials give access to exactly one company; call payspace_list_companies to see them.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,49}$"
},
"top": {
"description": "Page size ($top, default and maximum 100).",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"skip": {
"description": "Records to skip ($skip), for paging: page 2 of size 100 is skip=100.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"count": {
"description": "Include the total number of matching records as @odata.count.",
"type": "boolean"
},
"filter": {
"description": "OData $filter, for example `EmployeeNumber eq 'E001'` or `contains(LastName,'Smith')`. Field names: see the vendor docs for the entity.",
"type": "string",
"maxLength": 1000
},
"orderby": {
"description": "OData $orderby, for example `LastName asc`.",
"type": "string",
"maxLength": 200
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢payspace_list_leave_entitlements(company_id, top, skip, count, filter, ...)
List employee leave setup entitlements (leave type, days per cycle). GET /odata/v2.0/{company}/EmployeeLeaveSetupEntitlement.
入力スキーマ
{
"type": "object",
"properties": {
"company_id": {
"description": "PaySpace company id or company code. Optional when the credentials give access to exactly one company; call payspace_list_companies to see them.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,49}$"
},
"top": {
"description": "Page size ($top, default and maximum 100).",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"skip": {
"description": "Records to skip ($skip), for paging: page 2 of size 100 is skip=100.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"count": {
"description": "Include the total number of matching records as @odata.count.",
"type": "boolean"
},
"filter": {
"description": "OData $filter, for example `EmployeeNumber eq 'E001'` or `contains(LastName,'Smith')`. Field names: see the vendor docs for the entity.",
"type": "string",
"maxLength": 1000
},
"orderby": {
"description": "OData $orderby, for example `LastName asc`.",
"type": "string",
"maxLength": 200
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢payspace_list_records(company_id, top, skip, count, filter, ...)
List records of another read-only entity set: CompanyEmploymentCategory, CompanyEmploymentSubCategory, CompanyLeaveReason, CompanyPositionFamily, CompanyPositionFunctionArea, CompanyTrainingCourse, CompanyQualification, CostingProjectActivity, OrganizationGrade, EmployeeAsset, EmployeeClaim, EmployeeDependant, EmployeeIncident, EmployeePayRate, EmployeeProject, EmployeeQualification, EmployeeSkill, EmployeeOutOfOffice. GET /odata/v2.0/{company}/{entity}. Employee-level entities contain personal data.
入力スキーマ
{
"type": "object",
"properties": {
"company_id": {
"description": "PaySpace company id or company code. Optional when the credentials give access to exactly one company; call payspace_list_companies to see them.",
"type": "string",
"pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,49}$"
},
"top": {
"description": "Page size ($top, default and maximum 100).",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"skip": {
"description": "Records to skip ($skip), for paging: page 2 of size 100 is skip=100.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"count": {
"description": "Include the total number of matching records as @odata.count.",
"type": "boolean"
},
"filter": {
"description": "OData $filter, for example `EmployeeNumber eq 'E001'` or `contains(LastName,'Smith')`. Field names: see the vendor docs for the entity.",
"type": "string",
"maxLength": 1000
},
"orderby": {
"description": "OData $orderby, for example `LastName asc`.",
"type": "string",
"maxLength": 200
},
"entity": {
"type": "string",
"enum": [
"CompanyEmploymentCategory",
"CompanyEmploymentSubCategory",
"CompanyLeaveReason",
"CompanyPositionFamily",
"CompanyPositionFunctionArea",
"CompanyTrainingCourse",
"CompanyQualification",
"CostingProjectActivity",
"OrganizationGrade",
"EmployeeAsset",
"EmployeeClaim",
"EmployeeDependant",
"EmployeeIncident",
"EmployeePayRate",
"EmployeeProject",
"EmployeeQualification",
"EmployeeSkill",
"EmployeeOutOfOffice"
],
"description": "Entity set name."
},
"select": {
"description": "OData $select: comma-separated field names to return (smaller replies).",
"type": "string",
"maxLength": 500
}
},
"required": [
"entity"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}コミュニティ
エビデンス