Share via

Sirva Relocating Employee (Preview)

Connect to Sirva Relocation's employee portal platform to retrieve information about your past and present relocations. This connector requires an active account with Sirva Relocation for our employee portal (https://ee.sirva.com).

This connector grants access to move information and allows you to fetch contact information and availability of your personal counselor. You may also fetch your benefit package and related allowances for review and ask questions about your policy.

This connector is available in the following products and regions:

Service Class Regions
Copilot Studio Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Sirva Relocation Support
URL https://support.sirva.com
Email sirvacsc@sirva.com
Connector Metadata
Publisher Sirva Relocation
Website https://www.sirva.com
Privacy policy https://www.sirva.com/support/privacy-policy
Categories Productivity

Sirva Relocating Employee Connector

Sirva Connect+ Transferee provides a connector that allows you to fetch information about your current, past, and present moves with Sirva.

Prerequisites

You will need the following to proceed:

  • An active account with Sirva Relocation

If you have access to the platform, you will receive an email with login credentials from Sirva.

Publisher: Sirva Relocation

Supported Operations

The connector supports the following operations:

  • Get Relocations: Lists relocations you have access to
  • Get Relocation Package: Retrieves a benefit package for a specific relocation
  • Get Counselor Contact Information: Retrieves counselor contact information for a relocation, including URLs to book meetings
  • Ask the Sirva bot a question about a topic: Asks the Sirva bot a question about your move

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Ask the Sirva bot a question about a topic

Sends question text to the Sirva answer bot about the selected topic and returns with a response
Get Counselor Contact Information

Gets the counselor assigned to a specific move and their contact information.
Retreive the benefit package associated with a move

Retrieve the benefit package associate with a specific relocation, including potential allowances
Retrieve a list of moves associated with the logged in user

Retrieve a list of moves associated with the logged in user, including past and present moves.

Ask the Sirva bot a question about a topic

Operation ID:
AskSirvaBotAboutTopic

Sends question text to the Sirva answer bot about the selected topic and returns with a response

Parameters

Name Key Required Type Description
RelocationId
 RelocationId True string

The unique identifier of the move.
Question to ask the bot
 Query True string

Question to ask the bot
The topic the question is about
 Topic True string

The topic the question is about

Returns

Name Path Type Description
answer
 answer string

The answer to the posed question.

Get Counselor Contact Information

Operation ID:
GetCounselorContactInformation

Gets the counselor assigned to a specific move and their contact information.

Parameters

Name Key Required Type Description
Indicates if the counselor picture should be retrieved
 IncludePicture True boolean

Indicates if the picture should be fetched and included in the response
The unique identifier of the move
 RelocationId True string

The unique identifier of the move to return the counselor for

Returns

Name Path Type Description
name
 name string

The name of the counselor.
initials
 initials string

The initials of the counselor.
email
 email string

The email address of the counselor.
phone
 phone string

The phone number of the counselor.
availability
 availability string

The availability of the counselor.
image
 image string

A base64 JPEG of the counselor. Not included if include picture is set to false.
bookingUrl
 bookingUrl string

A URL to Microsoft Booking that can be used to schedule a call with the counselor.
userTime
 userTime string

The time in the timezone that the counselor is in with offset information.
contUID
 contUID integer

The core system identifier for the counselor.
outOfOffice
 outOfOffice boolean

Indicates if the counselor is out of office.
outOfOfficeMessage
 outOfOfficeMessage string

The out of office message if set.
startTime
 startTime string

The time the counselor starts their work day.
endTime
 endTime string

The time the counselor ends their work day.

Retreive the benefit package associated with a move

Operation ID:
GetRelocationPackage

Retrieve the benefit package associate with a specific relocation, including potential allowances

Parameters

Name Key Required Type Description
The unique identifer of the relocation
 RelocationId True string

The unique identifier of the move to pull the package for

Returns

Name Path Type Description
isStarted
 isStarted boolean

Indicates if the package has been started to be prepared.
isComplete
 isComplete boolean

Indicates if the package has been completed.
isAccepted
 isAccepted boolean

Indicates if the package has been accepted.
readyForNeedsAnalysis
 readyForNeedsAnalysis boolean

Indicates if the package is ready for the needs analysis task to be issued.
allowances
 allowances array of object

An array of available and selected allowances that the relocating employee is eligible for.
uuid
 allowances.uuid string

The unique identifier of the allowance.
name
 allowances.name string

Information about what the allowance is for.
amountIdentifiedAtConsultation
 allowances.amountIdentifiedAtConsultation boolean

Indicates if the amount of the allowance is identified by the cousnselor during the initial benefit call.
allowances.amount float

The amount of the allowance if identified.
currency
 allowances.currency string

The ISO code of the currency that the allowance is to be paid in.
currencyId
 allowances.currencyId string

The internal ID of the currency.
categoryType
 allowances.categoryType string

The category the allowance is associated with.
categoryTypeId
 allowances.categoryTypeId string

The internal identifier of the category.
occurrenceType
 allowances.occurrenceType string

The frequency the allowance is paid on.
occurrenceTypeId
 allowances.occurrenceTypeId string

The internal identifier for the frequency.
paidByType
 allowances.paidByType string

The organization paying the allowance to the relocating employee.
paidByTypeId
 allowances.paidByTypeId string

The internal identifier for the paid by type.
isSelected
 allowances.isSelected boolean

Indicates if the allowance has been included in the benefit package.
userId
 allowances.paymentRequest.requestedBy.userId string

The user id associated with the payment request.
email
 allowances.paymentRequest.requestedBy.email string

The email address of the user requesting payment.
first
 allowances.paymentRequest.requestedBy.first string

The first name of the user requesting payment.
last
 allowances.paymentRequest.requestedBy.last string

The last name of the user requesting payment.
requestedDate
 allowances.paymentRequest.requestedDate string

The date requested to pay the allowance by.
remittanceMethod
 allowances.paymentRequest.remittanceMethod string

The remittance method for paying the allowance.
remittanceAccount
 allowances.paymentRequest.remittanceAccount string

The bank account for the payment to be made to.
services
 services array of object

A list of services with benefits and components that are available to the relocating employee.
isInPackage
 services.isInPackage boolean

Indicates if the service is included in the package. If a service is not included, a user may request it but it may not be covered by the organization providing the move.
uuid
 services.uuid string

The unique identifier of the service.
name
 services.name string

The name of the service.
categoryType
 services.categoryType string

The category the service falls under.
categoryTypeId
 services.categoryTypeId string

The unique identifier of the category type.
shortDescription
 services.shortDescription string

A short description of the benefits provided by the service.
longDescription
 services.longDescription string

A longer, more detailed description of the benefits provided by the service.
providerType
 services.providerType string

The provider of the service.
providerTypeId
 services.providerTypeId string

The unique identifier of the provider.
core
 services.core boolean

Indicates if this service is considered core, or not optional.
cashOutOption
 services.cashOutOption boolean

Indicates if the service supports exchanging the benefit for a cash amount.
cashOutPercentage
 services.cashOutPercentage integer

Defines the percentage of the estimated value of the service that is received if cashed out.
outOfPocket
 services.outOfPocket boolean

Indicates if the service is being paid for out of pocket by the relocating employee.
sequence
 services.sequence integer

A sorting sequence that puts the services in a more logical order based on when they start.
iconUrl
 services.iconUrl string

A URL to the Sirva CDN for an icon that represents the service.
isIncluded
 services.isIncluded boolean

Indicates if the service is currently included in the package.
masterServiceId
 services.masterServiceId string

A roll up identifier that ties variations of services together under a single parent.
isTravelService
 services.isTravelService boolean

Indicates if this is a travel service.
useRemittance
 services.useRemittance boolean

Indicates if the default remittance account should be used.
cashOutAmount
 services.cashOutAmount float

Defines a flat value for the service if the percentage is not defined.
benefits
 services.benefits array of object

A list of benefits associated with this service.
uuid
 services.benefits.uuid string

The unique identifier of the benefit.
name
 services.benefits.name string

The name of the benefit.
outOfPocket
 services.benefits.outOfPocket boolean

If the benefit is being paid for out of pocket by the relocating employee.
cashoutOption
 services.benefits.cashoutOption boolean

If the benefit supports a cash out option.
cashoutPercentage
 services.benefits.cashoutPercentage integer

Defines the percentage of the estimated value of the benefit that is received if cashed out.
cashoutAmount
 services.benefits.cashoutAmount float

Defines a flat cashout amount for the benefit if a percentage is not available.
isIncluded
 services.benefits.isIncluded boolean

Defines if the benefit is included in the package.
amountOptions
 services.benefits.amountOptions array of object

A list of different costing options for the benefit with different configurations and values.
uuid
 services.benefits.amountOptions.uuid string

The unique identifier of the costing option for the benefit.
unitType
 services.benefits.amountOptions.unitType string

The unit of measure.
unitTypeId
 services.benefits.amountOptions.unitTypeId string

The unique identifier for the unit of measure.
condition
 services.benefits.amountOptions.condition string

Defines any conditions on the how this option is used.
conditionId
 services.benefits.amountOptions.conditionId string

The unique identifier of the condition.
quantity
 services.benefits.amountOptions.quantity float

The total amount granted by the option.
cost
 services.benefits.amountOptions.cost float

The cost of this option.
actualCashOut
 services.benefits.amountOptions.actualCashOut float

The actual cash out value of this option.
recommended
 services.benefits.amountOptions.recommended boolean

Indicates this particular option is recommended by Sirva.
isSelected
 services.benefits.amountOptions.isSelected boolean

Indicates if this option is the selected option or not.
createdDate
 services.benefits.amountOptions.createdDate string

The create date of the option.
comment
 services.benefits.amountOptions.comment string

Additional comments about the option.
components
 services.benefits.components array of object

A list of components associated with this item.
uuid
 services.benefits.components.uuid string

The unique identifier of the component.
name
 services.benefits.components.name string

The name of the component.
componentType
 services.benefits.components.componentType string

The type of the component.
componentTypeId
 services.benefits.components.componentTypeId string

The unique identifier of the component.
options
 services.benefits.components.options array of object

Options associated with the component.
uuid
 services.benefits.components.options.uuid string

The unique identifier of the component.
value
 services.benefits.components.options.value string

An item associated with the component.
recommended
 services.benefits.components.options.recommended boolean

If the component is recommended by Sirva
sequence
 services.benefits.components.options.sequence integer

A sorting sequence for the components.
requestType
 services.serviceRequest.requestType string

The type of request.
requestedDate
 services.serviceRequest.requestedDate string

The date the request was made.
userId
 services.serviceRequest.requestedBy.userId string

The ID of the user making the request.
email
 services.serviceRequest.requestedBy.email string

The email address of the user making the request.
first
 services.serviceRequest.requestedBy.first string

The first name of the user making the request.
last
 services.serviceRequest.requestedBy.last string

The last neame of the user making the request.
servicesAvailable
 servicesAvailable array of

A list of available services.
uuid
 policy.uuid string

The unique identifier of the policy.
name
 policy.name string

The name associated with the policy.
client
 policy.client string

The client associated with the policy.
clientId
 policy.clientId string

The unique identifier of the client associated with the policy.
currency
 policy.currency string

The default currency of the policy.
currencyId
 policy.currencyId string

The identifier associated with the currency.
version
 policy.version integer

The version of the policy.
flexAmountCap
 policy.flexAmountCap integer

If defined, represents a logical cap on the amount of non-core services that can be included in the policy.
effectiveDate
 policy.effectiveDate string

The date this policy went into effect.
statusTypeId
 policy.statusTypeId string

The identifier associated with the status of the policy.
statusType
 policy.statusType string

The status of the policy.
policyTypeId
 policy.policyTypeId string

The identifier associated with the type of the policy.
policyType
 policy.policyType string

The type of the policy.
preDecision
 policy.preDecision boolean

If the policy is a pre-decision policy, used to make a determination if the move will be accepted.
completedDate
 status.completedDate string

The date the package was completed by Sirva.
userId
 status.completedBy.userId string

The user identifier of the person completing the package.
email
 status.completedBy.email string

The email address of the user completing the package.
first
 status.completedBy.first string

The first name of the person completing the package.
last
 status.completedBy.last string

The last name of the person completing the package.
userId
 status.modifiedBy.userId string

The user id of the last person to modify the package.
email
 status.modifiedBy.email string

The email address of the user that modified the package.
first
 status.modifiedBy.first string

The first name of the user that modified the package.
last
 status.modifiedBy.last string

The last name of the user that modified the package.
modifiedDate
 status.modifiedDate string

The date the package was last modified.
isReadyForESC
 isReadyForESC boolean

If the package is ready modification in self-service scenarios.
packageOwnerShip
 packageOwnerShip string

Defines who has permissions to modify the package.

Retrieve a list of moves associated with the logged in user

Operation ID:
GetRelocations

Retrieve a list of moves associated with the logged in user, including past and present moves.

Returns

Name Path Type Description
relocations
 relocations array of object

A list of relocations that the authenticated user has access to. Past and future moves are included if known.
relocationId
 relocations.relocationId string

The unique identifier of the move.
firstName
 relocations.firstName string

The first name of the logged in user.
lastName
 relocations.lastName string

The first name of the logged in user.
transfereeFirstName
 relocations.transfereeFirstName string

The first name of the person relocating.
transfereeLastName
 relocations.transfereeLastName string

The last name of the person relocating.
userAccountId
 relocations.userAccountId string

The account ID of the logged in user.
departureCountry
 relocations.departureCountry string

The departure country for the relocation.
departureCountryCode
 relocations.departureCountryCode string

The ISO country code of the departure location of the relocation.
departureState
 relocations.departureState string

The state or provice of the departure location.
departureCity
 relocations.departureCity string

The city of the departure location.
destinationCountry
 relocations.destinationCountry string

The country being relocated to.
destinationCountryCode
 relocations.destinationCountryCode string

The ISO code of the country being relocated to.
destinationState
 relocations.destinationState string

The destination state being relocated to.
destinationCity
 relocations.destinationCity string

The destination work city being relocated to.
system
 relocations.system string

The origin system of this move.
delegate
 relocations.delegate boolean

Indicates if the user has delegated access to this relocation.
access
 relocations.access string

Indicates the level of access.
sourceSystemId
 relocations.sourceSystemId integer

The operating platform ID, useful for support.
estimatedStartDate
 relocations.estimatedStartDate string

The estimated start date of the relocation.
clientName
 relocations.clientName string

The name of the client associated with the relocation.
clientId
 relocations.clientId string

The ID of the client associated with the relocation.
email
 relocations.email string

The email associated with the relocation.
preferredLanguage
 relocations.preferredLanguage string

The preferred language of the person being relocated.
programName
 relocations.programName string

The program the relocation is under which defines benefits.
isExpenseReceiptUploadRequired
 relocations.isExpenseReceiptUploadRequired boolean

If receipt uploads are required for expense reports on this relocation.
isMyDocumentsAccessEnabled
 relocations.isMyDocumentsAccessEnabled boolean

If document access is allowed for this relocation.
status
 relocations.status string

The status of the relocation. ACTIVE, CANCEL, CLOSED, or ONHOLD.
estimatedEndDate
 relocations.estimatedEndDate string

The estimated end date of the relocation. If the relocation is permanent, this will not be set.
isGovernmentClient
 relocations.isGovernmentClient boolean

Indicates if the relocation is associated with a government entity.
displayName
 relocations.displayName string

A display value for the move combinding the destination and departure elements.
isDPSClient
 relocations.isDPSClient boolean

Indicates if the relocation is using the digital policy platform.
orgUid
 relocations.orgUid integer

The organization ID associated with this move. Useful for support.
isTransitionFile
 isTransitionFile boolean

Indicates if this file was already underway with another agency before being moved to Sirva.
isExpenseBudgetEnabled
 isExpenseBudgetEnabled boolean

Indicates if the relocation is subject to specific expense budgets.
preferredLanguage
 preferredLanguage string

The preferred language of the logged in user.