PaySpace (publicador independiente) (versión preliminar)
Nuestra solución eficaz le permite acceder a los datos de sus empleados con el fin de utilizarlos en su entorno empresarial. Todos los puntos de conexión admitidos en un solo lugar y listos para integrarse en la solución.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | Soporte técnico de PaySpace mint |
| URL | https://za.mintgroup.net/ |
| Correo Electrónico | payspace.support@mintgroup.net |
| Metadatos del conector | |
|---|---|
| Publicador | Tecnologías de administración de Mint |
| Sitio web | https://www.payspace.com |
| Directiva de privacidad | https://www.payspace.com/privacy-policy/ |
| Categorías | Recursos humanos |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Actualización de un único registro de datos adjuntos de empleado |
Actualice un único registro de datos adjuntos basado en el attachmentId especificado. |
| Actualización de un único registro de detalles del banco |
Actualice un único registro de detalles bancario basado en el bankdetailId especificado. |
| Actualización de un único registro de empleado |
Actualice un único registro de empleado en función del Valor employeeId especificado. |
| Actualización de un único registro de posición |
Actualice un único registro de posición de empleado basado en employeePositionId especificado. |
| Cargar foto de empleado |
Actualice una sola foto de empleado en función del Valor employeeId especificado. |
| Creación de un registro de empleado único |
Cree un registro de empleado único para employeeNumber especificado. |
| Creación de un único registro de datos adjuntos de empleado |
Cree un único registro de datos adjuntos para employeeNumber especificado. |
| Creación de un único registro de detalles del banco |
Cree un registro de detalles bancarios de empleado único para employeeNumber especificado. |
| Creación de un único registro de estado de empleo |
Cree un registro de estado de empleo de empleado único para employeeNumber especificado. |
| Creación de un único registro de posición |
Cree un registro de posición de empleado único para employeeNumber especificado. |
| Descargar foto de empleado |
Recupera una sola foto de empleado basada en el EmployeeId especificado. |
| Eliminación de un único registro de datos adjuntos de empleado |
Elimine un único registro de datos adjuntos de empleado en función del valor attachmentId especificado. |
| Eliminar un único registro de detalles del banco |
Recupera información detallada del banco de empleados en función del BankDetailId especificado. |
| Obtención de un único registro de datos adjuntos de empleado |
Recupera la información de datos adjuntos de los empleados en función del attachmentId especificado. |
| Obtención de un único registro de detalles del banco |
Recupera información detallada del banco de empleados en función del BankDetailId especificado. |
| Obtención de un único registro de posición |
Recupera los registros de posición de los empleados en función del employeePositionId especificado. |
| Obtener un único registro de empleado |
Recupera la información de los empleados en función del Valor employeeId especificado. |
| Obtener una colección de empleados |
Recupera una lista de detalles biográficos de empleados activos a partir de la fecha de hoy y en función del identificador de empresa especificado. |
| Obtener una colección de empleados a partir de una fecha efectiva |
Recupera una lista de detalles biográficos de empleados activos a partir de la fecha efectiva especificada y en función del identificador de empresa especificado. |
| Obtener una colección de estados de empleo |
Recupera una lista de los estados actuales de empleo de los empleados activos en función del identificador de empresa especificado. |
| Obtener una colección de posiciones |
Recupera una lista de registros de puestos de empleado a partir de la fecha de hoy y en función del company_id especificado. |
| Obtener una colección de posiciones a partir de una fecha efectiva |
Recupera una lista de registros de puestos de empleado a partir de la fecha efectiva especificada y en función del company_id especificado. |
| Obtener una colección de registros adjuntos employee |
Recupera una lista de registros adjuntos de empleados activos en función del company_id especificado. |
| Obtener una colección de registros de detalles bancarios |
Recupera una lista de detalles bancarios de empleados en función del company_id especificado. |
| Obtener una colección de todos los estados de empleo |
Recupera una lista de todos los estados de empleo de los empleados en función del identificador de empresa especificado. |
Actualización de un único registro de datos adjuntos de empleado
Actualice un único registro de datos adjuntos basado en el attachmentId especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} El identificador de la compañía |
|
AttachmentId
|
AttachmentId | True | integer |
{{AttachmentId}} The AttachmentId |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor del token de portador (sin la palabra clave Bearer) |
|
Variable de entorno
|
CustomEnvironmentHeader | True | string |
Variable que es api (para PROD) o apistaging (para STAGING) |
|
body
|
body | True | string |
Devoluciones
- response
- object
Actualización de un único registro de detalles del banco
Actualice un único registro de detalles bancario basado en el bankdetailId especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} El identificador de la compañía |
|
{{BankDetailId}}
|
BankDetailId | True | integer |
{{BankDetailId}} The BankDetailId |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor del token de portador (sin la palabra clave Bearer) |
|
Variable de entorno
|
CustomEnvironmentHeader | True | string |
Variable que es api (para PROD) o apistaging (para STAGING) |
|
body
|
body | True | string |
Devoluciones
- response
- object
Actualización de un único registro de empleado
Actualice un único registro de empleado en función del Valor employeeId especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | string |
{{company-id}} El identificador de la compañía |
|
{{EmployeeId}}
|
EmployeeId | True | string |
{{EmployeeId}} The EmployeeId |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor del token de portador (sin la palabra clave Bearer) |
|
Variable de entorno
|
CustomEnvironmentHeader | True | string |
Variable que es api (para PROD) o apistaging (para STAGING) |
|
body
|
body | True | string |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
@odata.context
|
@odata.context | string |
@odata.context |
|
Success
|
Success | boolean |
Success |
Actualización de un único registro de posición
Actualice un único registro de posición de empleado basado en employeePositionId especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
{{EmployeePositionId}}
|
EmployeePositionId | True | integer |
{{EmployeePositionId}} The EmployeePositionId |
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} El identificador de la compañía |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor del token de portador (sin la palabra clave Bearer) |
|
Variable de entorno
|
CustomEnvironmentHeader | True | string |
Variable que es api (para PROD) o apistaging (para STAGING) |
|
body
|
body | True | string |
Devoluciones
- response
- object
Cargar foto de empleado
Actualice una sola foto de empleado en función del Valor employeeId especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} El identificador de la compañía |
|
{{EmployeeId}}
|
EmployeeId | True | integer |
The EmployeeId |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor del token de portador (sin la palabra clave Bearer) |
|
Variable de entorno
|
CustomEnvironmentHeader | True | string |
Variable que es api (para PROD) o apistaging (para STAGING) |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
@odata.context
|
@odata.context | string |
@odata.context |
|
Success
|
Success | boolean |
Success |
Creación de un registro de empleado único
Cree un registro de empleado único para employeeNumber especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} El identificador de la compañía |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor del token de portador (sin la palabra clave Bearer) |
|
Variable de entorno
|
CustomEnvironmentHeader | True | string |
Variable que es api (para PROD) o apistaging (para STAGING) |
|
body
|
body | True | string |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
@odata.context
|
@odata.context | string |
@odata.context |
|
EmployeeId
|
EmployeeId | integer |
EmployeeId |
|
Número de Empleado
|
EmployeeNumber | string |
Número de Empleado |
|
Title
|
Title | string |
Title |
|
Primer Nombre
|
FirstName | string |
Primer Nombre |
|
Apellido
|
LastName | string |
Apellido |
|
PreferredName
|
PreferredName | string |
PreferredName |
|
MaidenName
|
MaidenName | string |
MaidenName |
|
MiddleName
|
MiddleName | string |
MiddleName |
|
Initials
|
Initials | string |
Initials |
|
Correo Electrónico
|
string |
Correo Electrónico |
|
|
Cumpleaños
|
Birthday | string |
Cumpleaños |
|
HomeNumber
|
HomeNumber | string |
HomeNumber |
|
WorkNumber
|
WorkNumber | string |
WorkNumber |
|
CellNumber
|
CellNumber | string |
CellNumber |
|
WorkExtension
|
WorkExtension | string |
WorkExtension |
|
Language
|
Language | string |
Language |
|
Gender
|
Gender | string |
Gender |
|
MaritalStatus
|
MaritalStatus | string |
MaritalStatus |
|
Raza
|
Race | string |
Raza |
|
Nationality
|
Nationality | string |
Nationality |
|
Ciudadanía
|
Citizenship | string |
Ciudadanía |
|
DisabledType
|
DisabledType | string |
DisabledType |
|
ForeignNational
|
ForeignNational | boolean |
ForeignNational |
|
DateCreated
|
DateCreated | string |
DateCreated |
|
EmergencyContactName
|
EmergencyContactName | string |
EmergencyContactName |
|
EmergencyContactNumber
|
EmergencyContactNumber | string |
EmergencyContactNumber |
|
EmergencyContactAddress
|
EmergencyContactAddress | string |
EmergencyContactAddress |
|
IsRetired
|
IsRetired | boolean |
IsRetired |
|
CustomFieldValue
|
CustomFieldValue | string |
CustomFieldValue |
|
CustomFieldValue2
|
CustomFieldValue2 | string |
CustomFieldValue2 |
|
UifExemption
|
UifExemption | string |
UifExemption |
|
SdlExemption
|
SdlExemption | string |
SdlExemption |
|
EtiExempt
|
EtiExempt | boolean |
EtiExempt |
|
ImageDownloadUrl
|
ImageDownloadUrl | string |
ImageDownloadUrl |
|
CustomFields
|
CustomFields | array of object |
CustomFields |
|
Código
|
CustomFields.Code | string |
Código |
|
Etiqueta
|
CustomFields.Label | string |
Etiqueta |
|
Importancia
|
CustomFields.Value | string |
Importancia |
|
Dirección
|
Address | array of object |
Dirección |
|
AddressId
|
Address.AddressId | integer |
AddressId |
|
AddressType
|
Address.AddressType | string |
AddressType |
|
Número de Empleado
|
Address.EmployeeNumber | string |
Número de Empleado |
|
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 |
|
Provincia
|
Address.Province | string |
Provincia |
|
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 |
Creación de un único registro de datos adjuntos de empleado
Cree un único registro de datos adjuntos para employeeNumber especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} El identificador de la compañía |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor del token de portador (sin la palabra clave Bearer) |
|
Variable de entorno
|
CustomEnvironmentHeader | True | string |
Variable que es api (para PROD) o apistaging (para STAGING) |
|
body
|
body | True | string |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
@odata.context
|
@odata.context | string |
@odata.context |
|
AttachmentId
|
AttachmentId | integer |
AttachmentId |
|
Número de Empleado
|
EmployeeNumber | string |
Número de Empleado |
|
Classification
|
Classification | string |
Classification |
|
AttachmentDescription
|
AttachmentDescription | string |
AttachmentDescription |
|
AttachmentName
|
AttachmentName | string |
AttachmentName |
|
AttachmentUrl
|
AttachmentUrl | string |
AttachmentUrl |
|
Archivo adjunto
|
Attachment | string |
Archivo adjunto |
|
CustomFields
|
CustomFields | array of object |
CustomFields |
|
Código
|
CustomFields.Code | string |
Código |
|
Etiqueta
|
CustomFields.Label | string |
Etiqueta |
|
Importancia
|
CustomFields.Value | string |
Importancia |
Creación de un único registro de detalles del banco
Cree un registro de detalles bancarios de empleado único para employeeNumber especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} El identificador de la compañía |
|
body
|
body | True | string | |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor del token de portador (sin la palabra clave Bearer) |
|
Variable de entorno
|
CustomEnvironmentHeader | True | string |
Variable que es api (para PROD) o apistaging (para STAGING) |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
@odata.context
|
@odata.context | string |
@odata.context |
|
BankDetailId
|
BankDetailId | integer |
BankDetailId |
|
Número de Empleado
|
EmployeeNumber | string |
Número de Empleado |
|
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 |
|
Referencia
|
Reference | string |
Referencia |
|
IsMainAccount
|
IsMainAccount | boolean |
IsMainAccount |
|
Importe
|
Amount | integer |
Importe |
|
Comentarios
|
Comments | string |
Comentarios |
|
SwiftCode
|
SwiftCode | string |
SwiftCode |
|
RoutingCode
|
RoutingCode | string |
RoutingCode |
|
ComponentId
|
ComponentId | integer |
ComponentId |
Creación de un único registro de estado de empleo
Cree un registro de estado de empleo de empleado único para employeeNumber especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} El identificador de la compañía |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor del token de portador (sin la palabra clave Bearer) |
|
Variable de entorno
|
CustomEnvironmentHeader | True | string |
Variable que es api (para PROD) o apistaging (para STAGING) |
|
body
|
body | True | string |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
@odata.context
|
@odata.context | string |
@odata.context |
|
EmploymentStatusId
|
EmploymentStatusId | integer |
EmploymentStatusId |
|
Número de Empleado
|
EmployeeNumber | string |
Número de Empleado |
|
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úmeroID
|
IdNumber | string |
NúmeroID |
|
PassportNumber
|
PassportNumber | string |
PassportNumber |
|
PercentageAmount
|
PercentageAmount | string |
PercentageAmount |
|
Importe
|
Amount | integer |
Importe |
|
Porcentaje
|
Percentage | integer |
Porcentaje |
|
Se consideraMonthlyRemuneration
|
DeemedMonthlyRemuneration | integer |
Se consideraMonthlyRemuneration |
|
Considerado75Indicator
|
Deemed75Indicator | boolean |
Considerado75Indicator |
|
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 |
Creación de un único registro de posición
Cree un registro de posición de empleado único para employeeNumber especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} El identificador de la compañía |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor del token de portador (sin la palabra clave Bearer) |
|
Variable de entorno
|
CustomEnvironmentHeader | True | string |
Variable que es api (para PROD) o apistaging (para STAGING) |
|
body
|
body | True | string |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
@odata.context
|
@odata.context | string |
@odata.context |
|
EmployeePositionId
|
EmployeePositionId | integer |
EmployeePositionId |
|
Número de Empleado
|
EmployeeNumber | string |
Número de Empleado |
|
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 |
|
EmpleoCategory
|
EmploymentCategory | string |
EmpleoCategory |
|
EmpleoSubCategory
|
EmploymentSubCategory | string |
EmpleoSubCategory |
|
Administrator
|
Administrator | string |
Administrator |
|
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 |
|
Comentarios
|
Comments | string |
Comentarios |
|
AltPositionName
|
AltPositionName | string |
AltPositionName |
|
DateAdded
|
DateAdded | string |
DateAdded |
|
PositionEffectiveDate
|
PositionEffectiveDate | string |
PositionEffectiveDate |
|
CustomTradeUnion
|
CustomTradeUnion | string |
CustomTradeUnion |
|
CustomFields
|
CustomFields | array of object |
CustomFields |
|
Código
|
CustomFields.Code | string |
Código |
|
Etiqueta
|
CustomFields.Label | string |
Etiqueta |
|
Importancia
|
CustomFields.Value | string |
Importancia |
Descargar foto de empleado
Recupera una sola foto de empleado basada en el EmployeeId especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} El identificador de la compañía |
|
{{EmployeeId}}
|
EmployeeId | True | integer |
The EmployeeId |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor del token de portador (sin la palabra clave Bearer) |
|
Variable de entorno
|
CustomEnvironmentHeader | True | string |
Variable que es api (para PROD) o apistaging (para STAGING) |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
@odata.context
|
@odata.context | string |
@odata.context |
|
Success
|
Success | boolean |
Success |
Eliminación de un único registro de datos adjuntos de empleado
Elimine un único registro de datos adjuntos de empleado en función del valor attachmentId especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} El identificador de la compañía |
|
AttachmentId
|
AttachmentId | True | integer |
{{AttachmentId}} The AttachmentId |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor del token de portador (sin la palabra clave Bearer) |
|
Variable de entorno
|
CustomEnvironmentHeader | True | string |
Variable que es api (para PROD) o apistaging (para STAGING) |
Devoluciones
- response
- object
Eliminar un único registro de detalles del banco
Recupera información detallada del banco de empleados en función del BankDetailId especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} El identificador de la compañía |
|
{{BankDetailId}}
|
BankDetailId | True | integer |
{{BankDetailId}} The BankDetailId |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor del token de portador (sin la palabra clave Bearer) |
|
Variable de entorno
|
CustomEnvironmentHeader | True | string |
Variable que es api (para PROD) o apistaging (para STAGING) |
Devoluciones
- response
- object
Obtención de un único registro de datos adjuntos de empleado
Recupera la información de datos adjuntos de los empleados en función del attachmentId especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} El identificador de la compañía |
|
{{AttachmentId}}
|
AttachmentId | True | integer |
The AttachmentId |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor del token de portador (sin la palabra clave Bearer) |
|
Variable de entorno
|
CustomEnvironmentHeader | True | string |
Variable que es api (para PROD) o apistaging (para STAGING) |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
@odata.context
|
@odata.context | string |
@odata.context |
|
AttachmentId
|
AttachmentId | integer |
AttachmentId |
|
Número de Empleado
|
EmployeeNumber | string |
Número de Empleado |
|
Classification
|
Classification | string |
Classification |
|
AttachmentDescription
|
AttachmentDescription | string |
AttachmentDescription |
|
AttachmentName
|
AttachmentName | string |
AttachmentName |
|
AttachmentUrl
|
AttachmentUrl | string |
AttachmentUrl |
|
Archivo adjunto
|
Attachment | string |
Archivo adjunto |
|
CustomFields
|
CustomFields | array of object |
CustomFields |
|
Código
|
CustomFields.Code | string |
Código |
|
Etiqueta
|
CustomFields.Label | string |
Etiqueta |
|
Importancia
|
CustomFields.Value | string |
Importancia |
Obtención de un único registro de detalles del banco
Recupera información detallada del banco de empleados en función del BankDetailId especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} El identificador de la compañía |
|
{{BankDetailId}}
|
BankDetailId | True | integer |
The BankDetailId |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor del token de portador (sin la palabra clave Bearer) |
|
Variable de entorno
|
CustomEnvironmentHeader | True | string |
Variable que es api (para PROD) o apistaging (para STAGING) |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
@odata.context
|
@odata.context | string |
@odata.context |
|
BankDetailId
|
BankDetailId | integer |
BankDetailId |
|
Número de Empleado
|
EmployeeNumber | string |
Número de Empleado |
|
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 |
|
Referencia
|
Reference | string |
Referencia |
|
IsMainAccount
|
IsMainAccount | boolean |
IsMainAccount |
|
Importe
|
Amount | integer |
Importe |
|
Comentarios
|
Comments | string |
Comentarios |
|
SwiftCode
|
SwiftCode | string |
SwiftCode |
|
RoutingCode
|
RoutingCode | string |
RoutingCode |
|
ComponentId
|
ComponentId | integer |
ComponentId |
Obtención de un único registro de posición
Recupera los registros de posición de los empleados en función del employeePositionId especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} El identificador de la compañía |
|
{{EmployeePositionId}}
|
EmployeePositionId | True | integer |
The EmployeePositionId |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor del token de portador (sin la palabra clave Bearer) |
|
Variable de entorno
|
CustomEnvironmentHeader | True | string |
Variable que es api (para PROD) o apistaging (para STAGING) |
Devoluciones
| Nombre | Ruta de acceso | 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 de Empleado
|
value.EmployeeNumber | string |
Número de Empleado |
|
Nombre completo
|
value.FullName | string |
Nombre 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 |
|
Presupuesto
|
value.OrganizationGroups.Budget | integer |
Presupuesto |
|
Referencia
|
value.OrganizationGroups.Reference | string |
Referencia |
|
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 |
|
EmpleoCategory
|
value.EmploymentCategory | string |
EmpleoCategory |
|
EmpleoSubCategory
|
value.EmploymentSubCategory | string |
EmpleoSubCategory |
|
Administrator
|
value.Administrator | string |
Administrator |
|
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 |
|
Comentarios
|
value.Comments | string |
Comentarios |
|
AltPositionName
|
value.AltPositionName | string |
AltPositionName |
|
DateAdded
|
value.DateAdded | string |
DateAdded |
|
PositionEffectiveDate
|
value.PositionEffectiveDate | string |
PositionEffectiveDate |
|
CustomTradeUnion
|
value.CustomTradeUnion | string |
CustomTradeUnion |
|
CustomFields
|
value.CustomFields | array of object |
CustomFields |
|
Código
|
value.CustomFields.Code | string |
Código |
|
Etiqueta
|
value.CustomFields.Label | string |
Etiqueta |
|
Importancia
|
value.CustomFields.Value | string |
Importancia |
Obtener un único registro de empleado
Recupera la información de los empleados en función del Valor employeeId especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} El identificador de la compañía |
|
{{EmployeeId}}
|
EmployeeId | True | integer |
The EmployeeId |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor del token de portador (sin la palabra clave Bearer) |
|
Variable de entorno
|
CustomEnvironmentHeader | True | string |
Variable que es api (para PROD) o apistaging (para STAGING) |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
@odata.context
|
@odata.context | string |
@odata.context |
|
EmployeeId
|
EmployeeId | integer |
EmployeeId |
|
Número de Empleado
|
EmployeeNumber | string |
Número de Empleado |
|
Title
|
Title | string |
Title |
|
Primer Nombre
|
FirstName | string |
Primer Nombre |
|
Apellido
|
LastName | string |
Apellido |
|
PreferredName
|
PreferredName | string |
PreferredName |
|
MaidenName
|
MaidenName | string |
MaidenName |
|
MiddleName
|
MiddleName | string |
MiddleName |
|
Initials
|
Initials | string |
Initials |
|
Correo Electrónico
|
string |
Correo Electrónico |
|
|
Cumpleaños
|
Birthday | string |
Cumpleaños |
|
HomeNumber
|
HomeNumber | string |
HomeNumber |
|
WorkNumber
|
WorkNumber | string |
WorkNumber |
|
CellNumber
|
CellNumber | string |
CellNumber |
|
WorkExtension
|
WorkExtension | string |
WorkExtension |
|
Language
|
Language | string |
Language |
|
Gender
|
Gender | string |
Gender |
|
MaritalStatus
|
MaritalStatus | string |
MaritalStatus |
|
Raza
|
Race | string |
Raza |
|
Nationality
|
Nationality | string |
Nationality |
|
Ciudadanía
|
Citizenship | string |
Ciudadanía |
|
DisabledType
|
DisabledType | string |
DisabledType |
|
ForeignNational
|
ForeignNational | boolean |
ForeignNational |
|
DateCreated
|
DateCreated | string |
DateCreated |
|
EmergencyContactName
|
EmergencyContactName | string |
EmergencyContactName |
|
EmergencyContactNumber
|
EmergencyContactNumber | string |
EmergencyContactNumber |
|
EmergencyContactAddress
|
EmergencyContactAddress | string |
EmergencyContactAddress |
|
IsRetired
|
IsRetired | boolean |
IsRetired |
|
CustomFieldValue
|
CustomFieldValue | string |
CustomFieldValue |
|
CustomFieldValue2
|
CustomFieldValue2 | string |
CustomFieldValue2 |
|
UifExemption
|
UifExemption | string |
UifExemption |
|
SdlExemption
|
SdlExemption | string |
SdlExemption |
|
EtiExempt
|
EtiExempt | boolean |
EtiExempt |
|
ImageDownloadUrl
|
ImageDownloadUrl | string |
ImageDownloadUrl |
|
CustomFields
|
CustomFields | array of object |
CustomFields |
|
Código
|
CustomFields.Code | string |
Código |
|
Etiqueta
|
CustomFields.Label | string |
Etiqueta |
|
Importancia
|
CustomFields.Value | string |
Importancia |
|
Dirección
|
Address | array of object |
Dirección |
|
AddressId
|
Address.AddressId | integer |
AddressId |
|
AddressType
|
Address.AddressType | string |
AddressType |
|
Número de Empleado
|
Address.EmployeeNumber | string |
Número de Empleado |
|
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 |
|
Provincia
|
Address.Province | string |
Provincia |
|
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 |
Obtener una colección de empleados
Recupera una lista de detalles biográficos de empleados activos a partir de la fecha de hoy y en función del identificador de empresa especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} El identificador de la compañía |
|
Opcional por {{$employee-field}}
|
$orderby | string |
(string): especifica el orden en el que se devuelven los elementos. |
|
|
$top opcional
|
$top | integer |
(integer($int 32)): limita el número de elementos devueltos desde una colección. |
|
|
$skip opcional
|
$skip | integer |
(integer($int 32)): excluye el número especificado de elementos de la colección consultada del resultado. |
|
|
$count opcional
|
$count | string |
(true/false): recuento total devuelto en respuesta |
|
|
$filter opcional
|
$filter | string |
Opcional: filtrar por campo, por ejemplo, "EmployeeNumber eq 'Emp01'" |
|
|
$select opcional
|
$select | string |
Opcional (cadena): devuelve solo los campos especificados. |
|
|
Token de portador
|
CustomAuthHeader | True | string |
Valor del token de portador (sin la palabra clave Bearer) |
|
Variable de entorno
|
CustomEnvironmentHeader | True | string |
Variable que es api (para PROD) o apistaging (para STAGING) |
Devoluciones
| Nombre | Ruta de acceso | 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 de Empleado
|
value.EmployeeNumber | string |
Número de Empleado |
|
Title
|
value.Title | string |
Title |
|
Primer Nombre
|
value.FirstName | string |
Primer Nombre |
|
Apellido
|
value.LastName | string |
Apellido |
|
PreferredName
|
value.PreferredName | string |
PreferredName |
|
MaidenName
|
value.MaidenName | string |
MaidenName |
|
MiddleName
|
value.MiddleName | string |
MiddleName |
|
Initials
|
value.Initials | string |
Initials |
|
Correo Electrónico
|
value.Email | string |
Correo Electrónico |
|
Cumpleaños
|
value.Birthday | string |
Cumpleaños |
|
HomeNumber
|
value.HomeNumber | string |
HomeNumber |
|
WorkNumber
|
value.WorkNumber | string |
WorkNumber |
|
CellNumber
|
value.CellNumber | string |
CellNumber |
|
WorkExtension
|
value.WorkExtension | string |
WorkExtension |
|
Language
|
value.Language | string |
Language |
|
Gender
|
value.Gender | string |
Gender |
|
MaritalStatus
|
value.MaritalStatus | string |
MaritalStatus |
|
Raza
|
value.Race | string |
Raza |
|
Nationality
|
value.Nationality | string |
Nationality |
|
Ciudadanía
|
value.Citizenship | string |
Ciudadanía |
|
DisabledType
|
value.DisabledType | string |
DisabledType |
|
ForeignNational
|
value.ForeignNational | boolean |
ForeignNational |
|
DateCreated
|
value.DateCreated | string |
DateCreated |
|
EmergencyContactName
|
value.EmergencyContactName | string |
EmergencyContactName |
|
EmergencyContactNumber
|
value.EmergencyContactNumber | string |
EmergencyContactNumber |
|
EmergencyContactAddress
|
value.EmergencyContactAddress | string |
EmergencyContactAddress |
|
IsRetired
|
value.IsRetired | boolean |
IsRetired |
|
CustomFieldValue
|
value.CustomFieldValue | string |
CustomFieldValue |
|
CustomFieldValue2
|
value.CustomFieldValue2 | string |
CustomFieldValue2 |
|
UifExemption
|
value.UifExemption | string |
UifExemption |
|
SdlExemption
|
value.SdlExemption | string |
SdlExemption |
|
EtiExempt
|
value.EtiExempt | boolean |
EtiExempt |
|
ImageDownloadUrl
|
value.ImageDownloadUrl | string |
ImageDownloadUrl |
|
CustomFields
|
value.CustomFields | array of object |
CustomFields |
|
Código
|
value.CustomFields.Code | string |
Código |
|
Etiqueta
|
value.CustomFields.Label | string |
Etiqueta |
|
Importancia
|
value.CustomFields.Value | string |
Importancia |
|
Dirección
|
value.Address | array of object |
Dirección |
|
AddressId
|
value.Address.AddressId | integer |
AddressId |
|
AddressType
|
value.Address.AddressType | string |
AddressType |
|
Número de Empleado
|
value.Address.EmployeeNumber | string |
Número de Empleado |
|
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 |
|
Provincia
|
value.Address.Province | string |
Provincia |
|
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 |
Obtener una colección de empleados a partir de una fecha efectiva
Recupera una lista de detalles biográficos de empleados activos a partir de la fecha efectiva especificada y en función del identificador de empresa especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} El identificador de la compañía |
|
effectivedate
|
effectivedate | True | string |
Fecha efectiva con formato AAAA-MM-DD. Eg. 2022-01-15 |
|
Opcional por {{$employee-field}}
|
$orderby | string |
(string): especifica el orden en el que se devuelven los elementos. |
|
|
$top opcional
|
$top | integer |
(integer($int 32)): limita el número de elementos devueltos desde una colección. |
|
|
$skip opcional
|
$skip | True | integer |
(integer($int 32)): excluye el número especificado de elementos de la colección consultada del resultado. |
|
$count opcional
|
$count | True | string |
(true/false): recuento total devuelto en respuesta |
|
$filter opcional
|
$filter | string |
|
|
|
Token de portador
|
CustomAuthHeader | True | string |
Valor del token de portador (sin la palabra clave Bearer) |
|
Variable de entorno
|
CustomEnvironmentHeader | True | string |
Variable que es api (para PROD) o apistaging (para STAGING) |
Devoluciones
| Nombre | Ruta de acceso | 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 de Empleado
|
value.EmployeeNumber | string |
Número de Empleado |
|
Title
|
value.Title | string |
Title |
|
Primer Nombre
|
value.FirstName | string |
Primer Nombre |
|
Apellido
|
value.LastName | string |
Apellido |
|
PreferredName
|
value.PreferredName | string |
PreferredName |
|
MaidenName
|
value.MaidenName | string |
MaidenName |
|
MiddleName
|
value.MiddleName | string |
MiddleName |
|
Initials
|
value.Initials | string |
Initials |
|
Correo Electrónico
|
value.Email | string |
Correo Electrónico |
|
Cumpleaños
|
value.Birthday | string |
Cumpleaños |
|
HomeNumber
|
value.HomeNumber | string |
HomeNumber |
|
WorkNumber
|
value.WorkNumber | string |
WorkNumber |
|
CellNumber
|
value.CellNumber | string |
CellNumber |
|
WorkExtension
|
value.WorkExtension | string |
WorkExtension |
|
Language
|
value.Language | string |
Language |
|
Gender
|
value.Gender | string |
Gender |
|
MaritalStatus
|
value.MaritalStatus | string |
MaritalStatus |
|
Raza
|
value.Race | string |
Raza |
|
Nationality
|
value.Nationality | string |
Nationality |
|
Ciudadanía
|
value.Citizenship | string |
Ciudadanía |
|
TaxRefNumber
|
value.TaxRefNumber | string |
TaxRefNumber |
|
Disabled
|
value.Disabled | boolean |
Disabled |
|
DisabledType
|
value.DisabledType | string |
DisabledType |
|
EthnicGroup
|
value.EthnicGroup | string |
EthnicGroup |
|
ForeignNational
|
value.ForeignNational | boolean |
ForeignNational |
|
GroupDate
|
value.GroupDate | string |
GroupDate |
|
DateCreated
|
value.DateCreated | string |
DateCreated |
|
EmergencyContactName
|
value.EmergencyContactName | string |
EmergencyContactName |
|
EmergencyContactNumber
|
value.EmergencyContactNumber | string |
EmergencyContactNumber |
|
EmergencyContactAddress
|
value.EmergencyContactAddress | string |
EmergencyContactAddress |
|
IsMockEmployee
|
value.IsMockEmployee | boolean |
IsMockEmployee |
|
IsRetired
|
value.IsRetired | boolean |
IsRetired |
|
CustomFieldValue
|
value.CustomFieldValue | string |
CustomFieldValue |
|
CustomFieldValue2
|
value.CustomFieldValue2 | string |
CustomFieldValue2 |
|
UifExemption
|
value.UifExemption | string |
UifExemption |
|
SdlExemption
|
value.SdlExemption | string |
SdlExemption |
|
EtiExempt
|
value.EtiExempt | boolean |
EtiExempt |
|
ImageDownloadUrl
|
value.ImageDownloadUrl | string |
ImageDownloadUrl |
|
CustomFields
|
value.CustomFields | array of object |
CustomFields |
|
Código
|
value.CustomFields.Code | string |
Código |
|
Etiqueta
|
value.CustomFields.Label | string |
Etiqueta |
|
Importancia
|
value.CustomFields.Value | string |
Importancia |
|
Dirección
|
value.Address | array of object |
Dirección |
|
AddressId
|
value.Address.AddressId | integer |
AddressId |
|
AddressType
|
value.Address.AddressType | string |
AddressType |
|
Número de Empleado
|
value.Address.EmployeeNumber | string |
Número de Empleado |
|
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 |
|
Provincia
|
value.Address.Province | string |
Provincia |
|
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 |
Obtener una colección de estados de empleo
Recupera una lista de los estados actuales de empleo de los empleados activos en función del identificador de empresa especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Opcional por {{$employee-field}}
|
$orderby | string |
(string): especifica el orden en el que se devuelven los elementos. |
|
|
$top opcional
|
$top | integer |
(integer($int 32)): limita el número de elementos devueltos desde una colección. |
|
|
$skip opcional
|
$skip | True | integer |
(integer($int 32)): excluye el número especificado de elementos de la colección consultada del resultado. |
|
$count opcional
|
$count | True | string |
(true/false): recuento total devuelto en respuesta |
|
$filter opcional
|
$filter | string |
Filtre por campo, por ejemplo, "EmployeeNumber eq 'Emp01'" |
|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} El identificador de la compañía |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor del token de portador (sin la palabra clave Bearer) |
|
Variable de entorno
|
CustomEnvironmentHeader | True | string |
Variable que es api (para PROD) o apistaging (para STAGING) |
Devoluciones
| Nombre | Ruta de acceso | 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 de Empleado
|
value.EmployeeNumber | string |
Número de Empleado |
|
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úmeroID
|
value.IdNumber | string |
NúmeroID |
|
PassportNumber
|
value.PassportNumber | string |
PassportNumber |
|
PercentageAmount
|
value.PercentageAmount | string |
PercentageAmount |
|
Importe
|
value.Amount | integer |
Importe |
|
Porcentaje
|
value.Percentage | integer |
Porcentaje |
|
Se consideraMonthlyRemuneration
|
value.DeemedMonthlyRemuneration | integer |
Se consideraMonthlyRemuneration |
|
Considerado75Indicator
|
value.Deemed75Indicator | boolean |
Considerado75Indicator |
|
DeemedRecoveryMonthly
|
value.DeemedRecoveryMonthly | boolean |
DeemedRecoveryMonthly |
|
EncashLeave
|
value.EncashLeave | boolean |
EncashLeave |
|
Irp30
|
value.Irp30 | boolean |
Irp30 |
|
FinalizeIssueTaxCert
|
value.FinalizeIssueTaxCert | boolean |
FinalizeIssueTaxCert |
|
PassportCountry
|
value.PassportCountry | boolean |
PassportCountry |
|
PassportIssued
|
value.PassportIssued | string |
PassportIssued |
|
PassportExpiry
|
value.PassportExpiry | string |
PassportExpiry |
|
PermitIssued
|
value.PermitIssued | string |
PermitIssued |
|
PermitExpiry
|
value.PermitExpiry | string |
PermitExpiry |
|
AdditionalDate
|
value.AdditionalDate | string |
AdditionalDate |
|
EmploymentCaptureDate
|
value.EmploymentCaptureDate | string |
EmploymentCaptureDate |
|
TerminationCaptureDate
|
value.TerminationCaptureDate | string |
TerminationCaptureDate |
|
TempWorker
|
value.TempWorker | boolean |
TempWorker |
|
AdditionalDate1
|
value.AdditionalDate1 | string |
AdditionalDate1 |
|
NotReEmployable
|
value.NotReEmployable | boolean |
NotReEmployable |
|
ReferenceNumber
|
value.ReferenceNumber | string |
ReferenceNumber |
|
OldEmployeeId
|
value.OldEmployeeId | integer |
OldEmployeeId |
|
CustomFields
|
value.CustomFields | array of object |
CustomFields |
|
Código
|
value.CustomFields.Code | string |
Código |
|
Etiqueta
|
value.CustomFields.Label | string |
Etiqueta |
|
Importancia
|
value.CustomFields.Value | string |
Importancia |
Obtener una colección de posiciones
Recupera una lista de registros de puestos de empleado a partir de la fecha de hoy y en función del company_id especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
$top opcional
|
$top | integer |
(integer($int 32)): limita el número de elementos devueltos desde una colección. |
|
|
$skip opcional
|
$skip | True | integer |
(integer($int 32)): excluye el número especificado de elementos de la colección consultada del resultado. |
|
$count opcional
|
$count | True | string |
(true/false): recuento total devuelto en respuesta |
|
$filter opcional
|
$filter | string |
Filtre por campo, por ejemplo, "EmployeeNumber eq 'Emp01'" |
|
|
$expand opcional
|
$expand | True | string |
Opcional: para devolver los datos del campo OrganizationGroups, use el valor "OrganizationGroups". |
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} El identificador de la compañía |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor del token de portador (sin la palabra clave Bearer) |
|
Variable de entorno
|
CustomEnvironmentHeader | True | string |
Variable que es api (para PROD) o apistaging (para STAGING) |
Devoluciones
| Nombre | Ruta de acceso | 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 de Empleado
|
value.EmployeeNumber | string |
Número de Empleado |
|
Nombre completo
|
value.FullName | string |
Nombre 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 |
|
Presupuesto
|
value.OrganizationGroups.Budget | integer |
Presupuesto |
|
Referencia
|
value.OrganizationGroups.Reference | string |
Referencia |
|
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 |
|
EmpleoCategory
|
value.EmploymentCategory | string |
EmpleoCategory |
|
EmpleoSubCategory
|
value.EmploymentSubCategory | string |
EmpleoSubCategory |
|
Administrator
|
value.Administrator | string |
Administrator |
|
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 |
|
Comentarios
|
value.Comments | string |
Comentarios |
|
AltPositionName
|
value.AltPositionName | string |
AltPositionName |
|
DateAdded
|
value.DateAdded | string |
DateAdded |
|
PositionEffectiveDate
|
value.PositionEffectiveDate | string |
PositionEffectiveDate |
|
CustomTradeUnion
|
value.CustomTradeUnion | string |
CustomTradeUnion |
|
CustomFields
|
value.CustomFields | array of object |
CustomFields |
|
Código
|
value.CustomFields.Code | string |
Código |
|
Etiqueta
|
value.CustomFields.Label | string |
Etiqueta |
|
Importancia
|
value.CustomFields.Value | string |
Importancia |
Obtener una colección de posiciones a partir de una fecha efectiva
Recupera una lista de registros de puestos de empleado a partir de la fecha efectiva especificada y en función del company_id especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
{{$employee-field}}
|
$orderby | True | string |
(string): especifica el orden en el que se devuelven los elementos. |
|
$top opcional
|
$top | integer |
(integer($int 32)): limita el número de elementos devueltos desde una colección. |
|
|
$skip opcional
|
$skip | True | integer |
(integer($int 32)): excluye el número especificado de elementos de la colección consultada del resultado. |
|
$count opcional
|
$count | True | string |
(true/false): recuento total devuelto en respuesta |
|
$expand opcional
|
$expand | True | string |
Opcional: para devolver los datos del campo OrganizationGroups, use el valor "OrganizationGroups". |
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} El identificador de la compañía |
|
effectivedate
|
effectivedate | True | string |
Fecha efectiva con formato AAAA-MM-DD. Eg. 2022-01-15 |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor del token de portador (sin la palabra clave Bearer) |
|
Variable de entorno
|
CustomEnvironmentHeader | True | string |
Variable que es api (para PROD) o apistaging (para STAGING) |
Devoluciones
| Nombre | Ruta de acceso | 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 de Empleado
|
value.EmployeeNumber | string |
Número de Empleado |
|
Nombre completo
|
value.FullName | string |
Nombre 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 |
|
Presupuesto
|
value.OrganizationGroups.Budget | integer |
Presupuesto |
|
Referencia
|
value.OrganizationGroups.Reference | string |
Referencia |
|
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 |
|
EmpleoCategory
|
value.EmploymentCategory | string |
EmpleoCategory |
|
EmpleoSubCategory
|
value.EmploymentSubCategory | string |
EmpleoSubCategory |
|
Administrator
|
value.Administrator | string |
Administrator |
|
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 |
|
Comentarios
|
value.Comments | string |
Comentarios |
|
AltPositionName
|
value.AltPositionName | string |
AltPositionName |
|
DateAdded
|
value.DateAdded | string |
DateAdded |
|
PositionEffectiveDate
|
value.PositionEffectiveDate | string |
PositionEffectiveDate |
|
CustomTradeUnion
|
value.CustomTradeUnion | string |
CustomTradeUnion |
|
CustomFields
|
value.CustomFields | array of object |
CustomFields |
|
Código
|
value.CustomFields.Code | string |
Código |
|
Etiqueta
|
value.CustomFields.Label | string |
Etiqueta |
|
Importancia
|
value.CustomFields.Value | string |
Importancia |
Obtener una colección de registros adjuntos employee
Recupera una lista de registros adjuntos de empleados activos en función del company_id especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Opcional por {{$attachment-field}}
|
$orderby | string |
(string): especifica el orden en el que se devuelven los elementos. |
|
|
$top opcional
|
$top | integer |
(integer($int 32)): limita el número de elementos devueltos desde una colección. |
|
|
$skip opcional
|
$skip | True | integer |
(integer($int 32)): excluye el número especificado de elementos de la colección consultada del resultado. |
|
$count opcional
|
$count | True | string |
(true/false): recuento total devuelto en respuesta |
|
$filter opcional
|
$filter | string |
Filtre por campo, por ejemplo, "EmployeeNumber eq 'Emp01'" |
|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} El identificador de la compañía |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor del token de portador (sin la palabra clave Bearer) |
|
Variable de entorno
|
CustomEnvironmentHeader | True | string |
Variable que es api (para PROD) o apistaging (para STAGING) |
Devoluciones
| Nombre | Ruta de acceso | 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 de Empleado
|
value.EmployeeNumber | string |
Número de Empleado |
|
Classification
|
value.Classification | string |
Classification |
|
AttachmentDescription
|
value.AttachmentDescription | string |
AttachmentDescription |
|
AttachmentName
|
value.AttachmentName | string |
AttachmentName |
|
AttachmentUrl
|
value.AttachmentUrl | string |
AttachmentUrl |
|
Archivo adjunto
|
value.Attachment | string |
Archivo adjunto |
|
CustomFields
|
value.CustomFields | array of object |
CustomFields |
|
Código
|
value.CustomFields.Code | string |
Código |
|
Etiqueta
|
value.CustomFields.Label | string |
Etiqueta |
|
Importancia
|
value.CustomFields.Value | string |
Importancia |
Obtener una colección de registros de detalles bancarios
Recupera una lista de detalles bancarios de empleados en función del company_id especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Opcional por {{$bank-detail-field}}
|
$orderby | True | string |
(string): especifica el orden en el que se devuelven los elementos. |
|
$top opcional
|
$top | string |
(integer($int 32)): limita el número de elementos devueltos desde una colección. |
|
|
$skip opcional
|
$skip | True | string |
(integer($int 32)): excluye el número especificado de elementos de la colección consultada del resultado. |
|
$count opcional
|
$count | True | string |
(true/false): recuento total devuelto en respuesta |
|
$filter opcional
|
$filter | string |
Filtre por campo, por ejemplo, "EmployeeNumber eq 'Emp01'" |
|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} El identificador de la compañía |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor del token de portador (sin la palabra clave Bearer) |
|
Variable de entorno
|
CustomEnvironmentHeader | True | string |
Variable que es api (para PROD) o apistaging (para STAGING) |
Devoluciones
| Nombre | Ruta de acceso | 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 de Empleado
|
value.EmployeeNumber | string |
Número de Empleado |
|
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 |
|
Referencia
|
value.Reference | string |
Referencia |
|
IsMainAccount
|
value.IsMainAccount | boolean |
IsMainAccount |
|
Importe
|
value.Amount | integer |
Importe |
|
Comentarios
|
value.Comments | string |
Comentarios |
|
SwiftCode
|
value.SwiftCode | string |
SwiftCode |
|
RoutingCode
|
value.RoutingCode | string |
RoutingCode |
|
ComponentId
|
value.ComponentId | integer |
ComponentId |
Obtener una colección de todos los estados de empleo
Recupera una lista de todos los estados de empleo de los empleados en función del identificador de empresa especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
{{$employee-field}}
|
$orderby | string |
Opcional (cadena): especifica el orden en el que se devuelven los elementos. |
|
|
$top opcional
|
$top | integer |
(integer($int 32)): limita el número de elementos devueltos desde una colección. |
|
|
$skip opcional
|
$skip | True | integer |
(integer($int 32)): excluye el número especificado de elementos de la colección consultada del resultado. |
|
$count opcional
|
$count | True | string |
(true/false): recuento total devuelto en respuesta |
|
$filter opcional
|
$filter | string |
Filtre por campo, por ejemplo, "EmployeeNumber eq 'Emp01'" |
|
|
{{company-id}}
|
company-id | True | integer |
{{company-id}} El identificador de la compañía |
|
Token de portador
|
CustomAuthHeader | True | string |
Valor del token de portador (sin la palabra clave Bearer) |
|
Variable de entorno
|
CustomEnvironmentHeader | True | string |
Variable que es api (para PROD) o apistaging (para STAGING) |
Devoluciones
| Nombre | Ruta de acceso | 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 de Empleado
|
value.EmployeeNumber | string |
Número de Empleado |
|
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úmeroID
|
value.IdNumber | string |
NúmeroID |
|
PassportNumber
|
value.PassportNumber | string |
PassportNumber |
|
PercentageAmount
|
value.PercentageAmount | string |
PercentageAmount |
|
Importe
|
value.Amount | integer |
Importe |
|
Porcentaje
|
value.Percentage | integer |
Porcentaje |
|
Se consideraMonthlyRemuneration
|
value.DeemedMonthlyRemuneration | integer |
Se consideraMonthlyRemuneration |
|
Considerado75Indicator
|
value.Deemed75Indicator | boolean |
Considerado75Indicator |
|
DeemedRecoveryMonthly
|
value.DeemedRecoveryMonthly | boolean |
DeemedRecoveryMonthly |
|
EncashLeave
|
value.EncashLeave | boolean |
EncashLeave |
|
Irp30
|
value.Irp30 | boolean |
Irp30 |
|
FinalizeIssueTaxCert
|
value.FinalizeIssueTaxCert | boolean |
FinalizeIssueTaxCert |
|
PassportCountry
|
value.PassportCountry | boolean |
PassportCountry |
|
PassportIssued
|
value.PassportIssued | string |
PassportIssued |
|
PassportExpiry
|
value.PassportExpiry | string |
PassportExpiry |
|
PermitIssued
|
value.PermitIssued | string |
PermitIssued |
|
PermitExpiry
|
value.PermitExpiry | string |
PermitExpiry |
|
AdditionalDate
|
value.AdditionalDate | string |
AdditionalDate |
|
EmploymentCaptureDate
|
value.EmploymentCaptureDate | string |
EmploymentCaptureDate |
|
TerminationCaptureDate
|
value.TerminationCaptureDate | string |
TerminationCaptureDate |
|
TempWorker
|
value.TempWorker | boolean |
TempWorker |
|
AdditionalDate1
|
value.AdditionalDate1 | string |
AdditionalDate1 |
|
NotReEmployable
|
value.NotReEmployable | boolean |
NotReEmployable |
|
ReferenceNumber
|
value.ReferenceNumber | string |
ReferenceNumber |
|
OldEmployeeId
|
value.OldEmployeeId | integer |
OldEmployeeId |
|
CustomFields
|
value.CustomFields | array of object |
CustomFields |
|
Código
|
value.CustomFields.Code | string |
Código |
|
Etiqueta
|
value.CustomFields.Label | string |
Etiqueta |
|
Importancia
|
value.CustomFields.Value | string |
Importancia |
Definiciones
objeto
Este es el tipo 'object'.