Note: TBP Integrates directly with the TBP Desktop Application and TR 3E via the use of TR’s 3E Transaction Services.
Key Web Services/Connections
|
Topic |
Purpose |
Service Name |
Call |
|
Client List |
Allows users to search for clients |
GetDataFromArchetypes |
Archetype.Client |
|
Matter List |
Allow users to search for matters |
GetDataFromArchetypes |
Archetype.Matter |
|
PTA |
Pull of Phase Codes |
GetDataFromArchetypes |
Archetype.Phase |
|
PTA |
Pull of Task Codes |
GetDataFromArchetypes |
Archetype.Task |
|
PTA |
Pull of Activity Codes |
GetDataFromArchetypes |
Archetype.Activity |
|
PTA Groups |
Pull of PT Plan Codes |
GetDataFromArchetypes |
Archetype.PTAGroup |
|
Time Submission |
Push for Time Entry Create |
ESBTimeCardLoad |
TimeCardPending |
Authentication Method
|
Type |
Description |
|
Authentication |
User Name and Encrypted Password as required by 3E |
|
Authorization |
Rights defined in end service by 3E |
Inbound Integration
Data: Clients
- API Service: Archetype.Client
The clients call provides all information related to clients that need to be available in TBP to your timekeepers.
|
Column Name |
Data Type |
3E Mapping |
Description |
|
code |
string |
ClientID |
Required: The client code. |
|
id |
string |
ClientIndex |
Required: The client code identifier (sometimes set as externalId). |
|
displayName |
string |
DisplayName |
Required: The client name text that should display in TBP. |
Data: Matters
The matters call provides all information related to matters that need to be available in TBP to your timekeepers.
- API Service: Archetype.Matter
|
Column Name |
Data Type |
3E Mapping |
Description |
|
code |
string |
MatterID |
Required: The matter code that should display in TBP. |
|
displayName |
string |
DisplayName |
Required: The matter name text that should display in TBP. |
|
billingIncrement |
decimal |
TimeIncrement |
Required: The matter increment for billed time (ie. 0.1, 0.25). |
|
billingType |
string |
MattType |
Required: Matter type (ie. Billable, Non-Billable). |
|
currencyCode |
string |
Currency |
Optional: An optional string for currency type (ie. GBP). |
Data: Activity Codes
The activity code call provides all information related to activity codes that need to be available to be set in TBP by your timekeepers.
- API Service: Archetype.Activity
|
Column Name |
Data Type |
3E Mappings |
Description |
|
code |
string |
ActivityID |
Required: The Activity code that should display in TBP. |
|
description |
string |
Description |
Required: The description of the code. |
Data: Phase Codes
The phase code call provides all information related to phase codes that need to be available to be set in TBP by your timekeepers.
- API Service: Archetype.Phase
|
Column Name |
Data Type |
3E Mapping |
Description |
|
code |
string |
PhaseID |
Required: The Phase code that should display in TBP. |
|
description |
string |
Description |
Required: The description of the code. |
Data: Task Codes
The task code call provides all information related to task codes that need to be available to be set in TBP by your timekeepers.
- API Service: Archetype.Phase
|
Column Name |
Data Type |
3E Mapping |
Description |
|
code |
string |
TaskID |
Required: The Task code that should display in TBP. |
|
description |
string |
Description |
Required: The description of the code. |
Data: Phase and Task Plan Codes
The phase task plan call provides all information related to phase and task groups that need to be available to be set in TBP by your timekeepers.
- API Service: Archetype.PTAGroup
|
Column Name |
Data Type |
3E Mapping |
Description |
|
code |
string |
Code |
Required: The task or phase code that should display in TBP. |
|
description |
string |
Description |
Required: The description of the code. |
Outbound Integration
Time Release
As timekeepers use TBP to track and release their time, released time data will be processed via the web service call in real time.
Data: Time Create
The time entry created provides all information related to time from timekeepers using TBP.
- API Service: TimeCardPending
|
Column Name |
Data Type |
3E Mapping |
Description |
|
timeSource |
string |
LOADSOURCE |
Required: A text noting the source of the time entry (ex.: “TBP”). |
|
timekeeperId |
string |
TIMEKEEPER_NUMBER |
Required: Timekeeper identifier for which the time entry is assigned (ex.: 1234). |
|
workDate |
datetime |
WORK_DATE |
Required: The date that the work for the time entry was completed in ISO 8601 format. |
|
matterCode |
string |
MATTER_NUMBER |
Required: The identifier for the Matter assigned to time entry (ex.: 02728-0002). |
|
durationIncrements |
decimal |
WORK_HRS |
Required: The number of work increments assigned to time entry (ex.: 0.3 or 0.25). |
|
narrativeText |
string |
NARRATIVE |
Required: The narrative assigned to time entry in text format with encoding considered (ex.: “Correspondence with Cpt. Lucard regarding Space matter”). |
|
phaseCode |
string |
PHASE_CODE |
Not Required: The phase code assigned to time entry, in non-description format if possible (ex.: L400). |
|
taskCode |
string |
TASK_CODE |
Not Required: The task code assigned to time entry (ex.: A108). |
|
activityCode |
string |
ACTIVITY_CODE |
Not Required: The activity code assigned to time entry. |
|
timeType |
string |
TIMETYPE |
Required: The type of time being recorded (ex.: Hourly) |
|
locationCode |
string |
LOCATION_CODE |
Not Required: The location code assigned to time entry (ex.: NYC1). |
