PaySpace (Editor Independente) (versão prévia)
Nossa solução avançada permite que você acesse seus dados de funcionários para utilizar em seu ambiente de negócios. Todos os pontos de extremidade com suporte em um só lugar e prontos para serem integrados à sua solução.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte ao PaySpace da Mint |
| URL | https://za.mintgroup.net/ |
| payspace.support@mintgroup.net |
| Metadados do conector | |
|---|---|
| Publicador | Tecnologias de gerenciamento da Mint |
| Site | https://www.payspace.com |
| Política de privacidade | https://www.payspace.com/privacy-policy/ |
| Categorias | Recursos Humanos |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Atualizar um único registro de anexo de funcionário |
Atualize um único registro de anexo com base no AttachmentId especificado. |
| Atualizar um único registro de detalhes do banco |
Atualize um único registro de detalhes do banco com base no BankdetailId especificado. |
| Atualizar um único registro de funcionário |
Atualize um único registro de funcionário com base na EmployeeId especificada. |
| Atualizar um único registro de posição |
Atualize um único registro de posição de funcionário com base no EmployeePositionId especificado. |
| Baixar foto do funcionário |
Recupera uma única foto de funcionário com base na EmployeeId especificada. |
| Carregar foto do funcionário |
Atualize uma única foto de funcionário com base na EmployeeId especificada. |
| Criar um único registro de anexo de funcionário |
Crie um único registro de anexo para o EmployeeNumber especificado. |
| Criar um único registro de detalhes do banco |
Crie um único registro de detalhes do banco de funcionários para o EmployeeNumber especificado. |
| Criar um único registro de funcionário |
Crie um único registro de funcionário para o EmployeeNumber especificado. |
| Criar um único registro de posição |
Crie um único registro de posição de funcionário para o EmployeeNumber especificado. |
| Criar um único registro de status de emprego |
Crie um único registro de status de emprego de funcionário para o EmployeeNumber especificado. |
| Excluir um único registro de anexo de funcionário |
Exclua um único registro de anexo de funcionário com base no AttachmentId especificado. |
| Excluir um único registro de detalhes do banco |
Recupera informações detalhadas do banco de funcionários com base no BankDetailId especificado. |
| Obter um único registro de anexo de funcionário |
Recupera informações de anexo do funcionário com base na AttachmentId especificada. |
| Obter um único registro de detalhes do banco |
Recupera informações detalhadas do banco de funcionários com base no BankDetailId especificado. |
| Obter um único registro de funcionário |
Recupera informações de funcionários com base na EmployeeId especificada. |
| Obter um único registro de posição |
Recupera registros de posição do funcionário com base no EmployeePositionId especificado. |
| Obter uma coleção de funcionários |
Recupera uma lista de detalhes biográficos de funcionários ativos a partir da data de hoje e com base na ID da empresa especificada. |
| Obter uma coleção de funcionários a partir de uma data efetiva |
Recupera uma lista de detalhes biográficos de funcionários ativos a partir da data efetiva especificada e com base na ID da empresa especificada. |
| Obter uma coleção de posições |
Recupera uma lista de registros de posição do funcionário a partir da data de hoje e com base no company_id especificado. |
| Obter uma coleção de posições a partir de uma data efetiva |
Recupera uma lista de registros de posição do funcionário a partir da data efetiva especificada e com base no company_id especificado. |
| Obter uma coleção de registros de anexo de funcionário |
Recupera uma lista de registros de anexos de funcionários ativos com base no company_id especificado. |
| Obter uma coleção de registros de detalhes do banco |
Recupera uma lista de detalhes do banco de funcionários com base no company_id especificado. |
| Obter uma coleção de status de emprego |
Recupera uma lista de status de emprego de funcionários ativos atuais com base na ID da empresa especificada. |
| Obter uma coleção de todos os status de emprego |
Recupera uma lista de todos os status de emprego dos funcionários com base na ID da empresa especificada. |
Atualizar um único registro de anexo de funcionário
Atualize um único registro de anexo com base no AttachmentId especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} A ID da Empresa |
|
AttachmentId
|
AttachmentId | True | integer |
{{AttachmentId}} A AttachmentId |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor do token do portador (sem o portador da palavra-chave) |
|
Variável de ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
|
body
|
body | True | string |
Retornos
- response
- object
Atualizar um único registro de detalhes do banco
Atualize um único registro de detalhes do banco com base no BankdetailId especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} A ID da Empresa |
|
{{BankDetailId}}
|
BankDetailId | True | integer |
{{BankDetailId}} O BankDetailId |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor do token do portador (sem o portador da palavra-chave) |
|
Variável de ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
|
body
|
body | True | string |
Retornos
- response
- object
Atualizar um único registro de funcionário
Atualize um único registro de funcionário com base na EmployeeId especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | string |
{{company-id}} A ID da Empresa |
|
{{EmployeeId}}
|
EmployeeId | True | string |
{{EmployeeId}} A EmployeeId |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor do token do portador (sem o portador da palavra-chave) |
|
Variável de ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
|
body
|
body | True | string |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.context
|
@odata.context | string |
@odata.context |
|
Êxito
|
Success | boolean |
Êxito |
Atualizar um único registro de posição
Atualize um único registro de posição de funcionário com base no EmployeePositionId especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
{{EmployeePositionId}}
|
EmployeePositionId | True | integer |
{{EmployeePositionId}} The EmployeePositionId |
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} A ID da Empresa |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor do token do portador (sem o portador da palavra-chave) |
|
Variável de ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
|
body
|
body | True | string |
Retornos
- response
- object
Baixar foto do funcionário
Recupera uma única foto de funcionário com base na EmployeeId especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} A ID da Empresa |
|
{{EmployeeId}}
|
EmployeeId | True | integer |
A EmployeeId |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor do token do portador (sem o portador da palavra-chave) |
|
Variável de ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.context
|
@odata.context | string |
@odata.context |
|
Êxito
|
Success | boolean |
Êxito |
Carregar foto do funcionário
Atualize uma única foto de funcionário com base na EmployeeId especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} A ID da Empresa |
|
{{EmployeeId}}
|
EmployeeId | True | integer |
A EmployeeId |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor do token do portador (sem o portador da palavra-chave) |
|
Variável de ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.context
|
@odata.context | string |
@odata.context |
|
Êxito
|
Success | boolean |
Êxito |
Criar um único registro de anexo de funcionário
Crie um único registro de anexo para o EmployeeNumber especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} A ID da Empresa |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor do token do portador (sem o portador da palavra-chave) |
|
Variável de ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
|
body
|
body | True | string |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.context
|
@odata.context | string |
@odata.context |
|
AttachmentId
|
AttachmentId | integer |
AttachmentId |
|
Número do Funcionário
|
EmployeeNumber | string |
Número do Funcionário |
|
Classification
|
Classification | string |
Classification |
|
AttachmentDescription
|
AttachmentDescription | string |
AttachmentDescription |
|
AttachmentName
|
AttachmentName | string |
AttachmentName |
|
AttachmentUrl
|
AttachmentUrl | string |
AttachmentUrl |
|
Anexo
|
Attachment | string |
Anexo |
|
Campos Personalizados
|
CustomFields | array of object |
Campos Personalizados |
|
Code
|
CustomFields.Code | string |
Code |
|
Etiqueta
|
CustomFields.Label | string |
Etiqueta |
|
Value
|
CustomFields.Value | string |
Value |
Criar um único registro de detalhes do banco
Crie um único registro de detalhes do banco de funcionários para o EmployeeNumber especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} A ID da Empresa |
|
body
|
body | True | string | |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor do token do portador (sem o portador da palavra-chave) |
|
Variável de ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.context
|
@odata.context | string |
@odata.context |
|
BankDetailId
|
BankDetailId | integer |
BankDetailId |
|
Número do Funcionário
|
EmployeeNumber | string |
Número do Funcionário |
|
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 |
|
Referência
|
Reference | string |
Referência |
|
IsMainAccount
|
IsMainAccount | boolean |
IsMainAccount |
|
Quantidade
|
Amount | integer |
Quantidade |
|
Comments
|
Comments | string |
Comments |
|
SwiftCode
|
SwiftCode | string |
SwiftCode |
|
Código de Roteamento
|
RoutingCode | string |
Código de Roteamento |
|
ComponentId
|
ComponentId | integer |
ComponentId |
Criar um único registro de funcionário
Crie um único registro de funcionário para o EmployeeNumber especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} A ID da Empresa |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor do token do portador (sem o portador da palavra-chave) |
|
Variável de ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
|
body
|
body | True | string |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.context
|
@odata.context | string |
@odata.context |
|
EmployeeId
|
EmployeeId | integer |
EmployeeId |
|
Número do Funcionário
|
EmployeeNumber | string |
Número do Funcionário |
|
Title
|
Title | string |
Title |
|
Primeiro Nome
|
FirstName | string |
Primeiro Nome |
|
LastName
|
LastName | string |
LastName |
|
PreferredName
|
PreferredName | string |
PreferredName |
|
MaidenName
|
MaidenName | string |
MaidenName |
|
MiddleName
|
MiddleName | string |
MiddleName |
|
Initials
|
Initials | string |
Initials |
|
Email
|
string |
|
|
|
Aniversário
|
Birthday | string |
Aniversário |
|
HomeNumber
|
HomeNumber | string |
HomeNumber |
|
WorkNumber
|
WorkNumber | string |
WorkNumber |
|
CellNumber
|
CellNumber | string |
CellNumber |
|
WorkExtension
|
WorkExtension | string |
WorkExtension |
|
Linguagem
|
Language | string |
Linguagem |
|
Gênero
|
Gender | string |
Gênero |
|
MaritalStatus
|
MaritalStatus | string |
MaritalStatus |
|
Raça
|
Race | string |
Raça |
|
Nationality
|
Nationality | string |
Nationality |
|
Cidadania
|
Citizenship | string |
Cidadania |
|
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 |
|
Campos Personalizados
|
CustomFields | array of object |
Campos Personalizados |
|
Code
|
CustomFields.Code | string |
Code |
|
Etiqueta
|
CustomFields.Label | string |
Etiqueta |
|
Value
|
CustomFields.Value | string |
Value |
|
Endereço
|
Address | array of object |
Endereço |
|
AddressId
|
Address.AddressId | integer |
AddressId |
|
AddressType
|
Address.AddressType | string |
AddressType |
|
Número do Funcionário
|
Address.EmployeeNumber | string |
Número do Funcionário |
|
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 |
|
Província
|
Address.Province | string |
Província |
|
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 |
Criar um único registro de posição
Crie um único registro de posição de funcionário para o EmployeeNumber especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} A ID da Empresa |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor do token do portador (sem o portador da palavra-chave) |
|
Variável de ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
|
body
|
body | True | string |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.context
|
@odata.context | string |
@odata.context |
|
EmployeePositionId
|
EmployeePositionId | integer |
EmployeePositionId |
|
Número do Funcionário
|
EmployeeNumber | string |
Número do Funcionário |
|
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 |
|
Administradores
|
Administrator | string |
Administradores |
|
AdministratorEmployeeNumber
|
AdministratorEmployeeNumber | string |
AdministratorEmployeeNumber |
|
WorkflowRole
|
WorkflowRole | string |
WorkflowRole |
|
GeneralLedger
|
GeneralLedger | string |
GeneralLedger |
|
TradeUnion
|
TradeUnion | string |
TradeUnion |
|
IsPromotion
|
IsPromotion | boolean |
IsPromotion |
|
Lista
|
Roster | string |
Lista |
|
Job
|
Job | string |
Job |
|
Comments
|
Comments | string |
Comments |
|
AltPositionName
|
AltPositionName | string |
AltPositionName |
|
DateAdded
|
DateAdded | string |
DateAdded |
|
PositionEffectiveDate
|
PositionEffectiveDate | string |
PositionEffectiveDate |
|
CustomTradeUnion
|
CustomTradeUnion | string |
CustomTradeUnion |
|
Campos Personalizados
|
CustomFields | array of object |
Campos Personalizados |
|
Code
|
CustomFields.Code | string |
Code |
|
Etiqueta
|
CustomFields.Label | string |
Etiqueta |
|
Value
|
CustomFields.Value | string |
Value |
Criar um único registro de status de emprego
Crie um único registro de status de emprego de funcionário para o EmployeeNumber especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} A ID da Empresa |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor do token do portador (sem o portador da palavra-chave) |
|
Variável de ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
|
body
|
body | True | string |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.context
|
@odata.context | string |
@odata.context |
|
EmploymentStatusId
|
EmploymentStatusId | integer |
EmploymentStatusId |
|
Número do Funcionário
|
EmployeeNumber | string |
Número do Funcionário |
|
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 |
|
Número de Identificação
|
IdNumber | string |
Número de Identificação |
|
PassportNumber
|
PassportNumber | string |
PassportNumber |
|
PercentageAmount
|
PercentageAmount | string |
PercentageAmount |
|
Quantidade
|
Amount | integer |
Quantidade |
|
Porcentagem
|
Percentage | integer |
Porcentagem |
|
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 |
Excluir um único registro de anexo de funcionário
Exclua um único registro de anexo de funcionário com base no AttachmentId especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} A ID da Empresa |
|
AttachmentId
|
AttachmentId | True | integer |
{{AttachmentId}} A AttachmentId |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor do token do portador (sem o portador da palavra-chave) |
|
Variável de ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Retornos
- response
- object
Excluir um único registro de detalhes do banco
Recupera informações detalhadas do banco de funcionários com base no BankDetailId especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} A ID da Empresa |
|
{{BankDetailId}}
|
BankDetailId | True | integer |
{{BankDetailId}} O BankDetailId |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor do token do portador (sem o portador da palavra-chave) |
|
Variável de ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Retornos
- response
- object
Obter um único registro de anexo de funcionário
Recupera informações de anexo do funcionário com base na AttachmentId especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} A ID da Empresa |
|
{{AttachmentId}}
|
AttachmentId | True | integer |
A AttachmentId |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor do token do portador (sem o portador da palavra-chave) |
|
Variável de ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.context
|
@odata.context | string |
@odata.context |
|
AttachmentId
|
AttachmentId | integer |
AttachmentId |
|
Número do Funcionário
|
EmployeeNumber | string |
Número do Funcionário |
|
Classification
|
Classification | string |
Classification |
|
AttachmentDescription
|
AttachmentDescription | string |
AttachmentDescription |
|
AttachmentName
|
AttachmentName | string |
AttachmentName |
|
AttachmentUrl
|
AttachmentUrl | string |
AttachmentUrl |
|
Anexo
|
Attachment | string |
Anexo |
|
Campos Personalizados
|
CustomFields | array of object |
Campos Personalizados |
|
Code
|
CustomFields.Code | string |
Code |
|
Etiqueta
|
CustomFields.Label | string |
Etiqueta |
|
Value
|
CustomFields.Value | string |
Value |
Obter um único registro de detalhes do banco
Recupera informações detalhadas do banco de funcionários com base no BankDetailId especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} A ID da Empresa |
|
{{BankDetailId}}
|
BankDetailId | True | integer |
O BankDetailId |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor do token do portador (sem o portador da palavra-chave) |
|
Variável de ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.context
|
@odata.context | string |
@odata.context |
|
BankDetailId
|
BankDetailId | integer |
BankDetailId |
|
Número do Funcionário
|
EmployeeNumber | string |
Número do Funcionário |
|
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 |
|
Referência
|
Reference | string |
Referência |
|
IsMainAccount
|
IsMainAccount | boolean |
IsMainAccount |
|
Quantidade
|
Amount | integer |
Quantidade |
|
Comments
|
Comments | string |
Comments |
|
SwiftCode
|
SwiftCode | string |
SwiftCode |
|
Código de Roteamento
|
RoutingCode | string |
Código de Roteamento |
|
ComponentId
|
ComponentId | integer |
ComponentId |
Obter um único registro de funcionário
Recupera informações de funcionários com base na EmployeeId especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} A ID da Empresa |
|
{{EmployeeId}}
|
EmployeeId | True | integer |
A EmployeeId |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor do token do portador (sem o portador da palavra-chave) |
|
Variável de ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.context
|
@odata.context | string |
@odata.context |
|
EmployeeId
|
EmployeeId | integer |
EmployeeId |
|
Número do Funcionário
|
EmployeeNumber | string |
Número do Funcionário |
|
Title
|
Title | string |
Title |
|
Primeiro Nome
|
FirstName | string |
Primeiro Nome |
|
LastName
|
LastName | string |
LastName |
|
PreferredName
|
PreferredName | string |
PreferredName |
|
MaidenName
|
MaidenName | string |
MaidenName |
|
MiddleName
|
MiddleName | string |
MiddleName |
|
Initials
|
Initials | string |
Initials |
|
Email
|
string |
|
|
|
Aniversário
|
Birthday | string |
Aniversário |
|
HomeNumber
|
HomeNumber | string |
HomeNumber |
|
WorkNumber
|
WorkNumber | string |
WorkNumber |
|
CellNumber
|
CellNumber | string |
CellNumber |
|
WorkExtension
|
WorkExtension | string |
WorkExtension |
|
Linguagem
|
Language | string |
Linguagem |
|
Gênero
|
Gender | string |
Gênero |
|
MaritalStatus
|
MaritalStatus | string |
MaritalStatus |
|
Raça
|
Race | string |
Raça |
|
Nationality
|
Nationality | string |
Nationality |
|
Cidadania
|
Citizenship | string |
Cidadania |
|
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 |
|
Campos Personalizados
|
CustomFields | array of object |
Campos Personalizados |
|
Code
|
CustomFields.Code | string |
Code |
|
Etiqueta
|
CustomFields.Label | string |
Etiqueta |
|
Value
|
CustomFields.Value | string |
Value |
|
Endereço
|
Address | array of object |
Endereço |
|
AddressId
|
Address.AddressId | integer |
AddressId |
|
AddressType
|
Address.AddressType | string |
AddressType |
|
Número do Funcionário
|
Address.EmployeeNumber | string |
Número do Funcionário |
|
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 |
|
Província
|
Address.Province | string |
Província |
|
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 |
Obter um único registro de posição
Recupera registros de posição do funcionário com base no EmployeePositionId especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} A ID da Empresa |
|
{{EmployeePositionId}}
|
EmployeePositionId | True | integer |
The EmployeePositionId |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor do token do portador (sem o portador da palavra-chave) |
|
Variável de ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
@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 |
|
Número do Funcionário
|
value.EmployeeNumber | string |
Número do Funcionário |
|
Nome Completo
|
value.FullName | string |
Nome Completo |
|
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 |
|
Orçamento
|
value.OrganizationGroups.Budget | integer |
Orçamento |
|
Referência
|
value.OrganizationGroups.Reference | string |
Referência |
|
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 |
|
Administradores
|
value.Administrator | string |
Administradores |
|
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 |
|
Lista
|
value.Roster | string |
Lista |
|
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 |
|
Campos Personalizados
|
value.CustomFields | array of object |
Campos Personalizados |
|
Code
|
value.CustomFields.Code | string |
Code |
|
Etiqueta
|
value.CustomFields.Label | string |
Etiqueta |
|
Value
|
value.CustomFields.Value | string |
Value |
Obter uma coleção de funcionários
Recupera uma lista de detalhes biográficos de funcionários ativos a partir da data de hoje e com base na ID da empresa especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} A ID da Empresa |
|
Opcional por {{$employee-field}}
|
$orderby | string |
(cadeia de caracteres) – Especifica a ordem na qual os itens são retornados |
|
|
$top opcional
|
$top | integer |
(inteiro($int 32)) – limita o número de itens retornados de uma coleção |
|
|
$skip opcional
|
$skip | integer |
(inteiro($int 32)) – exclui o número especificado de itens da coleção consultada do resultado |
|
|
$count opcional
|
$count | string |
(true/false) – Retornar contagem total em resposta |
|
|
$filter opcional
|
$filter | string |
Opcional – Filtrar por campo, por exemplo. "EmployeeNumber eq 'Emp01'" |
|
|
$select opcional
|
$select | string |
Opcional (cadeia de caracteres) – retorna apenas os campos especificados |
|
|
Token de portador
|
CustomAuthHeader | True | string |
Valor do token do portador (sem o portador da palavra-chave) |
|
Variável de ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
@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 |
|
Número do Funcionário
|
value.EmployeeNumber | string |
Número do Funcionário |
|
Title
|
value.Title | string |
Title |
|
Primeiro Nome
|
value.FirstName | string |
Primeiro Nome |
|
LastName
|
value.LastName | string |
LastName |
|
PreferredName
|
value.PreferredName | string |
PreferredName |
|
MaidenName
|
value.MaidenName | string |
MaidenName |
|
MiddleName
|
value.MiddleName | string |
MiddleName |
|
Initials
|
value.Initials | string |
Initials |
|
Email
|
value.Email | string |
|
|
Aniversário
|
value.Birthday | string |
Aniversário |
|
HomeNumber
|
value.HomeNumber | string |
HomeNumber |
|
WorkNumber
|
value.WorkNumber | string |
WorkNumber |
|
CellNumber
|
value.CellNumber | string |
CellNumber |
|
WorkExtension
|
value.WorkExtension | string |
WorkExtension |
|
Linguagem
|
value.Language | string |
Linguagem |
|
Gênero
|
value.Gender | string |
Gênero |
|
MaritalStatus
|
value.MaritalStatus | string |
MaritalStatus |
|
Raça
|
value.Race | string |
Raça |
|
Nationality
|
value.Nationality | string |
Nationality |
|
Cidadania
|
value.Citizenship | string |
Cidadania |
|
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 |
|
Campos Personalizados
|
value.CustomFields | array of object |
Campos Personalizados |
|
Code
|
value.CustomFields.Code | string |
Code |
|
Etiqueta
|
value.CustomFields.Label | string |
Etiqueta |
|
Value
|
value.CustomFields.Value | string |
Value |
|
Endereço
|
value.Address | array of object |
Endereço |
|
AddressId
|
value.Address.AddressId | integer |
AddressId |
|
AddressType
|
value.Address.AddressType | string |
AddressType |
|
Número do Funcionário
|
value.Address.EmployeeNumber | string |
Número do Funcionário |
|
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 |
|
Província
|
value.Address.Province | string |
Província |
|
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 |
Obter uma coleção de funcionários a partir de uma data efetiva
Recupera uma lista de detalhes biográficos de funcionários ativos a partir da data efetiva especificada e com base na ID da empresa especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} A ID da Empresa |
|
effectivedate
|
effectivedate | True | string |
Data efetiva formatada no YYYY-MM-DD. Eg. 2022-01-15 |
|
Opcional por {{$employee-field}}
|
$orderby | string |
(cadeia de caracteres) – Especifica a ordem na qual os itens são retornados |
|
|
$top opcional
|
$top | integer |
(inteiro($int 32)) – limita o número de itens retornados de uma coleção |
|
|
$skip opcional
|
$skip | True | integer |
(inteiro($int 32)) – exclui o número especificado de itens da coleção consultada do resultado |
|
$count opcional
|
$count | True | string |
(true/false) – Retornar contagem total em resposta |
|
$filter opcional
|
$filter | string |
|
|
|
Token de portador
|
CustomAuthHeader | True | string |
Valor do token do portador (sem o portador da palavra-chave) |
|
Variável de ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
@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 |
|
Número do Funcionário
|
value.EmployeeNumber | string |
Número do Funcionário |
|
Title
|
value.Title | string |
Title |
|
Primeiro Nome
|
value.FirstName | string |
Primeiro Nome |
|
LastName
|
value.LastName | string |
LastName |
|
PreferredName
|
value.PreferredName | string |
PreferredName |
|
MaidenName
|
value.MaidenName | string |
MaidenName |
|
MiddleName
|
value.MiddleName | string |
MiddleName |
|
Initials
|
value.Initials | string |
Initials |
|
Email
|
value.Email | string |
|
|
Aniversário
|
value.Birthday | string |
Aniversário |
|
HomeNumber
|
value.HomeNumber | string |
HomeNumber |
|
WorkNumber
|
value.WorkNumber | string |
WorkNumber |
|
CellNumber
|
value.CellNumber | string |
CellNumber |
|
WorkExtension
|
value.WorkExtension | string |
WorkExtension |
|
Linguagem
|
value.Language | string |
Linguagem |
|
Gênero
|
value.Gender | string |
Gênero |
|
MaritalStatus
|
value.MaritalStatus | string |
MaritalStatus |
|
Raça
|
value.Race | string |
Raça |
|
Nationality
|
value.Nationality | string |
Nationality |
|
Cidadania
|
value.Citizenship | string |
Cidadania |
|
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 |
|
Campos Personalizados
|
value.CustomFields | array of object |
Campos Personalizados |
|
Code
|
value.CustomFields.Code | string |
Code |
|
Etiqueta
|
value.CustomFields.Label | string |
Etiqueta |
|
Value
|
value.CustomFields.Value | string |
Value |
|
Endereço
|
value.Address | array of object |
Endereço |
|
AddressId
|
value.Address.AddressId | integer |
AddressId |
|
AddressType
|
value.Address.AddressType | string |
AddressType |
|
Número do Funcionário
|
value.Address.EmployeeNumber | string |
Número do Funcionário |
|
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 |
|
Província
|
value.Address.Province | string |
Província |
|
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 |
Obter uma coleção de posições
Recupera uma lista de registros de posição do funcionário a partir da data de hoje e com base no company_id especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
$top opcional
|
$top | integer |
(inteiro($int 32)) – limita o número de itens retornados de uma coleção |
|
|
$skip opcional
|
$skip | True | integer |
(inteiro($int 32)) – exclui o número especificado de itens da coleção consultada do resultado |
|
$count opcional
|
$count | True | string |
(true/false) – Retornar contagem total em resposta |
|
$filter opcional
|
$filter | string |
Filtrar por campo, por exemplo. "EmployeeNumber eq 'Emp01'" |
|
|
$expand opcional
|
$expand | True | string |
Opcional : para retornar os dados de campo OrganizationGroups, use o valor 'OrganizationGroups' |
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} A ID da Empresa |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor do token do portador (sem o portador da palavra-chave) |
|
Variável de ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
@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 |
|
Número do Funcionário
|
value.EmployeeNumber | string |
Número do Funcionário |
|
Nome Completo
|
value.FullName | string |
Nome Completo |
|
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 |
|
Orçamento
|
value.OrganizationGroups.Budget | integer |
Orçamento |
|
Referência
|
value.OrganizationGroups.Reference | string |
Referência |
|
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 |
|
Administradores
|
value.Administrator | string |
Administradores |
|
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 |
|
Lista
|
value.Roster | string |
Lista |
|
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 |
|
Campos Personalizados
|
value.CustomFields | array of object |
Campos Personalizados |
|
Code
|
value.CustomFields.Code | string |
Code |
|
Etiqueta
|
value.CustomFields.Label | string |
Etiqueta |
|
Value
|
value.CustomFields.Value | string |
Value |
Obter uma coleção de posições a partir de uma data efetiva
Recupera uma lista de registros de posição do funcionário a partir da data efetiva especificada e com base no company_id especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
{{$employee-field}}
|
$orderby | True | string |
(cadeia de caracteres) – Especifica a ordem na qual os itens são retornados |
|
$top opcional
|
$top | integer |
(inteiro($int 32)) – limita o número de itens retornados de uma coleção |
|
|
$skip opcional
|
$skip | True | integer |
(inteiro($int 32)) – exclui o número especificado de itens da coleção consultada do resultado |
|
$count opcional
|
$count | True | string |
(true/false) – Retornar contagem total em resposta |
|
$expand opcional
|
$expand | True | string |
Opcional : para retornar os dados de campo OrganizationGroups, use o valor 'OrganizationGroups' |
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} A ID da Empresa |
|
effectivedate
|
effectivedate | True | string |
Data efetiva formatada no YYYY-MM-DD. Eg. 2022-01-15 |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor do token do portador (sem o portador da palavra-chave) |
|
Variável de ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
@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 |
|
Número do Funcionário
|
value.EmployeeNumber | string |
Número do Funcionário |
|
Nome Completo
|
value.FullName | string |
Nome Completo |
|
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 |
|
Orçamento
|
value.OrganizationGroups.Budget | integer |
Orçamento |
|
Referência
|
value.OrganizationGroups.Reference | string |
Referência |
|
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 |
|
Administradores
|
value.Administrator | string |
Administradores |
|
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 |
|
Lista
|
value.Roster | string |
Lista |
|
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 |
|
Campos Personalizados
|
value.CustomFields | array of object |
Campos Personalizados |
|
Code
|
value.CustomFields.Code | string |
Code |
|
Etiqueta
|
value.CustomFields.Label | string |
Etiqueta |
|
Value
|
value.CustomFields.Value | string |
Value |
Obter uma coleção de registros de anexo de funcionário
Recupera uma lista de registros de anexos de funcionários ativos com base no company_id especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Opcional por {{$attachment-field}}
|
$orderby | string |
(cadeia de caracteres) – Especifica a ordem na qual os itens são retornados |
|
|
$top opcional
|
$top | integer |
(inteiro($int 32)) – limita o número de itens retornados de uma coleção |
|
|
$skip opcional
|
$skip | True | integer |
(inteiro($int 32)) – exclui o número especificado de itens da coleção consultada do resultado |
|
$count opcional
|
$count | True | string |
(true/false) – Retornar contagem total em resposta |
|
$filter opcional
|
$filter | string |
Filtrar por campo, por exemplo. "EmployeeNumber eq 'Emp01'" |
|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} A ID da Empresa |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor do token do portador (sem o portador da palavra-chave) |
|
Variável de ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
@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 |
|
Número do Funcionário
|
value.EmployeeNumber | string |
Número do Funcionário |
|
Classification
|
value.Classification | string |
Classification |
|
AttachmentDescription
|
value.AttachmentDescription | string |
AttachmentDescription |
|
AttachmentName
|
value.AttachmentName | string |
AttachmentName |
|
AttachmentUrl
|
value.AttachmentUrl | string |
AttachmentUrl |
|
Anexo
|
value.Attachment | string |
Anexo |
|
Campos Personalizados
|
value.CustomFields | array of object |
Campos Personalizados |
|
Code
|
value.CustomFields.Code | string |
Code |
|
Etiqueta
|
value.CustomFields.Label | string |
Etiqueta |
|
Value
|
value.CustomFields.Value | string |
Value |
Obter uma coleção de registros de detalhes do banco
Recupera uma lista de detalhes do banco de funcionários com base no company_id especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Opcional por {{$bank-detail-field}}
|
$orderby | True | string |
(cadeia de caracteres) – Especifica a ordem na qual os itens são retornados |
|
$top opcional
|
$top | string |
(inteiro($int 32)) – limita o número de itens retornados de uma coleção |
|
|
$skip opcional
|
$skip | True | string |
(inteiro($int 32)) – exclui o número especificado de itens da coleção consultada do resultado |
|
$count opcional
|
$count | True | string |
(true/false) – Retornar contagem total em resposta |
|
$filter opcional
|
$filter | string |
Filtrar por campo, por exemplo. "EmployeeNumber eq 'Emp01'" |
|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} A ID da Empresa |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor do token do portador (sem o portador da palavra-chave) |
|
Variável de ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
@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 |
|
Número do Funcionário
|
value.EmployeeNumber | string |
Número do Funcionário |
|
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 |
|
Referência
|
value.Reference | string |
Referência |
|
IsMainAccount
|
value.IsMainAccount | boolean |
IsMainAccount |
|
Quantidade
|
value.Amount | integer |
Quantidade |
|
Comments
|
value.Comments | string |
Comments |
|
SwiftCode
|
value.SwiftCode | string |
SwiftCode |
|
Código de Roteamento
|
value.RoutingCode | string |
Código de Roteamento |
|
ComponentId
|
value.ComponentId | integer |
ComponentId |
Obter uma coleção de status de emprego
Recupera uma lista de status de emprego de funcionários ativos atuais com base na ID da empresa especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Opcional por {{$employee-field}}
|
$orderby | string |
(cadeia de caracteres) – Especifica a ordem na qual os itens são retornados |
|
|
$top opcional
|
$top | integer |
(inteiro($int 32)) – limita o número de itens retornados de uma coleção |
|
|
$skip opcional
|
$skip | True | integer |
(inteiro($int 32)) – exclui o número especificado de itens da coleção consultada do resultado |
|
$count opcional
|
$count | True | string |
(true/false) – Retornar contagem total em resposta |
|
$filter opcional
|
$filter | string |
Filtrar por campo, por exemplo. "EmployeeNumber eq 'Emp01'" |
|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} A ID da Empresa |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor do token do portador (sem o portador da palavra-chave) |
|
Variável de ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
@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 |
|
Número do Funcionário
|
value.EmployeeNumber | string |
Número do Funcionário |
|
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 |
|
Número de Identificação
|
value.IdNumber | string |
Número de Identificação |
|
PassportNumber
|
value.PassportNumber | string |
PassportNumber |
|
PercentageAmount
|
value.PercentageAmount | string |
PercentageAmount |
|
Quantidade
|
value.Amount | integer |
Quantidade |
|
Porcentagem
|
value.Percentage | integer |
Porcentagem |
|
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 |
|
Campos Personalizados
|
value.CustomFields | array of object |
Campos Personalizados |
|
Code
|
value.CustomFields.Code | string |
Code |
|
Etiqueta
|
value.CustomFields.Label | string |
Etiqueta |
|
Value
|
value.CustomFields.Value | string |
Value |
Obter uma coleção de todos os status de emprego
Recupera uma lista de todos os status de emprego dos funcionários com base na ID da empresa especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
{{$employee-field}}
|
$orderby | string |
Opcional (cadeia de caracteres) – especifica a ordem na qual os itens são retornados |
|
|
$top opcional
|
$top | integer |
(inteiro($int 32)) – limita o número de itens retornados de uma coleção |
|
|
$skip opcional
|
$skip | True | integer |
(inteiro($int 32)) – exclui o número especificado de itens da coleção consultada do resultado |
|
$count opcional
|
$count | True | string |
(true/false) – Retornar contagem total em resposta |
|
$filter opcional
|
$filter | string |
Filtrar por campo, por exemplo. "EmployeeNumber eq 'Emp01'" |
|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} A ID da Empresa |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor do token do portador (sem o portador da palavra-chave) |
|
Variável de ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
@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 |
|
Número do Funcionário
|
value.EmployeeNumber | string |
Número do Funcionário |
|
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 |
|
Número de Identificação
|
value.IdNumber | string |
Número de Identificação |
|
PassportNumber
|
value.PassportNumber | string |
PassportNumber |
|
PercentageAmount
|
value.PercentageAmount | string |
PercentageAmount |
|
Quantidade
|
value.Amount | integer |
Quantidade |
|
Porcentagem
|
value.Percentage | integer |
Porcentagem |
|
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 |
|
Campos Personalizados
|
value.CustomFields | array of object |
Campos Personalizados |
|
Code
|
value.CustomFields.Code | string |
Code |
|
Etiqueta
|
value.CustomFields.Label | string |
Etiqueta |
|
Value
|
value.CustomFields.Value | string |
Value |
Definições
objeto
Esse é o tipo 'object'.