Integration between TBP and Aderant Expert

Screen_Shot_2022-06-18_at_12.32.06_AM.png

Note: TBP Integrates directly with the TBP Desktop Application and Aderant Expert via the use of Aderant’s web services.

Key Web Services/Connectivity

Topic

Purpose

Service Name

Call

Client List

Allows users to search for clients

http://ADERANTROOT/FileOpening/FileOpeningWS/ClientService.asmx

ClientService.Read

Matter List

Allow users to search for matters

http://ADERANTROOT/FileOpening/FileOpeningWS/MatterService.asmx

MatterService.Read

Action Code List

Pull all Action Codes

http://ADERANTROOT/Time/TimeWS/ActionService.asmx

ActionService.Read

Location

Pull all Location Codes

http://ADERANTROOT/Time/TimeWS/LocationService.asmx

LocationService.Read

Activity

Pull all Activity Codes

http://ADERANTROOT/Time/TimeWS/ActivityService.asmx

ActivityService.Read

Phase and Task List

Pull on PT Plan Codes

Direct SQL

PhaseTaskSQL

Time Submission

Push for Time Entry Create

http://ADERANTROOT/Time/TimeWS/TimeEntryService.asmx

TimeEntryService.Create

Time Release

Push for Time Entry Release

http://ADERANTROOT/Time/TimeWS/TimeEntryService.asmx

TimeEntryService.Release

 

Authentication Method

Type

Description 

Authentication

User Name and Encrypted Password as required by Aderant

Authorization

Rights defined in end service by Aderant

 

Inbound Integration

Data: Clients

API Service: ClientService.Read

The clients call provides all information related to clients that need to be available in TBP to your timekeepers.

Column Name

Data Type

Aderant Mapping

Description 

code

string

HBM_CLIENT.CLIENT_CODE

Required: The client code. 

id

string

HBM_CLIENT.CLIENT_UNO

Required: The client code identifier (sometimes set as externalId).

displayName

string

HBM_CLIENT.CLIENT_NAME

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: MatterService.Read

Column Name

Data Type

Aderant Mapping

Description 

code

string

TBM_MATTER.MATTER_CODE

Required: The matter code that should display in TBP.

displayName

string

HBM_MATTER.MATTER_NAME

Required: The matter name text that should display in TBP.

billingIncrement

decimal

TBM_MATTER.TIME_INC

Required: The matter increment for billed time (ie. 0.1, 0.25).

clientId

string

HBM_MATTER.CLIENT_CODE

Required: Client ID for the Matter.

billingType

string

TBM_MATTER.MATT_TYPE _CODE

Required: Please set to Billable, Nonbillable, Probono.

currencyCode

string

CURRENCY_CODE

Optional: An optional string for currency type (ie. GBP, USD).

 

Data: Action Codes

The action code call provides all information related to action codes that need to be available to be set in TBP by your timekeepers. 

  • API Service: ActionService.Read

Column Name

Data Type

Aderant Mappings

Description 

code

string

ACTION_CODE

Required: The Action code that should display in TBP.

description

string

ACTION_DESC

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 codes that need to be available to be set in TBP by your timekeepers. 

  • DirectSQL: PhaseTaskSQL

Column Name

Data Type

Aderant Mapping

Description 

code

string

PHTASK_CODE

Required: The task or phase code that should display in TBP. 

description

string

PHTASK_DESC

">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 with two options: 

  • Time created into Aderant for ongoing management 
  • Time created and released into Aderant in readiness for invoicing

Please work with your Customer Success Manager and Solutions Engineer to confirm the best option for your firm's billing workflow.

 

Data:  Time Create

The time entry create provides all information related to time from timekeepers using TBP. Each file is formatted as laid out below. 

  • API Service: TimeEntryService.Create

Column Name

Data Type

Aderant Mapping

Description 

uniqueEventId

string

TIME_UNO

Required: A 32 char UUID for each time entry to assist in IT administrative efforts

(ex.: 5dd8849f-ebc7-47f2-b400-28f4bbb8fc41 ).

transactionDate

datetime

POST_DATE

Required: The date that the time entry was generated (createdOn) in ISO 8601 format.

timeSource

string

SOURCE

Required: A text noting the source of the time entry (ex.: “PG”).

timekeeperId

string

TK_EMPL_UNO.EMPLOYEE_CODE

Required: Timekeeper identifier for which the time entry is assigned (ex.: 1234).

timekeeperSource

string

ENTRY_EMPL_UNO.EMPLOYEE_CODE

Required: Timekeeper identifier for the time entry releaser (ex.: 4321). Usually this value is the same as timekeeperId but may differ in situations where a timekeeper has delegated their timekeeping to another person.

workDate

datetime

TRAN_DATE

Required: The date that the work for the time entry was completed in ISO 8601 format.

clientCode

string

CLIENT_CODE

Required: The identifier for the Client assigned to time entry (ex.: 13200).

matterCode

string

CLNT_MATT_CODE

Required: The identifier for the Matter assigned to time entry (ex.: 02728-0002).

durationIncrements

decimal

TIME_INC

Required: The number of work increments assigned to time entry (ex.: 0.3 or 0.25).

narrativeText

string

NAR_TEXT_ID

Required: The narrative assigned to time entry in text format with encoding considered

(ex.: “Correspondence with Cpt. Lucard regarding Space matter”).

phasetaskCode

string

PHTASK_UNO.PHTASK_CODE

Optional: The phase code assigned to time entry, in non-description format if possible (ex.: L400).

actionCode

string

ACTION_CODE

Not Required: The action code assigned to time entry (ex.: A108).

activityCode

string

ACTIVITY_CODE

Not Required: The activity code assigned to time entry (ex.: EMAIL).

currencyCode

string

CURRENY_CODE

Not Required: The currency code assigned to time entry (ex.: GBP).

locationCode

string

LOCATION_CODE

Not Required: The location code assigned to time entry (ex.: NYC1).

 

Data:   Time Release

The time entry release provides all information related to time from timekeepers using TBP that is ready for final release.

  • API Service: TimeEntryService.Release

Column Name

Data Type

Aderant Mappings

Description 

uniqueEventId

string

TIME_UNO

Required: A 32 char UUID for each time entry to assist in IT administrative efforts

(ex.: 5dd8849f-ebc7-47f2-b400-28f4bbb8fc41 ).

transactionDate

datetime

POST_DATE

Required: The date that the time entry was generated (createdOn) in ISO 8601 format.

timeSource

string

SOURCE

Required: A text noting the source of the time entry (ex.: “TBP”).

timekeeperId

string

TK_EMPL_UNO.EMPLOYEE_CODE

Required: Timekeeper identifier for which the time entry is assigned (ex.: 1234).

timekeeperSource

string

ENTRY_EMPL_UNO.EMPLOYEE_CODE

Required: Timekeeper identifier for the time entry releaser (ex.: 4321). Usually this value is the same as timekeeperId but may differ in situations where a timekeeper has delegated their timekeeping to another person.

workDate

datetime

TRAN_DATE

Required: The date that the work for the time entry was completed in ISO 8601 format.

clientCode

string

CLIENT_CODE

Required: The identifier for the Client assigned to time entry (ex.: 13200).

matterCode

string

CLNT_MATT_CODE

Required: The identifier for the Matter assigned to time entry (ex.: 02728-0002).

durationIncrements

decimal

TIME_INC

Required: The number of work increments assigned to time entry (ex.: 0.3 or 0.25).

narrativeText

string

NAR_TEXT_ID

Required: The narrative assigned to time entry in text format with encoding considered

(ex.: “Correspondence with Cpt. Lucard regarding Space matter”).

phasetaskCode

string

PHTASK_UNO.PHTASK_CODE

Not Required: The phase code assigned to time entry, in non-description format if possible (ex.: L400).

actionCode

string

ACTION_CODE

Not Required: The action code assigned to time entry (ex.: A108).

activityCode

string

ACTIVITY_CODE

Not Required: The activity code assigned to time entry (ex.: EMAIL).

currencyCode

string

CURRENY_CODE

Not Required: The currency code assigned to time entry (ex.:GBP).

locationCode

string

LOCATION_CODE

Not Required: The location code assigned to time entry (ex.: NYC1).

Articles in this section

Was this article helpful?
0 out of 0 found this helpful
  • Training

    An interactive tutorial to learn TBP in no time