PaySpace (Editora Independente) (Pré-visualização)
Nossa poderosa solução permite que você acesse os dados de seus funcionários para utilizá-los em seu ambiente de negócios. Todos os endpoints suportados em um só lugar e prontos para serem integrados à sua solução.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte Mint PaySpace |
| URL | https://za.mintgroup.net/ |
| payspace.support@mintgroup.net |
| Metadados do conector | |
|---|---|
| Editora | Tecnologias de Gestão da Casa da Moeda |
| Sítio Web | https://www.payspace.com |
| Política de privacidade | https://www.payspace.com/privacy-policy/ |
| Categorias | Recursos Humanos |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Atualizar um registro de posição única |
Atualize um único registro de posição de funcionário com base no EmployeePositionId especificado. |
| Atualizar um único registo de dados bancários |
Atualize um único registro de dados bancários com base no BankdetailId especificado. |
| 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 funcionário |
Atualize um único registro de funcionário com base no EmployeeId especificado. |
| Baixar foto do funcionário |
Recupera uma única foto de funcionário com base no EmployeeId especificado. |
| Carregue a foto do funcionário |
Atualize uma única foto de funcionário com base no EmployeeId especificado. |
| Criar um registo de posição única |
Crie um único registro de posição de funcionário para o EmployeeNumber especificado. |
| Criar um único registo de dados bancários |
Crie um único registro de detalhes bancários de funcionário para o EmployeeNumber especificado. |
| Criar um único registro de anexo de funcionário |
Crie um único registro de anexo 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 status de emprego |
Crie um único registro de status de emprego de funcionário para o EmployeeNumber especificado. |
| Eliminar um único registo de dados bancários |
Recupera informações de detalhes bancários de funcionários com base no BankDetailId especificado. |
| Excluir um único registro de anexo de funcionário |
Exclua um único registro de anexo de funcionário com base no AttachmentId especificado. |
| Obtenha uma coleção de funcionários |
Recupera uma lista de detalhes biográficos ativos do funcionário a partir da data de hoje e com base no ID da empresa especificado. |
| Obtenha uma coleção de posições |
Recupera uma lista de registros de posição de funcionários a partir da data de hoje e com base no company_id especificado. |
| Obtenha uma coleção de todos os status de emprego |
Recupera uma lista de todos os status de emprego de funcionários com base no ID da empresa especificado. |
| Obter um registo de posição única |
Recupera registros de posição de funcionário com base no EmployeePositionId especificado. |
| Obter um único registo de dados bancários |
Recupera informações de detalhes bancários de funcionários com base no BankDetailId especificado. |
| Obter um único registro de anexo de funcionário |
Recupera informações de anexo de funcionário com base no AttachmentId especificado. |
| Obter um único registro de funcionário |
Recupera informações de funcionários com base no EmployeeId especificado. |
| Obter uma coleção de funcionários a partir de uma data efetiva |
Recupera uma lista de detalhes biográficos ativos do funcionário a partir da data efetiva especificada e com base no ID da empresa especificado. |
| Obter uma coleção de posições a partir de uma data efetiva |
Recupera uma lista de registros de posição de funcionários a partir da data efetiva especificada e com base no company_id especificado. |
| Obter uma coleção de registros de anexos de funcionários |
Recupera uma lista de registros de anexos de funcionários ativos com base no company_id especificado. |
| Obter uma coleção de registros de dados bancários |
Recupera uma lista de detalhes bancários 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 no ID da empresa especificado. |
Atualizar um registro de posição única
Atualize um único registro de posição de funcionário com base no EmployeePositionId especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
{{EmployeePositionId}}
|
EmployeePositionId | True | integer |
{{EmployeePositionId}} O EmployeePositionId |
|
{{empresa-id}}
|
company-id | True | integer |
{{empresa-id}} O ID da Empresa |
|
Token ao portador
|
CustomAuthHeader | True | string |
Valor do token ao portador (sem a palavra-chave Portador) |
|
Variável de Ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
|
body
|
body | True | string |
Devoluções
- response
- object
Atualizar um único registo de dados bancários
Atualize um único registro de dados bancários com base no BankdetailId especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
{{empresa-id}}
|
company-id | True | integer |
{{empresa-id}} O ID da Empresa |
|
{{BankDetailId}}
|
BankDetailId | True | integer |
{{BankDetailId}} O BankDetailId |
|
Token ao portador
|
CustomAuthHeader | True | string |
Valor do token ao portador (sem a palavra-chave Portador) |
|
Variável de Ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
|
body
|
body | True | string |
Devoluções
- response
- object
Atualizar um único registro de anexo de funcionário
Atualize um único registro de anexo com base no AttachmentId especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
{{empresa-id}}
|
company-id | True | integer |
{{empresa-id}} O ID da Empresa |
|
AttachmentId
|
AttachmentId | True | integer |
{{AttachmentId}} O AttachmentId |
|
Token ao portador
|
CustomAuthHeader | True | string |
Valor do token ao portador (sem a palavra-chave Portador) |
|
Variável de Ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
|
body
|
body | True | string |
Devoluções
- response
- object
Atualizar um único registro de funcionário
Atualize um único registro de funcionário com base no EmployeeId especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
{{empresa-id}}
|
company-id | True | string |
{{empresa-id}} O ID da Empresa |
|
{{EmployeeId}}
|
EmployeeId | True | string |
{{EmployeeId}} O EmployeeId |
|
Token ao portador
|
CustomAuthHeader | True | string |
Valor do token ao portador (sem a palavra-chave Portador) |
|
Variável de Ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
|
body
|
body | True | string |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.CONTEXTO
|
@odata.context | string |
@odata.context |
|
Sucesso
|
Success | boolean |
Sucesso |
Baixar foto do funcionário
Recupera uma única foto de funcionário com base no EmployeeId especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
{{empresa-id}}
|
company-id | True | integer |
{{empresa-id}} O ID da Empresa |
|
{{EmployeeId}}
|
EmployeeId | True | integer |
O EmployeeId |
|
Token ao portador
|
CustomAuthHeader | True | string |
Valor do token ao portador (sem a palavra-chave Portador) |
|
Variável de Ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.CONTEXTO
|
@odata.context | string |
@odata.context |
|
Sucesso
|
Success | boolean |
Sucesso |
Carregue a foto do funcionário
Atualize uma única foto de funcionário com base no EmployeeId especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
{{empresa-id}}
|
company-id | True | integer |
{{empresa-id}} O ID da Empresa |
|
{{EmployeeId}}
|
EmployeeId | True | integer |
O EmployeeId |
|
Token ao portador
|
CustomAuthHeader | True | string |
Valor do token ao portador (sem a palavra-chave Portador) |
|
Variável de Ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.CONTEXTO
|
@odata.context | string |
@odata.context |
|
Sucesso
|
Success | boolean |
Sucesso |
Criar um registo de posição única
Crie um único registro de posição de funcionário para o EmployeeNumber especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
{{empresa-id}}
|
company-id | True | integer |
{{empresa-id}} O ID da Empresa |
|
Token ao portador
|
CustomAuthHeader | True | string |
Valor do token ao portador (sem a palavra-chave Portador) |
|
Variável de Ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
|
body
|
body | True | string |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.CONTEXTO
|
@odata.context | string |
@odata.context |
|
EmployeePositionId
|
EmployeePositionId | integer |
EmployeePositionId |
|
Número de Funcionário
|
EmployeeNumber | string |
Número de Funcionário |
|
Data de Eficácia
|
EffectiveDate | string |
Data de Eficácia |
|
PosiçãoOrganizacional
|
OrganizationPosition | string |
PosiçãoOrganizacional |
|
OrganizaçãoPosiçãoWithCode
|
OrganizationPositionWithCode | string |
OrganizaçãoPosiçãoWithCode |
|
Tipo de posição
|
PositionType | string |
Tipo de posição |
|
Grade
|
Grade | string |
Grade |
|
Nível Ocupacional
|
OccupationalLevel | string |
Nível Ocupacional |
|
DiretamenteReportsPositionOverride
|
DirectlyReportsPositionOverride | string |
DiretamenteReportsPositionOverride |
|
DiretamenteRelatóriosPosição
|
DirectlyReportsPosition | string |
DiretamenteRelatóriosPosição |
|
Grupo Organizacional
|
OrganizationGroup | string |
Grupo Organizacional |
|
GruposOrganizacionais
|
OrganizationGroups | array of |
GruposOrganizacionais |
|
OrganizaçãoRegião
|
OrganizationRegion | string |
OrganizaçãoRegião |
|
Ponto de Pagamento
|
PayPoint | string |
Ponto de Pagamento |
|
DiretamenteRelatóriosFuncionário
|
DirectlyReportsEmployee | string |
DiretamenteRelatóriosFuncionário |
|
DiretamenteRelatóriosNúmero do Funcionário
|
DirectlyReportsEmployeeNumber | string |
DiretamenteRelatóriosNúmero do Funcionário |
|
EmpregoCategoria
|
EmploymentCategory | string |
EmpregoCategoria |
|
Subcategoria Emprego
|
EmploymentSubCategory | string |
Subcategoria Emprego |
|
Administradores
|
Administrator | string |
Administradores |
|
AdministratorEmployeeNumber
|
AdministratorEmployeeNumber | string |
AdministratorEmployeeNumber |
|
Função de fluxo de trabalho
|
WorkflowRole | string |
Função de fluxo de trabalho |
|
Razão Geral
|
GeneralLedger | string |
Razão Geral |
|
Sindicato
|
TradeUnion | string |
Sindicato |
|
IsPromotion
|
IsPromotion | boolean |
IsPromotion |
|
Escala de trabalho
|
Roster | string |
Escala de trabalho |
|
Tarefa
|
Job | string |
Tarefa |
|
Comments
|
Comments | string |
Comments |
|
AltPositionName
|
AltPositionName | string |
AltPositionName |
|
DataAdicionada
|
DateAdded | string |
DataAdicionada |
|
PosiçãoDataEfetiva
|
PositionEffectiveDate | string |
PosiçãoDataEfetiva |
|
Sindicato Aduaneiro
|
CustomTradeUnion | string |
Sindicato Aduaneiro |
|
Campos Personalizados
|
CustomFields | array of object |
Campos Personalizados |
|
Código
|
CustomFields.Code | string |
Código |
|
Etiqueta
|
CustomFields.Label | string |
Etiqueta |
|
Valor
|
CustomFields.Value | string |
Valor |
Criar um único registo de dados bancários
Crie um único registro de detalhes bancários de funcionário para o EmployeeNumber especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
{{empresa-id}}
|
company-id | True | integer |
{{empresa-id}} O ID da Empresa |
|
body
|
body | True | string | |
|
Token ao portador
|
CustomAuthHeader | True | string |
Valor do token ao portador (sem a palavra-chave Portador) |
|
Variável de Ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.CONTEXTO
|
@odata.context | string |
@odata.context |
|
BankDetailId
|
BankDetailId | integer |
BankDetailId |
|
Número de Funcionário
|
EmployeeNumber | string |
Número de Funcionário |
|
Método de Pagamento
|
PaymentMethod | string |
Método de Pagamento |
|
SplitType
|
SplitType | string |
SplitType |
|
Proprietário de Conta Bancária
|
BankAccountOwner | string |
Proprietário de Conta Bancária |
|
BankAccountOwnerName
|
BankAccountOwnerName | string |
BankAccountOwnerName |
|
Tipo de Conta
|
AccountType | string |
Tipo de Conta |
|
Nome do Banco
|
BankName | string |
Nome do Banco |
|
Agência-BancáriaN.º
|
BankBranchNo | string |
Agência-BancáriaN.º |
|
Conta BancáriaN.º
|
BankAccountNo | string |
Conta BancáriaN.º |
|
Reference
|
Reference | string |
Reference |
|
IsMainAccount
|
IsMainAccount | boolean |
IsMainAccount |
|
Montante
|
Amount | integer |
Montante |
|
Comments
|
Comments | string |
Comments |
|
Código Swift
|
SwiftCode | string |
Código Swift |
|
Código de Roteamento
|
RoutingCode | string |
Código de Roteamento |
|
ComponentId
|
ComponentId | integer |
ComponentId |
Criar um único registro de anexo de funcionário
Crie um único registro de anexo para o EmployeeNumber especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
{{empresa-id}}
|
company-id | True | integer |
{{empresa-id}} O ID da Empresa |
|
Token ao portador
|
CustomAuthHeader | True | string |
Valor do token ao portador (sem a palavra-chave Portador) |
|
Variável de Ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
|
body
|
body | True | string |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.CONTEXTO
|
@odata.context | string |
@odata.context |
|
AttachmentId
|
AttachmentId | integer |
AttachmentId |
|
Número de Funcionário
|
EmployeeNumber | string |
Número de Funcionário |
|
Classification
|
Classification | string |
Classification |
|
AnexoDescrição
|
AttachmentDescription | string |
AnexoDescrição |
|
AttachmentName
|
AttachmentName | string |
AttachmentName |
|
AttachmentUrl
|
AttachmentUrl | string |
AttachmentUrl |
|
Anexo
|
Attachment | string |
Anexo |
|
Campos Personalizados
|
CustomFields | array of object |
Campos Personalizados |
|
Código
|
CustomFields.Code | string |
Código |
|
Etiqueta
|
CustomFields.Label | string |
Etiqueta |
|
Valor
|
CustomFields.Value | string |
Valor |
Criar um único registro de funcionário
Crie um único registro de funcionário para o EmployeeNumber especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
{{empresa-id}}
|
company-id | True | integer |
{{empresa-id}} O ID da Empresa |
|
Token ao portador
|
CustomAuthHeader | True | string |
Valor do token ao portador (sem a palavra-chave Portador) |
|
Variável de Ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
|
body
|
body | True | string |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.CONTEXTO
|
@odata.context | string |
@odata.context |
|
EmployeeId
|
EmployeeId | integer |
EmployeeId |
|
Número de Funcionário
|
EmployeeNumber | string |
Número de Funcionário |
|
Title
|
Title | string |
Title |
|
Primeiro Nome
|
FirstName | string |
Primeiro Nome |
|
Apelido
|
LastName | string |
Apelido |
|
PreferredName
|
PreferredName | string |
PreferredName |
|
Nome da Donzela
|
MaidenName | string |
Nome da Donzela |
|
Nome do meio
|
MiddleName | string |
Nome do meio |
|
Iniciais
|
Initials | string |
Iniciais |
|
Email
|
string |
|
|
|
Aniversário
|
Birthday | string |
Aniversário |
|
Número de casa
|
HomeNumber | string |
Número de casa |
|
Número de trabalho
|
WorkNumber | string |
Número de trabalho |
|
Número da célula
|
CellNumber | string |
Número da célula |
|
Extensão de trabalho
|
WorkExtension | string |
Extensão de trabalho |
|
Linguagem
|
Language | string |
Linguagem |
|
Sexo
|
Gender | string |
Sexo |
|
MaritalStatus
|
MaritalStatus | string |
MaritalStatus |
|
Raça
|
Race | string |
Raça |
|
Nationality
|
Nationality | string |
Nationality |
|
Cidadania
|
Citizenship | string |
Cidadania |
|
Tipo desativado
|
DisabledType | string |
Tipo desativado |
|
EstrangeiroNacional
|
ForeignNational | boolean |
EstrangeiroNacional |
|
DataCriada
|
DateCreated | string |
DataCriada |
|
EmergencyContactName
|
EmergencyContactName | string |
EmergencyContactName |
|
Número de contato de emergência
|
EmergencyContactNumber | string |
Número de contato de emergência |
|
EmergênciaContactoEndereço
|
EmergencyContactAddress | string |
EmergênciaContactoEndereço |
|
IsRetired
|
IsRetired | boolean |
IsRetired |
|
CustomFieldValue
|
CustomFieldValue | string |
CustomFieldValue |
|
CustomFieldValue2
|
CustomFieldValue2 | string |
CustomFieldValue2 |
|
UifIsenção
|
UifExemption | string |
UifIsenção |
|
SdlExemption
|
SdlExemption | string |
SdlExemption |
|
EtiExempt
|
EtiExempt | boolean |
EtiExempt |
|
ImageDownloadUrl
|
ImageDownloadUrl | string |
ImageDownloadUrl |
|
Campos Personalizados
|
CustomFields | array of object |
Campos Personalizados |
|
Código
|
CustomFields.Code | string |
Código |
|
Etiqueta
|
CustomFields.Label | string |
Etiqueta |
|
Valor
|
CustomFields.Value | string |
Valor |
|
Address
|
Address | array of object |
Address |
|
EndereçoId
|
Address.AddressId | integer |
EndereçoId |
|
EndereçoType
|
Address.AddressType | string |
EndereçoType |
|
Número de Funcionário
|
Address.EmployeeNumber | string |
Número de Funcionário |
|
EndereçoLinha1
|
Address.AddressLine1 | string |
EndereçoLinha1 |
|
Linha de Endereço 2
|
Address.AddressLine2 | string |
Linha de Endereço 2 |
|
EndereçoLine3
|
Address.AddressLine3 | string |
EndereçoLine3 |
|
AddressCode
|
Address.AddressCode | string |
AddressCode |
|
EndereçoPaís
|
Address.AddressCountry | string |
EndereçoPaís |
|
Província
|
Address.Province | string |
Província |
|
Número da unidade
|
Address.UnitNumber | string |
Número da unidade |
|
Complexo
|
Address.Complex | string |
Complexo |
|
StreetNumber
|
Address.StreetNumber | string |
StreetNumber |
|
SameAsPhysical
|
Address.SameAsPhysical | boolean |
SameAsPhysical |
|
IsCareofAddress
|
Address.IsCareofAddress | boolean |
IsCareofAddress |
|
CareOfIntermediário
|
Address.CareOfIntermediary | string |
CareOfIntermediário |
|
Serviços Especiais
|
Address.SpecialServices | string |
Serviços Especiais |
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
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
{{empresa-id}}
|
company-id | True | integer |
{{empresa-id}} O ID da Empresa |
|
Token ao portador
|
CustomAuthHeader | True | string |
Valor do token ao portador (sem a palavra-chave Portador) |
|
Variável de Ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
|
body
|
body | True | string |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.CONTEXTO
|
@odata.context | string |
@odata.context |
|
EmpregoStatusId
|
EmploymentStatusId | integer |
EmpregoStatusId |
|
Número de Funcionário
|
EmployeeNumber | string |
Número de Funcionário |
|
GroupJoinDate
|
GroupJoinDate | string |
GroupJoinDate |
|
Data de Emprego
|
EmploymentDate | string |
Data de Emprego |
|
Data de Rescisão
|
TerminationDate | string |
Data de Rescisão |
|
RescisãoMotivo
|
TerminationReason | string |
RescisãoMotivo |
|
TaxStatus
|
TaxStatus | string |
TaxStatus |
|
TaxReferenceNumber
|
TaxReferenceNumber | string |
TaxReferenceNumber |
|
NaturezadePessoa
|
NatureOfPerson | string |
NaturezadePessoa |
|
Repartição de Finanças
|
TaxOffice | integer |
Repartição de Finanças |
|
Número da Diretiva Fiscal
|
TaxDirectiveNumber | string |
Número da Diretiva Fiscal |
|
IT3AReason
|
IT3AReason | integer |
IT3AReason |
|
EmpregoAcção
|
EmploymentAction | string |
EmpregoAcção |
|
RescisãoEmpresaRun
|
TerminationCompanyRun | string |
RescisãoEmpresaRun |
|
Tipo de identidade
|
IdentityType | string |
Tipo de identidade |
|
Número de identificação
|
IdNumber | string |
Número de identificação |
|
Número de passaporte
|
PassportNumber | string |
Número de passaporte |
|
PercentageAmount
|
PercentageAmount | string |
PercentageAmount |
|
Montante
|
Amount | integer |
Montante |
|
Percentagem
|
Percentage | integer |
Percentagem |
|
DeemedMonthlyRemuneration
|
DeemedMonthlyRemuneration | integer |
DeemedMonthlyRemuneration |
|
Deemed75Indicador
|
Deemed75Indicator | boolean |
Deemed75Indicador |
|
DeemedRecoveryMonthly
|
DeemedRecoveryMonthly | boolean |
DeemedRecoveryMonthly |
|
EncashLeave
|
EncashLeave | boolean |
EncashLeave |
|
IRP30
|
Irp30 | boolean |
IRP30 |
|
FinalizeIssueTaxCert
|
FinalizeIssueTaxCert | boolean |
FinalizeIssueTaxCert |
|
PassaportePaís
|
PassportCountry | boolean |
PassaportePaís |
|
PassaporteEmitido
|
PassportIssued | string |
PassaporteEmitido |
|
PassaporteValidade
|
PassportExpiry | string |
PassaporteValidade |
|
LicençaEmitida
|
PermitIssued | string |
LicençaEmitida |
|
LicençaExpiração
|
PermitExpiry | string |
LicençaExpiração |
|
Data Adicional
|
AdditionalDate | string |
Data Adicional |
|
EmploymentCaptureDate
|
EmploymentCaptureDate | string |
EmploymentCaptureDate |
|
TerminationCaptureDate
|
TerminationCaptureDate | string |
TerminationCaptureDate |
|
Trabalhador temporário
|
TempWorker | boolean |
Trabalhador temporário |
|
Data1 Adicional
|
AdditionalDate1 | string |
Data1 Adicional |
|
NotReEmployable
|
NotReEmployable | boolean |
NotReEmployable |
|
Número de referência
|
ReferenceNumber | string |
Número de referência |
|
OldEmployeeId
|
OldEmployeeId | integer |
OldEmployeeId |
Eliminar um único registo de dados bancários
Recupera informações de detalhes bancários de funcionários com base no BankDetailId especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
{{empresa-id}}
|
company-id | True | integer |
{{empresa-id}} O ID da Empresa |
|
{{BankDetailId}}
|
BankDetailId | True | integer |
{{BankDetailId}} O BankDetailId |
|
Token ao portador
|
CustomAuthHeader | True | string |
Valor do token ao portador (sem a palavra-chave Portador) |
|
Variável de Ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Devoluções
- response
- object
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
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
{{empresa-id}}
|
company-id | True | integer |
{{empresa-id}} O ID da Empresa |
|
AttachmentId
|
AttachmentId | True | integer |
{{AttachmentId}} O AttachmentId |
|
Token ao portador
|
CustomAuthHeader | True | string |
Valor do token ao portador (sem a palavra-chave Portador) |
|
Variável de Ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Devoluções
- response
- object
Obtenha uma coleção de funcionários
Recupera uma lista de detalhes biográficos ativos do funcionário a partir da data de hoje e com base no ID da empresa especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
{{empresa-id}}
|
company-id | True | integer |
{{empresa-id}} O ID da Empresa |
|
Opcional por {{$employee-field}}
|
$orderby | string |
(string) - Especifica a ordem em que os itens são retornados |
|
|
Opcional $top
|
$top | integer |
(inteiro($int 32)) - Limita o número de itens devolvidos de uma coleção |
|
|
Opcional $skip
|
$skip | integer |
(inteiro($int 32)) - Exclui o número especificado de itens da coleção consultada do resultado |
|
|
Opcional $count
|
$count | string |
(true/false) - Retorna contagem total em resposta |
|
|
Opcional $filter
|
$filter | string |
Opcional - Filtrar por campo, por exemplo. "EmployeeNumber eq 'Emp01'" |
|
|
Opcional $select
|
$select | string |
Opcional (string) - Devolve apenas os campos especificados |
|
|
Token ao portador
|
CustomAuthHeader | True | string |
Valor do token ao portador (sem a palavra-chave Portador) |
|
Variável de Ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.CONTEXTO
|
@odata.context | string |
@odata.context |
|
@odata.count
|
@odata.count | integer |
@odata.count |
|
valor
|
value | array of object |
valor |
|
EmployeeId
|
value.EmployeeId | integer |
EmployeeId |
|
Número de Funcionário
|
value.EmployeeNumber | string |
Número de Funcionário |
|
Title
|
value.Title | string |
Title |
|
Primeiro Nome
|
value.FirstName | string |
Primeiro Nome |
|
Apelido
|
value.LastName | string |
Apelido |
|
PreferredName
|
value.PreferredName | string |
PreferredName |
|
Nome da Donzela
|
value.MaidenName | string |
Nome da Donzela |
|
Nome do meio
|
value.MiddleName | string |
Nome do meio |
|
Iniciais
|
value.Initials | string |
Iniciais |
|
Email
|
value.Email | string |
|
|
Aniversário
|
value.Birthday | string |
Aniversário |
|
Número de casa
|
value.HomeNumber | string |
Número de casa |
|
Número de trabalho
|
value.WorkNumber | string |
Número de trabalho |
|
Número da célula
|
value.CellNumber | string |
Número da célula |
|
Extensão de trabalho
|
value.WorkExtension | string |
Extensão de trabalho |
|
Linguagem
|
value.Language | string |
Linguagem |
|
Sexo
|
value.Gender | string |
Sexo |
|
MaritalStatus
|
value.MaritalStatus | string |
MaritalStatus |
|
Raça
|
value.Race | string |
Raça |
|
Nationality
|
value.Nationality | string |
Nationality |
|
Cidadania
|
value.Citizenship | string |
Cidadania |
|
Tipo desativado
|
value.DisabledType | string |
Tipo desativado |
|
EstrangeiroNacional
|
value.ForeignNational | boolean |
EstrangeiroNacional |
|
DataCriada
|
value.DateCreated | string |
DataCriada |
|
EmergencyContactName
|
value.EmergencyContactName | string |
EmergencyContactName |
|
Número de contato de emergência
|
value.EmergencyContactNumber | string |
Número de contato de emergência |
|
EmergênciaContactoEndereço
|
value.EmergencyContactAddress | string |
EmergênciaContactoEndereço |
|
IsRetired
|
value.IsRetired | boolean |
IsRetired |
|
CustomFieldValue
|
value.CustomFieldValue | string |
CustomFieldValue |
|
CustomFieldValue2
|
value.CustomFieldValue2 | string |
CustomFieldValue2 |
|
UifIsenção
|
value.UifExemption | string |
UifIsenção |
|
SdlExemption
|
value.SdlExemption | string |
SdlExemption |
|
EtiExempt
|
value.EtiExempt | boolean |
EtiExempt |
|
ImageDownloadUrl
|
value.ImageDownloadUrl | string |
ImageDownloadUrl |
|
Campos Personalizados
|
value.CustomFields | array of object |
Campos Personalizados |
|
Código
|
value.CustomFields.Code | string |
Código |
|
Etiqueta
|
value.CustomFields.Label | string |
Etiqueta |
|
Valor
|
value.CustomFields.Value | string |
Valor |
|
Address
|
value.Address | array of object |
Address |
|
EndereçoId
|
value.Address.AddressId | integer |
EndereçoId |
|
EndereçoType
|
value.Address.AddressType | string |
EndereçoType |
|
Número de Funcionário
|
value.Address.EmployeeNumber | string |
Número de Funcionário |
|
EndereçoLinha1
|
value.Address.AddressLine1 | string |
EndereçoLinha1 |
|
Linha de Endereço 2
|
value.Address.AddressLine2 | string |
Linha de Endereço 2 |
|
EndereçoLine3
|
value.Address.AddressLine3 | string |
EndereçoLine3 |
|
AddressCode
|
value.Address.AddressCode | string |
AddressCode |
|
EndereçoPaís
|
value.Address.AddressCountry | string |
EndereçoPaís |
|
Província
|
value.Address.Province | string |
Província |
|
Número da unidade
|
value.Address.UnitNumber | string |
Número da unidade |
|
Complexo
|
value.Address.Complex | string |
Complexo |
|
StreetNumber
|
value.Address.StreetNumber | string |
StreetNumber |
|
SameAsPhysical
|
value.Address.SameAsPhysical | boolean |
SameAsPhysical |
|
IsCareofAddress
|
value.Address.IsCareofAddress | boolean |
IsCareofAddress |
|
CareOfIntermediário
|
value.Address.CareOfIntermediary | string |
CareOfIntermediário |
|
Serviços Especiais
|
value.Address.SpecialServices | string |
Serviços Especiais |
Obtenha uma coleção de posições
Recupera uma lista de registros de posição de funcionários a partir da data de hoje e com base no company_id especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Opcional $top
|
$top | integer |
(inteiro($int 32)) - Limita o número de itens devolvidos de uma coleção |
|
|
Opcional $skip
|
$skip | True | integer |
(inteiro($int 32)) - Exclui o número especificado de itens da coleção consultada do resultado |
|
Opcional $count
|
$count | True | string |
(true/false) - Retorna contagem total em resposta |
|
Opcional $filter
|
$filter | string |
Filtrar por campo, por exemplo. "EmployeeNumber eq 'Emp01'" |
|
|
Opcional $expand
|
$expand | True | string |
Opcional - para retornar os dados do campo OrganizationGroups, use o valor 'OrganizationGroups' |
|
{{empresa-id}}
|
company-id | True | integer |
{{empresa-id}} O ID da Empresa |
|
Token ao portador
|
CustomAuthHeader | True | string |
Valor do token ao portador (sem a palavra-chave Portador) |
|
Variável de Ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.CONTEXTO
|
@odata.context | string |
@odata.context |
|
@odata.count
|
@odata.count | integer |
@odata.count |
|
valor
|
value | array of object |
valor |
|
EmployeePositionId
|
value.EmployeePositionId | integer |
EmployeePositionId |
|
Número de Funcionário
|
value.EmployeeNumber | string |
Número de Funcionário |
|
Nome Completo
|
value.FullName | string |
Nome Completo |
|
Data de Eficácia
|
value.EffectiveDate | string |
Data de Eficácia |
|
PosiçãoOrganizacional
|
value.OrganizationPosition | string |
PosiçãoOrganizacional |
|
OrganizationPositionId
|
value.OrganizationPositionId | integer |
OrganizationPositionId |
|
OrganizaçãoPosiçãoWithCode
|
value.OrganizationPositionWithCode | string |
OrganizaçãoPosiçãoWithCode |
|
Tipo de posição
|
value.PositionType | string |
Tipo de posição |
|
Grade
|
value.Grade | string |
Grade |
|
Nível Ocupacional
|
value.OccupationalLevel | string |
Nível Ocupacional |
|
DiretamenteReportsPositionOverride
|
value.DirectlyReportsPositionOverride | string |
DiretamenteReportsPositionOverride |
|
DiretamenteRelatóriosPosição
|
value.DirectlyReportsPosition | string |
DiretamenteRelatóriosPosição |
|
Grupo Organizacional
|
value.OrganizationGroup | string |
Grupo Organizacional |
|
OrganizaçãoGrupoDescrição
|
value.OrganizationGroupDescription | string |
OrganizaçãoGrupoDescrição |
|
GruposOrganizacionais
|
value.OrganizationGroups | array of object |
GruposOrganizacionais |
|
OrganizaçãoUnitId
|
value.OrganizationGroups.OrganizationUnitId | integer |
OrganizaçãoUnitId |
|
ParentOrganizationUnitId
|
value.OrganizationGroups.ParentOrganizationUnitId | integer |
ParentOrganizationUnitId |
|
UploadCode
|
value.OrganizationGroups.UploadCode | string |
UploadCode |
|
Description
|
value.OrganizationGroups.Description | string |
Description |
|
Centro de Custos
|
value.OrganizationGroups.CostCentre | boolean |
Centro de Custos |
|
Nível de Organização
|
value.OrganizationGroups.OrganizationLevel | string |
Nível de Organização |
|
GrupoGlKey
|
value.OrganizationGroups.GroupGlKey | string |
GrupoGlKey |
|
Orçamento
|
value.OrganizationGroups.Budget | integer |
Orçamento |
|
Reference
|
value.OrganizationGroups.Reference | string |
Reference |
|
ManagerEmployeeNumber
|
value.OrganizationGroups.ManagerEmployeeNumber | string |
ManagerEmployeeNumber |
|
Data inativa
|
value.OrganizationGroups.InactiveDate | string |
Data inativa |
|
OrganizaçãoRegião
|
value.OrganizationRegion | string |
OrganizaçãoRegião |
|
Ponto de Pagamento
|
value.PayPoint | string |
Ponto de Pagamento |
|
DiretamenteRelatóriosFuncionário
|
value.DirectlyReportsEmployee | string |
DiretamenteRelatóriosFuncionário |
|
DiretamenteRelatóriosNúmero do Funcionário
|
value.DirectlyReportsEmployeeNumber | string |
DiretamenteRelatóriosNúmero do Funcionário |
|
EmpregoCategoria
|
value.EmploymentCategory | string |
EmpregoCategoria |
|
Subcategoria Emprego
|
value.EmploymentSubCategory | string |
Subcategoria Emprego |
|
Administradores
|
value.Administrator | string |
Administradores |
|
AdministratorEmployeeNumber
|
value.AdministratorEmployeeNumber | string |
AdministratorEmployeeNumber |
|
Função de fluxo de trabalho
|
value.WorkflowRole | string |
Função de fluxo de trabalho |
|
Razão Geral
|
value.GeneralLedger | string |
Razão Geral |
|
Sindicato
|
value.TradeUnion | string |
Sindicato |
|
IsPromotion
|
value.IsPromotion | boolean |
IsPromotion |
|
Escala de trabalho
|
value.Roster | string |
Escala de trabalho |
|
Tarefa
|
value.Job | string |
Tarefa |
|
Comments
|
value.Comments | string |
Comments |
|
AltPositionName
|
value.AltPositionName | string |
AltPositionName |
|
DataAdicionada
|
value.DateAdded | string |
DataAdicionada |
|
PosiçãoDataEfetiva
|
value.PositionEffectiveDate | string |
PosiçãoDataEfetiva |
|
Sindicato Aduaneiro
|
value.CustomTradeUnion | string |
Sindicato Aduaneiro |
|
Campos Personalizados
|
value.CustomFields | array of object |
Campos Personalizados |
|
Código
|
value.CustomFields.Code | string |
Código |
|
Etiqueta
|
value.CustomFields.Label | string |
Etiqueta |
|
Valor
|
value.CustomFields.Value | string |
Valor |
Obtenha uma coleção de todos os status de emprego
Recupera uma lista de todos os status de emprego de funcionários com base no ID da empresa especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
{{$employee-campo}}
|
$orderby | string |
Opcional (string) - Especifica a ordem em que os itens são retornados |
|
|
Opcional $top
|
$top | integer |
(inteiro($int 32)) - Limita o número de itens devolvidos de uma coleção |
|
|
Opcional $skip
|
$skip | True | integer |
(inteiro($int 32)) - Exclui o número especificado de itens da coleção consultada do resultado |
|
Opcional $count
|
$count | True | string |
(true/false) - Retorna contagem total em resposta |
|
Opcional $filter
|
$filter | string |
Filtrar por campo, por exemplo. "EmployeeNumber eq 'Emp01'" |
|
|
{{empresa-id}}
|
company-id | True | integer |
{{empresa-id}} O ID da Empresa |
|
Token ao portador
|
CustomAuthHeader | True | string |
Valor do token ao portador (sem a palavra-chave Portador) |
|
Variável de Ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.CONTEXTO
|
@odata.context | string |
@odata.context |
|
@odata.count
|
@odata.count | integer |
@odata.count |
|
valor
|
value | array of object |
valor |
|
EmpregoStatusId
|
value.EmploymentStatusId | integer |
EmpregoStatusId |
|
Número de Funcionário
|
value.EmployeeNumber | string |
Número de Funcionário |
|
GroupJoinDate
|
value.GroupJoinDate | string |
GroupJoinDate |
|
Data de Emprego
|
value.EmploymentDate | string |
Data de Emprego |
|
Data de Rescisão
|
value.TerminationDate | string |
Data de Rescisão |
|
RescisãoMotivo
|
value.TerminationReason | string |
RescisãoMotivo |
|
TaxStatus
|
value.TaxStatus | string |
TaxStatus |
|
TaxReferenceNumber
|
value.TaxReferenceNumber | string |
TaxReferenceNumber |
|
NaturezadePessoa
|
value.NatureOfPerson | string |
NaturezadePessoa |
|
Repartição de Finanças
|
value.TaxOffice | integer |
Repartição de Finanças |
|
Número da Diretiva Fiscal
|
value.TaxDirectiveNumber | string |
Número da Diretiva Fiscal |
|
IT3AReason
|
value.IT3AReason | integer |
IT3AReason |
|
EmpregoAcção
|
value.EmploymentAction | string |
EmpregoAcção |
|
RescisãoEmpresaRun
|
value.TerminationCompanyRun | string |
RescisãoEmpresaRun |
|
Tipo de identidade
|
value.IdentityType | string |
Tipo de identidade |
|
Número de identificação
|
value.IdNumber | string |
Número de identificação |
|
Número de passaporte
|
value.PassportNumber | string |
Número de passaporte |
|
PercentageAmount
|
value.PercentageAmount | string |
PercentageAmount |
|
Montante
|
value.Amount | integer |
Montante |
|
Percentagem
|
value.Percentage | integer |
Percentagem |
|
DeemedMonthlyRemuneration
|
value.DeemedMonthlyRemuneration | integer |
DeemedMonthlyRemuneration |
|
Deemed75Indicador
|
value.Deemed75Indicator | boolean |
Deemed75Indicador |
|
DeemedRecoveryMonthly
|
value.DeemedRecoveryMonthly | boolean |
DeemedRecoveryMonthly |
|
EncashLeave
|
value.EncashLeave | boolean |
EncashLeave |
|
IRP30
|
value.Irp30 | boolean |
IRP30 |
|
FinalizeIssueTaxCert
|
value.FinalizeIssueTaxCert | boolean |
FinalizeIssueTaxCert |
|
PassaportePaís
|
value.PassportCountry | boolean |
PassaportePaís |
|
PassaporteEmitido
|
value.PassportIssued | string |
PassaporteEmitido |
|
PassaporteValidade
|
value.PassportExpiry | string |
PassaporteValidade |
|
LicençaEmitida
|
value.PermitIssued | string |
LicençaEmitida |
|
LicençaExpiração
|
value.PermitExpiry | string |
LicençaExpiração |
|
Data Adicional
|
value.AdditionalDate | string |
Data Adicional |
|
EmploymentCaptureDate
|
value.EmploymentCaptureDate | string |
EmploymentCaptureDate |
|
TerminationCaptureDate
|
value.TerminationCaptureDate | string |
TerminationCaptureDate |
|
Trabalhador temporário
|
value.TempWorker | boolean |
Trabalhador temporário |
|
Data1 Adicional
|
value.AdditionalDate1 | string |
Data1 Adicional |
|
NotReEmployable
|
value.NotReEmployable | boolean |
NotReEmployable |
|
Número de referência
|
value.ReferenceNumber | string |
Número de referência |
|
OldEmployeeId
|
value.OldEmployeeId | integer |
OldEmployeeId |
|
Campos Personalizados
|
value.CustomFields | array of object |
Campos Personalizados |
|
Código
|
value.CustomFields.Code | string |
Código |
|
Etiqueta
|
value.CustomFields.Label | string |
Etiqueta |
|
Valor
|
value.CustomFields.Value | string |
Valor |
Obter um registo de posição única
Recupera registros de posição de funcionário com base no EmployeePositionId especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
{{empresa-id}}
|
company-id | True | integer |
{{empresa-id}} O ID da Empresa |
|
{{EmployeePositionId}}
|
EmployeePositionId | True | integer |
O EmployeePositionId |
|
Token ao portador
|
CustomAuthHeader | True | string |
Valor do token ao portador (sem a palavra-chave Portador) |
|
Variável de Ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.CONTEXTO
|
@odata.context | string |
@odata.context |
|
@odata.count
|
@odata.count | integer |
@odata.count |
|
valor
|
value | array of object |
valor |
|
EmployeePositionId
|
value.EmployeePositionId | integer |
EmployeePositionId |
|
Número de Funcionário
|
value.EmployeeNumber | string |
Número de Funcionário |
|
Nome Completo
|
value.FullName | string |
Nome Completo |
|
Data de Eficácia
|
value.EffectiveDate | string |
Data de Eficácia |
|
PosiçãoOrganizacional
|
value.OrganizationPosition | string |
PosiçãoOrganizacional |
|
OrganizationPositionId
|
value.OrganizationPositionId | integer |
OrganizationPositionId |
|
OrganizaçãoPosiçãoWithCode
|
value.OrganizationPositionWithCode | string |
OrganizaçãoPosiçãoWithCode |
|
Tipo de posição
|
value.PositionType | string |
Tipo de posição |
|
Grade
|
value.Grade | string |
Grade |
|
Nível Ocupacional
|
value.OccupationalLevel | string |
Nível Ocupacional |
|
DiretamenteReportsPositionOverride
|
value.DirectlyReportsPositionOverride | string |
DiretamenteReportsPositionOverride |
|
DiretamenteRelatóriosPosição
|
value.DirectlyReportsPosition | string |
DiretamenteRelatóriosPosição |
|
Grupo Organizacional
|
value.OrganizationGroup | string |
Grupo Organizacional |
|
OrganizaçãoGrupoDescrição
|
value.OrganizationGroupDescription | string |
OrganizaçãoGrupoDescrição |
|
GruposOrganizacionais
|
value.OrganizationGroups | array of object |
GruposOrganizacionais |
|
OrganizaçãoUnitId
|
value.OrganizationGroups.OrganizationUnitId | integer |
OrganizaçãoUnitId |
|
ParentOrganizationUnitId
|
value.OrganizationGroups.ParentOrganizationUnitId | integer |
ParentOrganizationUnitId |
|
UploadCode
|
value.OrganizationGroups.UploadCode | string |
UploadCode |
|
Description
|
value.OrganizationGroups.Description | string |
Description |
|
Centro de Custos
|
value.OrganizationGroups.CostCentre | boolean |
Centro de Custos |
|
Nível de Organização
|
value.OrganizationGroups.OrganizationLevel | string |
Nível de Organização |
|
GrupoGlKey
|
value.OrganizationGroups.GroupGlKey | string |
GrupoGlKey |
|
Orçamento
|
value.OrganizationGroups.Budget | integer |
Orçamento |
|
Reference
|
value.OrganizationGroups.Reference | string |
Reference |
|
ManagerEmployeeNumber
|
value.OrganizationGroups.ManagerEmployeeNumber | string |
ManagerEmployeeNumber |
|
Data inativa
|
value.OrganizationGroups.InactiveDate | string |
Data inativa |
|
OrganizaçãoRegião
|
value.OrganizationRegion | string |
OrganizaçãoRegião |
|
Ponto de Pagamento
|
value.PayPoint | string |
Ponto de Pagamento |
|
DiretamenteRelatóriosFuncionário
|
value.DirectlyReportsEmployee | string |
DiretamenteRelatóriosFuncionário |
|
DiretamenteRelatóriosNúmero do Funcionário
|
value.DirectlyReportsEmployeeNumber | string |
DiretamenteRelatóriosNúmero do Funcionário |
|
EmpregoCategoria
|
value.EmploymentCategory | string |
EmpregoCategoria |
|
Subcategoria Emprego
|
value.EmploymentSubCategory | string |
Subcategoria Emprego |
|
Administradores
|
value.Administrator | string |
Administradores |
|
AdministratorEmployeeNumber
|
value.AdministratorEmployeeNumber | string |
AdministratorEmployeeNumber |
|
Função de fluxo de trabalho
|
value.WorkflowRole | string |
Função de fluxo de trabalho |
|
Razão Geral
|
value.GeneralLedger | string |
Razão Geral |
|
Sindicato
|
value.TradeUnion | string |
Sindicato |
|
IsPromotion
|
value.IsPromotion | boolean |
IsPromotion |
|
Escala de trabalho
|
value.Roster | string |
Escala de trabalho |
|
Tarefa
|
value.Job | string |
Tarefa |
|
Comments
|
value.Comments | string |
Comments |
|
AltPositionName
|
value.AltPositionName | string |
AltPositionName |
|
DataAdicionada
|
value.DateAdded | string |
DataAdicionada |
|
PosiçãoDataEfetiva
|
value.PositionEffectiveDate | string |
PosiçãoDataEfetiva |
|
Sindicato Aduaneiro
|
value.CustomTradeUnion | string |
Sindicato Aduaneiro |
|
Campos Personalizados
|
value.CustomFields | array of object |
Campos Personalizados |
|
Código
|
value.CustomFields.Code | string |
Código |
|
Etiqueta
|
value.CustomFields.Label | string |
Etiqueta |
|
Valor
|
value.CustomFields.Value | string |
Valor |
Obter um único registo de dados bancários
Recupera informações de detalhes bancários de funcionários com base no BankDetailId especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
{{empresa-id}}
|
company-id | True | integer |
{{empresa-id}} O ID da Empresa |
|
{{BankDetailId}}
|
BankDetailId | True | integer |
O BankDetailId |
|
Token ao portador
|
CustomAuthHeader | True | string |
Valor do token ao portador (sem a palavra-chave Portador) |
|
Variável de Ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.CONTEXTO
|
@odata.context | string |
@odata.context |
|
BankDetailId
|
BankDetailId | integer |
BankDetailId |
|
Número de Funcionário
|
EmployeeNumber | string |
Número de Funcionário |
|
Método de Pagamento
|
PaymentMethod | string |
Método de Pagamento |
|
SplitType
|
SplitType | string |
SplitType |
|
Proprietário de Conta Bancária
|
BankAccountOwner | string |
Proprietário de Conta Bancária |
|
BankAccountOwnerName
|
BankAccountOwnerName | string |
BankAccountOwnerName |
|
Tipo de Conta
|
AccountType | string |
Tipo de Conta |
|
Nome do Banco
|
BankName | string |
Nome do Banco |
|
Agência-BancáriaN.º
|
BankBranchNo | string |
Agência-BancáriaN.º |
|
Conta BancáriaN.º
|
BankAccountNo | string |
Conta BancáriaN.º |
|
Reference
|
Reference | string |
Reference |
|
IsMainAccount
|
IsMainAccount | boolean |
IsMainAccount |
|
Montante
|
Amount | integer |
Montante |
|
Comments
|
Comments | string |
Comments |
|
Código Swift
|
SwiftCode | string |
Código Swift |
|
Código de Roteamento
|
RoutingCode | string |
Código de Roteamento |
|
ComponentId
|
ComponentId | integer |
ComponentId |
Obter um único registro de anexo de funcionário
Recupera informações de anexo de funcionário com base no AttachmentId especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
{{empresa-id}}
|
company-id | True | integer |
{{empresa-id}} O ID da Empresa |
|
{{AttachmentId}}
|
AttachmentId | True | integer |
O AttachmentId |
|
Token ao portador
|
CustomAuthHeader | True | string |
Valor do token ao portador (sem a palavra-chave Portador) |
|
Variável de Ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.CONTEXTO
|
@odata.context | string |
@odata.context |
|
AttachmentId
|
AttachmentId | integer |
AttachmentId |
|
Número de Funcionário
|
EmployeeNumber | string |
Número de Funcionário |
|
Classification
|
Classification | string |
Classification |
|
AnexoDescrição
|
AttachmentDescription | string |
AnexoDescrição |
|
AttachmentName
|
AttachmentName | string |
AttachmentName |
|
AttachmentUrl
|
AttachmentUrl | string |
AttachmentUrl |
|
Anexo
|
Attachment | string |
Anexo |
|
Campos Personalizados
|
CustomFields | array of object |
Campos Personalizados |
|
Código
|
CustomFields.Code | string |
Código |
|
Etiqueta
|
CustomFields.Label | string |
Etiqueta |
|
Valor
|
CustomFields.Value | string |
Valor |
Obter um único registro de funcionário
Recupera informações de funcionários com base no EmployeeId especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
{{empresa-id}}
|
company-id | True | integer |
{{empresa-id}} O ID da Empresa |
|
{{EmployeeId}}
|
EmployeeId | True | integer |
O EmployeeId |
|
Token ao portador
|
CustomAuthHeader | True | string |
Valor do token ao portador (sem a palavra-chave Portador) |
|
Variável de Ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.CONTEXTO
|
@odata.context | string |
@odata.context |
|
EmployeeId
|
EmployeeId | integer |
EmployeeId |
|
Número de Funcionário
|
EmployeeNumber | string |
Número de Funcionário |
|
Title
|
Title | string |
Title |
|
Primeiro Nome
|
FirstName | string |
Primeiro Nome |
|
Apelido
|
LastName | string |
Apelido |
|
PreferredName
|
PreferredName | string |
PreferredName |
|
Nome da Donzela
|
MaidenName | string |
Nome da Donzela |
|
Nome do meio
|
MiddleName | string |
Nome do meio |
|
Iniciais
|
Initials | string |
Iniciais |
|
Email
|
string |
|
|
|
Aniversário
|
Birthday | string |
Aniversário |
|
Número de casa
|
HomeNumber | string |
Número de casa |
|
Número de trabalho
|
WorkNumber | string |
Número de trabalho |
|
Número da célula
|
CellNumber | string |
Número da célula |
|
Extensão de trabalho
|
WorkExtension | string |
Extensão de trabalho |
|
Linguagem
|
Language | string |
Linguagem |
|
Sexo
|
Gender | string |
Sexo |
|
MaritalStatus
|
MaritalStatus | string |
MaritalStatus |
|
Raça
|
Race | string |
Raça |
|
Nationality
|
Nationality | string |
Nationality |
|
Cidadania
|
Citizenship | string |
Cidadania |
|
Tipo desativado
|
DisabledType | string |
Tipo desativado |
|
EstrangeiroNacional
|
ForeignNational | boolean |
EstrangeiroNacional |
|
DataCriada
|
DateCreated | string |
DataCriada |
|
EmergencyContactName
|
EmergencyContactName | string |
EmergencyContactName |
|
Número de contato de emergência
|
EmergencyContactNumber | string |
Número de contato de emergência |
|
EmergênciaContactoEndereço
|
EmergencyContactAddress | string |
EmergênciaContactoEndereço |
|
IsRetired
|
IsRetired | boolean |
IsRetired |
|
CustomFieldValue
|
CustomFieldValue | string |
CustomFieldValue |
|
CustomFieldValue2
|
CustomFieldValue2 | string |
CustomFieldValue2 |
|
UifIsenção
|
UifExemption | string |
UifIsenção |
|
SdlExemption
|
SdlExemption | string |
SdlExemption |
|
EtiExempt
|
EtiExempt | boolean |
EtiExempt |
|
ImageDownloadUrl
|
ImageDownloadUrl | string |
ImageDownloadUrl |
|
Campos Personalizados
|
CustomFields | array of object |
Campos Personalizados |
|
Código
|
CustomFields.Code | string |
Código |
|
Etiqueta
|
CustomFields.Label | string |
Etiqueta |
|
Valor
|
CustomFields.Value | string |
Valor |
|
Address
|
Address | array of object |
Address |
|
EndereçoId
|
Address.AddressId | integer |
EndereçoId |
|
EndereçoType
|
Address.AddressType | string |
EndereçoType |
|
Número de Funcionário
|
Address.EmployeeNumber | string |
Número de Funcionário |
|
EndereçoLinha1
|
Address.AddressLine1 | string |
EndereçoLinha1 |
|
Linha de Endereço 2
|
Address.AddressLine2 | string |
Linha de Endereço 2 |
|
EndereçoLine3
|
Address.AddressLine3 | string |
EndereçoLine3 |
|
AddressCode
|
Address.AddressCode | string |
AddressCode |
|
EndereçoPaís
|
Address.AddressCountry | string |
EndereçoPaís |
|
Província
|
Address.Province | string |
Província |
|
Número da unidade
|
Address.UnitNumber | string |
Número da unidade |
|
Complexo
|
Address.Complex | string |
Complexo |
|
StreetNumber
|
Address.StreetNumber | string |
StreetNumber |
|
SameAsPhysical
|
Address.SameAsPhysical | boolean |
SameAsPhysical |
|
IsCareofAddress
|
Address.IsCareofAddress | boolean |
IsCareofAddress |
|
CareOfIntermediário
|
Address.CareOfIntermediary | string |
CareOfIntermediário |
|
Serviços Especiais
|
Address.SpecialServices | string |
Serviços Especiais |
Obter uma coleção de funcionários a partir de uma data efetiva
Recupera uma lista de detalhes biográficos ativos do funcionário a partir da data efetiva especificada e com base no ID da empresa especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
{{empresa-id}}
|
company-id | True | integer |
{{empresa-id}} O ID da Empresa |
|
data de entrada em vigor
|
effectivedate | True | string |
Data efetiva formatada em AAAA-MM-DD. por exemplo. 2022-01-15 |
|
Opcional por {{$employee-field}}
|
$orderby | string |
(string) - Especifica a ordem em que os itens são retornados |
|
|
Opcional $top
|
$top | integer |
(inteiro($int 32)) - Limita o número de itens devolvidos de uma coleção |
|
|
Opcional $skip
|
$skip | True | integer |
(inteiro($int 32)) - Exclui o número especificado de itens da coleção consultada do resultado |
|
Opcional $count
|
$count | True | string |
(true/false) - Retorna contagem total em resposta |
|
Opcional $filter
|
$filter | string |
|
|
|
Token ao portador
|
CustomAuthHeader | True | string |
Valor do token ao portador (sem a palavra-chave Portador) |
|
Variável de Ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.CONTEXTO
|
@odata.context | string |
@odata.context |
|
@odata.count
|
@odata.count | integer |
@odata.count |
|
valor
|
value | array of object |
valor |
|
EmployeeId
|
value.EmployeeId | integer |
EmployeeId |
|
Número de Funcionário
|
value.EmployeeNumber | string |
Número de Funcionário |
|
Title
|
value.Title | string |
Title |
|
Primeiro Nome
|
value.FirstName | string |
Primeiro Nome |
|
Apelido
|
value.LastName | string |
Apelido |
|
PreferredName
|
value.PreferredName | string |
PreferredName |
|
Nome da Donzela
|
value.MaidenName | string |
Nome da Donzela |
|
Nome do meio
|
value.MiddleName | string |
Nome do meio |
|
Iniciais
|
value.Initials | string |
Iniciais |
|
Email
|
value.Email | string |
|
|
Aniversário
|
value.Birthday | string |
Aniversário |
|
Número de casa
|
value.HomeNumber | string |
Número de casa |
|
Número de trabalho
|
value.WorkNumber | string |
Número de trabalho |
|
Número da célula
|
value.CellNumber | string |
Número da célula |
|
Extensão de trabalho
|
value.WorkExtension | string |
Extensão de trabalho |
|
Linguagem
|
value.Language | string |
Linguagem |
|
Sexo
|
value.Gender | string |
Sexo |
|
MaritalStatus
|
value.MaritalStatus | string |
MaritalStatus |
|
Raça
|
value.Race | string |
Raça |
|
Nationality
|
value.Nationality | string |
Nationality |
|
Cidadania
|
value.Citizenship | string |
Cidadania |
|
Número de Referência Fiscal
|
value.TaxRefNumber | string |
Número de Referência Fiscal |
|
Disabled
|
value.Disabled | boolean |
Disabled |
|
Tipo desativado
|
value.DisabledType | string |
Tipo desativado |
|
Grupo Étnico
|
value.EthnicGroup | string |
Grupo Étnico |
|
EstrangeiroNacional
|
value.ForeignNational | boolean |
EstrangeiroNacional |
|
Data-do-grupo
|
value.GroupDate | string |
Data-do-grupo |
|
DataCriada
|
value.DateCreated | string |
DataCriada |
|
EmergencyContactName
|
value.EmergencyContactName | string |
EmergencyContactName |
|
Número de contato de emergência
|
value.EmergencyContactNumber | string |
Número de contato de emergência |
|
EmergênciaContactoEndereço
|
value.EmergencyContactAddress | string |
EmergênciaContactoEndereço |
|
IsMockEmployee
|
value.IsMockEmployee | boolean |
IsMockEmployee |
|
IsRetired
|
value.IsRetired | boolean |
IsRetired |
|
CustomFieldValue
|
value.CustomFieldValue | string |
CustomFieldValue |
|
CustomFieldValue2
|
value.CustomFieldValue2 | string |
CustomFieldValue2 |
|
UifIsenção
|
value.UifExemption | string |
UifIsenção |
|
SdlExemption
|
value.SdlExemption | string |
SdlExemption |
|
EtiExempt
|
value.EtiExempt | boolean |
EtiExempt |
|
ImageDownloadUrl
|
value.ImageDownloadUrl | string |
ImageDownloadUrl |
|
Campos Personalizados
|
value.CustomFields | array of object |
Campos Personalizados |
|
Código
|
value.CustomFields.Code | string |
Código |
|
Etiqueta
|
value.CustomFields.Label | string |
Etiqueta |
|
Valor
|
value.CustomFields.Value | string |
Valor |
|
Address
|
value.Address | array of object |
Address |
|
EndereçoId
|
value.Address.AddressId | integer |
EndereçoId |
|
EndereçoType
|
value.Address.AddressType | string |
EndereçoType |
|
Número de Funcionário
|
value.Address.EmployeeNumber | string |
Número de Funcionário |
|
EndereçoLinha1
|
value.Address.AddressLine1 | string |
EndereçoLinha1 |
|
Linha de Endereço 2
|
value.Address.AddressLine2 | string |
Linha de Endereço 2 |
|
EndereçoLine3
|
value.Address.AddressLine3 | string |
EndereçoLine3 |
|
AddressCode
|
value.Address.AddressCode | string |
AddressCode |
|
EndereçoPaís
|
value.Address.AddressCountry | string |
EndereçoPaís |
|
Província
|
value.Address.Province | string |
Província |
|
Número da unidade
|
value.Address.UnitNumber | string |
Número da unidade |
|
Complexo
|
value.Address.Complex | string |
Complexo |
|
StreetNumber
|
value.Address.StreetNumber | string |
StreetNumber |
|
SameAsPhysical
|
value.Address.SameAsPhysical | boolean |
SameAsPhysical |
|
IsCareofAddress
|
value.Address.IsCareofAddress | boolean |
IsCareofAddress |
|
CareOfIntermediário
|
value.Address.CareOfIntermediary | string |
CareOfIntermediário |
|
Serviços Especiais
|
value.Address.SpecialServices | string |
Serviços Especiais |
Obter uma coleção de posições a partir de uma data efetiva
Recupera uma lista de registros de posição de funcionários a partir da data efetiva especificada e com base no company_id especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
{{$employee-campo}}
|
$orderby | True | string |
(string) - Especifica a ordem em que os itens são retornados |
|
Opcional $top
|
$top | integer |
(inteiro($int 32)) - Limita o número de itens devolvidos de uma coleção |
|
|
Opcional $skip
|
$skip | True | integer |
(inteiro($int 32)) - Exclui o número especificado de itens da coleção consultada do resultado |
|
Opcional $count
|
$count | True | string |
(true/false) - Retorna contagem total em resposta |
|
Opcional $expand
|
$expand | True | string |
Opcional - para retornar os dados do campo OrganizationGroups, use o valor 'OrganizationGroups' |
|
{{empresa-id}}
|
company-id | True | integer |
{{empresa-id}} O ID da Empresa |
|
data de entrada em vigor
|
effectivedate | True | string |
Data efetiva formatada em AAAA-MM-DD. por exemplo. 2022-01-15 |
|
Token ao portador
|
CustomAuthHeader | True | string |
Valor do token ao portador (sem a palavra-chave Portador) |
|
Variável de Ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.CONTEXTO
|
@odata.context | string |
@odata.context |
|
@odata.count
|
@odata.count | integer |
@odata.count |
|
valor
|
value | array of object |
valor |
|
EmployeePositionId
|
value.EmployeePositionId | integer |
EmployeePositionId |
|
Número de Funcionário
|
value.EmployeeNumber | string |
Número de Funcionário |
|
Nome Completo
|
value.FullName | string |
Nome Completo |
|
Data de Eficácia
|
value.EffectiveDate | string |
Data de Eficácia |
|
PosiçãoOrganizacional
|
value.OrganizationPosition | string |
PosiçãoOrganizacional |
|
OrganizationPositionId
|
value.OrganizationPositionId | integer |
OrganizationPositionId |
|
OrganizaçãoPosiçãoWithCode
|
value.OrganizationPositionWithCode | string |
OrganizaçãoPosiçãoWithCode |
|
Tipo de posição
|
value.PositionType | string |
Tipo de posição |
|
Grade
|
value.Grade | string |
Grade |
|
Nível Ocupacional
|
value.OccupationalLevel | string |
Nível Ocupacional |
|
DiretamenteReportsPositionOverride
|
value.DirectlyReportsPositionOverride | string |
DiretamenteReportsPositionOverride |
|
DiretamenteRelatóriosPosição
|
value.DirectlyReportsPosition | string |
DiretamenteRelatóriosPosição |
|
Grupo Organizacional
|
value.OrganizationGroup | string |
Grupo Organizacional |
|
OrganizaçãoGrupoDescrição
|
value.OrganizationGroupDescription | string |
OrganizaçãoGrupoDescrição |
|
GruposOrganizacionais
|
value.OrganizationGroups | array of object |
GruposOrganizacionais |
|
OrganizaçãoUnitId
|
value.OrganizationGroups.OrganizationUnitId | integer |
OrganizaçãoUnitId |
|
ParentOrganizationUnitId
|
value.OrganizationGroups.ParentOrganizationUnitId | integer |
ParentOrganizationUnitId |
|
UploadCode
|
value.OrganizationGroups.UploadCode | string |
UploadCode |
|
Description
|
value.OrganizationGroups.Description | string |
Description |
|
Centro de Custos
|
value.OrganizationGroups.CostCentre | boolean |
Centro de Custos |
|
Nível de Organização
|
value.OrganizationGroups.OrganizationLevel | string |
Nível de Organização |
|
GrupoGlKey
|
value.OrganizationGroups.GroupGlKey | string |
GrupoGlKey |
|
Orçamento
|
value.OrganizationGroups.Budget | integer |
Orçamento |
|
Reference
|
value.OrganizationGroups.Reference | string |
Reference |
|
ManagerEmployeeNumber
|
value.OrganizationGroups.ManagerEmployeeNumber | string |
ManagerEmployeeNumber |
|
Data inativa
|
value.OrganizationGroups.InactiveDate | string |
Data inativa |
|
OrganizaçãoRegião
|
value.OrganizationRegion | string |
OrganizaçãoRegião |
|
Ponto de Pagamento
|
value.PayPoint | string |
Ponto de Pagamento |
|
DiretamenteRelatóriosFuncionário
|
value.DirectlyReportsEmployee | string |
DiretamenteRelatóriosFuncionário |
|
DiretamenteRelatóriosNúmero do Funcionário
|
value.DirectlyReportsEmployeeNumber | string |
DiretamenteRelatóriosNúmero do Funcionário |
|
EmpregoCategoria
|
value.EmploymentCategory | string |
EmpregoCategoria |
|
Subcategoria Emprego
|
value.EmploymentSubCategory | string |
Subcategoria Emprego |
|
Administradores
|
value.Administrator | string |
Administradores |
|
AdministratorEmployeeNumber
|
value.AdministratorEmployeeNumber | string |
AdministratorEmployeeNumber |
|
Função de fluxo de trabalho
|
value.WorkflowRole | string |
Função de fluxo de trabalho |
|
Razão Geral
|
value.GeneralLedger | string |
Razão Geral |
|
Sindicato
|
value.TradeUnion | string |
Sindicato |
|
IsPromotion
|
value.IsPromotion | boolean |
IsPromotion |
|
Escala de trabalho
|
value.Roster | string |
Escala de trabalho |
|
Tarefa
|
value.Job | string |
Tarefa |
|
Comments
|
value.Comments | string |
Comments |
|
AltPositionName
|
value.AltPositionName | string |
AltPositionName |
|
DataAdicionada
|
value.DateAdded | string |
DataAdicionada |
|
PosiçãoDataEfetiva
|
value.PositionEffectiveDate | string |
PosiçãoDataEfetiva |
|
Sindicato Aduaneiro
|
value.CustomTradeUnion | string |
Sindicato Aduaneiro |
|
Campos Personalizados
|
value.CustomFields | array of object |
Campos Personalizados |
|
Código
|
value.CustomFields.Code | string |
Código |
|
Etiqueta
|
value.CustomFields.Label | string |
Etiqueta |
|
Valor
|
value.CustomFields.Value | string |
Valor |
Obter uma coleção de registros de anexos de funcionários
Recupera uma lista de registros de anexos de funcionários ativos com base no company_id especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Opcional por {{$attachment-field}}
|
$orderby | string |
(string) - Especifica a ordem em que os itens são retornados |
|
|
Opcional $top
|
$top | integer |
(inteiro($int 32)) - Limita o número de itens devolvidos de uma coleção |
|
|
Opcional $skip
|
$skip | True | integer |
(inteiro($int 32)) - Exclui o número especificado de itens da coleção consultada do resultado |
|
Opcional $count
|
$count | True | string |
(true/false) - Retorna contagem total em resposta |
|
Opcional $filter
|
$filter | string |
Filtrar por campo, por exemplo. "EmployeeNumber eq 'Emp01'" |
|
|
{{empresa-id}}
|
company-id | True | integer |
{{empresa-id}} O ID da Empresa |
|
Token ao portador
|
CustomAuthHeader | True | string |
Valor do token ao portador (sem a palavra-chave Portador) |
|
Variável de Ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.CONTEXTO
|
@odata.context | string |
@odata.context |
|
@odata.count
|
@odata.count | integer |
@odata.count |
|
valor
|
value | array of object |
valor |
|
AttachmentId
|
value.AttachmentId | integer |
AttachmentId |
|
Número de Funcionário
|
value.EmployeeNumber | string |
Número de Funcionário |
|
Classification
|
value.Classification | string |
Classification |
|
AnexoDescrição
|
value.AttachmentDescription | string |
AnexoDescrição |
|
AttachmentName
|
value.AttachmentName | string |
AttachmentName |
|
AttachmentUrl
|
value.AttachmentUrl | string |
AttachmentUrl |
|
Anexo
|
value.Attachment | string |
Anexo |
|
Campos Personalizados
|
value.CustomFields | array of object |
Campos Personalizados |
|
Código
|
value.CustomFields.Code | string |
Código |
|
Etiqueta
|
value.CustomFields.Label | string |
Etiqueta |
|
Valor
|
value.CustomFields.Value | string |
Valor |
Obter uma coleção de registros de dados bancários
Recupera uma lista de detalhes bancários de funcionários com base no company_id especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Opcional por {{$bank-detail-field}}
|
$orderby | True | string |
(string) - Especifica a ordem em que os itens são retornados |
|
Opcional $top
|
$top | string |
(inteiro($int 32)) - Limita o número de itens devolvidos de uma coleção |
|
|
Opcional $skip
|
$skip | True | string |
(inteiro($int 32)) - Exclui o número especificado de itens da coleção consultada do resultado |
|
Opcional $count
|
$count | True | string |
(true/false) - Retorna contagem total em resposta |
|
Opcional $filter
|
$filter | string |
Filtrar por campo, por exemplo. "EmployeeNumber eq 'Emp01'" |
|
|
{{empresa-id}}
|
company-id | True | integer |
{{empresa-id}} O ID da Empresa |
|
Token ao portador
|
CustomAuthHeader | True | string |
Valor do token ao portador (sem a palavra-chave Portador) |
|
Variável de Ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.CONTEXTO
|
@odata.context | string |
@odata.context |
|
@odata.count
|
@odata.count | integer |
@odata.count |
|
valor
|
value | array of object |
valor |
|
BankDetailId
|
value.BankDetailId | integer |
BankDetailId |
|
Número de Funcionário
|
value.EmployeeNumber | string |
Número de Funcionário |
|
Método de Pagamento
|
value.PaymentMethod | string |
Método de Pagamento |
|
SplitType
|
value.SplitType | string |
SplitType |
|
Proprietário de Conta Bancária
|
value.BankAccountOwner | string |
Proprietário de Conta Bancária |
|
BankAccountOwnerName
|
value.BankAccountOwnerName | string |
BankAccountOwnerName |
|
Tipo de Conta
|
value.AccountType | string |
Tipo de Conta |
|
Nome do Banco
|
value.BankName | string |
Nome do Banco |
|
Agência-BancáriaN.º
|
value.BankBranchNo | string |
Agência-BancáriaN.º |
|
Conta BancáriaN.º
|
value.BankAccountNo | string |
Conta BancáriaN.º |
|
Reference
|
value.Reference | string |
Reference |
|
IsMainAccount
|
value.IsMainAccount | boolean |
IsMainAccount |
|
Montante
|
value.Amount | integer |
Montante |
|
Comments
|
value.Comments | string |
Comments |
|
Código Swift
|
value.SwiftCode | string |
Código Swift |
|
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 no ID da empresa especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Opcional por {{$employee-field}}
|
$orderby | string |
(string) - Especifica a ordem em que os itens são retornados |
|
|
Opcional $top
|
$top | integer |
(inteiro($int 32)) - Limita o número de itens devolvidos de uma coleção |
|
|
Opcional $skip
|
$skip | True | integer |
(inteiro($int 32)) - Exclui o número especificado de itens da coleção consultada do resultado |
|
Opcional $count
|
$count | True | string |
(true/false) - Retorna contagem total em resposta |
|
Opcional $filter
|
$filter | string |
Filtrar por campo, por exemplo. "EmployeeNumber eq 'Emp01'" |
|
|
{{empresa-id}}
|
company-id | True | integer |
{{empresa-id}} O ID da Empresa |
|
Token ao portador
|
CustomAuthHeader | True | string |
Valor do token ao portador (sem a palavra-chave Portador) |
|
Variável de Ambiente
|
CustomEnvironmentHeader | True | string |
Variável que é api (para PROD) ou apistaging (para STAGING) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
@odata.CONTEXTO
|
@odata.context | string |
@odata.context |
|
@odata.count
|
@odata.count | integer |
@odata.count |
|
valor
|
value | array of object |
valor |
|
EmpregoStatusId
|
value.EmploymentStatusId | integer |
EmpregoStatusId |
|
Número de Funcionário
|
value.EmployeeNumber | string |
Número de Funcionário |
|
GroupJoinDate
|
value.GroupJoinDate | string |
GroupJoinDate |
|
Data de Emprego
|
value.EmploymentDate | string |
Data de Emprego |
|
Data de Rescisão
|
value.TerminationDate | string |
Data de Rescisão |
|
RescisãoMotivo
|
value.TerminationReason | string |
RescisãoMotivo |
|
TaxStatus
|
value.TaxStatus | string |
TaxStatus |
|
TaxReferenceNumber
|
value.TaxReferenceNumber | string |
TaxReferenceNumber |
|
NaturezadePessoa
|
value.NatureOfPerson | string |
NaturezadePessoa |
|
Repartição de Finanças
|
value.TaxOffice | integer |
Repartição de Finanças |
|
Número da Diretiva Fiscal
|
value.TaxDirectiveNumber | string |
Número da Diretiva Fiscal |
|
IT3AReason
|
value.IT3AReason | integer |
IT3AReason |
|
EmpregoAcção
|
value.EmploymentAction | string |
EmpregoAcção |
|
RescisãoEmpresaRun
|
value.TerminationCompanyRun | string |
RescisãoEmpresaRun |
|
Tipo de identidade
|
value.IdentityType | string |
Tipo de identidade |
|
Número de identificação
|
value.IdNumber | string |
Número de identificação |
|
Número de passaporte
|
value.PassportNumber | string |
Número de passaporte |
|
PercentageAmount
|
value.PercentageAmount | string |
PercentageAmount |
|
Montante
|
value.Amount | integer |
Montante |
|
Percentagem
|
value.Percentage | integer |
Percentagem |
|
DeemedMonthlyRemuneration
|
value.DeemedMonthlyRemuneration | integer |
DeemedMonthlyRemuneration |
|
Deemed75Indicador
|
value.Deemed75Indicator | boolean |
Deemed75Indicador |
|
DeemedRecoveryMonthly
|
value.DeemedRecoveryMonthly | boolean |
DeemedRecoveryMonthly |
|
EncashLeave
|
value.EncashLeave | boolean |
EncashLeave |
|
IRP30
|
value.Irp30 | boolean |
IRP30 |
|
FinalizeIssueTaxCert
|
value.FinalizeIssueTaxCert | boolean |
FinalizeIssueTaxCert |
|
PassaportePaís
|
value.PassportCountry | boolean |
PassaportePaís |
|
PassaporteEmitido
|
value.PassportIssued | string |
PassaporteEmitido |
|
PassaporteValidade
|
value.PassportExpiry | string |
PassaporteValidade |
|
LicençaEmitida
|
value.PermitIssued | string |
LicençaEmitida |
|
LicençaExpiração
|
value.PermitExpiry | string |
LicençaExpiração |
|
Data Adicional
|
value.AdditionalDate | string |
Data Adicional |
|
EmploymentCaptureDate
|
value.EmploymentCaptureDate | string |
EmploymentCaptureDate |
|
TerminationCaptureDate
|
value.TerminationCaptureDate | string |
TerminationCaptureDate |
|
Trabalhador temporário
|
value.TempWorker | boolean |
Trabalhador temporário |
|
Data1 Adicional
|
value.AdditionalDate1 | string |
Data1 Adicional |
|
NotReEmployable
|
value.NotReEmployable | boolean |
NotReEmployable |
|
Número de referência
|
value.ReferenceNumber | string |
Número de referência |
|
OldEmployeeId
|
value.OldEmployeeId | integer |
OldEmployeeId |
|
Campos Personalizados
|
value.CustomFields | array of object |
Campos Personalizados |
|
Código
|
value.CustomFields.Code | string |
Código |
|
Etiqueta
|
value.CustomFields.Label | string |
Etiqueta |
|
Valor
|
value.CustomFields.Value | string |
Valor |
Definições
objecto
Este é o tipo 'objeto'.