次の方法で共有

PaySpace (独立した発行元) (プレビュー)

Microsoft の強力なソリューションを使用すると、ビジネス環境で利用するために従業員データにアクセスできます。 サポートされているすべてのエンドポイントを 1 か所に配置し、ソリューションに統合する準備が整いました。

このコネクタは、次の製品とリージョンで使用できます。

サービス クラス リージョン
コピロット スタジオ Premium 次を除くすべての Power Automate リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
ロジック アプリ Standard 次を除くすべての Logic Apps リージョン :
     - Azure Government リージョン
     - Azure China リージョン
     - 米国国防総省 (DoD)
Power Apps Premium 次を除くすべての Power Apps リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
Power Automate Premium 次を除くすべての Power Automate リージョン :
     - 米国政府 (GCC)
     - 米国政府 (GCC High)
     - 21Vianet が運営する China Cloud
     - 米国国防総省 (DoD)
お問い合わせ
名前 Mint PaySpace のサポート
URL https://za.mintgroup.net/
Email payspace.support@mintgroup.net
コネクタ メタデータ
Publisher Mint Management Technologies
Website https://www.payspace.com
プライバシー ポリシー https://www.payspace.com/privacy-policy/
カテゴリ 人的資源

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒

アクション

1 つの Employee レコードを作成する

指定した EmployeeNumber の 1 つの従業員レコードを作成します。
1 つの位置レコードを作成する

指定した EmployeeNumber に対して 1 つの従業員の位置レコードを作成します。
1 つの位置レコードを取得する

指定した EmployeePositionId に基づいて従業員の位置レコードを取得します。
1 つの位置レコードを更新する

指定した EmployeePositionId に基づいて、1 つの従業員の位置レコードを更新します。
1 つの従業員の添付ファイル レコードを作成する

指定した EmployeeNumber の添付ファイル レコードを 1 つ作成します。
1 つの銀行詳細レコードを作成する

指定した EmployeeNumber の 1 つの従業員銀行詳細レコードを作成します。
1 つの銀行詳細レコードを削除する

指定した BankDetailId に基づいて、従業員の銀行の詳細情報を取得します。
1 つの銀行詳細レコードを取得する

指定した BankDetailId に基づいて、従業員の銀行の詳細情報を取得します。
1 つの銀行詳細レコードを更新する

指定した BankdetailId に基づいて、1 つの銀行詳細レコードを更新します。
1 つの雇用状態レコードを作成する

指定した EmployeeNumber に対して 1 つの従業員の雇用状態レコードを作成します。
1 人の従業員の添付ファイル レコードを削除する

指定した AttachmentId に基づいて、1 つの従業員の添付ファイル レコードを削除します。
1 人の従業員の添付ファイル レコードを取得する

指定した AttachmentId に基づいて従業員の添付ファイル情報を取得します。
1 人の従業員の添付ファイル レコードを更新する

指定した AttachmentId に基づいて、1 つの添付ファイル レコードを更新します。
1 人の従業員レコードを取得する

指定した EmployeeId に基づいて従業員情報を取得します。
1 人の従業員レコードを更新する

指定した EmployeeId に基づいて、1 つの従業員レコードを更新します。
すべての雇用状態のコレクションを取得する

指定した会社 ID に基づいて、すべての従業員の雇用状態の一覧を取得します。
位置のコレクションを取得する

指定したcompany_idに基づいて、今日の日付の従業員の役職レコードの一覧を取得します。
従業員のコレクションを取得する

指定した会社 ID に基づいて、今日の現在のアクティブな従業員の略歴の詳細の一覧を取得します。
従業員の写真をアップロードする

指定した EmployeeId に基づいて、1 人の従業員の写真を更新します。
従業員の写真をダウンロードする

指定した EmployeeId に基づいて、1 つの従業員の写真を取得します。
従業員の添付ファイル レコードのコレクションを取得する

指定したcompany_idに基づいて、アクティブな従業員の添付ファイル レコードの一覧を取得します。
有効な日付の位置のコレクションを取得する

指定したcompany_idに基づいて、指定した有効日の従業員の位置レコードの一覧を取得します。
有効な日付の時点で従業員のコレクションを取得する

指定した有効日の時点で、指定した会社 ID に基づいて、アクティブな従業員の略歴の詳細の一覧を取得します。
銀行詳細レコードのコレクションを取得する

指定したcompany_idに基づいて、従業員の銀行の詳細の一覧を取得します。
雇用状態のコレクションを取得する

指定した会社 ID に基づいて、現在のアクティブな従業員の雇用状態の一覧を取得します。

1 つの Employee レコードを作成する

操作 ID:
CreateASingleEmployeeRecord

指定した EmployeeNumber の 1 つの従業員レコードを作成します。

パラメーター

名前 キー 必須 型 説明
{{company-id}}
 company-id True integer

{{company-id}}会社 ID
ベアラー トークン
 CustomAuthHeader True string

ベアラー トークン値 (キーワード Bearer なし)
環境変数
 CustomEnvironmentHeader True string

API (PROD の場合) または apistaging (STAGING の場合) である変数
body
 body True string

戻り値

名前 パス 型 説明
@odata.context
 @odata.context string

@odata.context
EmployeeId
 EmployeeId integer

EmployeeId
従業員番号
 EmployeeNumber string

従業員番号
Title
 Title string

Title
ファーストネーム
 FirstName string

ファーストネーム
LastName
 LastName string

LastName
PreferredName
 PreferredName string

PreferredName
MaidenName
 MaidenName string

MaidenName
MiddleName
 MiddleName string

MiddleName
イニシャル
 Initials string

イニシャル
Email
 Email string

Email
Birthday
 Birthday string

Birthday
HomeNumber
 HomeNumber string

HomeNumber
WorkNumber
 WorkNumber string

WorkNumber
CellNumber
 CellNumber string

CellNumber
WorkExtension
 WorkExtension string

WorkExtension
Language
 Language string

Language
ジェンダー
 Gender string

ジェンダー
MaritalStatus
 MaritalStatus string

MaritalStatus
競走
 Race string

競走
Nationality
 Nationality string

Nationality
市民権
 Citizenship string

市民権
DisabledType
 DisabledType string

DisabledType
ForeignNational
 ForeignNational boolean

ForeignNational
DateCreated
 DateCreated string

DateCreated
EmergencyContactName
 EmergencyContactName string

EmergencyContactName
EmergencyContactNumber
 EmergencyContactNumber string

EmergencyContactNumber
EmergencyContactAddress
 EmergencyContactAddress string

EmergencyContactAddress
IsRetired
 IsRetired boolean

IsRetired
CustomFieldValue
 CustomFieldValue string

CustomFieldValue
CustomFieldValue2
 CustomFieldValue2 string

CustomFieldValue2
UifExemption
 UifExemption string

UifExemption
SdlExemption
 SdlExemption string

SdlExemption
EtiExempt
 EtiExempt boolean

EtiExempt
ImageDownloadUrl
 ImageDownloadUrl string

ImageDownloadUrl
CustomFields
 CustomFields array of object

CustomFields
Code
 CustomFields.Code string

Code
ラベル
 CustomFields.Label string

ラベル
価値
 CustomFields.Value string

価値
住所
 Address array of object

住所
AddressId
 Address.AddressId integer

AddressId
addressType
 Address.AddressType string

addressType
従業員番号
 Address.EmployeeNumber string

従業員番号
AddressLine1
 Address.AddressLine1 string

AddressLine1
AddressLine2
 Address.AddressLine2 string

AddressLine2
AddressLine3
 Address.AddressLine3 string

AddressLine3
AddressCode
 Address.AddressCode string

AddressCode
AddressCountry
 Address.AddressCountry string

AddressCountry
州
 Address.Province string

州
UnitNumber
 Address.UnitNumber string

UnitNumber
Complex
 Address.Complex string

Complex
StreetNumber
 Address.StreetNumber string

StreetNumber
SameAsPhysical
 Address.SameAsPhysical boolean

SameAsPhysical
IsCareofAddress
 Address.IsCareofAddress boolean

IsCareofAddress
CareOfIntermediary
 Address.CareOfIntermediary string

CareOfIntermediary
SpecialServices
 Address.SpecialServices string

SpecialServices

1 つの位置レコードを作成する

操作 ID:
CreateASinglePositionRecord

指定した EmployeeNumber に対して 1 つの従業員の位置レコードを作成します。

パラメーター

名前 キー 必須 型 説明
{{company-id}}
 company-id True integer

{{company-id}}会社 ID
ベアラー トークン
 CustomAuthHeader True string

ベアラー トークン値 (キーワード Bearer なし)
環境変数
 CustomEnvironmentHeader True string

API (PROD の場合) または apistaging (STAGING の場合) である変数
body
 body True string

戻り値

名前 パス 型 説明
@odata.context
 @odata.context string

@odata.context
EmployeePositionId
 EmployeePositionId integer

EmployeePositionId
従業員番号
 EmployeeNumber string

従業員番号
EffectiveDate
 EffectiveDate string

EffectiveDate
OrganizationPosition
 OrganizationPosition string

OrganizationPosition
OrganizationPositionWithCode
 OrganizationPositionWithCode string

OrganizationPositionWithCode
PositionType
 PositionType string

PositionType
Grade
 Grade string

Grade
OccupationalLevel
 OccupationalLevel string

OccupationalLevel
DirectlyReportsPositionOverride
 DirectlyReportsPositionOverride string

DirectlyReportsPositionOverride
DirectlyReportsPosition
 DirectlyReportsPosition string

DirectlyReportsPosition
OrganizationGroup
 OrganizationGroup string

OrganizationGroup
OrganizationGroups
 OrganizationGroups array of

OrganizationGroups
OrganizationRegion
 OrganizationRegion string

OrganizationRegion
PayPoint
 PayPoint string

PayPoint
DirectlyReportsEmployee
 DirectlyReportsEmployee string

DirectlyReportsEmployee
DirectlyReportsEmployeeNumber
 DirectlyReportsEmployeeNumber string

DirectlyReportsEmployeeNumber
EmploymentCategory
 EmploymentCategory string

EmploymentCategory
EmploymentSubCategory
 EmploymentSubCategory string

EmploymentSubCategory
管理者
 Administrator string

管理者
AdministratorEmployeeNumber
 AdministratorEmployeeNumber string

AdministratorEmployeeNumber
WorkflowRole
 WorkflowRole string

WorkflowRole
GeneralLedger
 GeneralLedger string

GeneralLedger
TradeUnion
 TradeUnion string

TradeUnion
IsPromotion
 IsPromotion boolean

IsPromotion
ロスター
 Roster string

ロスター
Job
 Job string

Job
Comments
 Comments string

Comments
AltPositionName
 AltPositionName string

AltPositionName
DateAdded
 DateAdded string

DateAdded
PositionEffectiveDate
 PositionEffectiveDate string

PositionEffectiveDate
CustomTradeUnion
 CustomTradeUnion string

CustomTradeUnion
CustomFields
 CustomFields array of object

CustomFields
Code
 CustomFields.Code string

Code
ラベル
 CustomFields.Label string

ラベル
価値
 CustomFields.Value string

価値

1 つの位置レコードを取得する

操作 ID:
GetASinglePositionRecord

指定した EmployeePositionId に基づいて従業員の位置レコードを取得します。

パラメーター

名前 キー 必須 型 説明
{{company-id}}
 company-id True integer

{{company-id}}会社 ID
{{EmployeePositionId}}
 EmployeePositionId True integer

The EmployeePositionId
ベアラー トークン
 CustomAuthHeader True string

ベアラー トークン値 (キーワード Bearer なし)
環境変数
 CustomEnvironmentHeader True string

API (PROD の場合) または apistaging (STAGING の場合) である変数

戻り値

名前 パス 型 説明
@odata.context
 @odata.context string

@odata.context
@odata.count
 @odata.count integer

@odata.count
value
 value array of object

value
EmployeePositionId
 value.EmployeePositionId integer

EmployeePositionId
従業員番号
 value.EmployeeNumber string

従業員番号
FullName
 value.FullName string

FullName
EffectiveDate
 value.EffectiveDate string

EffectiveDate
OrganizationPosition
 value.OrganizationPosition string

OrganizationPosition
OrganizationPositionId
 value.OrganizationPositionId integer

OrganizationPositionId
OrganizationPositionWithCode
 value.OrganizationPositionWithCode string

OrganizationPositionWithCode
PositionType
 value.PositionType string

PositionType
Grade
 value.Grade string

Grade
OccupationalLevel
 value.OccupationalLevel string

OccupationalLevel
DirectlyReportsPositionOverride
 value.DirectlyReportsPositionOverride string

DirectlyReportsPositionOverride
DirectlyReportsPosition
 value.DirectlyReportsPosition string

DirectlyReportsPosition
OrganizationGroup
 value.OrganizationGroup string

OrganizationGroup
OrganizationGroupDescription
 value.OrganizationGroupDescription string

OrganizationGroupDescription
OrganizationGroups
 value.OrganizationGroups array of object

OrganizationGroups
OrganizationUnitId
 value.OrganizationGroups.OrganizationUnitId integer

OrganizationUnitId
ParentOrganizationUnitId
 value.OrganizationGroups.ParentOrganizationUnitId integer

ParentOrganizationUnitId
UploadCode
 value.OrganizationGroups.UploadCode string

UploadCode
Description
 value.OrganizationGroups.Description string

Description
CostCentre
 value.OrganizationGroups.CostCentre boolean

CostCentre
OrganizationLevel
 value.OrganizationGroups.OrganizationLevel string

OrganizationLevel
GroupGlKey
 value.OrganizationGroups.GroupGlKey string

GroupGlKey
予算
 value.OrganizationGroups.Budget integer

予算
リファレンス
 value.OrganizationGroups.Reference string

リファレンス
ManagerEmployeeNumber
 value.OrganizationGroups.ManagerEmployeeNumber string

ManagerEmployeeNumber
InactiveDate
 value.OrganizationGroups.InactiveDate string

InactiveDate
OrganizationRegion
 value.OrganizationRegion string

OrganizationRegion
PayPoint
 value.PayPoint string

PayPoint
DirectlyReportsEmployee
 value.DirectlyReportsEmployee string

DirectlyReportsEmployee
DirectlyReportsEmployeeNumber
 value.DirectlyReportsEmployeeNumber string

DirectlyReportsEmployeeNumber
EmploymentCategory
 value.EmploymentCategory string

EmploymentCategory
EmploymentSubCategory
 value.EmploymentSubCategory string

EmploymentSubCategory
管理者
 value.Administrator string

管理者
AdministratorEmployeeNumber
 value.AdministratorEmployeeNumber string

AdministratorEmployeeNumber
WorkflowRole
 value.WorkflowRole string

WorkflowRole
GeneralLedger
 value.GeneralLedger string

GeneralLedger
TradeUnion
 value.TradeUnion string

TradeUnion
IsPromotion
 value.IsPromotion boolean

IsPromotion
ロスター
 value.Roster string

ロスター
Job
 value.Job string

Job
Comments
 value.Comments string

Comments
AltPositionName
 value.AltPositionName string

AltPositionName
DateAdded
 value.DateAdded string

DateAdded
PositionEffectiveDate
 value.PositionEffectiveDate string

PositionEffectiveDate
CustomTradeUnion
 value.CustomTradeUnion string

CustomTradeUnion
CustomFields
 value.CustomFields array of object

CustomFields
Code
 value.CustomFields.Code string

Code
ラベル
 value.CustomFields.Label string

ラベル
価値
 value.CustomFields.Value string

価値

1 つの位置レコードを更新する

操作 ID:
UpdateASinglePositionRecord

指定した EmployeePositionId に基づいて、1 つの従業員の位置レコードを更新します。

パラメーター

名前 キー 必須 型 説明
{{EmployeePositionId}}
 EmployeePositionId True integer

{{EmployeePositionId}}The EmployeePositionId
{{company-id}}
 company-id True integer

{{company-id}}会社 ID
ベアラー トークン
 CustomAuthHeader True string

ベアラー トークン値 (キーワード Bearer なし)
環境変数
 CustomEnvironmentHeader True string

API (PROD の場合) または apistaging (STAGING の場合) である変数
body
 body True string

戻り値

response
object

1 つの従業員の添付ファイル レコードを作成する

操作 ID:
CreateASingleEmployeeAttachmentRecord

指定した EmployeeNumber の添付ファイル レコードを 1 つ作成します。

パラメーター

名前 キー 必須 型 説明
{{company-id}}
 company-id True integer

{{company-id}}会社 ID
ベアラー トークン
 CustomAuthHeader True string

ベアラー トークン値 (キーワード Bearer なし)
環境変数
 CustomEnvironmentHeader True string

API (PROD の場合) または apistaging (STAGING の場合) である変数
body
 body True string

戻り値

名前 パス 型 説明
@odata.context
 @odata.context string

@odata.context
AttachmentId
 AttachmentId integer

AttachmentId
従業員番号
 EmployeeNumber string

従業員番号
Classification
 Classification string

Classification
AttachmentDescription
 AttachmentDescription string

AttachmentDescription
AttachmentName
 AttachmentName string

AttachmentName
AttachmentUrl
 AttachmentUrl string

AttachmentUrl
Attachment
 Attachment string

Attachment
CustomFields
 CustomFields array of object

CustomFields
Code
 CustomFields.Code string

Code
ラベル
 CustomFields.Label string

ラベル
価値
 CustomFields.Value string

価値

1 つの銀行詳細レコードを作成する

操作 ID:
CreateASingleBankDetailRecord

指定した EmployeeNumber の 1 つの従業員銀行詳細レコードを作成します。

パラメーター

名前 キー 必須 型 説明
{{company-id}}
 company-id True integer

{{company-id}}会社 ID
body
 body True string
ベアラー トークン
 CustomAuthHeader True string

ベアラー トークン値 (キーワード Bearer なし)
環境変数
 CustomEnvironmentHeader True string

API (PROD の場合) または apistaging (STAGING の場合) である変数

戻り値

名前 パス 型 説明
@odata.context
 @odata.context string

@odata.context
BankDetailId
 BankDetailId integer

BankDetailId
従業員番号
 EmployeeNumber string

従業員番号
PaymentMethod
 PaymentMethod string

PaymentMethod
SplitType
 SplitType string

SplitType
BankAccountOwner
 BankAccountOwner string

BankAccountOwner
BankAccountOwnerName
 BankAccountOwnerName string

BankAccountOwnerName
AccountType
 AccountType string

AccountType
BankName
 BankName string

BankName
BankBranchNo
 BankBranchNo string

BankBranchNo
BankAccountNo
 BankAccountNo string

BankAccountNo
リファレンス
 Reference string

リファレンス
IsMainAccount
 IsMainAccount boolean

IsMainAccount
金額
 Amount integer

金額
Comments
 Comments string

Comments
SwiftCode
 SwiftCode string

SwiftCode
RoutingCode
 RoutingCode string

RoutingCode
ComponentId
 ComponentId integer

ComponentId

1 つの銀行詳細レコードを削除する

操作 ID:
DeleteASingleBankDetailRecord

指定した BankDetailId に基づいて、従業員の銀行の詳細情報を取得します。

パラメーター

名前 キー 必須 型 説明
{{company-id}}
 company-id True integer

{{company-id}}会社 ID
{{BankDetailId}}
 BankDetailId True integer

{{BankDetailId}}The BankDetailId
ベアラー トークン
 CustomAuthHeader True string

ベアラー トークン値 (キーワード Bearer なし)
環境変数
 CustomEnvironmentHeader True string

API (PROD の場合) または apistaging (STAGING の場合) である変数

戻り値

response
object

1 つの銀行詳細レコードを取得する

操作 ID:
GetASingleBankDetailRecord

指定した BankDetailId に基づいて、従業員の銀行の詳細情報を取得します。

パラメーター

名前 キー 必須 型 説明
{{company-id}}
 company-id True integer

{{company-id}}会社 ID
{{BankDetailId}}
 BankDetailId True integer

The BankDetailId
ベアラー トークン
 CustomAuthHeader True string

ベアラー トークン値 (キーワード Bearer なし)
環境変数
 CustomEnvironmentHeader True string

API (PROD の場合) または apistaging (STAGING の場合) である変数

戻り値

名前 パス 型 説明
@odata.context
 @odata.context string

@odata.context
BankDetailId
 BankDetailId integer

BankDetailId
従業員番号
 EmployeeNumber string

従業員番号
PaymentMethod
 PaymentMethod string

PaymentMethod
SplitType
 SplitType string

SplitType
BankAccountOwner
 BankAccountOwner string

BankAccountOwner
BankAccountOwnerName
 BankAccountOwnerName string

BankAccountOwnerName
AccountType
 AccountType string

AccountType
BankName
 BankName string

BankName
BankBranchNo
 BankBranchNo string

BankBranchNo
BankAccountNo
 BankAccountNo string

BankAccountNo
リファレンス
 Reference string

リファレンス
IsMainAccount
 IsMainAccount boolean

IsMainAccount
金額
 Amount integer

金額
Comments
 Comments string

Comments
SwiftCode
 SwiftCode string

SwiftCode
RoutingCode
 RoutingCode string

RoutingCode
ComponentId
 ComponentId integer

ComponentId

1 つの銀行詳細レコードを更新する

操作 ID:
UpdateASingleBankDetailRecord

指定した BankdetailId に基づいて、1 つの銀行詳細レコードを更新します。

パラメーター

名前 キー 必須 型 説明
{{company-id}}
 company-id True integer

{{company-id}}会社 ID
{{BankDetailId}}
 BankDetailId True integer

{{BankDetailId}}The BankDetailId
ベアラー トークン
 CustomAuthHeader True string

ベアラー トークン値 (キーワード Bearer なし)
環境変数
 CustomEnvironmentHeader True string

API (PROD の場合) または apistaging (STAGING の場合) である変数
body
 body True string

戻り値

response
object

1 つの雇用状態レコードを作成する

操作 ID:
CreateASingleEmploymentStatusRecord

指定した EmployeeNumber に対して 1 つの従業員の雇用状態レコードを作成します。

パラメーター

名前 キー 必須 型 説明
{{company-id}}
 company-id True integer

{{company-id}}会社 ID
ベアラー トークン
 CustomAuthHeader True string

ベアラー トークン値 (キーワード Bearer なし)
環境変数
 CustomEnvironmentHeader True string

API (PROD の場合) または apistaging (STAGING の場合) である変数
body
 body True string

戻り値

名前 パス 型 説明
@odata.context
 @odata.context string

@odata.context
EmploymentStatusId
 EmploymentStatusId integer

EmploymentStatusId
従業員番号
 EmployeeNumber string

従業員番号
GroupJoinDate
 GroupJoinDate string

GroupJoinDate
EmploymentDate
 EmploymentDate string

EmploymentDate
TerminationDate
 TerminationDate string

TerminationDate
TerminationReason
 TerminationReason string

TerminationReason
TaxStatus
 TaxStatus string

TaxStatus
TaxReferenceNumber
 TaxReferenceNumber string

TaxReferenceNumber
NatureOfPerson
 NatureOfPerson string

NatureOfPerson
TaxOffice
 TaxOffice integer

TaxOffice
TaxDirectiveNumber
 TaxDirectiveNumber string

TaxDirectiveNumber
IT3AReason
 IT3AReason integer

IT3AReason
EmploymentAction
 EmploymentAction string

EmploymentAction
TerminationCompanyRun
 TerminationCompanyRun string

TerminationCompanyRun
IdentityType
 IdentityType string

IdentityType
ID番号
 IdNumber string

ID番号
PassportNumber
 PassportNumber string

PassportNumber
PercentageAmount
 PercentageAmount string

PercentageAmount
金額
 Amount integer

金額
百分率
 Percentage integer

百分率
DeemedMonthlyRemuneration
 DeemedMonthlyRemuneration integer

DeemedMonthlyRemuneration
Deemed75Indicator
 Deemed75Indicator boolean

Deemed75Indicator
DeemedRecoveryMonthly
 DeemedRecoveryMonthly boolean

DeemedRecoveryMonthly
EncashLeave
 EncashLeave boolean

EncashLeave
Irp30
 Irp30 boolean

Irp30
FinalizeIssueTaxCert
 FinalizeIssueTaxCert boolean

FinalizeIssueTaxCert
PassportCountry
 PassportCountry boolean

PassportCountry
PassportIssued
 PassportIssued string

PassportIssued
PassportExpiry
 PassportExpiry string

PassportExpiry
PermitIssued
 PermitIssued string

PermitIssued
PermitExpiry
 PermitExpiry string

PermitExpiry
AdditionalDate
 AdditionalDate string

AdditionalDate
EmploymentCaptureDate
 EmploymentCaptureDate string

EmploymentCaptureDate
TerminationCaptureDate
 TerminationCaptureDate string

TerminationCaptureDate
TempWorker
 TempWorker boolean

TempWorker
AdditionalDate1
 AdditionalDate1 string

AdditionalDate1
NotReEmployable
 NotReEmployable boolean

NotReEmployable
ReferenceNumber
 ReferenceNumber string

ReferenceNumber
OldEmployeeId
 OldEmployeeId integer

OldEmployeeId

1 人の従業員の添付ファイル レコードを削除する

操作 ID:
DeleteASingleEmployeeAttachmentRecord

指定した AttachmentId に基づいて、1 つの従業員の添付ファイル レコードを削除します。

パラメーター

名前 キー 必須 型 説明
{{company-id}}
 company-id True integer

{{company-id}}会社 ID
AttachmentId
 AttachmentId True integer

{{AttachmentId}}The AttachmentId
ベアラー トークン
 CustomAuthHeader True string

ベアラー トークン値 (キーワード Bearer なし)
環境変数
 CustomEnvironmentHeader True string

API (PROD の場合) または apistaging (STAGING の場合) である変数

戻り値

response
object

1 人の従業員の添付ファイル レコードを取得する

操作 ID:
GetASingleEmployeeAttachmentRecord

指定した AttachmentId に基づいて従業員の添付ファイル情報を取得します。

パラメーター

名前 キー 必須 型 説明
{{company-id}}
 company-id True integer

{{company-id}}会社 ID
{{AttachmentId}}
 AttachmentId True integer

The AttachmentId
ベアラー トークン
 CustomAuthHeader True string

ベアラー トークン値 (キーワード Bearer なし)
環境変数
 CustomEnvironmentHeader True string

API (PROD の場合) または apistaging (STAGING の場合) である変数

戻り値

名前 パス 型 説明
@odata.context
 @odata.context string

@odata.context
AttachmentId
 AttachmentId integer

AttachmentId
従業員番号
 EmployeeNumber string

従業員番号
Classification
 Classification string

Classification
AttachmentDescription
 AttachmentDescription string

AttachmentDescription
AttachmentName
 AttachmentName string

AttachmentName
AttachmentUrl
 AttachmentUrl string

AttachmentUrl
Attachment
 Attachment string

Attachment
CustomFields
 CustomFields array of object

CustomFields
Code
 CustomFields.Code string

Code
ラベル
 CustomFields.Label string

ラベル
価値
 CustomFields.Value string

価値

1 人の従業員の添付ファイル レコードを更新する

操作 ID:
UpdateASingleEmployeeAttachmentRecord

指定した AttachmentId に基づいて、1 つの添付ファイル レコードを更新します。

パラメーター

名前 キー 必須 型 説明
{{company-id}}
 company-id True integer

{{company-id}}会社 ID
AttachmentId
 AttachmentId True integer

{{AttachmentId}}The AttachmentId
ベアラー トークン
 CustomAuthHeader True string

ベアラー トークン値 (キーワード Bearer なし)
環境変数
 CustomEnvironmentHeader True string

API (PROD の場合) または apistaging (STAGING の場合) である変数
body
 body True string

戻り値

response
object

1 人の従業員レコードを取得する

操作 ID:
GetASingleEmployeeRecord

指定した EmployeeId に基づいて従業員情報を取得します。

パラメーター

名前 キー 必須 型 説明
{{company-id}}
 company-id True integer

{{company-id}}会社 ID
{{EmployeeId}}
 EmployeeId True integer

The EmployeeId
ベアラー トークン
 CustomAuthHeader True string

ベアラー トークン値 (キーワード Bearer なし)
環境変数
 CustomEnvironmentHeader True string

API (PROD の場合) または apistaging (STAGING の場合) である変数

戻り値

名前 パス 型 説明
@odata.context
 @odata.context string

@odata.context
EmployeeId
 EmployeeId integer

EmployeeId
従業員番号
 EmployeeNumber string

従業員番号
Title
 Title string

Title
ファーストネーム
 FirstName string

ファーストネーム
LastName
 LastName string

LastName
PreferredName
 PreferredName string

PreferredName
MaidenName
 MaidenName string

MaidenName
MiddleName
 MiddleName string

MiddleName
イニシャル
 Initials string

イニシャル
Email
 Email string

Email
Birthday
 Birthday string

Birthday
HomeNumber
 HomeNumber string

HomeNumber
WorkNumber
 WorkNumber string

WorkNumber
CellNumber
 CellNumber string

CellNumber
WorkExtension
 WorkExtension string

WorkExtension
Language
 Language string

Language
ジェンダー
 Gender string

ジェンダー
MaritalStatus
 MaritalStatus string

MaritalStatus
競走
 Race string

競走
Nationality
 Nationality string

Nationality
市民権
 Citizenship string

市民権
DisabledType
 DisabledType string

DisabledType
ForeignNational
 ForeignNational boolean

ForeignNational
DateCreated
 DateCreated string

DateCreated
EmergencyContactName
 EmergencyContactName string

EmergencyContactName
EmergencyContactNumber
 EmergencyContactNumber string

EmergencyContactNumber
EmergencyContactAddress
 EmergencyContactAddress string

EmergencyContactAddress
IsRetired
 IsRetired boolean

IsRetired
CustomFieldValue
 CustomFieldValue string

CustomFieldValue
CustomFieldValue2
 CustomFieldValue2 string

CustomFieldValue2
UifExemption
 UifExemption string

UifExemption
SdlExemption
 SdlExemption string

SdlExemption
EtiExempt
 EtiExempt boolean

EtiExempt
ImageDownloadUrl
 ImageDownloadUrl string

ImageDownloadUrl
CustomFields
 CustomFields array of object

CustomFields
Code
 CustomFields.Code string

Code
ラベル
 CustomFields.Label string

ラベル
価値
 CustomFields.Value string

価値
住所
 Address array of object

住所
AddressId
 Address.AddressId integer

AddressId
addressType
 Address.AddressType string

addressType
従業員番号
 Address.EmployeeNumber string

従業員番号
AddressLine1
 Address.AddressLine1 string

AddressLine1
AddressLine2
 Address.AddressLine2 string

AddressLine2
AddressLine3
 Address.AddressLine3 string

AddressLine3
AddressCode
 Address.AddressCode string

AddressCode
AddressCountry
 Address.AddressCountry string

AddressCountry
州
 Address.Province string

州
UnitNumber
 Address.UnitNumber string

UnitNumber
Complex
 Address.Complex string

Complex
StreetNumber
 Address.StreetNumber string

StreetNumber
SameAsPhysical
 Address.SameAsPhysical boolean

SameAsPhysical
IsCareofAddress
 Address.IsCareofAddress boolean

IsCareofAddress
CareOfIntermediary
 Address.CareOfIntermediary string

CareOfIntermediary
SpecialServices
 Address.SpecialServices string

SpecialServices

1 人の従業員レコードを更新する

操作 ID:
UpdateASingleEmployeeRecord

指定した EmployeeId に基づいて、1 つの従業員レコードを更新します。

パラメーター

名前 キー 必須 型 説明
{{company-id}}
 company-id True string

{{company-id}}会社 ID
{{EmployeeId}}
 EmployeeId True string

{{EmployeeId}}The EmployeeId
ベアラー トークン
 CustomAuthHeader True string

ベアラー トークン値 (キーワード Bearer なし)
環境変数
 CustomEnvironmentHeader True string

API (PROD の場合) または apistaging (STAGING の場合) である変数
body
 body True string

戻り値

名前 パス 型 説明
@odata.context
 @odata.context string

@odata.context
Success
 Success boolean

Success

すべての雇用状態のコレクションを取得する

操作 ID:
GetACollectionOfAllEmploymentStatuses

指定した会社 ID に基づいて、すべての従業員の雇用状態の一覧を取得します。

パラメーター

名前 キー 必須 型 説明
{{$employee-field}}
 $orderby string

省略可能 (文字列) - 項目が返される順序を指定します
省略可能な$top
 $top integer

(integer($int 32)) - コレクションから返される項目の数を制限します
省略可能な$skip
 $skip True integer

(integer($int 32)) - クエリされたコレクションの指定された数の項目を結果から除外します
省略可能な$count
 $count True string

(true/false) - 応答の合計カウントを返します
省略可能な$filter
 $filter string

フィールドでフィルター処理する例 "EmployeeNumber eq 'Emp01'"
{{company-id}}
 company-id True integer

{{company-id}}会社 ID
ベアラー トークン
 CustomAuthHeader True string

ベアラー トークン値 (キーワード Bearer なし)
環境変数
 CustomEnvironmentHeader True string

API (PROD の場合) または apistaging (STAGING の場合) である変数

戻り値

名前 パス 型 説明
@odata.context
 @odata.context string

@odata.context
@odata.count
 @odata.count integer

@odata.count
value
 value array of object

value
EmploymentStatusId
 value.EmploymentStatusId integer

EmploymentStatusId
従業員番号
 value.EmployeeNumber string

従業員番号
GroupJoinDate
 value.GroupJoinDate string

GroupJoinDate
EmploymentDate
 value.EmploymentDate string

EmploymentDate
TerminationDate
 value.TerminationDate string

TerminationDate
TerminationReason
 value.TerminationReason string

TerminationReason
TaxStatus
 value.TaxStatus string

TaxStatus
TaxReferenceNumber
 value.TaxReferenceNumber string

TaxReferenceNumber
NatureOfPerson
 value.NatureOfPerson string

NatureOfPerson
TaxOffice
 value.TaxOffice integer

TaxOffice
TaxDirectiveNumber
 value.TaxDirectiveNumber string

TaxDirectiveNumber
IT3AReason
 value.IT3AReason integer

IT3AReason
EmploymentAction
 value.EmploymentAction string

EmploymentAction
TerminationCompanyRun
 value.TerminationCompanyRun string

TerminationCompanyRun
IdentityType
 value.IdentityType string

IdentityType
ID番号
 value.IdNumber string

ID番号
PassportNumber
 value.PassportNumber string

PassportNumber
PercentageAmount
 value.PercentageAmount string

PercentageAmount
金額
 value.Amount integer

金額
百分率
 value.Percentage integer

百分率
DeemedMonthlyRemuneration
 value.DeemedMonthlyRemuneration integer

DeemedMonthlyRemuneration
Deemed75Indicator
 value.Deemed75Indicator boolean

Deemed75Indicator
DeemedRecoveryMonthly
 value.DeemedRecoveryMonthly boolean

DeemedRecoveryMonthly
EncashLeave
 value.EncashLeave boolean

EncashLeave
Irp30
 value.Irp30 boolean

Irp30
FinalizeIssueTaxCert
 value.FinalizeIssueTaxCert boolean

FinalizeIssueTaxCert
PassportCountry
 value.PassportCountry boolean

PassportCountry
PassportIssued
 value.PassportIssued string

PassportIssued
PassportExpiry
 value.PassportExpiry string

PassportExpiry
PermitIssued
 value.PermitIssued string

PermitIssued
PermitExpiry
 value.PermitExpiry string

PermitExpiry
AdditionalDate
 value.AdditionalDate string

AdditionalDate
EmploymentCaptureDate
 value.EmploymentCaptureDate string

EmploymentCaptureDate
TerminationCaptureDate
 value.TerminationCaptureDate string

TerminationCaptureDate
TempWorker
 value.TempWorker boolean

TempWorker
AdditionalDate1
 value.AdditionalDate1 string

AdditionalDate1
NotReEmployable
 value.NotReEmployable boolean

NotReEmployable
ReferenceNumber
 value.ReferenceNumber string

ReferenceNumber
OldEmployeeId
 value.OldEmployeeId integer

OldEmployeeId
CustomFields
 value.CustomFields array of object

CustomFields
Code
 value.CustomFields.Code string

Code
ラベル
 value.CustomFields.Label string

ラベル
価値
 value.CustomFields.Value string

価値

位置のコレクションを取得する

操作 ID:
GetACollectionOfPositions

指定したcompany_idに基づいて、今日の日付の従業員の役職レコードの一覧を取得します。

パラメーター

名前 キー 必須 型 説明
省略可能な$top
 $top integer

(integer($int 32)) - コレクションから返される項目の数を制限します
省略可能な$skip
 $skip True integer

(integer($int 32)) - クエリされたコレクションの指定された数の項目を結果から除外します
省略可能な$count
 $count True string

(true/false) - 応答の合計カウントを返します
省略可能な$filter
 $filter string

フィールドでフィルター処理する例 "EmployeeNumber eq 'Emp01'"
省略可能な$expand
 $expand True string

省略可能 - OrganizationGroups フィールド データを返すには、値 'OrganizationGroups' を使用します
{{company-id}}
 company-id True integer

{{company-id}}会社 ID
ベアラー トークン
 CustomAuthHeader True string

ベアラー トークン値 (キーワード Bearer なし)
環境変数
 CustomEnvironmentHeader True string

API (PROD の場合) または apistaging (STAGING の場合) である変数

戻り値

名前 パス 型 説明
@odata.context
 @odata.context string

@odata.context
@odata.count
 @odata.count integer

@odata.count
value
 value array of object

value
EmployeePositionId
 value.EmployeePositionId integer

EmployeePositionId
従業員番号
 value.EmployeeNumber string

従業員番号
FullName
 value.FullName string

FullName
EffectiveDate
 value.EffectiveDate string

EffectiveDate
OrganizationPosition
 value.OrganizationPosition string

OrganizationPosition
OrganizationPositionId
 value.OrganizationPositionId integer

OrganizationPositionId
OrganizationPositionWithCode
 value.OrganizationPositionWithCode string

OrganizationPositionWithCode
PositionType
 value.PositionType string

PositionType
Grade
 value.Grade string

Grade
OccupationalLevel
 value.OccupationalLevel string

OccupationalLevel
DirectlyReportsPositionOverride
 value.DirectlyReportsPositionOverride string

DirectlyReportsPositionOverride
DirectlyReportsPosition
 value.DirectlyReportsPosition string

DirectlyReportsPosition
OrganizationGroup
 value.OrganizationGroup string

OrganizationGroup
OrganizationGroupDescription
 value.OrganizationGroupDescription string

OrganizationGroupDescription
OrganizationGroups
 value.OrganizationGroups array of object

OrganizationGroups
OrganizationUnitId
 value.OrganizationGroups.OrganizationUnitId integer

OrganizationUnitId
ParentOrganizationUnitId
 value.OrganizationGroups.ParentOrganizationUnitId integer

ParentOrganizationUnitId
UploadCode
 value.OrganizationGroups.UploadCode string

UploadCode
Description
 value.OrganizationGroups.Description string

Description
CostCentre
 value.OrganizationGroups.CostCentre boolean

CostCentre
OrganizationLevel
 value.OrganizationGroups.OrganizationLevel string

OrganizationLevel
GroupGlKey
 value.OrganizationGroups.GroupGlKey string

GroupGlKey
予算
 value.OrganizationGroups.Budget integer

予算
リファレンス
 value.OrganizationGroups.Reference string

リファレンス
ManagerEmployeeNumber
 value.OrganizationGroups.ManagerEmployeeNumber string

ManagerEmployeeNumber
InactiveDate
 value.OrganizationGroups.InactiveDate string

InactiveDate
OrganizationRegion
 value.OrganizationRegion string

OrganizationRegion
PayPoint
 value.PayPoint string

PayPoint
DirectlyReportsEmployee
 value.DirectlyReportsEmployee string

DirectlyReportsEmployee
DirectlyReportsEmployeeNumber
 value.DirectlyReportsEmployeeNumber string

DirectlyReportsEmployeeNumber
EmploymentCategory
 value.EmploymentCategory string

EmploymentCategory
EmploymentSubCategory
 value.EmploymentSubCategory string

EmploymentSubCategory
管理者
 value.Administrator string

管理者
AdministratorEmployeeNumber
 value.AdministratorEmployeeNumber string

AdministratorEmployeeNumber
WorkflowRole
 value.WorkflowRole string

WorkflowRole
GeneralLedger
 value.GeneralLedger string

GeneralLedger
TradeUnion
 value.TradeUnion string

TradeUnion
IsPromotion
 value.IsPromotion boolean

IsPromotion
ロスター
 value.Roster string

ロスター
Job
 value.Job string

Job
Comments
 value.Comments string

Comments
AltPositionName
 value.AltPositionName string

AltPositionName
DateAdded
 value.DateAdded string

DateAdded
PositionEffectiveDate
 value.PositionEffectiveDate string

PositionEffectiveDate
CustomTradeUnion
 value.CustomTradeUnion string

CustomTradeUnion
CustomFields
 value.CustomFields array of object

CustomFields
Code
 value.CustomFields.Code string

Code
ラベル
 value.CustomFields.Label string

ラベル
価値
 value.CustomFields.Value string

価値

従業員のコレクションを取得する

操作 ID:
GetACollectionOfEmployees

指定した会社 ID に基づいて、今日の現在のアクティブな従業員の略歴の詳細の一覧を取得します。

パラメーター

名前 キー 必須 型 説明
{{company-id}}
 company-id True integer

{{company-id}}会社 ID
{{$employee-field}} による省略可能
 $orderby string

(文字列) - 項目が返される順序を指定します
省略可能な$top
 $top integer

(integer($int 32)) - コレクションから返される項目の数を制限します
省略可能な$skip
 $skip integer

(integer($int 32)) - クエリされたコレクションの指定された数の項目を結果から除外します
省略可能な$count
 $count string

(true/false) - 応答の合計カウントを返します
省略可能な$filter
 $filter string

省略可能 - フィールドでフィルター処理など。 "EmployeeNumber eq 'Emp01'"
省略可能な$select
 $select string

省略可能 (文字列) - 指定されたフィールドのみを返します
ベアラー トークン
 CustomAuthHeader True string

ベアラー トークン値 (キーワード Bearer なし)
環境変数
 CustomEnvironmentHeader True string

API (PROD の場合) または apistaging (STAGING の場合) である変数

戻り値

名前 パス 型 説明
@odata.context
 @odata.context string

@odata.context
@odata.count
 @odata.count integer

@odata.count
value
 value array of object

value
EmployeeId
 value.EmployeeId integer

EmployeeId
従業員番号
 value.EmployeeNumber string

従業員番号
Title
 value.Title string

Title
ファーストネーム
 value.FirstName string

ファーストネーム
LastName
 value.LastName string

LastName
PreferredName
 value.PreferredName string

PreferredName
MaidenName
 value.MaidenName string

MaidenName
MiddleName
 value.MiddleName string

MiddleName
イニシャル
 value.Initials string

イニシャル
Email
 value.Email string

Email
Birthday
 value.Birthday string

Birthday
HomeNumber
 value.HomeNumber string

HomeNumber
WorkNumber
 value.WorkNumber string

WorkNumber
CellNumber
 value.CellNumber string

CellNumber
WorkExtension
 value.WorkExtension string

WorkExtension
Language
 value.Language string

Language
ジェンダー
 value.Gender string

ジェンダー
MaritalStatus
 value.MaritalStatus string

MaritalStatus
競走
 value.Race string

競走
Nationality
 value.Nationality string

Nationality
市民権
 value.Citizenship string

市民権
DisabledType
 value.DisabledType string

DisabledType
ForeignNational
 value.ForeignNational boolean

ForeignNational
DateCreated
 value.DateCreated string

DateCreated
EmergencyContactName
 value.EmergencyContactName string

EmergencyContactName
EmergencyContactNumber
 value.EmergencyContactNumber string

EmergencyContactNumber
EmergencyContactAddress
 value.EmergencyContactAddress string

EmergencyContactAddress
IsRetired
 value.IsRetired boolean

IsRetired
CustomFieldValue
 value.CustomFieldValue string

CustomFieldValue
CustomFieldValue2
 value.CustomFieldValue2 string

CustomFieldValue2
UifExemption
 value.UifExemption string

UifExemption
SdlExemption
 value.SdlExemption string

SdlExemption
EtiExempt
 value.EtiExempt boolean

EtiExempt
ImageDownloadUrl
 value.ImageDownloadUrl string

ImageDownloadUrl
CustomFields
 value.CustomFields array of object

CustomFields
Code
 value.CustomFields.Code string

Code
ラベル
 value.CustomFields.Label string

ラベル
価値
 value.CustomFields.Value string

価値
住所
 value.Address array of object

住所
AddressId
 value.Address.AddressId integer

AddressId
addressType
 value.Address.AddressType string

addressType
従業員番号
 value.Address.EmployeeNumber string

従業員番号
AddressLine1
 value.Address.AddressLine1 string

AddressLine1
AddressLine2
 value.Address.AddressLine2 string

AddressLine2
AddressLine3
 value.Address.AddressLine3 string

AddressLine3
AddressCode
 value.Address.AddressCode string

AddressCode
AddressCountry
 value.Address.AddressCountry string

AddressCountry
州
 value.Address.Province string

州
UnitNumber
 value.Address.UnitNumber string

UnitNumber
Complex
 value.Address.Complex string

Complex
StreetNumber
 value.Address.StreetNumber string

StreetNumber
SameAsPhysical
 value.Address.SameAsPhysical boolean

SameAsPhysical
IsCareofAddress
 value.Address.IsCareofAddress boolean

IsCareofAddress
CareOfIntermediary
 value.Address.CareOfIntermediary string

CareOfIntermediary
SpecialServices
 value.Address.SpecialServices string

SpecialServices

従業員の写真をアップロードする

操作 ID:
UploadEmployeePhoto

指定した EmployeeId に基づいて、1 人の従業員の写真を更新します。

パラメーター

名前 キー 必須 型 説明
{{company-id}}
 company-id True integer

{{company-id}}会社 ID
{{EmployeeId}}
 EmployeeId True integer

The EmployeeId
ベアラー トークン
 CustomAuthHeader True string

ベアラー トークン値 (キーワード Bearer なし)
環境変数
 CustomEnvironmentHeader True string

API (PROD の場合) または apistaging (STAGING の場合) である変数

戻り値

名前 パス 型 説明
@odata.context
 @odata.context string

@odata.context
Success
 Success boolean

Success

従業員の写真をダウンロードする

操作 ID:
DownloadEmployeePhoto

指定した EmployeeId に基づいて、1 つの従業員の写真を取得します。

パラメーター

名前 キー 必須 型 説明
{{company-id}}
 company-id True integer

{{company-id}}会社 ID
{{EmployeeId}}
 EmployeeId True integer

The EmployeeId
ベアラー トークン
 CustomAuthHeader True string

ベアラー トークン値 (キーワード Bearer なし)
環境変数
 CustomEnvironmentHeader True string

API (PROD の場合) または apistaging (STAGING の場合) である変数

戻り値

名前 パス 型 説明
@odata.context
 @odata.context string

@odata.context
Success
 Success boolean

Success

従業員の添付ファイル レコードのコレクションを取得する

操作 ID:
GetACollectionOfEmployeeAttachmentRecords

指定したcompany_idに基づいて、アクティブな従業員の添付ファイル レコードの一覧を取得します。

パラメーター

名前 キー 必須 型 説明
{{$attachment-field}} による省略可能
 $orderby string

(文字列) - 項目が返される順序を指定します
省略可能な$top
 $top integer

(integer($int 32)) - コレクションから返される項目の数を制限します
省略可能な$skip
 $skip True integer

(integer($int 32)) - クエリされたコレクションの指定された数の項目を結果から除外します
省略可能な$count
 $count True string

(true/false) - 応答の合計カウントを返します
省略可能な$filter
 $filter string

フィールドでフィルター処理する例 "EmployeeNumber eq 'Emp01'"
{{company-id}}
 company-id True integer

{{company-id}}会社 ID
ベアラー トークン
 CustomAuthHeader True string

ベアラー トークン値 (キーワード Bearer なし)
環境変数
 CustomEnvironmentHeader True string

API (PROD の場合) または apistaging (STAGING の場合) である変数

戻り値

名前 パス 型 説明
@odata.context
 @odata.context string

@odata.context
@odata.count
 @odata.count integer

@odata.count
value
 value array of object

value
AttachmentId
 value.AttachmentId integer

AttachmentId
従業員番号
 value.EmployeeNumber string

従業員番号
Classification
 value.Classification string

Classification
AttachmentDescription
 value.AttachmentDescription string

AttachmentDescription
AttachmentName
 value.AttachmentName string

AttachmentName
AttachmentUrl
 value.AttachmentUrl string

AttachmentUrl
Attachment
 value.Attachment string

Attachment
CustomFields
 value.CustomFields array of object

CustomFields
Code
 value.CustomFields.Code string

Code
ラベル
 value.CustomFields.Label string

ラベル
価値
 value.CustomFields.Value string

価値

有効な日付の位置のコレクションを取得する

操作 ID:
GetACollectionOfPositionsAsOfAnEffectiveDate

指定したcompany_idに基づいて、指定した有効日の従業員の位置レコードの一覧を取得します。

パラメーター

名前 キー 必須 型 説明
{{$employee-field}}
 $orderby True string

(文字列) - 項目が返される順序を指定します
省略可能な$top
 $top integer

(integer($int 32)) - コレクションから返される項目の数を制限します
省略可能な$skip
 $skip True integer

(integer($int 32)) - クエリされたコレクションの指定された数の項目を結果から除外します
省略可能な$count
 $count True string

(true/false) - 応答の合計カウントを返します
省略可能な$expand
 $expand True string

省略可能 - OrganizationGroups フィールド データを返すには、値 'OrganizationGroups' を使用します
{{company-id}}
 company-id True integer

{{company-id}}会社 ID
effectivedate
 effectivedate True string

YYYY-MM-DD で書式設定された有効日。例えば。2022-01-15
ベアラー トークン
 CustomAuthHeader True string

ベアラー トークン値 (キーワード Bearer なし)
環境変数
 CustomEnvironmentHeader True string

API (PROD の場合) または apistaging (STAGING の場合) である変数

戻り値

名前 パス 型 説明
@odata.context
 @odata.context string

@odata.context
@odata.count
 @odata.count integer

@odata.count
value
 value array of object

value
EmployeePositionId
 value.EmployeePositionId integer

EmployeePositionId
従業員番号
 value.EmployeeNumber string

従業員番号
FullName
 value.FullName string

FullName
EffectiveDate
 value.EffectiveDate string

EffectiveDate
OrganizationPosition
 value.OrganizationPosition string

OrganizationPosition
OrganizationPositionId
 value.OrganizationPositionId integer

OrganizationPositionId
OrganizationPositionWithCode
 value.OrganizationPositionWithCode string

OrganizationPositionWithCode
PositionType
 value.PositionType string

PositionType
Grade
 value.Grade string

Grade
OccupationalLevel
 value.OccupationalLevel string

OccupationalLevel
DirectlyReportsPositionOverride
 value.DirectlyReportsPositionOverride string

DirectlyReportsPositionOverride
DirectlyReportsPosition
 value.DirectlyReportsPosition string

DirectlyReportsPosition
OrganizationGroup
 value.OrganizationGroup string

OrganizationGroup
OrganizationGroupDescription
 value.OrganizationGroupDescription string

OrganizationGroupDescription
OrganizationGroups
 value.OrganizationGroups array of object

OrganizationGroups
OrganizationUnitId
 value.OrganizationGroups.OrganizationUnitId integer

OrganizationUnitId
ParentOrganizationUnitId
 value.OrganizationGroups.ParentOrganizationUnitId integer

ParentOrganizationUnitId
UploadCode
 value.OrganizationGroups.UploadCode string

UploadCode
Description
 value.OrganizationGroups.Description string

Description
CostCentre
 value.OrganizationGroups.CostCentre boolean

CostCentre
OrganizationLevel
 value.OrganizationGroups.OrganizationLevel string

OrganizationLevel
GroupGlKey
 value.OrganizationGroups.GroupGlKey string

GroupGlKey
予算
 value.OrganizationGroups.Budget integer

予算
リファレンス
 value.OrganizationGroups.Reference string

リファレンス
ManagerEmployeeNumber
 value.OrganizationGroups.ManagerEmployeeNumber string

ManagerEmployeeNumber
InactiveDate
 value.OrganizationGroups.InactiveDate string

InactiveDate
OrganizationRegion
 value.OrganizationRegion string

OrganizationRegion
PayPoint
 value.PayPoint string

PayPoint
DirectlyReportsEmployee
 value.DirectlyReportsEmployee string

DirectlyReportsEmployee
DirectlyReportsEmployeeNumber
 value.DirectlyReportsEmployeeNumber string

DirectlyReportsEmployeeNumber
EmploymentCategory
 value.EmploymentCategory string

EmploymentCategory
EmploymentSubCategory
 value.EmploymentSubCategory string

EmploymentSubCategory
管理者
 value.Administrator string

管理者
AdministratorEmployeeNumber
 value.AdministratorEmployeeNumber string

AdministratorEmployeeNumber
WorkflowRole
 value.WorkflowRole string

WorkflowRole
GeneralLedger
 value.GeneralLedger string

GeneralLedger
TradeUnion
 value.TradeUnion string

TradeUnion
IsPromotion
 value.IsPromotion boolean

IsPromotion
ロスター
 value.Roster string

ロスター
Job
 value.Job string

Job
Comments
 value.Comments string

Comments
AltPositionName
 value.AltPositionName string

AltPositionName
DateAdded
 value.DateAdded string

DateAdded
PositionEffectiveDate
 value.PositionEffectiveDate string

PositionEffectiveDate
CustomTradeUnion
 value.CustomTradeUnion string

CustomTradeUnion
CustomFields
 value.CustomFields array of object

CustomFields
Code
 value.CustomFields.Code string

Code
ラベル
 value.CustomFields.Label string

ラベル
価値
 value.CustomFields.Value string

価値

有効な日付の時点で従業員のコレクションを取得する

操作 ID:
GetACollectionOfEmployeesAsOfAnEffectiveDate

指定した有効日の時点で、指定した会社 ID に基づいて、アクティブな従業員の略歴の詳細の一覧を取得します。

パラメーター

名前 キー 必須 型 説明
{{company-id}}
 company-id True integer

{{company-id}}会社 ID
effectivedate
 effectivedate True string

YYYY-MM-DD で書式設定された有効日。例えば。2022-01-15
{{$employee-field}} による省略可能
 $orderby string

(文字列) - 項目が返される順序を指定します
省略可能な$top
 $top integer

(integer($int 32)) - コレクションから返される項目の数を制限します
省略可能な$skip
 $skip True integer

(integer($int 32)) - クエリされたコレクションの指定された数の項目を結果から除外します
省略可能な$count
 $count True string

(true/false) - 応答の合計カウントを返します
省略可能な$filter
 $filter string
  • フィールドでフィルター処理する例 "EmployeeNumber eq 'Emp01'"
ベアラー トークン
 CustomAuthHeader True string

ベアラー トークン値 (キーワード Bearer なし)
環境変数
 CustomEnvironmentHeader True string

API (PROD の場合) または apistaging (STAGING の場合) である変数

戻り値

名前 パス 型 説明
@odata.context
 @odata.context string

@odata.context
@odata.count
 @odata.count integer

@odata.count
value
 value array of object

value
EmployeeId
 value.EmployeeId integer

EmployeeId
従業員番号
 value.EmployeeNumber string

従業員番号
Title
 value.Title string

Title
ファーストネーム
 value.FirstName string

ファーストネーム
LastName
 value.LastName string

LastName
PreferredName
 value.PreferredName string

PreferredName
MaidenName
 value.MaidenName string

MaidenName
MiddleName
 value.MiddleName string

MiddleName
イニシャル
 value.Initials string

イニシャル
Email
 value.Email string

Email
Birthday
 value.Birthday string

Birthday
HomeNumber
 value.HomeNumber string

HomeNumber
WorkNumber
 value.WorkNumber string

WorkNumber
CellNumber
 value.CellNumber string

CellNumber
WorkExtension
 value.WorkExtension string

WorkExtension
Language
 value.Language string

Language
ジェンダー
 value.Gender string

ジェンダー
MaritalStatus
 value.MaritalStatus string

MaritalStatus
競走
 value.Race string

競走
Nationality
 value.Nationality string

Nationality
市民権
 value.Citizenship string

市民権
TaxRefNumber
 value.TaxRefNumber string

TaxRefNumber
Disabled
 value.Disabled boolean

Disabled
DisabledType
 value.DisabledType string

DisabledType
EthnicGroup
 value.EthnicGroup string

EthnicGroup
ForeignNational
 value.ForeignNational boolean

ForeignNational
GroupDate
 value.GroupDate string

GroupDate
DateCreated
 value.DateCreated string

DateCreated
EmergencyContactName
 value.EmergencyContactName string

EmergencyContactName
EmergencyContactNumber
 value.EmergencyContactNumber string

EmergencyContactNumber
EmergencyContactAddress
 value.EmergencyContactAddress string

EmergencyContactAddress
IsMockEmployee
 value.IsMockEmployee boolean

IsMockEmployee
IsRetired
 value.IsRetired boolean

IsRetired
CustomFieldValue
 value.CustomFieldValue string

CustomFieldValue
CustomFieldValue2
 value.CustomFieldValue2 string

CustomFieldValue2
UifExemption
 value.UifExemption string

UifExemption
SdlExemption
 value.SdlExemption string

SdlExemption
EtiExempt
 value.EtiExempt boolean

EtiExempt
ImageDownloadUrl
 value.ImageDownloadUrl string

ImageDownloadUrl
CustomFields
 value.CustomFields array of object

CustomFields
Code
 value.CustomFields.Code string

Code
ラベル
 value.CustomFields.Label string

ラベル
価値
 value.CustomFields.Value string

価値
住所
 value.Address array of object

住所
AddressId
 value.Address.AddressId integer

AddressId
addressType
 value.Address.AddressType string

addressType
従業員番号
 value.Address.EmployeeNumber string

従業員番号
AddressLine1
 value.Address.AddressLine1 string

AddressLine1
AddressLine2
 value.Address.AddressLine2 string

AddressLine2
AddressLine3
 value.Address.AddressLine3 string

AddressLine3
AddressCode
 value.Address.AddressCode string

AddressCode
AddressCountry
 value.Address.AddressCountry string

AddressCountry
州
 value.Address.Province string

州
UnitNumber
 value.Address.UnitNumber string

UnitNumber
Complex
 value.Address.Complex string

Complex
StreetNumber
 value.Address.StreetNumber string

StreetNumber
SameAsPhysical
 value.Address.SameAsPhysical boolean

SameAsPhysical
IsCareofAddress
 value.Address.IsCareofAddress boolean

IsCareofAddress
CareOfIntermediary
 value.Address.CareOfIntermediary string

CareOfIntermediary
SpecialServices
 value.Address.SpecialServices string

SpecialServices

銀行詳細レコードのコレクションを取得する

操作 ID:
GetACollectionOfBankDetailRecords

指定したcompany_idに基づいて、従業員の銀行の詳細の一覧を取得します。

パラメーター

名前 キー 必須 型 説明
{{$bank-detail-field}} による省略可能
 $orderby True string

(文字列) - 項目が返される順序を指定します
省略可能な$top
 $top string

(integer($int 32)) - コレクションから返される項目の数を制限します
省略可能な$skip
 $skip True string

(integer($int 32)) - クエリされたコレクションの指定された数の項目を結果から除外します
省略可能な$count
 $count True string

(true/false) - 応答の合計カウントを返します
省略可能な$filter
 $filter string

フィールドでフィルター処理する例 "EmployeeNumber eq 'Emp01'"
{{company-id}}
 company-id True integer

{{company-id}}会社 ID
ベアラー トークン
 CustomAuthHeader True string

ベアラー トークン値 (キーワード Bearer なし)
環境変数
 CustomEnvironmentHeader True string

API (PROD の場合) または apistaging (STAGING の場合) である変数

戻り値

名前 パス 型 説明
@odata.context
 @odata.context string

@odata.context
@odata.count
 @odata.count integer

@odata.count
value
 value array of object

value
BankDetailId
 value.BankDetailId integer

BankDetailId
従業員番号
 value.EmployeeNumber string

従業員番号
PaymentMethod
 value.PaymentMethod string

PaymentMethod
SplitType
 value.SplitType string

SplitType
BankAccountOwner
 value.BankAccountOwner string

BankAccountOwner
BankAccountOwnerName
 value.BankAccountOwnerName string

BankAccountOwnerName
AccountType
 value.AccountType string

AccountType
BankName
 value.BankName string

BankName
BankBranchNo
 value.BankBranchNo string

BankBranchNo
BankAccountNo
 value.BankAccountNo string

BankAccountNo
リファレンス
 value.Reference string

リファレンス
IsMainAccount
 value.IsMainAccount boolean

IsMainAccount
金額
 value.Amount integer

金額
Comments
 value.Comments string

Comments
SwiftCode
 value.SwiftCode string

SwiftCode
RoutingCode
 value.RoutingCode string

RoutingCode
ComponentId
 value.ComponentId integer

ComponentId

雇用状態のコレクションを取得する

操作 ID:
GetACollectionOfEmploymentStatuses

指定した会社 ID に基づいて、現在のアクティブな従業員の雇用状態の一覧を取得します。

パラメーター

名前 キー 必須 型 説明
{{$employee-field}} による省略可能
 $orderby string

(文字列) - 項目が返される順序を指定します
省略可能な$top
 $top integer

(integer($int 32)) - コレクションから返される項目の数を制限します
省略可能な$skip
 $skip True integer

(integer($int 32)) - クエリされたコレクションの指定された数の項目を結果から除外します
省略可能な$count
 $count True string

(true/false) - 応答の合計カウントを返します
省略可能な$filter
 $filter string

フィールドでフィルター処理する例 "EmployeeNumber eq 'Emp01'"
{{company-id}}
 company-id True integer

{{company-id}}会社 ID
ベアラー トークン
 CustomAuthHeader True string

ベアラー トークン値 (キーワード Bearer なし)
環境変数
 CustomEnvironmentHeader True string

API (PROD の場合) または apistaging (STAGING の場合) である変数

戻り値

名前 パス 型 説明
@odata.context
 @odata.context string

@odata.context
@odata.count
 @odata.count integer

@odata.count
value
 value array of object

value
EmploymentStatusId
 value.EmploymentStatusId integer

EmploymentStatusId
従業員番号
 value.EmployeeNumber string

従業員番号
GroupJoinDate
 value.GroupJoinDate string

GroupJoinDate
EmploymentDate
 value.EmploymentDate string

EmploymentDate
TerminationDate
 value.TerminationDate string

TerminationDate
TerminationReason
 value.TerminationReason string

TerminationReason
TaxStatus
 value.TaxStatus string

TaxStatus
TaxReferenceNumber
 value.TaxReferenceNumber string

TaxReferenceNumber
NatureOfPerson
 value.NatureOfPerson string

NatureOfPerson
TaxOffice
 value.TaxOffice integer

TaxOffice
TaxDirectiveNumber
 value.TaxDirectiveNumber string

TaxDirectiveNumber
IT3AReason
 value.IT3AReason integer

IT3AReason
EmploymentAction
 value.EmploymentAction string

EmploymentAction
TerminationCompanyRun
 value.TerminationCompanyRun string

TerminationCompanyRun
IdentityType
 value.IdentityType string

IdentityType
ID番号
 value.IdNumber string

ID番号
PassportNumber
 value.PassportNumber string

PassportNumber
PercentageAmount
 value.PercentageAmount string

PercentageAmount
金額
 value.Amount integer

金額
百分率
 value.Percentage integer

百分率
DeemedMonthlyRemuneration
 value.DeemedMonthlyRemuneration integer

DeemedMonthlyRemuneration
Deemed75Indicator
 value.Deemed75Indicator boolean

Deemed75Indicator
DeemedRecoveryMonthly
 value.DeemedRecoveryMonthly boolean

DeemedRecoveryMonthly
EncashLeave
 value.EncashLeave boolean

EncashLeave
Irp30
 value.Irp30 boolean

Irp30
FinalizeIssueTaxCert
 value.FinalizeIssueTaxCert boolean

FinalizeIssueTaxCert
PassportCountry
 value.PassportCountry boolean

PassportCountry
PassportIssued
 value.PassportIssued string

PassportIssued
PassportExpiry
 value.PassportExpiry string

PassportExpiry
PermitIssued
 value.PermitIssued string

PermitIssued
PermitExpiry
 value.PermitExpiry string

PermitExpiry
AdditionalDate
 value.AdditionalDate string

AdditionalDate
EmploymentCaptureDate
 value.EmploymentCaptureDate string

EmploymentCaptureDate
TerminationCaptureDate
 value.TerminationCaptureDate string

TerminationCaptureDate
TempWorker
 value.TempWorker boolean

TempWorker
AdditionalDate1
 value.AdditionalDate1 string

AdditionalDate1
NotReEmployable
 value.NotReEmployable boolean

NotReEmployable
ReferenceNumber
 value.ReferenceNumber string

ReferenceNumber
OldEmployeeId
 value.OldEmployeeId integer

OldEmployeeId
CustomFields
 value.CustomFields array of object

CustomFields
Code
 value.CustomFields.Code string

Code
ラベル
 value.CustomFields.Label string

ラベル
価値
 value.CustomFields.Value string

価値

定義

オブジェクト

これは型 'object' です。