WorkBook

Deltek WorkBook puts your projects and people at the center of your business so that you have the visibility to deliver successful projects.

With WorkBook, you get the actionable insight you need to proactively manage your projects and improve client satisfaction with a project-based solution designed for your firm. WorkBook helps you increase project profitability, improve utilization rates, and streamline back-office accounting processes.

Connector Overview

The Deltek WorkBook connector empowers you to build automation around WorkBook to help you support and integrate project management with accounting functions from within one system, by enabling connections with other Deltek products or third-party applications.

API Version

The Deltek WorkBook connector uses WorkBook API. It requires WorkBook version 13.3 or later.

Connection

An app connection or connection authorizes the Deltek WorkBook connector to interact with the WorkBook application.

Connection Name

Provide a name for the connection.

Note: The option to change the name from the default My Deltek WorkBook account is only available if you are using the upgraded platform and create new connections outside of a productized integration.

Parameters

This connector requires the following parameters:

Parameter	Description
API Key (Bearer Token)	Authorization Bearer Token provided by WorkBook.
WorkBook Domain	Host or domain name of your Deltek WorkBook application instance. For example: demo.workbook.net

Parameter

Description

API Key (Bearer Token)

Authorization Bearer Token provided by WorkBook.

WorkBook Domain

Host or domain name of your Deltek WorkBook application instance.

For example: demo.workbook.net

Authentication

Authentication requires the Deltek WorkBook connector to prove that it has the correct identity before its connection authorizes or allows you to do certain actions.

This connector supports the following authentication method.

Authentication Method	Description
API Key (Bearer Token)	Authorization Bearer Token provided by WorkBook. This value can be generated by navigating to the API key setup tab in Settings > Advanced Tools > User access rights of your WorkBook application instance.

Authentication Method

Description

API Key (Bearer Token)

Authorization Bearer Token provided by WorkBook.

This value can be generated by navigating to the API key setup tab in Settings > Advanced Tools > User access rights of your WorkBook application instance.

Triggers

Triggers check for certain events to occur and can group these events for further processing.

Note: Deltek recommends that you always use real time-triggers over polling triggers to have quicker responses and lesser load on your application instances. For real-time triggers, the Aggregate Events setting for WorkBook is now always on to reduce the number of event notifications sent during record edits.

This connector provides the following triggers.

Trigger	Description
Employees	Triggers when an Employee is Inserted, Updated or Deleted in WorkBook.
Clients	Triggers when a Client is Inserted, Updated or Deleted in WorkBook.
Suppliers	Triggers when a Supplier is Inserted, Updated or Deleted in WorkBook.
Creditors	Triggers when a Creditor is Inserted, Updated or Deleted in WorkBook.
Debtors	Triggers when a Debtor is Inserted, Updated or Deleted in WorkBook.
Projects	Triggers when a Project is Inserted, Updated or Deleted in WorkBook.
Jobs	Triggers when a Job is Inserted, Updated or Deleted in WorkBook.
Tasks	Triggers when a Task is Inserted, Updated or Deleted in WorkBook.
Activities	Triggers when an Activity or Activity List is Updated in WorkBook.
Purchase Orders	Triggers when a Purchase Order is Updated in WorkBook.
Sales Invoices	Triggers when a Sales Invoice, Invoice Line, or Invoice Phrase is Updated in WorkBook.
Creditor Invoices	Triggers when a Vendor Invoice Notification or Vendor Invoice Detail Notification is Updated in WorkBook.
Time Entries	Triggers when a Time Entry is Updated in WorkBook.
Job Price	Triggers when a Job Price is Updated in WorkBook.
Finance Posting	Triggers when a Finance Posting is Inserted, Updated or Deleted in WorkBook.
Mileage	Triggers when a Mileage Record is created, updated, or deleted in WorkBook.
Currency	Triggers when a Currency Record is created, updated, or deleted in WorkBook.
WIP Adjustments	Triggers when a WIP Adjustment is created, updated, or deleted in WorkBook.
Contact	Triggers when a Contact is Inserted, Updated or Deleted in WorkBook.
Prospect	Triggers when a Prospect is Inserted, Updated or Deleted in WorkBook.
Job Created/Updated	Triggers when a Job is Inserted, Updated or Deleted in WorkBook.
Employee	Triggers when an Employee is Inserted, Updated or Deleted in WorkBook.
Opportunity (Pipeline)	Triggers when an Opportunity is Inserted, Updated or Deleted in WorkBook.
Price list (Rate card) Upserted	Triggers when a price list is created or updated in WorkBook.

Actions

When a trigger event occurs, you can specify at least one action (or step) to execute through the WorkBook connector.

This connector provides the following actions. The field list with descriptions for each can be seen while building recipe.

Action	Description
Create Client (Customer) in WorkBook	This action creates Clients in WorkBook.
Get Client (Customer) by Id from WorkBook	This action retrieves Clients from WorkBook.
Search for Client (Customer) in WorkBook	This action searches Clients in WorkBook.
Update Client (Customer) in WorkBook	This action updates existing Clients in WorkBook.
Create Creditor in WorkBook	This action creates Creditors in WorkBook.
Get Creditor from WorkBook	This action retrieves Creditors from WorkBook.
Search Creditor in WorkBook	This action searches Creditors in WorkBook.
Update Creditor in WorkBook	This action updates existing Creditors in WorkBook.
Create Debtor in WorkBook	This action creates Debtors in WorkBook.
Get Debtor from WorkBook	This action retrieves Debtors from WorkBook.
Search Debtor in WorkBook	This action searches Debtors in WorkBook.
Update Debtor in WorkBook	This action updates existing Debtors in WorkBook.
Create Employee in WorkBook	This action creates Employees in WorkBook.
Get Employee from WorkBook	This action retrieves Employees from WorkBook.
Search Employee in WorkBook	This action searches Employees in WorkBook.
Update Employee in WorkBook	This action updates existing Employees in WorkBook.
Create Jobs in WorkBook	This action creates Jobs in WorkBook.
Get Jobs from WorkBook	This action retrieves Jobs from WorkBook.
Search Jobs in WorkBook	This action searches Jobs in WorkBook.
Update Jobs in WorkBook	This action updates existing Jobs in WorkBook.
Create Projects in WorkBook	This action creates Projects in WorkBook.
Get Projects from WorkBook	This action retrieves Projects from WorkBook.
Search Projects in WorkBook	This action searches Projects in WorkBook.
Update Projects in WorkBook	This action updates existing Projects in WorkBook.
Create Supplier in WorkBook	This action creates Suppliers in WorkBook.
Get Supplier from WorkBook	This action retrieves Suppliers from WorkBook.
Search Supplier in WorkBook	This action searches Suppliers in WorkBook.
Update Supplier in WorkBook	This action updates existing Suppliers in WorkBook.
Create Tasks in WorkBook	This action creates Tasks in WorkBook.
Get Tasks from WorkBook	This action retrieves Tasks from WorkBook.
Search Tasks in WorkBook	This action searches Tasks in WorkBook.
Update Tasks in WorkBook	This action updates existing Tasks in WorkBook.
Create Activity in WorkBook	This action creates Activity records in WorkBook.
Get Activity from WorkBook	This action retrieves a single Activity record from WorkBook.
Search Activity in WorkBook	This action searches Activity records in WorkBook.
Update Activity in WorkBook	This action updates existing Activity records in WorkBook.
Create Job Price in WorkBook	This action creates Job Price quotes records in WorkBook.
Get Job Price from WorkBook	This action retrieves a single Job Price quotes record from WorkBook.
Search Job Price in WorkBook	This action searches Job Price quotes records in WorkBook.
Update Job Price in WorkBook	This action updates existing Job Price quotes records in WorkBook.
Create Purchase Orders in WorkBook	This action creates Purchase Orders in WorkBook.
Get Purchase Orders from WorkBook	This action retrieves a single Purchase Order from WorkBook.
Search Purchase Orders in WorkBook	This action searches Purchase Orders in WorkBook.
Update Purchase Orders in WorkBook	This action updates existing Purchase Orders in WorkBook.
Create Creditor Invoices in WorkBook	This action creates Creditor Invoices in WorkBook.
Get Creditor Invoices from WorkBook	This action retrieves a single Creditor Invoice from WorkBook.
Search Creditor Invoices in WorkBook	This action searches Creditor Invoices in WorkBook.
Update Creditor Invoices in WorkBook	This action updates existing Creditor Invoices in WorkBook.
Create Sales Invoices in WorkBook	This action creates Sales Invoices (including status) in WorkBook.
Get Sales Invoices from WorkBook	This action retrieves Sales Invoices (including payment and status) from WorkBook.
Search Sales Invoices in WorkBook	This action searches Sales Invoices in WorkBook.
Update Sales Invoices in WorkBook	This action updates existing Sales Invoices (including status) in WorkBook.
Create Time Entry in WorkBook	This action creates Time Entry records in WorkBook.
Get Time Entry from WorkBook	This action retrieves a single Time Entry record from WorkBook.
Search Time Entry in WorkBook	This action searches Time Entry records in WorkBook.
Update Time Entry in WorkBook	This action updates existing Time Entry records in WorkBook.
Create Expenses in WorkBook	This action creates Expense records in WorkBook.
Get Expenses from WorkBook	This action retrieves a single Expense record from WorkBook.
Search Expenses in WorkBook	This action searches Expense records in WorkBook.
Update Expenses in WorkBook	This action updates existing Expense records in WorkBook.
Create Pricelist in WorkBook	This action creates Pricelist records in WorkBook.
Get Pricelist from WorkBook	This action retrieves a single Pricelist record from WorkBook.
Search Pricelist in WorkBook	This action searches Pricelist records in WorkBook.
Update Pricelist in WorkBook	This action updates existing Pricelist records in WorkBook.
Create Finance Posting in WorkBook	This action creates Finance Posting records in WorkBook.
Get Finance Posting from WorkBook	This action retrieves a single Finance Posting record from WorkBook.
Search Finance Posting in WorkBook	This action searches Finance Posting records in WorkBook.
Update Finance Posting in WorkBook	This action updates existing Finance Posting records in WorkBook.
Get Company from WorkBook	This action retrieves a single Company record from WorkBook.
Search Company in WorkBook	This action searches Company records in WorkBook.
Update Company in WorkBook	This action updates existing Company records in WorkBook.
Get Job Schedule from WorkBook	This action retrieves a single Job Schedule record from WorkBook.
Search Job Schedule in WorkBook	This action searches Job Schedule records in WorkBook.
Create Job Schedule in WorkBook	This action creates Job Schedule records in WorkBook.
Update Job Schedule in WorkBook	This action updates existing Job Schedule records in WorkBook.
Get Mileage from WorkBook	This action retrieves a single Mileage record from WorkBook.
Search Mileage in WorkBook	This action searches Mileage records in WorkBook.
Create Mileage in WorkBook	This action creates Mileage records in WorkBook.
Update Mileage in WorkBook	This action updates existing Mileage records in WorkBook.
Get Currency from WorkBook	This action retrieves a single Currency record from WorkBook.
Search Currency in WorkBook	This action searches Currency records in WorkBook.
Create Currency in WorkBook	This action creates Currency records in WorkBook.
Update Currency in WorkBook	This action updates existing Currency records in WorkBook.
Get Material by Id from WorkBook	This action retrieves a single Material record from WorkBook.
Search for Materials in WorkBook	This action searches Material records in WorkBook.
Create new Material in WorkBook	This action creates Material records in WorkBook.
Update a Material in WorkBook	This action updates existing Material records in WorkBook.
Get Prospect by Id from WorkBook	This action retrieves a single Prospect record from WorkBook.
Search for Prospects in WorkBook	This action searches Prospect records in WorkBook.
Create new Prospect in WorkBook	This action creates Prospect records in WorkBook.
Update a Prospect in WorkBook	This action updates Prospect Material records in WorkBook.
Get Price List Details from WorkBook	This action retrieves a single Price List Detail record from WorkBook.
Search for Contacts in WorkBook	This action searches Contacts in WorkBook.
Create new Contact in WorkBook	This action creates Contacts in WorkBook.
Update a Contact in WorkBook	This action updates Contacts in WorkBook.
Get Contact by Id or Contacts by ResourceID from WorkBook	This action retrieves Contacts from WorkBook.
Get Opportunity by Id from WorkBook	This action retrieves Opportunities from WorkBook.
Get Opportunity activity by Id from WorkBook	This action retrieves Opportunity activities from WorkBook.
Search for Opportunities in WorkBook	This action searches Opportunities in WorkBook.
Create new Opportunity in WorkBook	This action creates Opportunities records in WorkBook.
Update a Opportunity in WorkBook	This action updates Opportunities in WorkBook.
Search for Absence Requests in WorkBook	This action searches Absence Requests in WorkBook.
Create new Absence Request in WorkBook	This action creates Absence Requests in WorkBook.
List all Absence Entries in WorkBook	This action lists Absence Requests in WorkBook.
Search for Absence Entries in WorkBook	This action searches Absence Entries in WorkBook.
Approve Absence Requests in WorkBook	This action approves Absence Requests in WorkBook.
Get Absence Codes in WorkBook	This action retrieves Absence Codes from WorkBook.
Add lines to existing Purchase Order in WorkBook	This action updates Purchase Orders in WorkBook.
Add lines to existing Creditor Invoice in WorkBook	This action adds detail lines to existing Creditor Invoices in WorkBook.
Add one of more new phases to an existing Job Price in WorkBook	This action adds phases to existing Job Prices in WorkBook.
Add one of more new lines to an existing Job Price in WorkBook	This action adds detail lines to existing Job Prices in WorkBook.

Custom Actions

This connector also provides custom actions. These custom actions allow you to create and implement actions you need that were not available in the connector.

Note: It is recommended to use the available actions as much as possible.

For more information about actions and custom actions, refer to the WorkBook API documentation.

Deltek Unionpoint Help