InfoQuery
InfoQuery allows you to automate your business by leveraging your Resware data in a low-code solution. You can view, create, delete and update files, documents, partners, etc.
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 | Premium | 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 | Premium | 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 | InfoQuery Support |
| URL | https://infoquery.pro/support/ |
| [email protected] |
| Connector Metadata | |
|---|---|
| Publisher | InfoQuery LLC |
| Website | https://infoquery.pro/ |
| Privacy policy | https://infoquery.pro/privacy/ |
| Categories | Content and Files;Data |
InfoQuery Title Explorer allows you to automate changes to your Resware system. You'll have the ability to add, delete or edit files, actions, notes, documents, etc.
Prerequisites
- API key is required, must sign up at https://connector.infoquery.pro/
- A Resware account is also required. Username, password and portal URL will be needed to form connection.
How to get credentials
- Go to https://connector.infoquery.pro/signup and create an account. From here you can pick a subscription of your choice, API key will be provided after selection.
- Visit https://connector.infoquery.pro/products for subscription and pricing details.
- Resware account details will be provided by your Resware administrator.
Get started with your connector
- Go to Power Automate at https://powerautomate.microsoft.com.
- Create a new flow or edit an existing flow.
- Add a new step to the flow, search for InfoQuery Title Explorer to see all available actions.
- After selecting the action you will need to create a new connection.
- Enter the connection name, API key, Resware username, password and portal URL. The portal URL must be in the format of https://portal.infoquery.com/API.
- Contact [email protected] or visit https://infoquery.pro/support/ if assistance is required.
Known issues and limitations
Each business that utilizes Resware has the ability to customize it to meet their specific needs. Depending on your Resware set up, certain actions may require specific information be provided for the connector to work properly. Knowledge of your Resware system will be needed.
Common errors and remedies
Actions may give a 200 response, but the expected information is not returned. This will most likely be due to the required information of your specific Resware set up not be provided. The information you did provide was successfully sent to Resware, giving the 200 response, but actions may not have occurred as expected. Your Resware administrator or portal will be able to provide you with the information needed to complete the actions.
FAQ
Where do I find my Resware portal URL?
Your Resware administrator will provide the portal URL.
How do I get an API key?
Go to https://connector.infoquery.pro/signup and create an account. From here you are able to pick a subscription of your choice, API key will be provided after selection.
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 |
|---|---|---|---|
| API Key | securestring | The API Key for this api | True |
| ResWare Username | string | The username for ResWare | True |
| ResWare Password | securestring | The password for ResWare | True |
| ResWare Portal URL | string | The portal url for ResWare | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Add Action To File |
Adds an action to the specified file. |
| Add New Partner Employee To Partner Company |
Adds a new partner employee to a partner company. |
| Add Note To File |
Adds a new note to the specified file. |
| Add Or Update Custom Field On Specific Document |
Adds or updates custom fields on the specified document on the specified file. |
| Add Or Update Custom Field On Specific File |
Adds or updates custom fields on the specified file. |
| Add Partner To Specific File |
Adds a partner to the specified file. |
| Cancels Previously Placed Order |
Cancels a previously placed order. |
| Create New Document On Specific File |
Creates a new document on the specified file. |
| Create New File |
Creates a new file. |
| Delete Partner On Specific File |
Removes a partner from the specified file. |
| Delete Previously Placed Order |
Cancels a previously placed order. |
| Estimate Closing Fee |
Estimates the closing fees. |
| Get Actions For Specific File |
Gets all the actions on the specified file. |
| Get Closing Fee Estimate Receipt |
Gets the closing fee estimate receipt. |
| Get Closing Fee Estimate Receipt PDF |
Gets the closing fee estimate receipt in the pdf format. |
| Get Current User Info |
Gets the information on the currently connected user. |
| Get Custom Fields For Specific File |
Gets the custom fields for the specified file. |
| Get Custom Fields On Specific Document |
Get the custom fields on the specified document. |
| Get Document |
Gets information on a document with the specified ID. |
| Get Documents For Specific File |
Gets all information regarding the documents on the specified file. |
| Get Note |
Gets the note with the specified ID. |
| Get Notes For Specific File |
Gets a list of the notes on the specified file. |
| Get Parties For Specific File |
Gets a list of the parties and their information on the specified file. |
| Get Partner Information |
Gets information on a partner with the specified ID. |
| Get Partners For Specific File |
Gets a list of partners and their information on the specified file. |
| Get Transaction And Product Types For Estimation And Order Placement |
Get transaction types and product types for fee estimation and placing orders. |
| Gets Files From Given Search Criteria |
Gets a list of files and their information based on the given search criteria. |
| Update Action For File |
Updates an action for a given file. Can update the Action Group ID and start/complete Coordinator Type ID, Partner Type ID, Due Date, Due Date Locked and Done Date Locked. This API call cannot be used to mark an action as started or completed. |
| Update Partner Employee |
Updates the information of a partner employee. |
| Update Partner Information For Specific File |
Updates the partner information on the specified file. |
| Upload Web URL Document To Specific File |
Loads the Web URL document on the specified file. |
Add Action To File
Adds an action to the specified file.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File ID
|
FileID | True | string |
File identification number. |
|
ActionTypeID
|
ActionTypeID | integer |
The action type identification number. |
|
|
ActionGroupID
|
ActionGroupID | integer |
The action group identification number. |
|
|
CoordinatorTypeID
|
CoordinatorTypeID | integer |
The coordinator type identification number. |
|
|
DueDate
|
DueDate | string |
The due date of the action. |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
The partner type identification number. |
|
|
DueDate
|
DueDate | string |
The due date of the action. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
FileActionID
|
FileActionID | integer |
The file action identification number. |
Add New Partner Employee To Partner Company
Adds a new partner employee to a partner company.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Partner Company ID
|
PartnerCompanyID | True | string |
Partner company identification number. |
|
Password
|
Password | string |
Password for the new employee. |
|
|
PasswordExpirationDate
|
PasswordExpirationDate | string |
The date the password will expire. |
|
|
Enabled
|
Enabled | boolean |
Whether or not the new employee will be enabled for use. |
|
|
WebsiteAccess
|
WebsiteAccess | boolean |
Whether or not the new employee has website access. |
|
|
Name
|
Name | string |
The full name of the new employee. |
|
|
FirstName
|
FirstName | string |
The first name of the new employee. |
|
|
LastName
|
LastName | string |
The last name of the new employee. |
|
|
EmailAddress
|
EmailAddress | string |
The email address of the new employee. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
PartnerCompanyID
|
Employee.PartnerCompanyID | integer |
The partner company identification number. |
|
Enabled
|
Employee.Enabled | boolean |
Whether or not the new employee has been enabled for use. |
|
WebsiteAccess
|
Employee.WebsiteAccess | boolean |
Whether or not the employee has website access. |
|
UserID
|
Employee.UserID | integer |
The identification number of the new employee. |
|
Name
|
Employee.Name | string |
The full name of the employee. |
|
FirstName
|
Employee.FirstName | string |
The first name of the employee. |
|
LastName
|
Employee.LastName | string |
The last name of the employee. |
|
EmailAddress
|
Employee.ContactInformation.EmailAddress | string |
The email address of the employee. |
Add Note To File
Adds a new note to the specified file.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File ID
|
FileID | True | string |
File identification number. |
|
Subject
|
Subject | string |
The note subject. |
|
|
Body
|
Body | string |
The note body. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
NoteID
|
note.NoteID | integer |
The note identification number. |
Add Or Update Custom Field On Specific Document
Adds or updates custom fields on the specified document on the specified file.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File ID
|
FileID | True | string |
File identification number. |
|
Document ID
|
DocumentID | True | string |
Document identification number. |
|
Name
|
Name | string |
The name of the custom field. |
|
|
Value
|
Value | string |
The value of the custom field. |
Returns
- response
- object
Add Or Update Custom Field On Specific File
Adds or updates custom fields on the specified file.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File ID
|
FileID | True | string |
File identification number. |
|
Name
|
Name | string |
The name of the custom field. |
|
|
Value
|
Value | string |
The value of the custom field. |
Returns
- response
- object
Add Partner To Specific File
Adds a partner to the specified file.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File ID
|
FileID | True | string |
File identification number. |
|
UserID
|
UserID | integer |
The user identification number. |
|
|
UserID
|
UserID | integer |
The user identification number. |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
The partner type identification number. |
|
|
PartnerID
|
PartnerID | integer |
The partner identification number. |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
The partner type identification number. |
Returns
- response
- object
Cancels Previously Placed Order
Cancels a previously placed order.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File ID
|
FileID | True | string |
File identification number. |
|
FileID
|
FileID | integer |
The file identification number. |
Returns
- response
- object
Create New Document On Specific File
Creates a new document on the specified file.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File ID
|
FileID | True | string |
File identification number. |
|
DocumentName
|
DocumentName | string |
The document name. |
|
|
DocumentTypeID
|
DocumentTypeID | integer |
The document type identification number. |
|
|
Description
|
Description | string |
The description of the document. |
|
|
InternalOnly
|
InternalOnly | string |
Whether or not the document is internal only. |
|
|
DocumentBody
|
DocumentBody | string |
The document body. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
DocumentID
|
Document.DocumentID | integer |
The document identification number. |
Create New File
Creates a new file.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
EntityType
|
EntityType | string |
The name of the entity type. Individual, corporation, etc. |
|
|
IsPrimaryTransactee
|
IsPrimaryTransactee | boolean |
Whether or not the buyer is the primary transactee. |
|
|
First
|
First | string |
The first name of the buyer. |
|
|
Last
|
Last | string |
The last name of the buyer. |
|
|
UsePropertyAddress
|
UsePropertyAddress | boolean |
Whether or not the mailing address should be used as the property address of the new file. |
|
|
Address1
|
Address1 | string |
The street number and name. |
|
|
City
|
City | string |
The city name. |
|
|
State
|
State | string |
The two letter state abbreviation. |
|
|
Zip
|
Zip | string |
The ZIP code. |
|
|
MaritalStatus
|
MaritalStatus | string |
The marital status of the buyer. |
|
|
Email
|
string |
The email address of the buyer. |
||
|
EntityType
|
EntityType | string |
The name of the entity type. Individual, corporation, etc. |
|
|
IsPrimaryTransactee
|
IsPrimaryTransactee | boolean |
Whether or not the seller is the primary transactee. |
|
|
First
|
First | string |
The first name of the seller. |
|
|
Last
|
Last | string |
The last name of the seller. |
|
|
UsePropertyAddress
|
UsePropertyAddress | boolean |
Whether or not the mailing address should be used as the property address of the new file. |
|
|
Address1
|
Address1 | string |
The street number and name. |
|
|
City
|
City | string |
The city name. |
|
|
State
|
State | string |
The two letter state abbreviation. |
|
|
Zip
|
Zip | string |
The ZIP code. |
|
|
MaritalStatus
|
MaritalStatus | string |
The marital status of the seller. |
|
|
Email
|
string |
The email address of the seller. |
||
|
EstimatedSettlementDate
|
EstimatedSettlementDate | string |
The estimated settlement date of the order. |
|
|
TransactionTypeID
|
TransactionTypeID | integer |
The transaction type identification number. |
|
|
ProductTypeID
|
ProductTypeID | integer |
The product type identification number. |
|
|
SalesPrice
|
SalesPrice | integer |
The sales price of the property. |
|
|
ClientFileNumber
|
ClientFileNumber | string |
The clients file number. |
|
|
PiggybackFileNumber
|
PiggybackFileNumber | string |
The piggyback file number. |
|
|
MainFileNumber
|
MainFileNumber | string |
The main file number. |
|
|
SourceOfBusinessID
|
SourceOfBusinessID | integer |
The source of business identification number. |
|
|
Note
|
Note | string |
A note to add to the new file. |
|
|
Name
|
Name | string |
The name of the custom field. |
|
|
Value
|
Value | string |
The value of the custom field |
|
|
LienPosition
|
LienPosition | integer |
The lien position. |
|
|
LoanNumber
|
LoanNumber | string |
The loan number. |
|
|
LoanAmount
|
LoanAmount | integer |
The amount of the loan. |
|
|
LoanType
|
LoanType | string |
The type of loan. |
|
|
IsPrimary
|
IsPrimary | boolean |
Whether or not this is the primary property address. |
|
|
StreetNumber
|
StreetNumber | string |
The street number. |
|
|
StreetName
|
StreetName | string |
The street name. |
|
|
City
|
City | string |
The city name. |
|
|
State
|
State | string |
The two letter state abbreviation. |
|
|
County
|
County | string |
The county the property is located in. |
|
|
Zip
|
Zip | string |
The ZIP code. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
FileID
|
FileID | integer |
The identification number of the new file. |
|
FileNumber
|
FileNumber | string |
The file number of the new file. |
|
Warnings
|
Warnings | array of string |
Warnings concerning the new file. |
Delete Partner On Specific File
Removes a partner from the specified file.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File ID
|
FileID | True | string |
File identification number. |
|
PartnerTypeID
|
PartnerTypeID | integer |
The partner type identification number. |
|
|
PartnerID
|
PartnerID | integer |
The partner identification number. |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
The partner type identification number. |
Returns
- response
- object
Delete Previously Placed Order
Cancels a previously placed order.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File ID
|
FileID | True | string |
File identification number. |
|
FileID
|
FileID | integer |
The file identification number. |
Returns
- response
- object
Estimate Closing Fee
Estimates the closing fees.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
TransactionTypeID
|
TransactionTypeID | integer |
The transaction type identification number. |
|
|
ProductTypeID
|
ProductTypeID | integer |
The product type identification number. |
|
|
SettlementStatementVersion
|
SettlementStatementVersion | string |
The settlement statement version. |
|
|
SalesPrice
|
SalesPrice | integer |
The sales price. |
|
|
LienPosition
|
LienPosition | integer |
The lien position. |
|
|
LoanAmount
|
LoanAmount | integer |
The loan amount. |
|
|
LoanType
|
LoanType | string |
The loan type. |
|
|
IsPrimary
|
IsPrimary | boolean |
Whether or not this is the primary property. |
|
|
StreetNumber
|
StreetNumber | string |
The street number. |
|
|
StreetName
|
StreetName | string |
The street name. |
|
|
City
|
City | string |
The city name. |
|
|
State
|
State | string |
The two letter state abbreviation. |
|
|
County
|
County | string |
The county name. |
|
|
Zip
|
Zip | string |
The ZIP code. |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
The partner type identification number. |
|
|
PartnerID
|
PartnerID | integer |
The partner identification number. |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
The partner type identification number. |
|
|
Name
|
Name | string |
Name of the endorsement. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
ClosingFeeEstimateID
|
ClosingFeeEstimate.ClosingFeeEstimateID | integer |
The closing fee estimate identification number. |
|
HUDFees
|
ClosingFeeEstimate.HUDFees | array of object |
The HUD fees. |
|
Amount
|
ClosingFeeEstimate.HUDFees.Amount | integer |
The amount of the HUD fee. |
|
Description
|
ClosingFeeEstimate.HUDFees.Description | string |
The description of the fee. |
|
LineNumber
|
ClosingFeeEstimate.HUDFees.LineNumber | string |
The line number. |
|
BuyerAmount
|
ClosingFeeEstimate.HUDFees.BuyerAmount | integer |
The buyer amount. |
|
BuyerPOCAmount
|
ClosingFeeEstimate.HUDFees.BuyerPOCAmount | integer |
The buyer POC amount. |
|
SellerAmount
|
ClosingFeeEstimate.HUDFees.SellerAmount | integer |
The seller amount. |
|
SellerPOCAmount
|
ClosingFeeEstimate.HUDFees.SellerPOCAmount | integer |
The seller POC amount. |
|
OtherPOCAmount
|
ClosingFeeEstimate.HUDFees.OtherPOCAmount | integer |
The other POC amount. |
|
PartnerTypeID
|
ClosingFeeEstimate.HUDFees.OtherPOCPartnerType.PartnerTypeID | integer |
The partner type identification number. |
|
PartnerTypeName
|
ClosingFeeEstimate.HUDFees.OtherPOCPartnerType.PartnerTypeName | string |
The partner type name. |
|
GFE
|
ClosingFeeEstimate.GFE | array of object |
The good faith estimates. |
|
Description
|
ClosingFeeEstimate.GFE.Description | string |
What the estimate is for. |
|
Amount
|
ClosingFeeEstimate.GFE.Amount | integer |
The amount of the estimate. |
|
LendersPremium
|
ClosingFeeEstimate.Premiums.LendersPremium | integer |
The lenders premium. |
|
FullLendersPremium
|
ClosingFeeEstimate.Premiums.FullLendersPremium | integer |
The full lenders premium. |
|
Timestamp
|
ClosingFeeEstimate.Timestamp | string |
The timestamp. |
Get Actions For Specific File
Gets all the actions on the specified file.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File ID
|
FileID | True | string |
File identification number. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Actions
|
Actions | array of object |
List of actions. |
|
FileActionID
|
Actions.FileActionID | integer |
The file action identification number. |
|
ActionTypeID
|
Actions.ActionType.ActionTypeID | integer |
The action type identification number. |
|
Name
|
Actions.ActionType.Name | string |
The name of the action. |
|
DisplayName
|
Actions.ActionType.DisplayName | string |
The display name. |
|
ActionGroupID
|
Actions.Group.ActionGroupID | integer |
The action group identification number. |
|
Name
|
Actions.Group.Name | string |
The name of the action. |
|
CoordinatorTypeID
|
Actions.StartTask.CoordinatorTypeID | integer |
The coordinator type identification number. |
|
DueDate
|
Actions.StartTask.DueDate | string |
The due date of the action. |
|
DueDateLocked
|
Actions.StartTask.DueDateLocked | boolean |
whether or not the due date is locked. |
|
DoneDate
|
Actions.StartTask.DoneDate | string |
The done date of the action. |
|
DoneDateLocked
|
Actions.StartTask.DoneDateLocked | boolean |
Whether or not the done date is locked. |
|
UserID
|
Actions.StartTask.DoneBy.UserID | integer |
The user identification number. |
|
Name
|
Actions.StartTask.DoneBy.Name | string |
The user name. |
|
CoordinatorTypeID
|
Actions.CompleteTask.CoordinatorTypeID | integer |
The coordinator type identification number. |
|
DueDate
|
Actions.CompleteTask.DueDate | string |
The due date of the action. |
|
DueDateLocked
|
Actions.CompleteTask.DueDateLocked | boolean |
Whether or not the due date is locked. |
|
DoneDateLocked
|
Actions.CompleteTask.DoneDateLocked | boolean |
Whether or not the done date is locked. |
|
UserID
|
Actions.CompleteTask.DoneBy.UserID | integer |
The user identification number. |
|
Name
|
Actions.CompleteTask.DoneBy.Name | string |
The name of the user. |
Get Closing Fee Estimate Receipt
Gets the closing fee estimate receipt.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Closing Fee ID
|
ClosingFeeID | True | string |
Closing fee identification number. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
EstimateDate
|
EstimateDate | string |
The date of the estimate. |
|
TransactionTypeID
|
Request.TransactionProductType.TransactionTypeID | integer |
The transaction type identification number. |
|
ProductTypeID
|
Request.TransactionProductType.ProductTypeID | integer |
The product type identification number. |
|
SettlementStatementVersion
|
Request.SettlementStatementVersion | string |
The settlement statement version. |
|
SalesPrice
|
Request.SalesPrice | integer |
The sales price. |
|
Loans
|
Request.Loans | array of object |
Information regarding the loans. |
|
LienPosition
|
Request.Loans.LienPosition | integer |
The lien position. |
|
LoanAmount
|
Request.Loans.LoanAmount | integer |
The loan amount. |
|
LoanType
|
Request.Loans.LoanType | string |
The loan type. |
|
Properties
|
Request.Properties | array of object |
Properties in the estimate. |
|
IsPrimary
|
Request.Properties.IsPrimary | boolean |
Whether or not this is the primary property. |
|
StreetNumber
|
Request.Properties.StreetNumber | string |
The street number. |
|
StreetName
|
Request.Properties.StreetName | string |
The street name. |
|
City
|
Request.Properties.City | string |
The city name. |
|
State
|
Request.Properties.State | string |
The two letter state abbreviation. |
|
County
|
Request.Properties.County | string |
The county name. |
|
Zip
|
Request.Properties.Zip | string |
The ZIP code. |
|
FilePartners
|
Request.FilePartners | array of object |
Partners on the file. |
|
PartnerTypeID
|
Request.FilePartners.PartnerTypeID | integer |
The partner type identification number. |
|
PartnerID
|
Request.FilePartners.PartnerID | integer |
The partner identification number. |
|
PartnerTypeID
|
Request.FilePartners.PartnerType.PartnerTypeID | integer |
The partner type identification number. |
|
Endorsements
|
Request.Endorsements | array of object |
The endorsements. |
|
Name
|
Request.Endorsements.Name | string |
Name of the endorsement. |
|
ClosingFeeEstimateID
|
Response.ClosingFeeEstimateID | integer |
The closing fee estimate identification number. |
|
HUDFees
|
Response.HUDFees | array of object |
The HUD fees. |
|
Amount
|
Response.HUDFees.Amount | integer |
The amount of the HUD fee. |
|
Description
|
Response.HUDFees.Description | string |
The description of the fee. |
|
LineNumber
|
Response.HUDFees.LineNumber | string |
The line number. |
|
BuyerAmount
|
Response.HUDFees.BuyerAmount | integer |
The buyer amount. |
|
BuyerPOCAmount
|
Response.HUDFees.BuyerPOCAmount | integer |
The buyer POC amount. |
|
SellerAmount
|
Response.HUDFees.SellerAmount | integer |
The seller amount. |
|
SellerPOCAmount
|
Response.HUDFees.SellerPOCAmount | integer |
The seller POC amount. |
|
OtherPOCAmount
|
Response.HUDFees.OtherPOCAmount | integer |
The other POC amount. |
|
PartnerTypeID
|
Response.HUDFees.OtherPOCPartnerType.PartnerTypeID | integer |
The partner type identification number. |
|
PartnerTypeName
|
Response.HUDFees.OtherPOCPartnerType.PartnerTypeName | string |
The partner type name. |
|
GFE
|
Response.GFE | array of object |
The good faith estimates. |
|
Description
|
Response.GFE.Description | string |
What the estimate is for. |
|
Amount
|
Response.GFE.Amount | integer |
The amount of the estimate. |
|
LendersPremium
|
Response.Premiums.LendersPremium | integer |
The lenders premium. |
|
FullLendersPremium
|
Response.Premiums.FullLendersPremium | integer |
The full lenders premium. |
|
Timestamp
|
Response.Timestamp | string |
The timestamp. |
Get Closing Fee Estimate Receipt PDF
Gets the closing fee estimate receipt in the pdf format.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Closing Fee ID
|
ClosingFeeID | True | string |
Closing fee identification number. |
Returns
- response
- object
Get Current User Info
Gets the information on the currently connected user.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Title
|
Title | string |
Title of the user. |
|
PasswordExpirationDate
|
PasswordExpirationDate | string |
The date the password will expire. |
|
UserID
|
UserID | integer |
The user identification number. |
|
Name
|
Name | string |
The name of the user. |
|
FirstName
|
FirstName | string |
The first name of the user. |
|
LastName
|
LastName | string |
The last name of the user. |
|
CellPhoneNumber
|
ContactInformation.CellPhoneNumber | string |
The cell phone number of the user. |
|
EmailAddress
|
ContactInformation.EmailAddress | string |
The email address of the user. |
|
PreferredCommunicationMethod
|
ContactInformation.PreferredCommunicationMethod | string |
The users preferred communication method. |
|
PhoneNumber
|
ContactInformation.PhoneNumber | string |
The phone number of the user. |
|
FaxNumber
|
ContactInformation.FaxNumber | string |
The fax number of the user. |
|
Website
|
ContactInformation.Website | string |
The website of the user. |
Get Custom Fields For Specific File
Gets the custom fields for the specified file.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File ID
|
FileID | True | string |
File identification number. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
CustomFields
|
CustomFields | array of object |
List of custom fields on the file. |
|
Name
|
CustomFields.Name | string |
The name of the custom field. |
|
Value
|
CustomFields.Value | string |
The value of the custom field. |
|
CustomFieldListCount
|
CustomFieldListCount | integer |
the number of custom fields on the file. |
Get Custom Fields On Specific Document
Get the custom fields on the specified document.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File ID
|
FileID | True | string |
File identification number. |
|
Document ID
|
DocumentID | True | string |
Document identification number. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
CustomFields
|
CustomFields | array of object |
the custom fields. |
|
Name
|
CustomFields.Name | string |
The name of the custom field. |
|
Value
|
CustomFields.Value | string |
The value of the custom field. |
|
CustomFieldListCount
|
CustomFieldListCount | integer |
The number of custom fields on the file. |
Get Document
Gets information on a document with the specified ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Document ID
|
DocumentID | True | string |
Document identification number. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
DocumentID
|
DocumentID | integer |
The document identification number. |
|
DocumentName
|
DocumentName | string |
The document name. |
|
DocumentTypeID
|
DocumentType.DocumentTypeID | integer |
The document type name. |
|
Name
|
DocumentType.Name | string |
The name of the document type. |
|
Description
|
Description | string |
The description of the document. |
|
InternalOnly
|
InternalOnly | boolean |
Whether or not the document is internal only. |
|
Approved
|
Approved | boolean |
Whether or not the document is approved. |
|
UserID
|
CreateUser.UserID | integer |
The user identification number. |
|
CreateDate
|
CreateDate | string |
The date the document was created. |
Get Documents For Specific File
Gets all information regarding the documents on the specified file.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File ID
|
FileID | True | string |
File identification number. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Documents
|
Documents | array of object |
List of documents on the file. |
|
DocumentID
|
Documents.DocumentID | integer |
The document identification number. |
|
DocumentName
|
Documents.DocumentName | string |
The document name. |
|
DocumentTypeID
|
Documents.DocumentType.DocumentTypeID | integer |
The document type identification number. |
|
Name
|
Documents.DocumentType.Name | string |
The name of the document type. |
|
Description
|
Documents.Description | string |
The description of the document. |
|
InternalOnly
|
Documents.InternalOnly | boolean |
Whether or not the document is internal only. |
|
Approved
|
Documents.Approved | boolean |
Whether or not the document is approved. |
|
AssociatedNotes
|
Documents.AssociatedNotes | array of object |
Notes associated with the document. |
|
NoteID
|
Documents.AssociatedNotes.NoteID | integer |
Note identification number. |
|
UserID
|
Documents.CreateUser.UserID | integer |
The user identification number. |
|
Name
|
Documents.CreateUser.Name | string |
The name of the user. |
|
CreateDate
|
Documents.CreateDate | string |
The date the document was created. |
|
UserID
|
Documents.ModifyUser.UserID | integer |
The user identification number. |
|
Name
|
Documents.ModifyUser.Name | string |
The name of the user. |
|
ModifyDate
|
Documents.ModifyDate | string |
The date the document was modified. |
Get Note
Gets the note with the specified ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Note ID
|
NoteID | True | string |
Note identification number. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
NoteID
|
NoteID | integer |
The note identification number. |
|
Subject
|
Subject | string |
The note subject. |
|
Body
|
Body | string |
The note body. |
|
UserID
|
CreatedBy.UserID | integer |
The user identification number. |
|
CreatedDate
|
CreatedDate | string |
The date the note was created. |
|
FileID
|
FileID | integer |
The file identification number. |
Get Notes For Specific File
Gets a list of the notes on the specified file.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File ID
|
FileID | True | string |
File identification number. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Notes
|
Notes | array of object |
The list of notes on the file. |
|
NoteID
|
Notes.NoteID | integer |
The note identification number. |
|
Subject
|
Notes.Subject | string |
The note subject. |
|
Body
|
Notes.Body | string |
The note body. |
|
UserID
|
Notes.CreatedBy.UserID | integer |
The user identification number. |
|
Name
|
Notes.CreatedBy.Name | string |
The full name of the user. |
|
FirstName
|
Notes.CreatedBy.FirstName | string |
The first name of the user. |
|
LastName
|
Notes.CreatedBy.LastName | string |
The last name of the user. |
|
PhoneNumber
|
Notes.CreatedBy.ContactInformation.PhoneNumber | string |
The users phone number. |
|
EmailAddress
|
Notes.CreatedBy.ContactInformation.EmailAddress | string |
The users email address. |
|
CreatedDate
|
Notes.CreatedDate | string |
The date the note was created. |
|
FileID
|
Notes.FileID | integer |
The file identification number. |
|
Expedite
|
Notes.Expedite | boolean |
Whether or not the note was expedited. |
Get Parties For Specific File
Gets a list of the parties and their information on the specified file.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File ID
|
FileID | True | string |
File identification number. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Buyers
|
Buyers | array of object |
Information regarding the buyers. |
|
LegalEntityID
|
Buyers.LegalEntityID | integer |
The legal entity identification number. |
|
EntityType
|
Buyers.EntityType | string |
The name of the entity type. |
|
Prefix
|
Buyers.Primary.Prefix | string |
Prefix of the buyer. |
|
First
|
Buyers.Primary.First | string |
First name of the buyer. |
|
Middle
|
Buyers.Primary.Middle | string |
Middle name of the buyer. |
|
Last
|
Buyers.Primary.Last | string |
Last name of the buyer. |
|
Suffix
|
Buyers.Primary.Suffix | string |
Suffix of the buyer. |
|
Prefix
|
Buyers.Secondary.Prefix | string |
Prefix of the secondary buyer. |
|
First
|
Buyers.Secondary.First | string |
First name of the secondary buyer. |
|
Middle
|
Buyers.Secondary.Middle | string |
Middle name of the secondary buyer. |
|
Last
|
Buyers.Secondary.Last | string |
Last name of the secondary buyer. |
|
UsePropertyAddress
|
Buyers.UsePropertyAddress | boolean |
Whether or not to use the address. |
|
Address1
|
Buyers.Address.Address1 | string |
The street number and name. |
|
City
|
Buyers.Address.City | string |
The city name. |
|
State
|
Buyers.Address.State | string |
The two letter state abbreviation. |
|
Zip
|
Buyers.Address.Zip | string |
The ZIP code. |
|
MaritalStatus
|
Buyers.MaritalStatus | string |
The marital status of the party. |
|
Email
|
Buyers.Email | string |
The email address of the party. |
|
HomePhone
|
Buyers.HomePhone | string |
The home phone number of the party. |
|
EmailSecondary
|
Buyers.EmailSecondary | string |
The email address of the secondary party. |
|
Sellers
|
Sellers | array of object |
Information regarding the sellers. |
|
LegalEntityID
|
Sellers.LegalEntityID | integer |
The legal entity identification number. |
|
EntityType
|
Sellers.EntityType | string |
The entity type. |
|
BusinessName
|
Sellers.Primary.BusinessName | string |
The business name. |
|
UsePropertyAddress
|
Sellers.UsePropertyAddress | boolean |
Whether or not to use the address. |
|
Address1
|
Sellers.Address.Address1 | string |
The street number and name. |
|
City
|
Sellers.Address.City | string |
The city name. |
|
State
|
Sellers.Address.State | string |
The two letter state abbreviation. |
|
Zip
|
Sellers.Address.Zip | string |
The ZIP code. |
|
MaritalStatus
|
Sellers.MaritalStatus | string |
The marital status of the party. |
|
Email
|
Sellers.Email | string |
The email address of the party. |
|
Customers
|
Customers | array of string |
Information regarding the customers. |
Get Partner Information
Gets information on a partner with the specified ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Partner Company ID
|
PartnerCompanyID | True | string |
Partner company identification number. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
PartnerCompanyID
|
PartnerCompanyID | integer |
The partner company identification number. |
|
PartnerTypes
|
PartnerTypes | array of object |
Information regarding the partner type. |
|
PartnerTypeID
|
PartnerTypes.PartnerTypeID | integer |
The partner type identification number. |
|
PartnerTypeName
|
PartnerTypes.PartnerTypeName | string |
The partner type name. |
|
OfficeID
|
OfficeID | integer |
The office identification number. |
|
PartnerName
|
PartnerName | string |
The partner name. |
|
CompanyAbbreviation
|
CompanyAbbreviation | string |
The company abbreviation. |
|
ProperCompanyName
|
ProperCompanyName | string |
The full company name. |
|
Address1
|
MailingAddress.Address1 | string |
The street number and name. |
|
Address2
|
MailingAddress.Address2 | string |
Further address information. |
|
City
|
MailingAddress.City | string |
The city name. |
|
State
|
MailingAddress.State | string |
The two letter state abbreviation. |
|
Zip
|
MailingAddress.Zip | string |
The ZIP code. |
|
PhoneNumber
|
ContactInformation.PhoneNumber | string |
The partner phone number. |
|
HomePhoneNumber
|
ContactInformation.HomePhoneNumber | string |
The partner home phone number. |
|
CellPhoneNumber
|
ContactInformation.CellPhoneNumber | string |
The partner cell phone number. |
|
Voicemail
|
ContactInformation.Voicemail | string |
The partner voicemail number. |
|
FaxNumber
|
ContactInformation.FaxNumber | string |
The partner fax number. |
|
EmailAddress
|
ContactInformation.EmailAddress | string |
The partner email address. |
|
PreferredCommunicationMethod
|
ContactInformation.PreferredCommunicationMethod | string |
The partners preferred way of communication. |
|
Website
|
ContactInformation.Website | string |
The partner website URL. |
|
ID
|
CompanyInformation.ParentCompany.ID | integer |
The identification number. |
|
Name
|
CompanyInformation.ParentCompany.Name | string |
The parent company name. |
|
ID
|
CompanyInformation.PartnerEntity.ID | integer |
The identification number. |
|
name
|
CompanyInformation.PartnerEntity.name | string |
The partner entity name. |
|
IsBillable
|
CompanyInformation.IsBillable | boolean |
Whether or not the partner is billable. |
|
IsInvoiceable
|
CompanyInformation.IsInvoiceable | boolean |
Whether or not the property is invoiceable. |
|
TaxID
|
CompanyInformation.TaxID | string |
The partner tax identification number. |
|
AccountingCode
|
CompanyInformation.AccountingCode | string |
The accounting code. |
|
CommentsSpecialInstructions
|
CompanyInformation.CommentsSpecialInstructions | string |
Comments on the partner. |
|
DontAllowSelectionInSettlement
|
CompanyInformation.DontAllowSelectionInSettlement | boolean |
Whether or not to allow selection in settlement. |
|
Needs1099
|
CompanyInformation.Needs1099 | boolean |
Whether or not a 1099 is required. |
|
MWBE
|
CompanyInformation.MWBE | boolean |
Whether or not the partner is a MWBE? |
|
SendDocumentsAsWebLinks
|
SendDocumentsAsWebLinks | boolean |
Whether or not to send the documents as web links. |
|
WireConfirmationEmailTemplateID
|
WireConfirmationEmailTemplateID | integer |
The wire confirmation template identification number. |
|
UseOnDisbursements
|
CourierAddress.UseOnDisbursements | boolean |
Whether or not this is to be used on disbursements. |
|
Address1
|
CourierAddress.Address1 | string |
The street number and name. |
|
Address2
|
CourierAddress.Address2 | string |
Further address information. |
|
City
|
CourierAddress.City | string |
The city name. |
|
State
|
CourierAddress.State | string |
The two letter state abbreviation. |
|
Zip
|
CourierAddress.Zip | string |
The ZIP code. |
Get Partners For Specific File
Gets a list of partners and their information on the specified file.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File ID
|
FileID | True | string |
File identification number. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Partners
|
Partners | array of object |
Information regarding the partners. |
|
UserID
|
Partners.PrimaryEmployee.UserID | integer |
The user identification number. |
|
Name
|
Partners.PrimaryEmployee.Name | string |
The full name of the employee. |
|
FirstName
|
Partners.PrimaryEmployee.FirstName | string |
The first name of the employee. |
|
LastName
|
Partners.PrimaryEmployee.LastName | string |
The last name of the employee. |
|
PhoneNumber
|
Partners.PrimaryEmployee.ContactInformation.PhoneNumber | string |
The phone number of the employee. |
|
EmailAddress
|
Partners.PrimaryEmployee.ContactInformation.EmailAddress | string |
The email address of the employee. |
|
PartnerTypeID
|
Partners.PartnerTypeID | integer |
The partner type identification number. |
|
PartnerID
|
Partners.PartnerID | integer |
The partner identification number. |
|
PartnerTypeID
|
Partners.PartnerType.PartnerTypeID | integer |
The partner type identification number. |
|
PartnerTypeName
|
Partners.PartnerType.PartnerTypeName | string |
The partner type name. |
|
PartnerName
|
Partners.PartnerName | string |
The partner name. |
Get Transaction And Product Types For Estimation And Order Placement
Get transaction types and product types for fee estimation and placing orders.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
State
|
State | string |
State of estimated property location. |
|
|
County
|
County | string |
County of estimated property location. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
TransactionType
|
TransactionType | string |
The transaction type. |
|
TransactionTypeID
|
TransactionTypeID | integer |
The transaction type identification number. |
|
ProductType
|
ProductType | string |
The product type. |
|
ProductTypeID
|
ProductTypeID | integer |
The product type identification number. |
|
AncillaryProducts
|
AncillaryProducts | array of object |
The ancillary products. |
|
Name
|
AncillaryProducts.Name | string |
The name of the ancillary product. |
|
ID
|
AncillaryProducts.ID | integer |
The identification number of the product. |
|
Options
|
AncillaryProducts.Options | array of object |
The options. |
|
ID
|
AncillaryProducts.Options.ID | integer |
The identification number of the option. |
|
Name
|
AncillaryProducts.Options.Name | string |
The name of the option. |
|
AddOnProducts
|
AddOnProducts | array of object |
The added on products. |
|
TransactionType
|
AddOnProducts.TransactionType | string |
The transaction type. |
|
TransactionTypeID
|
AddOnProducts.TransactionTypeID | integer |
The transaction type identification number. |
|
ProductType
|
AddOnProducts.ProductType | string |
The product type. |
|
ProductTypeID
|
AddOnProducts.ProductTypeID | integer |
The product type identification number. |
Gets Files From Given Search Criteria
Gets a list of files and their information based on the given search criteria.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
FileNumber
|
FileNumber | string |
The file number. |
|
|
FileID
|
FileID | integer |
The file identification number. |
|
|
OfficeID
|
OfficeID | integer |
The office identification number. |
|
|
ClientsFileNumber
|
ClientsFileNumber | string |
The clients file number. |
|
|
TransactionTypeID
|
TransactionTypeID | integer |
The transaction type identification number. |
|
|
ProductTypeID
|
ProductTypeID | integer |
The product type identification number. |
|
|
StatusID
|
StatusID | integer |
The status identification number. |
|
|
Name
|
Name | string |
The name of the status. |
|
|
PolicyNumber
|
PolicyNumber | string |
The policy number. |
|
|
SearchNumber
|
SearchNumber | string |
The search number. |
|
|
LoanNumber
|
LoanNumber | string |
The loan number. |
|
|
IsPrimary
|
IsPrimary | boolean |
Whether or not this is the primary property address. |
|
|
StreetNumber
|
StreetNumber | string |
The street number. |
|
|
StreetName
|
StreetName | string |
The street name. |
|
|
City
|
City | string |
The city name. |
|
|
State
|
State | string |
The two letter state abbreviation. |
|
|
Zip
|
Zip | string |
The ZIP code. |
|
|
Subdivision
|
Subdivision | string |
The subdivision the property is located in. |
|
|
ParcelID
|
ParcelID | string |
The parcel identification number. |
|
|
EntityType
|
EntityType | string |
The entity type. |
|
|
First
|
First | string |
The first name of the party. |
|
|
Last
|
Last | string |
The last name of the party. |
|
|
UsePropertyAddress
|
UsePropertyAddress | boolean |
Whether or not this is the primary property address. |
|
|
MaritalStatus
|
MaritalStatus | string |
The marital status of the party. |
|
|
UserID
|
UserID | integer |
The user identification number. |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
The partner type identification number. |
|
|
PartnerID
|
PartnerID | integer |
The partner identification number. |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
The partner type identification number. |
|
|
OpenedFromDate
|
OpenedFromDate | string |
The date the file was opened. |
|
|
OpenedToDate
|
OpenedToDate | string |
The date the file was closed. |
Returns
- response
- object
Update Action For File
Updates an action for a given file. Can update the Action Group ID and start/complete Coordinator Type ID, Partner Type ID, Due Date, Due Date Locked and Done Date Locked. This API call cannot be used to mark an action as started or completed.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File ID
|
FileID | True | string |
File identification number. |
|
File Action ID
|
FileActionID | True | string |
Identification number of the action. |
|
CoordinatorTypeID
|
CoordinatorTypeID | integer |
The coordinator type identification number. |
|
|
DueDate
|
DueDate | string |
The due date of the action. |
|
|
DoneDateLocked
|
DoneDateLocked | boolean |
Whether or not the done date is locked. |
|
|
CoordinatorTypeID
|
CoordinatorTypeID | integer |
The coordinator type identification number. |
|
|
DueDate
|
DueDate | string |
The due date of the action. |
|
|
DoneDateLocked
|
DoneDateLocked | boolean |
Whether or not the done date is locked. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
FileActionID
|
FileActionID | integer |
The identification number of the action. |
Update Partner Employee
Updates the information of a partner employee.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
User ID
|
UserID | True | string |
User identification number. |
|
Partner Company ID
|
PartnerCompanyID | True | string |
Partner company identification number. |
|
Password
|
Password | string |
The employees password. |
|
|
PasswordExpirationDate
|
PasswordExpirationDate | string |
The date the password will expire. |
|
|
RoleID
|
RoleID | integer |
The role identification number. |
|
|
Name
|
Name | string |
The name of the role. |
|
|
Enabled
|
Enabled | boolean |
Whether or not the employee has been enabled for use. |
|
|
WebsiteAccess
|
WebsiteAccess | boolean |
Whether or not the employee has website access. |
|
|
Name
|
Name | string |
The full name of the employee. |
|
|
FirstName
|
FirstName | string |
The first name of the employee. |
|
|
LastName
|
LastName | string |
The last name of the employee. |
|
|
EmailAddress
|
EmailAddress | string |
The email address of the employee. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
PartnerCompanyID
|
Employee.PartnerCompanyID | integer |
The partner company identification number. |
|
Roles
|
Employee.Roles | array of object |
Roles of the employee. |
|
RoleID
|
Employee.Roles.RoleID | integer |
The role identification number. |
|
Name
|
Employee.Roles.Name | string |
The name of the role. |
|
Enabled
|
Employee.Enabled | boolean |
Whether or not the employee has been enabled for use. |
|
WebsiteAccess
|
Employee.WebsiteAccess | boolean |
Whether or not the employee has website access. |
|
UserID
|
Employee.UserID | integer |
The user identification number. |
|
Name
|
Employee.Name | string |
The full name of the employee. |
|
FirstName
|
Employee.FirstName | string |
The first name of the employee. |
|
LastName
|
Employee.LastName | string |
The last name of the employee. |
|
EmailAddress
|
Employee.ContactInformation.EmailAddress | string |
The email address of the employee. |
Update Partner Information For Specific File
Updates the partner information on the specified file.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File ID
|
FileID | True | string |
File identification number. |
|
Partner ID
|
PartnerID | True | string |
Partner identification number. |
|
FileID
|
FileID | integer |
The file identification number. |
|
|
UserID
|
UserID | integer |
The user identification number. |
|
|
Name
|
Name | string |
The full name of the employee. |
|
|
FirstName
|
FirstName | string |
The first name of the employee. |
|
|
LastName
|
LastName | string |
The last name of the employee. |
|
|
PhoneNumber
|
PhoneNumber | string |
The phone number of the employee. |
|
|
HomePhoneNumber
|
HomePhoneNumber | string |
The home phone number of the employee. |
|
|
CellPhoneNumber
|
CellPhoneNumber | string |
The cell phone number of the employee. |
|
|
Voicemail
|
Voicemail | string |
The voicemail of the employee. |
|
|
FaxNumber
|
FaxNumber | string |
The fax number of the employee. |
|
|
EmailAddress
|
EmailAddress | string |
The email address of the employee. |
|
|
PreferredCommunicationMethod
|
PreferredCommunicationMethod | string |
The employees preferred communication method. |
|
|
Website
|
Website | string |
The web link of the employee. |
|
|
UserID
|
UserID | integer |
The user identification number. |
|
|
Name
|
Name | string |
The full name of the secondary employee. |
|
|
FirstName
|
FirstName | string |
The first name of the secondary employee. |
|
|
LastName
|
LastName | string |
The last name of the secondary employee. |
|
|
PhoneNumber
|
PhoneNumber | string |
The phone number of the secondary employee. |
|
|
HomePhoneNumber
|
HomePhoneNumber | string |
The home phone number of the secondary employee. |
|
|
CellPhoneNumber
|
CellPhoneNumber | string |
The cell phone number of the secondary employee. |
|
|
Voicemail
|
Voicemail | string |
The voicemail of the secondary employee. |
|
|
FaxNumber
|
FaxNumber | string |
The fax number of the secondary employee. |
|
|
EmailAddress
|
EmailAddress | string |
The email address of the secondary employee. |
|
|
PreferredCommunicationMethod
|
PreferredCommunicationMethod | string |
The secondary employees preferred communication method. |
|
|
Website
|
Website | string |
The web link of the secondary employee. |
|
|
ReferenceNumber
|
ReferenceNumber | string |
The reference number. |
|
|
RemoteFileNumber
|
RemoteFileNumber | string |
The remote file number. |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
The partner type identification number. |
|
|
PartnerID
|
PartnerID | integer |
The partner identification number. |
|
|
PartnerTypeID
|
PartnerTypeID | integer |
The partner type identification number. |
|
|
PartnerTypeName
|
PartnerTypeName | string |
The partner type name. |
|
|
OfficeID
|
OfficeID | integer |
The office identification number. |
|
|
PartnerName
|
PartnerName | string |
The partner name. |
|
|
Address1
|
Address1 | string |
The street number and name. |
|
|
Address2
|
Address2 | string |
Further address information. |
|
|
City
|
City | string |
The city name. |
|
|
State
|
State | string |
The two letter state abbreviation. |
|
|
Zip
|
Zip | string |
The ZIP code. |
|
|
PhoneNumber
|
PhoneNumber | string |
The partner phone number. |
|
|
HomePhoneNumber
|
HomePhoneNumber | string |
The partner home phone number. |
|
|
CellPhoneNumber
|
CellPhoneNumber | string |
The partner cell phone number. |
|
|
Voicemail
|
Voicemail | string |
The partner voicemail number. |
|
|
FaxNumber
|
FaxNumber | string |
The partner fax number. |
|
|
EmailAddress
|
EmailAddress | string |
The partner email address. |
|
|
PreferredCommunicationMethod
|
PreferredCommunicationMethod | string |
The partners preferred way of communication. |
|
|
Website
|
Website | string |
The partner website URL. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
FileID
|
FileID | integer |
The file identification number. |
|
FileNumber
|
FileNumber | string |
The file number |
|
UserID
|
PrimaryEmployee.UserID | integer |
The user identification number. |
|
Name
|
PrimaryEmployee.Name | string |
The full name of the employee. |
|
FirstName
|
PrimaryEmployee.FirstName | string |
The first name of the employee. |
|
LastName
|
PrimaryEmployee.LastName | string |
The last name of the employee. |
|
PhoneNumber
|
PrimaryEmployee.ContactInformation.PhoneNumber | string |
The phone number of the employee. |
|
HomePhoneNumber
|
PrimaryEmployee.ContactInformation.HomePhoneNumber | string |
The home phone number of the employee. |
|
CellPhoneNumber
|
PrimaryEmployee.ContactInformation.CellPhoneNumber | string |
The cell phone number of the employee. |
|
Voicemail
|
PrimaryEmployee.ContactInformation.Voicemail | string |
The voicemail of the employee. |
|
FaxNumber
|
PrimaryEmployee.ContactInformation.FaxNumber | string |
The fax number of the employee. |
|
EmailAddress
|
PrimaryEmployee.ContactInformation.EmailAddress | string |
The email address of the employee. |
|
PreferredCommunicationMethod
|
PrimaryEmployee.ContactInformation.PreferredCommunicationMethod | string |
The employees preferred communication method. |
|
Website
|
PrimaryEmployee.ContactInformation.Website | string |
The web link of the employee. |
|
SecondaryEmployees
|
SecondaryEmployees | array of object |
Information regarding the secondary employee. |
|
UserID
|
SecondaryEmployees.UserID | integer |
The user identification number. |
|
Name
|
SecondaryEmployees.Name | string |
The full name of the secondary employee. |
|
FirstName
|
SecondaryEmployees.FirstName | string |
The first name of the secondary employee. |
|
LastName
|
SecondaryEmployees.LastName | string |
The last name of the secondary employee. |
|
PhoneNumber
|
SecondaryEmployees.ContactInformation.PhoneNumber | string |
The phone number of the secondary employee. |
|
HomePhoneNumber
|
SecondaryEmployees.ContactInformation.HomePhoneNumber | string |
The home phone number of the secondary employee. |
|
CellPhoneNumber
|
SecondaryEmployees.ContactInformation.CellPhoneNumber | string |
The cell phone number of the secondary employee. |
|
Voicemail
|
SecondaryEmployees.ContactInformation.Voicemail | string |
The voicemail of the secondary employee. |
|
FaxNumber
|
SecondaryEmployees.ContactInformation.FaxNumber | string |
The fax number of the secondary employee. |
|
EmailAddress
|
SecondaryEmployees.ContactInformation.EmailAddress | string |
The email address of the secondary employee. |
|
PreferredCommunicationMethod
|
SecondaryEmployees.ContactInformation.PreferredCommunicationMethod | string |
The secondary employees preferred communication method. |
|
Website
|
SecondaryEmployees.ContactInformation.Website | string |
The web link of the secondary employee. |
|
ReferenceNumber
|
ReferenceNumber | string |
The reference number. |
|
RemoteFileNumber
|
RemoteFileNumber | string |
The remote file number. |
|
PartnerTypeID
|
PartnerTypeID | integer |
The partner type identification number. |
|
PartnerID
|
PartnerID | integer |
The partner identification number. |
|
PartnerTypeID
|
PartnerType.PartnerTypeID | integer |
The partner type identification number. |
|
PartnerTypeName
|
PartnerType.PartnerTypeName | string |
The partner type name. |
|
OfficeID
|
OfficeID | integer |
The office identification number. |
|
PartnerName
|
PartnerName | string |
The partner name. |
|
Address1
|
MailingAddress.Address1 | string |
The street number and name. |
|
Address2
|
MailingAddress.Address2 | string |
Further address information. |
|
City
|
MailingAddress.City | string |
The city name. |
|
State
|
MailingAddress.State | string |
The two letter state abbreviation. |
|
Zip
|
MailingAddress.Zip | string |
The ZIP code. |
|
PhoneNumber
|
ContactInformation.PhoneNumber | string |
The partner phone number. |
|
HomePhoneNumber
|
ContactInformation.HomePhoneNumber | string |
The partner home phone number. |
|
CellPhoneNumber
|
ContactInformation.CellPhoneNumber | string |
The partner cell phone number. |
|
Voicemail
|
ContactInformation.Voicemail | string |
The partner voicemail number. |
|
FaxNumber
|
ContactInformation.FaxNumber | string |
The partner fax number. |
|
EmailAddress
|
ContactInformation.EmailAddress | string |
The partner email address. |
|
PreferredCommunicationMethod
|
ContactInformation.PreferredCommunicationMethod | string |
The partners preferred way of communication. |
|
Website
|
ContactInformation.Website | string |
The partner website URL. |
Upload Web URL Document To Specific File
Loads the Web URL document on the specified file.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File ID
|
FileID | True | string |
File identification number. |
|
DocumentName
|
DocumentName | string |
The document name. |
|
|
DocumentTypeID
|
DocumentTypeID | integer |
The document type identification number. |
|
|
Description
|
Description | string |
The description of the document. |
|
|
InternalOnly
|
InternalOnly | boolean |
Whether or not the document is internal only. |
|
|
WebURL
|
WebURL | string |
The web URL of the document. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
DocumentID
|
Document.DocumentID | integer |
The document identification number. |
Definitions
object
This is the type 'object'.