Deputy integration summary

Stitch’s Deputy integration replicates data using the Deputy API. Refer to the Schema section for a list of objects available for replication.

Deputy feature snapshot

A high-level look at Stitch's Deputy (v1) integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release status

Released on September 26, 2019

 Supported by

Singer Community
Stitch plan

Standard

 API availability

Available
Singer GitHub repository

singer-io/tap-deputy
REPLICATION SETTINGS
Anchor Scheduling

Supported

 Advanced Scheduling

Supported
Table-level reset

Unsupported

 Configurable Replication Methods

Unsupported
DATA SELECTION
Table selection

Supported

 Column selection

Supported
Select all

Supported
TRANSPARENCY
Extraction Logs

Supported

 Loading Reports

Supported

Connecting Deputy

Step 1: Add Deputy as a Stitch data source

  1. Sign into your Stitch account.

  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the Deputy icon.

  4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

    For example, the name “Stitch Deputy” would create a schema called stitch_deputy in the destination. Note: Schema names cannot be changed after you save the integration.

Step 2: Authorize Stitch to access Deputy

In this step, you’ll grant Stitch access to the Deputy organization you want to connect.

  1. When finished, click Authorize. You’ll be prompted to sign into your Deputy account if you aren’t already.
  2. After you log into Deputy, a screen with a list of your Deputy organizations will display. Select the organization you want to connect to Stitch and click Authorize.
  3. After the authorization process is successfully completed, you’ll be directed back to Stitch.
  4. Click All Done.

Step 3: Define the historical replication start date

The Sync Historical Data setting defines the starting date for your Deputy integration. This means that data equal to or newer than this date will be replicated to your data warehouse.

Change this setting if you want to replicate data beyond Deputy’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Step 4: Create a replication schedule

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Deputy integrations support the following replication scheduling methods:

To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Step 5: Set objects to replicate

The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.

Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.

For Deputy integrations, you can select:

  1. Individual tables and columns

  2. All tables and columns

Click the tabs to view instructions for each selection method.

  1. In the integration’s Tables to Replicate tab, locate a table you want to replicate.

  2. To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.

  3. To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.

  4. Repeat this process for all the tables and columns you want to replicate.
  5. When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
  1. Click into the integration from the Stitch Dashboard page.

  2. Click the Tables to Replicate tab.

  3. In the list of tables, click the box next to the Table Names column.

  4. In the menu that displays, click Track all Tables and Fields:

    The Track all Tables and Fields menu in the Tables to Replicate tab

  5. Click the Finalize Your Selections button at the bottom of the page to save your data selections.

Initial and historical replication jobs

After you finish setting up Deputy, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.

Deputy table reference

addresses

Replication Method :

Key-based Incremental

 Replication Key :

Modified
Primary Key :

Modified

 Official docs :

Official Docs

The addresses table contains info about addresses.

categories

Replication Method :

Key-based Incremental

 Replication Key :

Modified
Primary Key :

Modified

 Official docs :

Official Docs

The categories table contains info about categories.

comments

Replication Method :

Key-based Incremental

 Replication Key :

Modified
Primary Key :

Modified

 Official docs :

Official Docs

The comments table contains info about comments.

companies

Replication Method :

Key-based Incremental

 Replication Key :

Modified
Primary Key :

Modified

 Official docs :

Official Docs

The companies table contains info about companies.

companies table schema

Modified
INTEGER

The company ID.

Reference:

Modified
DATE-TIME

The time the company was last modified.

Portfolio
INTEGER

Code
STRING

Active
BOOLEAN

ParentCompany
INTEGER

Reference:

CompanyName
STRING

TradingName
STRING

BusinessNumber
STRING

CompanyNumber
STRING

IsWorkplace
BOOLEAN

IsPayrollEntity
BOOLEAN

PayrollExportCode
INTEGER

Address
INTEGER

Reference:

Contact
INTEGER

Reference:

Creator
INTEGER

Reference:

Created
DATE-TIME

company_periods

Replication Method :

Key-based Incremental

 Replication Key :

Modified
Primary Key :

Modified

 Official docs :

Official Docs

The company_periods table contains info about company periods.

contacts

Replication Method :

Key-based Incremental

 Replication Key :

Modified
Primary Key :

Modified

 Official docs :

Official Docs

The contacts table contains info about contacts.

contacts table schema

Modified
INTEGER

The contact ID.

Reference:

Modified
DATE-TIME

The time the contact was last modified.

Phone1
STRING

Phone2
STRING

Phone3
STRING

Fax
STRING

Phone1Type
STRING

Phone2Type
STRING

Phone3Type
STRING

PrimaryPhone
INTEGER

Email1
STRING

Email2
STRING

Email1Type
STRING

Email2Type
STRING

PrimaryEmail
INTEGER

Im1
STRING

Im2
STRING

Im1Type
STRING

Im2Type
STRING

Web
STRING

Notes
STRING

Saved
BOOLEAN

Creator
INTEGER

Reference:

Created
DATE-TIME

countries

Replication Method :

Key-based Incremental

 Replication Key :

Modified
Primary Key :

Modified

 Official docs :

Official Docs

The countries table contains info about countries.

custom_app_data

Replication Method :

Key-based Incremental

 Replication Key :

Modified
Primary Key :

Modified

 Official docs :

Official Docs

The custom_app_data table contains info about custom app data.

custom_fields

Replication Method :

Key-based Incremental

 Replication Key :

Modified
Primary Key :

Modified

 Official docs :

Official Docs

The custom_fields table contains info about

custom_field_data

Replication Method :

Key-based Incremental

 Replication Key :

Modified
Primary Key :

Modified

 Official docs :

Official Docs

The custom_field_data table contains info about custom field data.

employee_agreements

Replication Method :

Key-based Incremental

 Replication Key :

Modified
Primary Key :

Modified

 Official docs :

Official Docs

The employee_agreements table contains info about employee agreements.

employee_agreements table schema

Modified
INTEGER

The employee agreement ID.

Reference:

Modified
DATE-TIME

The time the employee agreement was last modified.

EmployeeId
INTEGER

Reference:

PayPoint
INTEGER

EmpType
INTEGER

CompanyName
STRING

Active
BOOLEAN

StartDate
DATE

Contract
INTEGER

Reference:

SalaryPayRule
INTEGER

Reference:

ContractFile
INTEGER

PayrollId
INTEGER

PayPeriod
INTEGER

Reference:

HistoryId
INTEGER

Reference:

Creator
INTEGER

Reference:

Created
DATE-TIME

employee_agreement_history

Replication Method :

Key-based Incremental

 Replication Key :

Modified
Primary Key :

Modified

 Official docs :

Official Docs

The employee_agreement_history table contains info about

employee_agreement_history table schema

Modified
INTEGER

The employee agreement history ID.

Reference:

Modified
DATE-TIME

The time the employee agreement history was last modified.

AgreementId
INTEGER

Reference:

PayPoint
INTEGER

EmpType
INTEGER

CompanyName
STRING

Active
BOOLEAN

StartDate
DATE

Contract
INTEGER

Reference:

SalaryPayRule
INTEGER

Reference:

ContractFile
INTEGER

PayrollId
INTEGER

PayPeriod
INTEGER

Reference:

Creator
INTEGER

Reference:

Created
DATE-TIME

employee_appraisal

Replication Method :

Key-based Incremental

 Replication Key :

Modified
Primary Key :

Modified

 Official docs :

Official Docs

The employee_appraisal table contains info about employee appraisals.

employee_availability

Replication Method :

Key-based Incremental

 Replication Key :

Modified
Primary Key :

Modified

 Official docs :

Official Docs

The employee_availability table contains info about employee availability.

employee_availability table schema

Modified
INTEGER

The employee availability ID.

Modified
DATE-TIME

The time the employee availability was last modified.

Employee
INTEGER

Reference:

Type
INTEGER

MaxDateRecurringGenerated
DATE

StartTime
INTEGER

EndTime
INTEGER

Date
DATE

Comment
INTEGER

Schedule
INTEGER

Reference:

Creator
INTEGER

Reference:

Created
DATE-TIME

employee_contracts

Replication Method :

Key-based Incremental

 Replication Key :

Modified
Primary Key :

Modified

 Official docs :

Official Docs

The employee_contracts table contains info about employee contracts.

employee_contracts table schema

employee_contract_leave_rules

Replication Method :

Key-based Incremental

 Replication Key :

Modified
Primary Key :

Modified

 Official docs :

Official Docs

The employee_contract_leave_rules table contains info about employment contract leave rules.

employee_contract_leave_rules table schema

Modified
INTEGER

The employment contract leave rule ID.

Modified
DATE-TIME

The time the employment contract leave rule was last modified.

ContractId
INTEGER

Reference:

LeaveRuleId
INTEGER

Reference:

LoadingPayRule1
INTEGER

Reference:

LoadingPayRule2
INTEGER

Reference:

LoadingPayRule3
INTEGER

Reference:

Creator
INTEGER

Reference:

Created
DATE-TIME

employee_history

Replication Method :

Key-based Incremental

 Replication Key :

Modified
Primary Key :

Modified

 Official docs :

Official Docs

The employee_history table contains info about employee histories.

employee_history table schema

Modified
INTEGER

The employee history ID.

Reference:

Modified
DATE-TIME

The time the employee history was last modified.

Company
INTEGER

Reference:

FirstName
STRING

LastName
STRING

DisplayName
STRING

OtherName
STRING

Salutation
STRING

MainAddress
STRING

Reference:

PostalAddress
STRING

Reference:

EmergencyAddress
STRING

Reference:

DateOfBirth
DATE

Gender
INTEGER

Photo
INTEGER

JobAppId
INTEGER

Active
BOOLEAN

StartDate
DATE

TerminationDate
DATE

Position
STRING

Role
INTEGER

Reference:

EmployeeId
INTEGER

Reference:

Creator
INTEGER

Reference:

Created
DATE-TIME

employee_paycycles

Replication Method :

Key-based Incremental

 Replication Key :

Modified
Primary Key :

Modified

 Official docs :

Official Docs

The employee_paycycles table contains info about employee paycycles.

employee_paycycles table schema

Modified
INTEGER

The employee paycycle ID.

Modified
DATE-TIME

The time the employee paycycle was last modified.

EmployeeId
INTEGER

Reference:

EmployeeAgreementId
INTEGER

Reference:

PeriodId
INTEGER

Reference:

RecommendedLoadings
BOOLEAN

Timesheets
INTEGER

TimesheetsTimeApproved
INTEGER

TimesheetsPayApproved
STRING

PaycycleRules
INTEGER

PaycycleRulesApproved
INTEGER

Exported
BOOLEAN

ExportId
INTEGER

Paid
BOOLEAN

TimeTotal
NUMBER

CostTotal
NUMBER

EmployeeAgreementHistoryId
INTEGER

Reference:

Creator
INTEGER

Reference:

Created
DATE-TIME

employee_paycycle_returns

Replication Method :

Key-based Incremental

 Replication Key :

Modified
Primary Key :

Modified

 Official docs :

Official Docs

The employee_paycycle_returns table contains info about employee paycycle returns.

employee_roles

Replication Method :

Key-based Incremental

 Replication Key :

Modified
Primary Key :

Modified

 Official docs :

Official Docs

The employee_roles table contains info about employee roles.

employee_salary_opunit_costing

Replication Method :

Key-based Incremental

 Replication Key :

Modified
Primary Key :

Modified

 Official docs :

Official Docs

The employee_salary_opunit_costing table contains info about employee salary operational unit costs.

employee_salary_opunit_costing table schema

Modified
INTEGER

The employee salary operational unit costing ID.

Modified
DATE-TIME

The time the employee salary operational unit costing was last modified.

Employee
INTEGER

Reference:

EmployeeAgreement
INTEGER

Reference:

AgreementHistory
INTEGER

Reference:

DayTimestamp
STRING

Date
DATE

OpUnit
INTEGER

Reference:

Cost
NUMBER

Final
BOOLEAN

Creator
INTEGER

Reference:

Created
DATE-TIME

employee_workplaces

Replication Method :

Key-based Incremental

 Replication Key :

Modified
Primary Key :

Modified

 Official docs :

Official Docs

The employee_workplaces table contains info about employee workplaces.

employee_workplaces table schema

Modified
INTEGER

The employee workplace ID.

Modified
DATE-TIME

The time the employee workplace was last modified.

EmployeeId
INTEGER

Reference:

Company
INTEGER

Reference:

SortOrder
INTEGER

Agreement1
INTEGER

Reference:

Agreement2
INTEGER

Reference:

Agreement3
INTEGER

Reference:

Creator
INTEGER

Reference:

Created
DATE-TIME

employment_conditions

Replication Method :

Key-based Incremental

 Replication Key :

Modified
Primary Key :

Modified

 Official docs :

Official Docs

The employment_conditions table contains info about employment conditions.

employment_conditions table schema

Modified
INTEGER

The employment condition ID.

Modified
DATE-TIME

The time the employment condition was last modified.

Name
STRING

Description
STRING

AwardLevel
STRING

EmploymentBasis
INTEGER

EmploymentCategory
INTEGER

Reference:

EmploymentPeriod
INTEGER

EmploymentStatus
INTEGER

ProbationaryPeriod
INTEGER

WorkingDaysPerPeriod
NUMBER

UsualStartTime
STRING

UsualFinishTime
STRING

UsualMealbreak
STRING

AvgHoursPerDay
NUMBER

MinHoursPerDay
NUMBER

MinHoursForLeave
NUMBER

Creator
INTEGER

Reference:

Created
DATE-TIME

events

Replication Method :

Key-based Incremental

 Replication Key :

Modified
Primary Key :

Modified

 Official docs :

Official Docs

The events table contains info about events.

geo

Replication Method :

Key-based Incremental

 Replication Key :

Modified
Primary Key :

Modified

 Official docs :

Official Docs

The geo table contains info about geographic locations.

geo table schema

Modified
INTEGER

The geo ID.

Modified
DATE-TIME

The time the geo was last modified.

Orm
STRING

RecId
INTEGER

Longitude
STRING

Latitude