Поделиться через

GoFileRoom

  • Reference

GoFileRoom is a cloud-based document management and workflow solution. With the GoFileRoom connector, you can perform document, user management, and FirmFlow actions.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Standard All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Standard All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name GoFileRoom Support
URL https://tax.thomsonreuters.com/us/en/cs-professional-suite/support/contact
Email [email protected]
Connector Metadata
Publisher Thomson Reuters
Website https://www.gofileroom.com/
Privacy policy https://www.thomsonreuters.com/en/privacy-statement.html
Categories Data;Business Management

The GoFileRoom Connector provides an easy way for Thomson Reuters customers to utilize API's for GoFileRoom and FirmFlow. Users can create automation and integration related to User Management, Documents or FirmFlow.

Prerequisites

Users must have a GoFileRoom API key in order to use the connector.

How to get credentials?

The API key can be obtained by registering for an account at https://developerportal.thomsonreuters.com/. Additionally you will need to have an active GoFileRoom account. If you are interested in GoFileRoom contact us here: https://tax.thomsonreuters.com/us/en/cs-professional-suite/gofileroom#contact

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
X-TR-API-APP-ID securestring The X-TR-API-APP-ID for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Add Master Deliverable

Add Master Deliverable
Copy Document

Copies the documents
Create Document

Creates a document record with indexes
Create Group

Creates permission group
Create Users

Creates GoFileRoom and ClientFlow users into the System
Create Workflow

Create Workflow
Delete Document

Deletes a document
Delete Master Deliverable

Delete Master Deliverable
Delete User

Delete GoFileRoom and ClientFlow users from the System
Delete Workflows

Delete Workflows
Document Reindex

Reindexes the documents
Document Search

Loads all the documents the user has access to in the specified drawer.
Edit Master Deliverable

Edit Master Deliverable
Edit WorkFlow

Edit WorkFlow
Get Child Indexes

Gets a list of child index values based on the list ID, which is provided when the parent list value is selected.
Get Document

Downloads the document
Get Document History

Gets the history of the document
Get Document Indexes

Retrieves the document's indexes
Get Document Status

Get the Status of Documents
Get Drawer Indexes

Retrieves a list of document indexes that are set up for the drawer
Get Drawers

Fetches the drawers accessible for the Logged in User
Get Dynamic Rules for Index

Gets the list of dynamic rules configured for the specified index
Get FirmFlow Data by Deliverable

Gets the Tracking Report by Deliverable data
Get Group Document Security

Retrieve group document security
Get Group Permissions

Gets permissions of groups
Get Groups

Fetches the groups available for user and group management
Get Licenses

Retrieves licensing counts
Get List of Index Values

Gets all the entries for a list type index
Get List of Reports

Fetches the reports available for user management
Get LookupList Values

Fetches the values from the LookupList
Get Master Deliverable

Get Master Deliverable
Get Password Policy

Fetches the Password policy for the firm
Get Upload Locations

Fetches the upload locations for the user
Get User Document Security

Fetches user document security per login
Get User Info

Fetches the GFR User Information
Get User Info V2

Gets the User infromation
Get User Permissions

Gets permissions of user
Get Users

Fetches the GFR users for the Logged in User
Index LookupList Find

This method is designed for use with autocomplete fields.
Login

Logs a user into the application
Logout

Logout of application
Merge PDF's

Merge PDF files together
Modify Group

Modify group permissions
Modify User

Modify user permissions
Publish Document Status

Publish or Unpublish documents from ClientFlow.
Route Workflow V2

Route Workflow V2
Set Group Document Security

Assigns document security to a group
Set Group Permissions

Assigns permission to group
Set User Document Security

Assigns user document security permissions
Set User Permissions

Assigns permission to user
Taxsort Document

Taxsort PDF document
Tracking Report By Deliverable V2

Tracking Report by DeliverableV2
Tracking Report By Workflow

Tracking Report by Workflow
Validate Indexes

Checks whether the indexes provided are valid.
Validate Token

Validate Token status

Add Master Deliverable

Operation ID:
AddMasterDeliverable

Add Master Deliverable

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication
Deliverable Name
 deliverableName string

Deliverable Name
Due Date
 dueDate string

Due Date
First Extension
 firstExtension string

First Extension
Second Extension
 secondExtension string

Second Extension
Third Extension
 thirdExtension string

Third Extension
Calendar Or Fiscal
 calenderOrFiscal string

Calendar Or Fiscal
Extension
 extension integer

Extension
Service Type
 ServiceType string

Service Type
Drawer Name
 DrawerName string

Drawer Name

Returns

Name Path Type Description
Is Saved
 isSaved boolean

Is Saved
Response Message
 responseMessage string

Response Message

Copy Document

Operation ID:
CopyDocument

Copies the documents

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication
DocumentIds
 DocumentIds array of string

DocumentIds
IndexId
 IndexId string

Enter Index Id
IndexValue
 IndexValue string

Enter Index Value

Returns

Name Path Type Description
array of object
copyDocumentException
 copyDocumentException string

copy Document Exception
documentId
 documentId string

document Id value
isCopied
 isCopied boolean

Did the document get copied
newDocumentId
 newDocumentId string

new Document Id

Create Document

Operation ID:
CreateDocument

Creates a document record with indexes

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication
DrawerId
 DrawerId string

Enter Drawer Id
IndexId
 IndexId string

Enter Index Id
IndexValue
 IndexValue string

Enter Index Value

Returns

Name Path Type Description
documentId
 documentCreate.documentId string

document Id value
errorMessage
 documentCreate.errorMessage string

error message
errorMessage
 indexValidation.errorMessage string

error message
errors
 indexValidation.errors array of

errors
isValid
 indexValidation.isValid boolean

is document valid

Create Group

Operation ID:
CreateGroup

Creates permission group

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication
AccessToApproveDocsOnly
 AccessToApproveDocsOnly string

Specify true or false
AllowAccessToReports
 AllowAccessToReports string

Specify true or false
Comments
 Comments string

Enter Comments
EnableMfa
 EnableMfa string

Specify true or false
EnforceMfaForUsers
 EnforceMfaForUsers string

Specify true or false
FirmFlowRoutingNotification
 FirmFlowRoutingNotification string

Specify true or false
FullAccessToDocTracking
 FullAccessToDocTracking string

Specify true or false
GroupName
 GroupName string

Enter Group Name
MfaRequired
 MfaRequired string

Specify true or false
PermissonToApproveDocs
 PermissonToApproveDocs string

Specify true or false
Allow
 Allow array of string

Allow
Deny
 Deny array of string

Deny
IsAllowAll
 IsAllowAll string

Specify true or false
IsDenyAll
 IsDenyAll string

Specify true or false
ReportType
 ReportType string

Specify true or false
UploadLocation
 UploadLocation string

Enter Upload Location
Users
 Users array of string

Users

Returns

Name Path Type Description
createGroupException
 createGroupException string

create Group Exception
groupId
 groupId string

group Id value
isCreated
 isCreated boolean

Did the group get created
mfaException
 mfaException string

mfa status

Create Users

Operation ID:
CreateUsers

Creates GoFileRoom and ClientFlow users into the System

Parameters

Name Key Required Type Description
UserType
 userType string

Enter User Type
Token
 X-Authorization string

Token Authentication
AccountExpiresDate
 AccountExpiresDate string

Enter Account Expires Date
DisabledComments
 DisabledComments string

Enter Disabled Comments
FullName
 FullName string

User Full Name
Groups
 Groups array of string

Groups
IsAccountExpires
 IsAccountExpires string

Specify true or false
IsAdvanceFlow
 IsAdvanceFlow string

Specify true or false
IsAllowAccessToReports
 IsAllowAccessToReports string

Specify true or false
IsAllowOffline
 IsAllowOffline string

Specify true or false
IsDisabled
 IsDisabled string

Specify true or false
IsFirmFlow
 IsFirmFlow string

Specify true or false
IsFirmFlowNotificationGroup
 IsFirmFlowNotificationGroup string

Specify true or false
IsFirmFlowNotificationUser
 IsFirmFlowNotificationUser string

Specify true or false
IsMfa
 IsMfa string

Specify true or false
IsUserAdministration
 IsUserAdministration string

Specify true or false
IsWorkflowManagerUser
 IsWorkflowManagerUser string

Specify true or false
LicenseType
 LicenseType string

Enter License Type
LoginName
 LoginName string

Enter Login Name
ManagerEmail
 ManagerEmail string

Enter Manager Email
Password
 Password string

Enter Password
Allow
 Allow array of string

Allow
Deny
 Deny array of string

Deny
IsAllowAll
 IsAllowAll string

Specify true or false
IsDenyAll
 IsDenyAll string

Specify true or false
ReportType
 ReportType string

Specify true or false
UploadLocation
 UploadLocation string

Enter Upload Location

Returns

Name Path Type Description
createUserException
 createUserException string

create User Exception
isCreated
 isCreated boolean

Did the user get created
mfaException
 mfaException string

mfa Exception
userId
 userId string

user Id value

Create Workflow

Operation ID:
CreateWorkflow

Create Workflow

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication
Drawer Name
 Drawer string

Drawer Name
Service Type
 ServiceType string

Service Type
Folder Id
 folderId string

Folder Id
Client Name
 ClientName string

Client Name
Client Number
 ClientNumber string

Client Number
Engagement Type
 EngagementType string

Engagement Type
PIC
 PIC string

PIC
Year
 Year string

Year
Period End
 PeriodEnd string

Period End
Workflow Name
 workflowName string

Workflow Name
Description
 description True string

Description
Status Name
 statusName string

Status Name
Deliverable Action
 action string

Deliverable Action
Current Due Date
 currentduedate string

Current Due Date
Original Due Date
 originalduedate string

Original Due Date
Deliverable Form
 form string

Deliverable Form
Delivery Method
 Delivery string

Delivery Method
Destination
 Destination string

Destination
Source Document
 sourceDocument string

Source Document
Note Action
 action string

Note Action
Note Type
 noteType string

Note Type
Note Message
 note string

Note Message
Information Field Name
 name string

Information Field Name
Information Field Value
 value string

Information Field Value
Responsible Field
 ResponsibleField string

Responsible Field
Responsible Field Value
 value string

Responsible Field Value

Returns

Name Path Type Description
Filing Id
 filingId integer

Filing Id
Error Comment
 errorComment string

Error Comment
Status
 status boolean

Status
errorMessage
 errorMessage array of string

errorMessage

Delete Document

Operation ID:
DocumentDelete

Deletes a document

Parameters

Name Key Required Type Description
DocumentId
 documentId True string

Enter Document ID
Token
 X-Authorization string

Token Authentication

Returns

Name Path Type Description
array of object
deleteDocumentException
 deleteDocumentException string

delete Document Exception
documentId
 documentId string

document Id value
isDeleted
 isDeleted boolean

is the document deleted

Delete Master Deliverable

Operation ID:
DeleteMasterDeliverable

Delete Master Deliverable

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication
Service Type
 ServiceType string

Service Type
Drawer Name
 DrawerName string

Drawer Name
DeliverableNames
 DeliverableNames array of string

DeliverableNames

Returns

Name Path Type Description
array of object
Delete Status
 isDeleted boolean

Delete Status
Response Message
 responseMessage string

Response Message

Delete User

Operation ID:
DeleteUser

Delete GoFileRoom and ClientFlow users from the System

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication
LoginId
 LoginId string

Enter the Login Id of the user
UserType
 UserType string

Enter the User Type

Returns

Name Path Type Description
deleteUserException
 deleteUserException string

delete User Exception
isDeleted
 isDeleted boolean

Did the login get Deleted
loginId
 loginId string

login Id value

Delete Workflows

Operation ID:
DeleteWorkflows

Delete Workflows

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication
filingId
 filingId array of integer

filingId

Returns

Name Path Type Description
Deleted Status
 isDeleted boolean

Deleted Status
Filing Id
 filingId string

Filing Id

Document Reindex

Operation ID:
DocumentReindex

Reindexes the documents

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication
DocumentIds
 DocumentIds array of string

DocumentIds
IndexId
 IndexId string

Enter Index Id
IndexValue
 IndexValue string

Enter Index Value

Returns

Name Path Type Description
array of object
documentId
 documentId string

document Id value
isReIndexed
 isReIndexed boolean

is the document ReIndexed
reIndexDocumentException
 reIndexDocumentException string

reIndex Document Exception
Operation ID:
DocumentSearch

Loads all the documents the user has access to in the specified drawer.

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication
DrawerId
 DrawerId string

Enter Drawer Id
IndexId
 IndexId string

Enter Index Id
IndexValue
 IndexValue string

Enter Index Value
NumberOfRows
 NumberOfRows integer

Enter Number Of Rows
PageNumber
 PageNumber integer

Enter Page Number
SortField
 SortField string

Enter Sort Field
SortOrder
 SortOrder string

Enter Sort Order

Returns

Name Path Type Description
documentIds
 documentIds array of string

documentIds
documentSearchCount
 documentSearchCount integer

document Search Count

Edit Master Deliverable

Operation ID:
EditMasterDeliverable

Edit Master Deliverable

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication
Current Deliverable Name
 currentdeliverableName string

Current Deliverable Name
Update Deliverable Name
 updatedeliverableName string

Update Deliverable Name
Due Date
 dueDate string

Due Date
First Extension
 firstExtension string

First Extension
Second Extension
 secondExtension string

Second Extension
Third Extension
 thirdExtension string

Third Extension
Calendar Or Fiscal
 calenderOrFiscal string

Calendar Or Fiscal
Extension
 extension integer

Extension
Service Type
 serviceType string

Service Type
Drawer Name
 drawerName string

Drawer Name

Returns

Name Path Type Description
Update Status
 isUpdated boolean

Update Status
Response Message
 responseMessage string

Response Message

Edit WorkFlow

Operation ID:
EditWorkflow

Edit WorkFlow

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication
Filing Id
 filingId integer

Filing Id
Client Name
 ClientName string

Client Name
Client Number
 ClientNumber string

Client Number
Engagement Type
 EngagementType string

Engagement Type
PIC
 PIC string

PIC
Year
 Year string

Year
Period End
 PeriodEnd string

Period End
Deliverable Name
 action string

Deliverable Name
Current Due Date
 currentduedate string

Current Due Date
Original Due Date
 originalduedate string

Original Due Date
Attachment
 form string

Attachment
Note Action
 action string

Note Action
Note Type
 noteType string

Note Type
noteid
 noteid array of string

noteid
Note Message
 note string

Note Message
Information Field Name
 name string

Information Field Name
Information Field Value
 value string

Information Field Value
Delivery Method
 Delivery string

Delivery Method
Destination
 Destination string

Destination
Source Document
 sourceDocument string

Source Document
Responsible Field
 responsibleField string

Responsible Field
Assigned To
 value string

Assigned To
Reindex Docs
 reindexDocs boolean

Reindex Docs

Returns

Name Path Type Description
Filing Id
 filingId integer

Filing Id
Error Comment
 errorComment string

Error Comment
Status
 status boolean

Status
errorMessage
 errorMessage array of object

errorMessage
Name
 errorMessage.name string

Name
Status
 errorMessage.status boolean

Status
Error Comment
 errorMessage.errorComment string

Error Comment

Get Child Indexes

Operation ID:
GetChildIndexes

Gets a list of child index values based on the list ID, which is provided when the parent list value is selected.

Parameters

Name Key Required Type Description
IndexId
 indexId True string

Enter Index ID
ListId
 listId True string

Enter List ID
Token
 X-Authorization string

Token Authentication

Returns

Name Path Type Description
array of object
childIndexId
 childIndexId string

child Index Id value
childListId
 childListId integer

child List Id value
hasChildren
 hasChildren boolean

Does the index have a child index
listEntryId
 listEntryId integer

list Entry Id value
listId
 listId integer

list Id value
value
 value string

value

Get Document

Operation ID:
GetDocument

Downloads the document

Parameters

Name Key Required Type Description
DocumentId
 documentId True string

Enter Document ID
Token
 X-Authorization string

Token Authentication

Returns

Get Document History

Operation ID:
GetDocumentHistory

Gets the history of the document

Parameters

Name Key Required Type Description
DocumentId
 documentId True string

Enter Document ID
Token
 X-Authorization string

Token Authentication

Returns

Name Path Type Description
documentAudit
 documentAudit array of

documentAudit
documentHistoryException
 documentHistoryException string

document History Exception
documentId
 documentId string

document Id value
mergeDocHistory
 mergeDocHistory array of

mergeDocHistory

Get Document Indexes

Operation ID:
GetDocumentIndexes

Retrieves the document's indexes

Parameters

Name Key Required Type Description
DocumentId
 documentId True string

Enter Document ID
Token
 X-Authorization string

Token Authentication

Returns

Name Path Type Description
array of object
indexId
 indexId string

index Id value
indexValue
 indexValue string

index Value

Get Document Status

Operation ID:
GetDocumentStatus

Get the Status of Documents

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication
body
 body array of string

Returns

Name Path Type Description
array of object
documentId
 documentId string

document Id value
documentStatusException
 documentStatusException string

document Status Exception
drawerId
 drawerId string

drawer Id value
fileSize
 fileSize string

file Size value
isArchived
 isArchived boolean

is the document Archived
isCheckedOut
 isCheckedOut boolean

is the document Checked Out
isEncrypted
 isEncrypted boolean

is the document Encrypted
isFiled
 isFiled boolean

is the document Filed
isInRedactionQueue
 isInRedactionQueue boolean

is the document In the Redaction Queue
isInTaxsortQueue
 isInTaxsortQueue boolean

is the document In the Taxsort Queue
isLocked
 isLocked boolean

is the document Locked
isOfficeDocument
 isOfficeDocument boolean

is the document an Office Document
isPublished
 isPublished boolean

is the document Published
isUndergoingMerging
 isUndergoingMerging boolean

is the document Undergoing Merging
localFile
 localFile string

is the document a local file
noEdit
 noEdit boolean

no Edit value
pages
 pages integer

pages in document
reviewed
 reviewed boolean

reviewed status
taxSort
 taxSort boolean

is the document taxSorted
type
 type string

type of file
version
 version integer

version of document

Get Drawer Indexes

Operation ID:
GetDrawerIndexes

Retrieves a list of document indexes that are set up for the drawer

Parameters

Name Key Required Type Description
DrawerId
 drawerId True string

Enter Drawer ID
Token
 X-Authorization string

Token Authentication

Returns

Name Path Type Description
array of object
childIndexId
 childIndexId string

child Index Id value
indexId
 indexId string

index Id value
indexName
 indexName string

index Name value
indexType
 indexType string

index Type value
length
 length integer

Drawer Index length
listId
 listId integer

list Id value
lookupAutoUpdate
 lookupAutoUpdate boolean

lookup Auto Update
required
 required boolean

Is the index required

Get Drawers

Operation ID:
GetDrawers

Fetches the drawers accessible for the Logged in User

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication

Returns

Name Path Type Description
array of object
drawerID
 drawerID string

drawer ID value
drawerName
 drawerName string

drawer Name value
add
 permissions.add boolean

add value
delete
 permissions.delete boolean

delete value
edit
 permissions.edit boolean

edit value
lookupManagement
 permissions.lookupManagement boolean

lookupManagement value
view
 permissions.view boolean

view value

Get Dynamic Rules for Index

Operation ID:
GetDynamicRulesForIndex

Gets the list of dynamic rules configured for the specified index

Parameters

Name Key Required Type Description
IndexId
 indexId True string

Enter Index ID
Token
 X-Authorization string

Token Authentication

Returns

Name Path Type Description
array of object
condition
 condition string

condition value
dependentIndexId
 dependentIndexId string

dependent Index Id value
dynamicRuleId
 dynamicRuleId string

dynamic Rule Id value
value
 value string

value

Get FirmFlow Data by Deliverable

Operation ID:
GetFirmFlowDeliverableReport

Gets the Tracking Report by Deliverable data

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication
Accountable
 Accountable string

Enter Accountable value
AssignedOn
 AssignedOn string

Enter Assigned On Date
AssignedTo
 AssignedTo string

Enter Assigned To value
AssignmentHistory
 AssignmentHistory string

Enter Assignment History
CompletedBy
 CompletedBy string

Enter Completed By value
CompletedOn
 CompletedOn string

Enter Completed On Date
CurrentDueDate
 CurrentDueDate string

Enter Current Due Date
CurrentStep
 CurrentStep string

Enter Current Step
DateExtended
 DateExtended string

Enter Date Extended
DaysAtStep
 DaysAtStep string

Enter Days At Step
DaysBetweenRoutings
 DaysBetweenRoutings string

Enter Days Between Routings
DrawerId
 DrawerId string

Enter Drawer Id
EngagementType
 EngagementType string

Enter Engagement Type
InProcessOnly
 InProcessOnly string

Enter In Process Only value
Indexes
 Indexes array of string

Indexes
InformationFields
 InformationFields array of string

InformationFields
OriginalDueDate
 OriginalDueDate string

Enter Original Due Date
PIC
 PIC string

Enter PIC
PageNumber
 PageNumber string

Enter Page Number
Priority
 Priority string

Enter Priority
ReceivedFrom
 ReceivedFrom string

Enter Received From value
ReceivedOn
 ReceivedOn string

Enter Received On Date
Responsible
 Responsible string

Enter Responsible value
RoutingDetails
 RoutingDetails string

Enter Routing Details
SentOn
 SentOn string

Enter Sent On Date
SentTo
 SentTo string

Enter Sent To value
ServiceType
 ServiceType string

Enter Service Type
Status
 Status string

Enter Status
TotalDaysAtStep
 TotalDaysAtStep string

Enter Total Days At Step
TotalDaysInProcess
 TotalDaysInProcess string

Enter Total Days In Process
Workflow
 Workflow string

Enter Workflow name
WorkflowDescription
 WorkflowDescription string

Enter Workflow Description

Returns

Name Path Type Description
firmFlowReportResponse
 firmFlowReportResponse array of object

firmFlowReportResponse
accountable
 firmFlowReportResponse.accountable string

accountable value
assignedOn
 firmFlowReportResponse.assignedOn string

assigned On date
assignedTo
 firmFlowReportResponse.assignedTo string

assigned To value
assignedToYesOrNo
 firmFlowReportResponse.assignedToYesOrNo string

Is the workflow assigned
assignmentHistory
 firmFlowReportResponse.assignmentHistory string

assignment History value
clientName
 firmFlowReportResponse.clientName string

client Name value
clientNumber
 firmFlowReportResponse.clientNumber string

client Number value
completedBy
 firmFlowReportResponse.completedBy string

completed By value
completedOn
 firmFlowReportResponse.completedOn string

completed On date
currentDueDate
 firmFlowReportResponse.currentDueDate string

current Due Date
currentStep
 firmFlowReportResponse.currentStep string

current Step value
dateExtended
 firmFlowReportResponse.dateExtended string

date Extended
daysAtStep
 firmFlowReportResponse.daysAtStep string

workflow days At Step
daysBetweenRoutings
 firmFlowReportResponse.daysBetweenRoutings string

workflow days Between Routings
deliverables
 firmFlowReportResponse.deliverables string

deliverables value
drawerId
 firmFlowReportResponse.drawerId string

drawer Id value
eFileYesOrNo
 firmFlowReportResponse.eFileYesOrNo string

is the deliverable to be eFiled
engagementType
 firmFlowReportResponse.engagementType string

engagement Type value
extendedYesOrNo
 firmFlowReportResponse.extendedYesOrNo string

has the deliverable been extended
informationFields
 firmFlowReportResponse.informationFields array of object

informationFields
name
 firmFlowReportResponse.informationFields.name string

name
value
 firmFlowReportResponse.informationFields.value string

value
originalDueDate
 firmFlowReportResponse.originalDueDate string

original Due Date
periodEnd
 firmFlowReportResponse.periodEnd string

period End of workflow
pic
 firmFlowReportResponse.pic string

pic of workflow
picYesOrNo
 firmFlowReportResponse.picYesOrNo string

has the pic been assigned
priority
 firmFlowReportResponse.priority string

priority value
progress
 firmFlowReportResponse.progress string

progress value
receivedFrom
 firmFlowReportResponse.receivedFrom string

received From value
receivedOn
 firmFlowReportResponse.receivedOn string

received On date
responsible
 firmFlowReportResponse.responsible string

responsible value
responsibleUserOrGroups
 firmFlowReportResponse.responsibleUserOrGroups array of

responsibleUserOrGroups
routingNotes
 firmFlowReportResponse.routingNotes string

routing Notes of workflow
routingSummary
 firmFlowReportResponse.routingSummary array of

routingSummary
sentOn
 firmFlowReportResponse.sentOn string

sent On date
sentTo
 firmFlowReportResponse.sentTo string

sent To value
serviceType
 firmFlowReportResponse.serviceType string

service Type of workflow
status
 firmFlowReportResponse.status string

status of workflow
totalDaysAtStep
 firmFlowReportResponse.totalDaysAtStep string

workflow total Days At Step
totalDaysInProcess
 firmFlowReportResponse.totalDaysInProcess string

workflow total Days In Process
workflow
 firmFlowReportResponse.workflow string

workflow type
workflowDescription
 firmFlowReportResponse.workflowDescription string

workflow Description
year
 firmFlowReportResponse.year string

year of workflow
getFirmFlowException
 getFirmFlowException string

get FirmFlow Exception
pageNumber
 pageNumber string

page Number of request
pageSize
 pageSize integer

page Size of request
totalPages
 totalPages integer

total Pages of request
totalRecords
 totalRecords integer

total Records of request

Get Group Document Security

Operation ID:
GetGroupDocumentSecurity

Retrieve group document security

Parameters

Name Key Required Type Description
GroupName
 groupName True string

Enter Group Name
CabinetName
 cabinetName True string

Enter Cabinet Name
DrawerName
 drawerName True string

Enter Drawer Name
Token
 X-Authorization string

Token Authentication

Returns

Name Path Type Description
Group Name
 groupName string

Group Name
Cabinet Name
 cabinetName string

Cabinet Name
Drawer Name
 drawerName string

Drawer Name
documentSecurity
 documentSecurity array of object

documentSecurity
Index Name
 documentSecurity.indexName string

Index Name
Doc Security Type
 documentSecurity.docSecurityType string

Doc Security Type
values
 documentSecurity.values array of string

values
Group Doc Security Exception
 getGroupDocSecurityException string

Group Doc Security Exception

Get Group Permissions

Operation ID:
GetGroupPermissions

Gets permissions of groups

Parameters

Name Key Required Type Description
GroupName
 groupName string

Enter Group Name
Token
 X-Authorization string

Token Authentication

Returns

Name Path Type Description
cabinet
 cabinet string

Cabinet Name
add
 cabinetPermissions.add boolean

add permissions
delete
 cabinetPermissions.delete boolean

delete permissions
deny
 cabinetPermissions.deny boolean

deny permissions
edit
 cabinetPermissions.edit boolean

edit permissions
lookUp
 cabinetPermissions.lookUp boolean

lookUp permissions
read
 cabinetPermissions.read boolean

read permissions
drawerPermissions
 drawerPermissions array of object

drawerPermissions
drawer
 drawerPermissions.drawer string

Drawer Name
add
 drawerPermissions.permission.add boolean

add permissions
delete
 drawerPermissions.permission.delete boolean

delete permissions
deny
 drawerPermissions.permission.deny boolean

deny permissions
edit
 drawerPermissions.permission.edit boolean

edit permissions
lookUp
 drawerPermissions.permission.lookUp boolean

lookUp permissions
read
 drawerPermissions.permission.read boolean

read permissions
groupName
 groupName string

Group Name
groupPermissionException
 groupPermissionException string

Group Permission Exception

Get Groups

Operation ID:
GetGroups

Fetches the groups available for user and group management

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication

Returns

Name Path Type Description
array of object
id
 id string

Group ID value
mfa
 mfa integer

mfa value
mfaRequired
 mfaRequired integer

mfa Required value
name
 name string

Group name value

Get Licenses

Operation ID:
GetLicenses

Retrieves licensing counts

Parameters

Name Key Required Type Description
LicenseType
 license string

Enter License Type
Token
 X-Authorization string

Token Authentication

Returns

Name Path Type Description
assignedLicenses
 assignedLicenses string

assigned License count
getLicenseException
 getLicenseException string

get License Exception
license
 license string

license name
message
 message string

message
totalLicenses
 totalLicenses string

total license count

Get List of Index Values

Operation ID:
GetListTypeIndexData

Gets all the entries for a list type index

Parameters

Name Key Required Type Description
IndexId
 indexId True string

Enter Index ID
Token
 X-Authorization string

Token Authentication

Returns

Name Path Type Description
array of object
childIndexId
 childIndexId string

child Index Id value
childListId
 childListId integer

child List Id value
hasChildren
 hasChildren boolean

Does the index have a child index
listEntryId
 listEntryId integer

list Entry Id value
listId
 listId integer

list Id value
value
 value string

value

Get List of Reports

Operation ID:
GetListOfReports

Fetches the reports available for user management

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication

Returns

Name Path Type Description
reports
 reports array of object

reports
reportName
 reports.reportName array of string

reportName
reportType
 reports.reportType string

report Type value
reportsException
 reportsException string

reports Exception value

Get LookupList Values

Operation ID:
GetLookupList

Fetches the values from the LookupList

Parameters

Name Key Required Type Description
Drawer ID. Example Clients Drawer: "0000000001"
 drawerId True string

Enter Drawer ID
Token
 X-Authorization string

Token Authentication

Returns

Name Path Type Description
array of object
clientName
 clientName string

client Name value
clientNumber
 clientNumber string

client number value

Get Master Deliverable

Operation ID:
GetMasterDeliverable

Get Master Deliverable

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication
Page Number
 PageNumber integer

Page Number
Page Size
 pageSize integer

Page Size
Service Type
 ServiceType string

Service Type
Drawer Name
 DrawerName string

Drawer Name

Returns

Name Path Type Description
deliverableList
 deliverableList array of object

deliverableList
Deliverable Name
 deliverableList.deliverableName string

Deliverable Name
Extension Type
 deliverableList.extensionType string

Extension Type
Due Date
 deliverableList.dueDate string

Due Date
First Extension
 deliverableList.firstExtension string

First Extension
Second Extension
 deliverableList.secondExtension string

Second Extension
Third Extension
 deliverableList.thirdExtension string

Third Extension
Extension
 deliverableList.extension string

Extension
Action
 deliverableList.action string

Action
Obligation Id
 deliverableList.obligationId string

Obligation Id
Firm Managed Option
 deliverableList.firmManagedOption string

Firm Managed Option
Total Records
 totalRecords string

Total Records
Response Message
 responseMessage string

Response Message

Get Password Policy

Operation ID:
GetPasswordPolicy

Fetches the Password policy for the firm

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication

Returns

Name Path Type Description
clientId
 passwordPolicy.clientId string

client Id value
forbidden_pwd_words
 passwordPolicy.forbidden_pwd_words array of string

forbidden_pwd_words
lockout_threshold
 passwordPolicy.lockout_threshold integer

lockout threshold
max_length
 passwordPolicy.max_length integer

max length of password
max_login_similarity
 passwordPolicy.max_login_similarity string

maximum login similarity
max_pwd_age
 passwordPolicy.max_pwd_age integer

max pwd age of password
max_repeat_chars
 passwordPolicy.max_repeat_chars string

max repeat chars in password
max_sequential_chars
 passwordPolicy.max_sequential_chars string

maximum sequential characters
mfa
 passwordPolicy.mfa integer

mfa value
min_length
 passwordPolicy.min_length integer

min length of password
pwd_req_alpha
 passwordPolicy.pwd_req_alpha integer

Alpha Password Requirement
pwd_req_lower
 passwordPolicy.pwd_req_lower integer

Lower Password Requirement
pwd_req_number
 passwordPolicy.pwd_req_number integer

Password Number Requirement
pwd_req_symbol
 passwordPolicy.pwd_req_symbol integer

Symbol Password Requirement
pwd_req_upper
 passwordPolicy.pwd_req_upper integer

Upper Password Requirement
passwordPolicyException
 passwordPolicyException string

passwordPolicyException

Get Upload Locations

Operation ID:
GetUploadLocation

Fetches the upload locations for the user

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication

Returns

Name Path Type Description
uploadLocations
 uploadLocations array of object

uploadLocations
locationName
 uploadLocations.locationName string

location Name value
locationPath
 uploadLocations.locationPath string

location Path value
uploadLocationsException
 uploadLocationsException string

upload Locations Exception

Get User Document Security

Operation ID:
GetUserDocumentSecurity

Fetches user document security per login

Parameters

Name Key Required Type Description
LoginId
 loginId True string

Enter Login ID
CabinetName
 cabinetName True string

Enter Cabinet Name
DrawerName
 drawerName True string

Enter Drawer Name
Token
 X-Authorization string

Token Authentication

Returns

Name Path Type Description
cabinetName
 cabinetName string

cabinet Name
documentSecurity
 documentSecurity string

document Security value
drawerName
 drawerName string

drawer name value
getUserDocSecurityException
 getUserDocSecurityException string

User Document Security Exception
loginId
 loginId string

login Id value

Get User Info

Operation ID:
GetUserInfo

Fetches the GFR User Information

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication
LoginName
 LoginName True string

Enter LoginName
UserType
 UserType True string

Select UserType

Returns

Name Path Type Description
createDate
 createDate string

createDate
createdBy
 createdBy string

createdBy
description
 description string

description
disabled
 disabled integer

disabled
disabledByAdmin
 disabledByAdmin boolean

disabledByAdmin
emailNotify
 emailNotify boolean

emailNotify
emailNotifyEventMgmtGroups
 emailNotifyEventMgmtGroups boolean

emailNotifyEventMgmtGroups
emailNotifyEventMgmtUsers
 emailNotifyEventMgmtUsers boolean

emailNotifyEventMgmtUsers
emailNotifyGroup
 emailNotifyGroup boolean

emailNotifyGroup
forcePasswordChange
 forcePasswordChange boolean

forcePasswordChange
fullName
 fullName string

fullName
hasDrawerSetupRights
 hasDrawerSetupRights string

hasDrawerSetupRights
isAdmin
 isAdmin integer

isAdmin
isManager
 isManager integer

isManager
licenseType
 licenseType string

licenseType
locationID
 locationID string

locationID
loginID
 loginID string

loginID
managerFullName
 managerFullName string

managerFullName
managerId
 managerId string

managerId
managerLoginId
 managerLoginId string

managerLoginId
oberonUser
 oberonUser integer

oberonUser
offline
 offline boolean

offline
passwordChangeDate
 passwordChangeDate string

passwordChangeDate
passwordChangeInterval
 passwordChangeInterval integer

passwordChangeInterval
passwordExpireDate
 passwordExpireDate string

passwordExpireDate
reports
 reports boolean

reports
signature
 signature string

signature
systemAdmin
 systemAdmin boolean

systemAdmin
taxFlow
 taxFlow boolean

taxFlow
userAdministration
 userAdministration integer

userAdministration
userID
 userID string

userID
workflowManagerUser
 workflowManagerUser boolean

workflowManagerUser

Get User Info V2

Operation ID:
GetUserInfoV2

Gets the User infromation

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication
Login Name
 LoginName string

Login Name
User Type
 UserType string

User Type

Returns

Name Path Type Description
User ID
 userID string

User ID
Login ID
 loginID string

Login ID
Full Name
 fullName string

Full Name
Create Date
 createDate string

Create Date
Created By
 createdBy string

Created By
Description
 description string

Description
Disabled
 disabled integer

Disabled
Disabled By Admin
 disabledByAdmin boolean

Disabled By Admin
Password Expire Date
 passwordExpireDate string

Password Expire Date
Force Password Change
 forcePasswordChange boolean

Force Password Change
Password Change Date
 passwordChangeDate string

Password Change Date
Password Change Interval
 passwordChangeInterval integer

Password Change Interval
License Type
 licenseType string

License Type
Offline
 offline boolean

Offline
Reports
 reports boolean

Reports
System Admin
 systemAdmin boolean

System Admin
Signature
 signature string

Signature
Location ID
 locationID string

Location ID
Has Drawer Setup Rights
 hasDrawerSetupRights string

Has Drawer Setup Rights
Tax Flow
 taxFlow boolean

Tax Flow
Email Notify
 emailNotify boolean

Email Notify
Email Notify Group
 emailNotifyGroup boolean

Email Notify Group
Email Notify Event Mgmt Users
 emailNotifyEventMgmtUsers boolean

Email Notify Event Mgmt Users
Email Notify Event Mgmt Groups
 emailNotifyEventMgmtGroups boolean

Email Notify Event Mgmt Groups
Portal User Administration
 portalUserAdministration boolean

Portal User Administration
Internal User Administration
 internalUserAdministration boolean

Internal User Administration
Workflow Manager User
 workflowManagerUser boolean

Workflow Manager User
Manager Id
 managerId string

Manager Id
Manager Login Id
 managerLoginId string

Manager Login Id
Manager Full Name
 managerFullName string

Manager Full Name
Is Manager
 isManager integer

Is Manager
Oberon User
 oberonUser integer

Oberon User
Is Admin
 isAdmin integer

Is Admin
Last Login
 lastLogin string

Last Login
groups
 groups array of string

groups

Get User Permissions

Operation ID:
GetUserPermission

Gets permissions of user

Parameters

Name Key Required Type Description
Login
 login True string

Enter Login
Token
 X-Authorization string

Token Authentication

Returns

Name Path Type Description
cabinet
 cabinet string

cabinet name value
add
 cabinetPermission.add boolean

add value
delete
 cabinetPermission.delete boolean

delete value
deny
 cabinetPermission.deny boolean

deny value
edit
 cabinetPermission.edit boolean

edit value
lookUp
 cabinetPermission.lookUp boolean

lookUp value
read
 cabinetPermission.read boolean

read value
drawerPermissions
 drawerPermissions array of object

drawerPermissions
drawer
 drawerPermissions.drawer string

drawer name value
add
 drawerPermissions.permission.add boolean

add value
delete
 drawerPermissions.permission.delete boolean

delete value
deny
 drawerPermissions.permission.deny boolean

deny value
edit
 drawerPermissions.permission.edit boolean

edit value
lookUp
 drawerPermissions.permission.lookUp boolean

lookUp value
read
 drawerPermissions.permission.read boolean

read value
getUserPermissionException
 getUserPermissionException string

User Permission Exception
loginId
 loginId string

login Id value

Get Users

Operation ID:
GetUsers

Fetches the GFR users for the Logged in User

Parameters

Name Key Required Type Description
UserType
 userType string

Enter User Type
Token
 X-Authorization string

Token Authentication

Returns

Name Path Type Description
array of object
isActive
 isActive boolean

Is the user Active
loginId
 loginId string

login Id value

Index LookupList Find

Operation ID:
IndexLookupListFind

This method is designed for use with autocomplete fields.

Parameters

Name Key Required Type Description
IndexID
 indexId True string

Enter Index ID
Token
 X-Authorization string

Token Authentication
ActionType
 ActionType integer

Enter Action Type
Count
 Count integer

Enter Count
IndexValue
 IndexValue string

Enter Index Value
SearchType
 SearchType integer

Enter Search Type

Returns

Name Path Type Description
array of object
indexId
 index.indexId string

index Id value
indexValue
 index.indexValue string

index Value
linkedIndexes
 linkedIndexes array of object

linkedIndexes
indexId
 linkedIndexes.indexId string

indexId
indexValue
 linkedIndexes.indexValue string

indexValue

Login

Operation ID:
Login

Logs a user into the application

Parameters

Name Key Required Type Description
LoginName
 LoginName True string

Enter Login Name
Password
 Password True password

Enter Password

Returns

Name Path Type Description
authSuccess
 authSuccess boolean

was authentication Successful
authenticationResponse
 authenticationResponse string

authentication Response value
customerId
 customerId string

customer Id value
errorCode
 errorCode string

error Code value
idleSessionTimeoutMinutes
 idleSessionTimeoutMinutes integer

idle Session Timeout Minutes
loneStarFirmId
 loneStarFirmId string

lone Star Firm Id
loneStarValidated
 loneStarValidated boolean

lone Star Validated
token
 token string

token value
userId
 userId string

user Id value
userName
 userName string

user Name value

Logout

Operation ID:
Logout

Logout of application

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication

Returns

Name Path Type Description
isLogoutSuccess
 isLogoutSuccess boolean

Was the Logout Successful

Merge PDF's

Operation ID:
MergePDF

Merge PDF files together

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication
body
 body array of string

Returns

response
string

Modify Group

Operation ID:
ModifyGroup

Modify group permissions

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication
AccessToApproveDocsOnly
 AccessToApproveDocsOnly string

Specify true or false
AllowAccessToReports
 AllowAccessToReports string

Specify true or false
Comments
 Comments string

Enter Comments
EnableMfa
 EnableMfa string

Specify true or false
EnforceMfaForUsers
 EnforceMfaForUsers string

Specify true or false
FirmFlowRoutingNotification
 FirmFlowRoutingNotification string

Specify true or false
FullAccessToDocTracking
 FullAccessToDocTracking string

Specify true or false
GroupName
 GroupName string

Enter Group Name
MfaRequired
 MfaRequired string

Specify true or false
PermissonToApproveDocs
 PermissonToApproveDocs string

Specify true or false
RenameGroup
 RenameGroup string

Enter New Group Name
Allow
 Allow array of string

Allow
Deny
 Deny array of string

Deny
IsAllowAll
 IsAllowAll string

Specify true or false
IsDenyAll
 IsDenyAll string

Specify true or false
ReportType
 ReportType string

Specify true or false
UploadLocation
 UploadLocation string

Enter Upload Location
Users
 Users array of string

Users

Returns

Name Path Type Description
groupId
 groupId string

group Id value
isModified
 isModified boolean

Did the Group get Modified
mfaException
 mfaException string

mfa Exception
modifyGroupException
 modifyGroupException string

modify Group Exception

Modify User

Operation ID:
ModifyUser

Modify user permissions

Parameters

Name Key Required Type Description
UserType
 userType string

Enter User Type
Token
 X-Authorization string

Token Authentication
AccountExpiresDate
 AccountExpiresDate string

Date the Account will expire
DisabledComments
 DisabledComments string

Enter Comments
FullName
 FullName string

Enter Full Name
Groups
 Groups array of string

Groups
IsAccountExpires
 IsAccountExpires string

Specify true or false
IsAdvanceFlow
 IsAdvanceFlow string

Specify true or false
IsAllowAccessToReports
 IsAllowAccessToReports string

Specify true or false
IsAllowOffline
 IsAllowOffline string

Specify true or false
IsChangeNextLogin
 IsChangeNextLogin string

Specify true or false
IsDisabled
 IsDisabled string

Specify true or false
IsFirmFlow
 IsFirmFlow string

Specify true or false
IsFirmFlowNotificationGroup
 IsFirmFlowNotificationGroup string

Specify true or false
IsFirmFlowNotificationUser
 IsFirmFlowNotificationUser string

Specify true or false
IsMfa
 IsMfa string

Specify true or false
IsUserAdministration
 IsUserAdministration string

Specify true or false
IsWorkflowManagerUser
 IsWorkflowManagerUser string

Specify true or false
LicenseType
 LicenseType string

Enter License Type
LoginName
 LoginName string

Enter Login Name
ManagerEmail
 ManagerEmail string

Enter Manager Email
Password
 Password string

Enter Password
Allow
 Allow array of string

Allow
Deny
 Deny array of string

Deny
IsAllowAll
 IsAllowAll string

Specify true or false
IsDenyAll
 IsDenyAll string

Specify true or false
ReportType
 ReportType string

Specify true or false
UploadLocation
 UploadLocation string

Enter Upload Location

Returns

Name Path Type Description
isModified
 isModified boolean

Was the user modified
mfaException
 mfaException string

mfa Exception
modifyUserException
 modifyUserException string

modify User Exception
userId
 userId string

user Id value

Publish Document Status

Operation ID:
PublishDocumentStatus

Publish or Unpublish documents from ClientFlow.

Parameters

Name Key Required Type Description
DocumentId
 documentId True string

Enter Document Id
Token
 X-Authorization string

Token Authentication
IsPublished
 IsPublished True string

Specify true or false

Returns

Name Path Type Description
array of object
documentException
 documentException string

document Exception
documentId
 documentId string

document Id value
isPublished
 isPublished boolean

is the document Published

Route Workflow V2

Operation ID:
RouteWorkflowV2

Route Workflow V2

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication
filingId
 filingId array of integer

filingId
CurrentStep
 CurrentStep array of string

CurrentStep
Complete
 Complete boolean

Complete
Completed Date
 CompletedDate string

Completed Date
Next Step
 NextStep string

Next Step
Assigned To
 AssignedTo string

Assigned To
Assigned Date
 AssignedDate string

Assigned Date
Priority
 Priority string

Priority
Status
 Status string

Status
Routing Note
 RoutingNote string

Routing Note
Email Notification
 emailNotify boolean

Email Notification

Returns

Name Path Type Description
Filing Id
 filingId string

Filing Id
Is Routed
 isRouted boolean

Is Routed

Set Group Document Security

Operation ID:
SetGroupDocSecurity

Assigns document security to a group

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication
CabinetName
 CabinetName string

Enter the Cabinet Name
DocSecurityType
 DocSecurityType string

Enter Document Security Type
IndexName
 IndexName string

Enter the Index Name
Operation
 Operation string

Enter the Operation Type
Values
 Values array of string

Values
DrawerName
 DrawerName string

Enter the Drawer Name
GroupName
 GroupName string

Enter the Group Name

Returns

Name Path Type Description
groupName
 groupName string

Group Name value
isSetGroupDocSecurity
 isSetGroupDocSecurity boolean

Did Document Security get set
setGroupDocSecurityException
 setGroupDocSecurityException string

Group Document Security Exception

Set Group Permissions

Operation ID:
SetGroupPermissions

Assigns permission to group

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication
Cabinet
 Cabinet string

Enter Cabinet Name
Add
 Add string

Specify true or false
Delete
 Delete string

Specify true or false
Deny
 Deny string

Specify true or false
Edit
 Edit string

Specify true or false
LookUp
 LookUp string

Specify true or false
Read
 Read string

Specify true or false
Drawer
 Drawer string

Enter Drawer Name
Add
 Add string

Specify true or false
Delete
 Delete string

Specify true or false
Deny
 Deny string

Specify true or false
Edit
 Edit string

Specify true or false
LookUp
 LookUp string

Specify true or false
Read
 Read string

Specify true or false
GroupName
 GroupName string

Enter Group Name

Returns

Name Path Type Description
groupId
 groupId string

group Id value
groupPermissionException
 groupPermissionException string

group Permission Exception
isSet
 isSet boolean

Did permissions get applied

Set User Document Security

Operation ID:
SetUserDocSecurity

Assigns user document security permissions

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication
CabinetName
 CabinetName string

Enter Cabinet Name
DocSecurityType
 DocSecurityType string

Enter Document Security Type
IndexName
 IndexName string

Enter Index Name
Operation
 Operation string

Enter Operation
Values
 Values array of string

Values
DrawerName
 DrawerName string

Enter Drawer Name
LoginId
 LoginId string

Enter Login Id

Returns

Name Path Type Description
isSetUserDocSecurity
 isSetUserDocSecurity boolean

Did User Document Security get applied
loginId
 loginId string

login Id value
setUserDocSecurityException
 setUserDocSecurityException string

set User Doc Security Exception

Set User Permissions

Operation ID:
SetUserPermissions

Assigns permission to user

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication
Cabinet
 Cabinet string

Enter Cabinet Name
Add
 Add string

Specify true or false
Delete
 Delete string

Specify true or false
Deny
 Deny string

Specify true or false
Edit
 Edit string

Specify true or false
LookUp
 LookUp string

Specify true or false
Read
 Read string

Specify true or false
Drawer
 Drawer string

Enter Drawer Name
Add
 Add string

Specify true or false
Delete
 Delete string

Specify true or false
Deny
 Deny string

Specify true or false
Edit
 Edit string

Specify true or false
LookUp
 LookUp string

Specify true or false
Read
 Read string

Specify true or false
LoginId
 LoginId string

Enter Login Id

Returns

Name Path Type Description
isSetUserPermission
 isSetUserPermission boolean

Did User Permission update
loginId
 loginId string

login Id value
setUserPermissionException
 setUserPermissionException string

set User Permission Exception

Taxsort Document

Operation ID:
TaxsortDocument

Taxsort PDF document

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication
body
 body array of string

Returns

Name Path Type Description
array of object
documentId
 documentId string

document Id value
isTaxSorted
 isTaxSorted boolean

Is the document TaxSorted
taxsortDocumentException
 taxsortDocumentException string

taxsort Document Exception

Tracking Report By Deliverable V2

Operation ID:
TrackingReportByDeliverableV2

Tracking Report by DeliverableV2

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication
Drawer Id
 DrawerId string

Drawer Id
Service Type
 ServiceType string

Service Type
Engagement Type
 EngagementType string

Engagement Type
Workflow
 Workflow string

Workflow
Current Step
 CurrentStep string

Current Step
PIC
 PIC string

PIC
Assigned To
 AssignedTo string

Assigned To
Assigned On
 AssignedOn string

Assigned On
Workflow Description
 WorkflowDescription string

Workflow Description
In Process Only
 InProcessOnly string

In Process Only
Status
 Status string

Status
Priority
 Priority string

Priority
Received On
 ReceivedOn string

Received On
Completed On
 CompletedOn string

Completed On
Sent On
 SentOn string

Sent On
Responsible
 Responsible string

Responsible
Assignment History
 AssignmentHistory string

Assignment History
Received From
 ReceivedFrom string

Received From
Sent To
 SentTo string

Sent To
Completed By
 CompletedBy string

Completed By
Accountable
 Accountable string

Accountable
Current Due Date
 CurrentDueDate string

Current Due Date
Original Due Date
 OriginalDueDate string

Original Due Date
Date Extended
 DateExtended string

Date Extended
Days At Step
 DaysAtStep string

Days At Step
Total Days At Step
 TotalDaysAtStep string

Total Days At Step
Days Between Routings
 DaysBetweenRoutings string

Days Between Routings
Total Days In Process
 TotalDaysInProcess string

Total Days In Process
Routing Details
 RoutingDetails string

Routing Details
Last Updated
 LastUpdated string

Last Updated
InformationFields
 InformationFields array of string

InformationFields
Indexes
 Indexes array of string

Indexes
Page Number
 PageNumber string

Page Number

Returns

Name Path Type Description
Total Records
 totalRecords integer

Total Records
Page Number
 pageNumber string

Page Number
Page Size
 pageSize integer

Page Size
Total Pages
 totalPages integer

Total Pages
firmFlowReportResponse
 firmFlowReportResponse array of object

firmFlowReportResponse
Client Name
 firmFlowReportResponse.clientName string

Client Name
Client Number
 firmFlowReportResponse.clientNumber string

Client Number
Drawer Id
 firmFlowReportResponse.drawerId string

Drawer Id
Service Type
 firmFlowReportResponse.serviceType string

Service Type
Engagement Type
 firmFlowReportResponse.engagementType string

Engagement Type
Workflow
 firmFlowReportResponse.workflow string

Workflow
Current Step
 firmFlowReportResponse.currentStep string

Current Step
PIC
 firmFlowReportResponse.pic string

PIC
Assigned To
 firmFlowReportResponse.assignedTo string

Assigned To
Assigned On
 firmFlowReportResponse.assignedOn string

Assigned On
Year
 firmFlowReportResponse.year string

Year
Period End
 firmFlowReportResponse.periodEnd string

Period End
Workflow Description
 firmFlowReportResponse.workflowDescription string

Workflow Description
Progress
 firmFlowReportResponse.progress string

Progress
Status
 firmFlowReportResponse.status string

Status
Priority
 firmFlowReportResponse.priority string

Priority
eFile Yes Or No
 firmFlowReportResponse.eFileYesOrNo string

eFile Yes Or No
Extended Yes Or No
 firmFlowReportResponse.extendedYesOrNo string

Extended Yes Or No
Received On
 firmFlowReportResponse.receivedOn string

Received On
Completed On
 firmFlowReportResponse.completedOn string

Completed On
Sent On
 firmFlowReportResponse.sentOn string

Sent On
Deliverables
 firmFlowReportResponse.deliverables string

Deliverables
Responsible
 firmFlowReportResponse.responsible string

Responsible
Assignment History
 firmFlowReportResponse.assignmentHistory string

Assignment History
Received From
 firmFlowReportResponse.receivedFrom string

Received From
Sent To
 firmFlowReportResponse.sentTo string

Sent To
Completed By
 firmFlowReportResponse.completedBy string

Completed By
Accountable
 firmFlowReportResponse.accountable string

Accountable
Current Due Date
 firmFlowReportResponse.currentDueDate string

Current Due Date
Original Due Date
 firmFlowReportResponse.originalDueDate string

Original Due Date
Routing Notes
 firmFlowReportResponse.routingNotes string

Routing Notes
PIC Yes Or No
 firmFlowReportResponse.picYesOrNo string

PIC Yes Or No
Assigned To Yes Or No
 firmFlowReportResponse.assignedToYesOrNo string

Assigned To Yes Or No
Date Extended
 firmFlowReportResponse.dateExtended string

Date Extended
Days At Step
 firmFlowReportResponse.daysAtStep string

Days At Step
Total Days At Step
 firmFlowReportResponse.totalDaysAtStep string

Total Days At Step
Days Between Routings
 firmFlowReportResponse.daysBetweenRoutings string

Days Between Routings
Total Days In Process
 firmFlowReportResponse.totalDaysInProcess string

Total Days In Process
Folder ID
 firmFlowReportResponse.folderID string

Folder ID
Filing ID
 firmFlowReportResponse.filingID string

Filing ID
Prior Filing ID
 firmFlowReportResponse.priorFilingID string

Prior Filing ID
Last Updated
 firmFlowReportResponse.lastUpdated string

Last Updated
informationFields
 firmFlowReportResponse.informationFields array of object

informationFields
name
 firmFlowReportResponse.informationFields.name string

name
value
 firmFlowReportResponse.informationFields.value string

value
routingSummary
 firmFlowReportResponse.routingSummary array of

routingSummary
responsibleUserOrGroups
 firmFlowReportResponse.responsibleUserOrGroups array of

responsibleUserOrGroups
Get FirmFlow Exception
 getFirmFlowException string

Get FirmFlow Exception

Tracking Report By Workflow

Operation ID:
TrackingReportByWorkflow

Tracking Report by Workflow

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication
Drawer Id
 DrawerId string

Drawer Id
Service Type
 ServiceType string

Service Type
Engagement Type
 EngagementType string

Engagement Type
Workflow
 Workflow string

Workflow
Current Step
 CurrentStep string

Current Step
PIC
 PIC string

PIC
Assigned To
 AssignedTo string

Assigned To
Assigned On
 AssignedOn string

Assigned On
Workflow Description
 WorkflowDescription string

Workflow Description
In Process Only
 InProcessOnly string

In Process Only
Status
 Status string

Status
Priority
 Priority string

Priority
Responsible
 Responsible string

Responsible
Assignment History
 AssignmentHistory string

Assignment History
Received From
 ReceivedFrom string

Received From
Received On
 ReceivedOn string

Received On
Sent To
 SentTo string

Sent To
Sent On
 SentOn string

Sent On
Completed By
 CompletedBy string

Completed By
Completed On
 CompletedOn string

Completed On
Current Due Date
 CurrentDueDate string

Current Due Date
Days At Step
 DaysAtStep string

Days At Step
Total Days At Step
 TotalDaysAtStep string

Total Days At Step
Days Between Routings
 DaysBetweenRoutings string

Days Between Routings
Total Days In Process
 TotalDaysInProcess string

Total Days In Process
Accountable
 Accountable string

Accountable
Routing Details
 RoutingDetails string

Routing Details
Last Updated
 LastUpdated string

Last Updated
InformationFields
 InformationFields array of string

InformationFields
Indexes
 Indexes array of string

Indexes
Page Number
 PageNumber string

Page Number

Returns

Name Path Type Description
Total Records
 totalRecords integer

Total Records
Page Number
 pageNumber string

Page Number
Page Size
 pageSize integer

Page Size
Total Pages
 totalPages integer

Total Pages
firmFlowReportResponse
 firmFlowReportResponse array of object

firmFlowReportResponse
Client Name
 firmFlowReportResponse.clientName string

Client Name
Client Number
 firmFlowReportResponse.clientNumber string

Client Number
Drawer Id
 firmFlowReportResponse.drawerId string

Drawer Id
Service Type
 firmFlowReportResponse.serviceType string

Service Type
Engagement Type
 firmFlowReportResponse.engagementType string

Engagement Type
Workflow
 firmFlowReportResponse.workflow string

Workflow
Current Step
 firmFlowReportResponse.currentStep string

Current Step
PIC
 firmFlowReportResponse.pic string

PIC
Assigned To
 firmFlowReportResponse.assignedTo string

Assigned To
Assigned On
 firmFlowReportResponse.assignedOn string

Assigned On
Year
 firmFlowReportResponse.year string

Year
Period End
 firmFlowReportResponse.periodEnd string

Period End
Workflow Description
 firmFlowReportResponse.workflowDescription string

Workflow Description
Progress
 firmFlowReportResponse.progress string

Progress
Status
 firmFlowReportResponse.status string

Status
Priority
 firmFlowReportResponse.priority string

Priority
eFile Yes Or No
 firmFlowReportResponse.eFileYesOrNo string

eFile Yes Or No
Extended Yes Or No
 firmFlowReportResponse.extendedYesOrNo string

Extended Yes Or No
Received On
 firmFlowReportResponse.receivedOn string

Received On
Completed On
 firmFlowReportResponse.completedOn string

Completed On
Sent On
 firmFlowReportResponse.sentOn string

Sent On
Deliverables
 firmFlowReportResponse.deliverables string

Deliverables
Responsible
 firmFlowReportResponse.responsible string

Responsible
Assignment History
 firmFlowReportResponse.assignmentHistory string

Assignment History
Received From
 firmFlowReportResponse.receivedFrom string

Received From
Sent To
 firmFlowReportResponse.sentTo string

Sent To
Completed By
 firmFlowReportResponse.completedBy string

Completed By
Accountable
 firmFlowReportResponse.accountable string

Accountable
Current Due Date
 firmFlowReportResponse.currentDueDate string

Current Due Date
Original Due Date
 firmFlowReportResponse.originalDueDate string

Original Due Date
Routing Notes
 firmFlowReportResponse.routingNotes string

Routing Notes
PIC Yes Or No
 firmFlowReportResponse.picYesOrNo string

PIC Yes Or No
Assigned To Yes Or No
 firmFlowReportResponse.assignedToYesOrNo string

Assigned To Yes Or No
Date Extended
 firmFlowReportResponse.dateExtended string

Date Extended
Days At Step
 firmFlowReportResponse.daysAtStep string

Days At Step
Total Days At Step
 firmFlowReportResponse.totalDaysAtStep string

Total Days At Step
Days Between Routings
 firmFlowReportResponse.daysBetweenRoutings string

Days Between Routings
Total Days In Process
 firmFlowReportResponse.totalDaysInProcess string

Total Days In Process
Folder ID
 firmFlowReportResponse.folderID string

Folder ID
Filing ID
 firmFlowReportResponse.filingID string

Filing ID
Workflow Last Updated
 firmFlowReportResponse.workflowLastUpdated string

Workflow Last Updated
informationFields
 firmFlowReportResponse.informationFields array of object

informationFields
name
 firmFlowReportResponse.informationFields.name string

name
value
 firmFlowReportResponse.informationFields.value string

value
routingSummary
 firmFlowReportResponse.routingSummary array of

routingSummary
responsibleUserOrGroups
 firmFlowReportResponse.responsibleUserOrGroups array of

responsibleUserOrGroups
Get FirmFlow Exception
 getFirmFlowException string

Get FirmFlow Exception

Validate Indexes

Operation ID:
ValidateIndexes

Checks whether the indexes provided are valid.

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication
DrawerId
 DrawerId string

Enter Drawer Id
IndexId
 IndexId string

Enter Index Id
IndexValue
 IndexValue string

Enter Index Value

Returns

Name Path Type Description
errorMessage
 errorMessage string

error Message
errors
 errors array of

errors
isValid
 isValid boolean

is the index valid

Validate Token

Operation ID:
ValidateToken

Validate Token status

Parameters

Name Key Required Type Description
Token
 X-Authorization string

Token Authentication

Returns

response
boolean

Definitions

string

This is the basic data type 'string'.

boolean

This is the basic data type 'boolean'.