Skip to main content
Mitratech Success Center

API Reference Summary

This section provides the following information per repository (Web Service interface):
  • A table of requests
  • A table of required fields to create a record with the repository
  • A table of related data objects (record property containers)

Note: There are some remaining data objects (for example, related to search criteria), that are currently not documented in this section.

AccountRepository

AccountRepository Requests Summary

Request

Description

activateAccount

Activates an account.

allocateMoney

Deposits funds to an account.

deactivateAccount

Deactivates an account.

deleteAccount

Deletes an account record.

insertAccount

Creates an account record.

readAccount

Reads and returns an account record. Specified account properties are returned with the record.

readAccountsByCriteria

Searches for account records that meet a given search criteria. Specified account properties are returned with the resulting records.

readChildAccounts

Reads child account records of a given parent account.

readRecentlyViewedAccounts

Reads and returns recently viewed account records.

transferMoney

Transfers funds between accounts.

updateAccount

Updates an existing account with the specified properties.

withdrawMoney

Withdraws funds from an account.

AccountRepository Data Objects Summary

Data Object

Description

  1. account
  2. accountCreate
  3. accountUpdate
  1. Account record property container returned when you read or search accounts.
  2. Account record property container used to set a new account's properties. This object is passed as a request parameter when you create (insert) an account.
  3. Account record property container used to update or clear an account's properties. This object is passed as a request parameter when you update an account.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the TAccount object.

accountType

An enumeration used to set the account type. Options include:

  • BUDGET
  • RESERVE

accountOverdraftType

An enumeration used to set the account overdraft type. Options include:

  • NON_NEGATIVE
  • ALLOW_NEGATIVE
  • OVERDRAFT

accountInvolvedType

An enumeration used to set restrictions on the posting criteria for an account. The effect of this enumeration's value depends on other account posting criteria you have set in either the accountCreate or accountUpdate properties.

If posting criteria is applied to tasks or expenses, use this enumeration to restrict account posting by the task/expense's associated contact. If posting criteria is applied to invoice line items, use this enumeration to restrict account posting by the line item's associated timekeeper.

Options include:

  • ANY_INVOLVED
  • ONE_INVOLVED

accountProjectType

An enumeration used to set restrictions on the posting criteria for an account. The effect of this enumeration's value depends on other account posting criteria you have set in either the accountCreate or accountUpdate properties.

Use this enumeration to restrict account posting by the task/ expense/invoice line item's associated project.

Options include:

  • ANY_PROJECT
  • ONE_PROJECT
  • BY_TYPE

accountVendorType

An enumeration used to set restrictions on the posting criteria for an account. The effect of this enumeration's value depends on other account posting criteria you have set in either the accountCreate or accountUpdate properties.

Use this enumeration to restrict account posting by the invoice line item's associated vendor.

Options include:

  • ANY_VENDOR
  • ONE_VENDOR

AppointmentRepository

AppointmentRepository Requests Summary

Request

Description

insertAppointment

Saves a new appointment to the repository.

updateAppointment

Updates a previously saved appointment.

readAppointment

Retrieves a appointment from the repository based on a unique key. For a list of available properties, see the type class, appointment.

readAppointmentsByCriteria

Retrieves a set of appointments based on specified criteria. If the criteria is empty, then the search will be for all appointments. The specified limit takes precedence over the current system setting for the maximum number of search results to obtain. For a list of available properties, see the type class, appointment.

deleteAppointment

Deletes the appointment specified by the unique key.

readRecentlyViewedAppointments

Read and return recently reviewed appointments.

AppointmentRepository Data Objects Summary

Data Object

Description

  1. appointment
  2. appointmentCreate
  3. appointmentUpdate
  1. Appointment record property container returned when you read or search appointments. When defining a repository search's return properties, refer to the property names defined in this object.
  2. Appointment record property container used to set a new appointment's properties. This object is passed as a request parameter when you create (insert) an appointment.
  3. Appointment record property container used to update or clear an appointment's properties. This object is passed as a request parameter when you update an appointment.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the TAppointment object.

  1. appointmentResource
  2. appointmentResourceCr eate
  3. appointmentResourceU pdate
  1. Appointment resource object property container returned when you read or search appointment resources.
  2. Appointment resource object property container used to set a new appointment resource's properties.
  3. Appointment resource object property container used to update or clear an appointment resource's properties.

appointmentResourceType

Subclass of lookupItem. Use the provided get methods to read an appointment resource's associated type.

lookupItem

Abstract class that provides get methods to read properties associated with TeamConnect system lookup table items.

  1. attendee
  2. attendeeCreate
  3. attendeeUpdate
  1. Attendee object property container returned when you read or search attendees.
  2. Attendee object property container used to set a new attendee's properties.
  3. Attendee object property container used to update or clear an attendee's properties.

attendanceType

An enumeration used to indicate an attendee's plans to attend an appointment.

Options include:

  • WILL_ATTEND
  • TENTATIVE
  • WILL_NOT_ATTEND
  • UNKNOWN

ContactRepository

ContactRepository Requests Summary

Request

Description

deleteContact

Deletes the contact specified by the unique key.

insertContact

Saves a new Contact object to the repository.

readContact

Retrieves a Contact from the repository based on a unique key. For a list of available properties, see the type class, contact.

readContactsByCriteria

Retrieves a set of contacts based on specified criteria. If the criteria is empty, then the search will be for all contacts. The specified limit takes precedence over the current system setting for the maximum number of search results to obtain. For a list of available properties, see the type class, contact.

ReadRecentlyViewedContacts

Retrieve a list of recently viewed contacts.

updateContact

Updates a previously saved contact.

ContactRepository Data Objects Summary

Data Object

Description

  1. Company
  2. CompanyCreate
  3. CompanyUpdate

All three objects are subclasses of the related Contact objects. The Company objects are used to work with contact records of type, Company.

  1. Company contact record property container returned when you read or search companies. When defining a repository search's return properties, refer to the property names defined in this object.
  2. Company contact record property container used to set a new company's properties. This object is passed as a request parameter when you create (insert) a company.
  3. Company contact record property container used to update or clear a company's properties. This object is passed as a request parameter when you update a company.

Note: CompanyCreate is a subclass of ContactCreate. CompanyUpdate is a subclass of ContactUpdate.

NoteFor more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the TContact object.

  1. Person
  2. PersonCreate
  3. PersonUpdate

All three objects are subclasses of the related Contact objects. The Person objects are used to work with contact records of type, Person.

  1. Person contact record property container returned when you read or search person contacts. When defining a repository search's return properties, refer to the property names defined in this object.
  2. Person contact record property container used to set a new person contact's properties. This object is passed as a request parameter when you create (insert) a person contact.
  3. Person contact record property container used to update or clear a person contact's properties. This object is passed as a request parameter when you update a person contact.

Note: PersonCreate is a subclass of ContactCreate. PersonUpdate is a subclass of ContactUpdate.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the TContact object.

  1. ContAddress
  2. ContAddressCreate
  3. ContAddressUpdate

All three objects are used to work with contact mailing addresses within contact records.

  1. Contact address object property container returned when you read or search contacts, including the ContAddress property.
  2. Contact address object property container used to set properties for a contact address.
  3. Contact address object property container used to update or clear properties for a contact address.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JContAddress object.

contAddressType

Subclass of lookupItem. Use the provided get methods to read the properties related to a contact address type.

countryItem

Subclass of lookupItem. Use the provided get methods to read the properties related to a contact address country.

  1. ContEmailAddress
  2. ContEmailAddressCrea te
  3. ContEmailAddressUpd ate

All three objects are used to work with contact email addresses within contact records.

  1. Contact email address object property container returned when you read or search contact email addresses.
  2. Contact email address object property container used to set properties for a contact email address.
  3. Contact email address object property container used to update or clear properties for a contact email address.

NoteFor more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JContEmail object.

contEmailAddressType

Subclass of lookupItem. Use the provided get methods to read the properties related to a contact email address' associated type.

  1. ContFaxNumber
  2. ContFaxNumberCreate
  3. ContFaxNumberUpdate

All three objects are used to work with contact fax numbers within contact records.

  1. Contact fax number object property container returned when you read or search contact fax numbers.
  2. Contact fax number object property container used to set properties for a new contact fax number.
  3. Contact fax number object property container used to update or clear properties for a contact fax number.

NoteFor more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JContFax object.

contFaxNumberType

Subclass of lookupItem. Use the provided get methods to read the properties related to a contact fax number's associated type.

  1. ContInetAddress
  2. ContInetAddressCreate
  3. ContInetAddressUpdate

All three objects are used to work with contact internet addresses (website URL's) within contact records.

  1. Contact internet address object property container returned when you read or search contact internet addresses.
  2. Contact internet address object property container used to set properties for a new contact internet address.
  3. Contact internet address object property container used to update or clear properties for a contact internet address.

NoteFor more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JContInetAddress object.

contInetAddressType

Subclass of lookupItem. Use the provided get methods to read the properties related to a contact email address' associated type.

  1. ContPhoneNumber
  2. ContPhoneNumberCre ate
  3. ContPhoneNumberUpd ate

All three objects are used to work with contact phone numbers within contact records.

  1. Contact phone number object property container returned when you read or search contact phone numbers.
  2. Contact phone number object property container used to set properties for a new contact phone number.
  3. Contact phone number object property container used to update or clear properties for a contact phone number.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JContPhone object.

contPhoneNumberType

Subclass of lookupItem. Use the provided get methods to read the properties related to a contact phone number's associated type.

  1. ContDefaultRate
  2. ContDefaultRateCreate
  3. ContDefaultRateUpdate

All three objects are used to work with contact default rates within contact records.

  1. Contact default rate object property container returned when you read or search contact default rates.
  2. Contact default rate object property container used to set properties for a new contact default rate.
  3. Contact default rate object property container used to update or clear properties for a contact default rate.

NoteFor more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JContRate object.

  1. contTaskRate
  2. contTaskRateCreate
  3. contTaskRateUpdate

All three objects are used to work with contact task rates within contact records.

  1. Contact task rate object property container returned when you read or search contacts.
  2. Container used to set properties for contact invoice task rates.
  3. Contact rate object property container used to update or clear properties for contact invoice task rates.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JContRate object.

  1. contInvoiceTaskRate
  2. contInvoiceTaskRateCreate
  3. contInvoiceTaskRateUp date

All three objects are used to work with contact invoice task rates within contact records.

  1. Contact invoice task rate object property container returned when you read or search contacts.
  2. Container used to set properties for contact invoice task rates.
  3. Contact rate object property container used to update or clear properties for contact invoice task rates.

NoteFor more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JContRate object.

  1. contDefaultRate
  2. contDefaultRateCreate
  3. contDefaultRateUpdate

All three objects are used to work with default contact rates within contact records.

  1. Default contact rate object property container returned when you read or search contacts.
  2. Default contact rate object property container used to set properties for a default contact rate.
  3. Default contact rate object property container used to update or clear properties for a default contact rate.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JContRate object.

currencyItem

Subclass of lookupItem. This class corresponds to the TeamConnect Multi-currency lookup table's items.

Use the provided get methods to read the properties related to either a contact rate's currency or invoice currency.

The currencyItem name property corresponds to the TeamConnect multi-currency lookup table Currency code.

The currencyItem name property

  1. ContRelation
  2. ContRelationCreate
  3. ContRelationUpdate

All three objects are used to work with contact relations within contact records.

  1. Contact relation object property container returned when you read or search contact relations.
  2. Contact relation object property container used to set properties for a new contact relation.
  3. Contact relation object property container used to update or clear properties for a contact relation.

NoteFor more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JContRelation object.

contRelationType

Subclass of lookupItem. Use the provided get methods to read the properties related to a contact relation's associated type.

relationDirection

An enumeration used to identify the direction between two relations. Options include:

  • FROM_THIS
  • TO_THIS
  1. ContSkill
  2. ContSkillCreate
  3. ContSkillUpdate

All three objects are used to work with contact skills within contact records.

  1. Contact skill object property container returned when you read or search contact skills.
  2. Contact skill object property container used to set properties for a new contact skill.
  3. Contact skill object property container used to update or clear properties for a contact skill.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JContSkill object.

contSkillType

Subclass of lookupItem. Use the provided get methods to read the properties related to a contact skill's associated type.

  1. ContTerritory
  2. ContTerritoryCreate
  3. ContTerritoryUpdate

All three objects are used to work with contact territories within contact records.

  1. Contact territory object property container returned when you read or search contact territories.
  2. Contact territory object property container used to set properties for a new contact territory.
  3. Contact territory object property container used to update or clear properties for a contact territory.

NoteFor more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JContTerritory object.

contTerritoryItem

Subclass of lookupItem. Use the provided get methods to read the properties related to a contact territory.

DocumentRepository

DocumentRepository Requests Summary

Request

Description

insertDocument

Saves a new Document object to the repository.

createShortcut

Creates a shortcut or link to a document (file, folder, or existing shortcut) with a given unique key. The parentFolderUniqueKey defines the folder where the shortcut will be created.

createSubFolder

Creates a sub-folder with given name in given parent folder.

createHyperlinkDefaultCategory

Creates a hyperlink and sets its category to the default Document category.

createHyperlink

Creates a hyperlink.

updateDocument

Updates a previously saved document.

readDocument

Retrieves a Document from the repository based on a unique key. For a list of available properties, see the type class, Document.

readDocumentsByCriteria

Retrieves a set of documents based on specified criteria. If the criteria is empty, then the search will be for all documents. The specified limit takes precedence over the current system setting for the maximum number of search results to obtain. For a list of available properties, see the type class, Document.

readChildDocuments

Performs two functions:

  • For a given document file (parent), gets older document versions of that file.
  • For a given folder, gets documents within that folder.

Returns documents with only specified property values. For a list of available properties, see the type class, document.

readChildDocumentForName

Retrieves a document from the repository given the file name and the unique ID of its parent folder.

readDocumentFolderForDocument Owner

Retrieves a document folder from the repository given the unique key of the folder's owner (user).

readDocumentByPath

Retrieves a Document from the repository based on a folder path.

checkOut

Attempts to check out a document with a given unique key.

undoCheckOut

Attempts to undo check out of a given document.

checkIn

Attempts to check in a document with a given unique key.

revert

Attempts to revert a given document to a given old version.

moveDocument

Moves a document to a new parent folder.

copyDocument

Copies a document to a new parent folder.

deleteDocument

Deletes the persistent document specified by the unique key.

ReadRecentlyViewedDocuments

Retrieves a list of recently viewed documents.

setDocumentAsRecentlyViewed

Set a document as recently viewed.

readFolderHierarchy

Retrieves a hierarchical list of document folders for one or more projects.

DocumentRepository Data Objects Summary

Data Object

Description

  1. document
  2. documentCreate
  3. documentUpdate
  1. Document record property container returned when you read or search documents. When defining a repository search's return properties, refer to the property names defined in this object.
  2. Document record property container used to set a new document's properties. This object is passed as a request parameter when you create (insert) a document.
  3. Document record property container used to update or clear a document's properties. This object is passed as a request parameter when you update a document.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the TDocument object.

documentContentType

This object defines the document file type. In an application you would typically use this object's properties to read or search documents.

Note: For more information about the data restrictions for properties that belong to this object, see the Object Model Reference for the YDocuContentType object.

documentType

An enumeration used to indicate the document type. Options include:

  • FILE
  • FOLDER
  • HYPERLINK
  • SHORTCUT
  • HISTORY—the documentType for previous versions of a document file. Note that a document with documentType HISTORY is different from a history record.

NoteFor more information about the data restrictions for properties that belong to this object, see the Object Model Reference for the YDocuContentType object.

ExpenseRepository

ExpenseRepository Requests Summary

Request

Description

deleteExpense

Deletes an expense record.

insertExpense

Creates an expense record.

postExpense

Posts an expense record.

readExpense

Reads and returns an expense record. Specified expense properties are returned with the record.

readExpensesByCriteria

Searches for expense records that meet a given search criteria. Specified invoice properties are returned with the resulting records.

readRecentlyViewedExpenses

Read and return recently viewed expense records.

updateExpense

Updates an expense record. Specified invoice properties are updated.

voidExpense

Voids an expense record.

ExpenseRepository Data Objects Summary

Data Object

Description

accountPostingStatus

An enumeration used to track whether a finance record has posted to an account. Typically in an application, you would read or search by this object's value. You would not explicitly set a financial record's posting status.

Options include:

  • NOT_SUBMITTED
  • POSTED
  • FAILED
  1. expense
  2. expenseCreate
  3. expenseUpdate
  1. Expense record property container returned when you read or search expenses.
  2. Expense record property container used to set a new expense's properties. This object is passed as a request parameter when you create (insert) an account.
  3. Expense record property container used to update or clear an expense's properties. This object is passed as a request parameter when you update an expense.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the TExpense object.

GroupAccountRepository

GroupAccountRepository Requests Summary

Request

Description

deleteGroupAccount

Deletes the group account specified by the unique key.

insertGroupAccount

Saves a new group account object to the repository.

readGroupAccount

Retrieves a group account from the repository based on a unique key. For a list of available properties, see the type class, groupAccount.

readGroupAccountsByCriteria

Retrieves a set of group accounts based on specified criteria. If the criteria is empty, then the search will be for all group accounts. The specified limit takes precedence over the current system setting for the maximum number of search results to obtain. For a list of available properties, see the type class, groupAccount.

readRecentlyViewedGroupAccounts

Read and return recently viewed group accounts.

updateGroupAccount

Updates a previously saved group account.

GroupAccountRepository Data Objects Summary

Data Object

Description

  1. groupAccount
  2. groupAccountCreate
  3. groupAccountUpdate
  1. Group account record property container returned when you read or search groups.
  2. Group account record property container used to set a new group's properties. This object is passed as a request parameter when you create (insert) a group.
  3. Group account record property container used to update or clear a group's properties. This object is passed as a request parameter when you update a group.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the YGroup object.

HistoryRepository

HistoryRepository Requests Summary

Request

Description

insertHistory

Saves a new history record to the repository.

readHistoriesByCriteria

Retrieves a set of records based on specified criteria. If the criteria is empty, then the search will be for all records. The specified limit takes precedence over the current system setting for the maximum number of search results to obtain. For a list of available properties, see the type class, history.

readHistory

Retrieves a record from the repository based on a unique key. For a list of available properties, see the type class, history.

updateHistory

Updates a previously saved history record.

deleteHistory

Deletes the record specified by the unique key.

readRecentlyViewedHistories

Read recently viewed histories.

HistoryRepository Data Objects Summary

Data Object

Description

  1. history
  2. historyCreate
  3. historyUpdate
  1. History record property container returned when you read or search history records. When defining a repository search's return properties, refer to the property names defined in this object.
  2. History record property container used to set a new history record's properties. This object is passed as a request parameter when you create (insert) a history record.
  3. History record property container used to update or clear a history record's properties. This object is passed as a request parameter when you update a history record.

NoteFor more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the THistory object.

Note: historyOwner refers to the unique key (String) of a parent record that the history describes.

InvoiceRepository

InvoiceRepository Requests Summary

Request

Description

adjustInvoiceHeader

Adjust an invoice on the header level.

deleteInvoice

Deletes an invoice record.

insertInvoice

Creates an invoice record.

postInvoice

Posts an invoice record.

readActiveApprovals

Read active approvals for an invoice.

readCompletedApprovals

Read completed approvals for an invoice.

readInvoice

Reads and returns an invoice record. Specified invoice properties are returned with the record.

readInvoiceApprovalsPendingOnPost

Read all pending invoice approvals that are pending on post.

readInvoicesByCriteria

Searches for invoice records that meet a given search criteria. Specified invoice properties are returned with the resulting records.

readRecentlyViewedInvoices

Read recently viewed invoices.

updateInvoice

Updates an invoice record. Specified invoice properties are updated.

voidInvoice

Voids an invoice record.

InvoiceRepository Data Objects Summary

Data Object

Description

adjustmentMethod

An enumeration used to identify the way an invoice summary is adjusted. Options include:

  • REDUCE_BY_AMOUNT
  • REDUCE_BY_PERCENT
  • NEW_AMOUNT

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JInvcHeaderAdjustment object.

currencyItem

See currencyItem.

  1. invoiceAdjustment
  2. invoiceAdjustmentCreate
  3. invoiceAdjustmentUpdate

All three objects are used to work with invoice summary adjustments within invoice records.

  1. Invoice summary adjustment object property container returned when you read or search invoices.
  2. Invoice summary adjustment object property container used to set properties for an invoice.
  3. Invoice summary adjustment object property container used to update an invoice.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JInvcHeaderAdjustment object.

invoiceAdjustmentTarget

An enumeration used to identify which property of the invoice summary to adjust. Options include:

  • TOTAL_FEES
  • TOTAL_EXPENSES
  • TOTAL_INVOICE
  1. invoice
  2. invoiceCreate
  3. invoiceUpdate
  1. Invoice record property container returned when you read or search invoices.
  2. Invoice record property container used to set a new invoice's properties. This object is passed as a request parameter when you create (insert) an invoice.
  3. Invoice record property container used to update or clear an invoice's properties. This object is passed as a request parameter when you update an invoice.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the TInvoice object.

invoiceNonUSTax

Invoice Non-US Taxes object property container returned when you read or search invoices.

Note: For more information about the data restrictions for properties that belong to the above-mentioned object, see the Object Model Reference for the TInvoice object.

invoiceNonUSTaxType

Subclass of lookupItem. Use the provided get methods to read the properties related to an invoice's Non-US Tax category.

Note: An invoice can have multiple Non-US Tax amounts.

invoicePostingStatus

An enumeration used to track whether a finance record has posted to an account. Typically in an application, you would read or search by this object's value. You would not explicitly set a invoice's posting status.

Options include:

  • NOT_SUBMITTED
  • POSTED
  • FAILED
  • REJECTED
  1. lineItemAdjustment
  2. lineItemAdjustmentCreate
  3. lineItemAdjustmentUpdate

All three objects are used to work with invoice line item adjustments within invoice records.

  1. Line item adjustment object property container returned when you read or search invoices.
  2. Line item adjustment object property container used to set properties for an invoice line item adjustment.
  3. Line item adjustment object property container set properties for an invoice line item adjustment.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JInvcLineItem object.

lineItemAdjustmentReason

Subclass of lookupItem. Use the provided get methods to read the properties related to a line item adjustment reason. This class corresponds to the options defined by the TeamConnect system lookup table, Invoice Rejection Reason.

lineItemAdjustmentTarget

An enumeration that identifies the line item property to adjust. Options include:

  • RATE
  • QUANTITY
  • DISCOUNT
  • TOTAL
  1. lineItem
  2. lineItemCreate
  3. lineItemUpdate
  1. Line Item record property container returned when you read or search invoices.
  2. Line Item record property container used to create a line item and add it to an invoice.
  3. Line Item record property container used to update a line item.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JInvcLineItem object.

lineItemType

An enumeration that sets the line item type. Options include:

  • EXPENSE
  • FEE

taskActivityItem

Subclass of lookupItem. Use the provided get methods to read the properties related to a invoice line item task activity option. This class corresponds to options defined in the TeamConnect system lookup table, Activity Item.

LookupTableSource

LookupTableSource Requests Summary

Request

Description

readSystemLookupTable

Retrieves a list of properties for a system table code. You use the properties to read values from lookup tables.

ProjectRepository

Use the ProjectRepository to manage project, matters, or custom object records (for example, create, update, read,search, delete). The corresponding custom object must already be defined in the TeamConnect Designer area Object Definitions screen. Corresponding categories for the custom object must also be defined in the TeamConnect Designer area Object Definitions screen.

ProjectRepository Requests Summary

Request

Description

changePhase

Changes the phase of a project record. The phase must already be defined in TeamConnect.

deleteProject

Deletes a project record.

insertProject

Creates a project record.

readChildProjectsForEntityType

Reads and returns a project record's child projects by a given category. Specified project properties are returned with the resulting records.

readProject

Reads and returns a project record. Specified project properties are returned with the record.

readProjectEntityTypes

Get a list of project entity types in TeamConnect.

readProjectIntegrationSearches

Get a list of search views that are of type "Integration", each returned search view should have a unique key, a name, and its associated entity type.

readProjectsByCriteria

Searches for project records that meet a given search criteria. Specified project properties are returned with the resulting records.

readProjectsUsingSearch

Get a list of records that match the search criteria given a unique key of search view of "Integration" type.

readRecentlyViewedProjects

Read recently viewed projects.

updateProject

Updates a project record. Specified project properties are updated.

ProjectRepository Data Objects Summary

Data Object

Description

assigneeRole

Use this object to read or search projects by associated assignee role.

Note: Project assignee role values must be pre-defined in TeamConnect UI in the Project (custom object) object definition.

  1. embeddedEntity
  2. embeddedEntityCreate
  3. embeddedEntityUpdate
  1. Embedded object record property container returned when you read or search projects.
  2. Embedded object record property container used to set properties of an embedded object record.
  3. Embedded object record property container used to set properties of an embedded object record.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the WObjdProjectInfo object.

embeddedEntityType

Use this object's uniqueCode property to identify the existing embedded object definition to work with.

phase

Use this object's properties to search or read projects. Also use this object's properties to search or read projects by the phaseInterval (object) property.

phaseInterval

The phaseInterval object is a container for properties about a phase's duration (for example, the date when a phase became active). In an application, typically you would

Project phase interval object property container returned when you read or search projects.

Note: For more information about the data restrictions for properties that belong to the above-mentioned object, see the Object Model Reference for the JProjPhase object.

  1. projectAssignee
  2. projectAssigneeCre ate
  3. projectAssigneeUpd ate
  1. Project assignee record property container returned when you read or search projects.
  2. Project assignee record property container used to set a project's properties.
  3. Project assignee record property container used to set a project's properties.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JProjAssignee object.

  1. project
  2. projectCreate
  3. projectUpdate
  1. Project (custom object) record property container returned when you read or search projects.
  2. Project (custom object) record property container used to set a new project's properties. This object is passed as a request parameter when you create (insert) a project.
  3. Project (custom object) record property container used to update or clear a project's properties. This object is passed as a request parameter when you update a project.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the TProject object.

  1. projRelation
  2. projRelationCreate
  3. projRelationUpdate
  1. Project relation record property container returned when you read or search projects.
  2. Project relation record property container used to set a project's properties.
  3. Project relation record property container used to set a project's properties.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JProjRelation object.

projRelationType

Subclass of lookupItem. Use the provided get methods to read the properties related to a project relation's associated type.

relationDirection

For more information, see relationDirection.

InvolvedRepository

Use this repository to work with involved party records or contacts who are involved in a project (matter).

InvolvedRepository Requests Summary

Request

Description

deleteInvolved

Deletes an involved party record.

insertInvolved

Inserts or creates an involved party record (associated with a project/ matter).

readInvolved

Reads and returns an involved record. Specified involved properties are returned with the record.

readInvolvedsByCriteria

Searches for involved party records that meet a given search criteria. Specified involved party properties are returned with the resulting records.

readInvolvedsForProject

Reads and returns a list of involved party records given the unique id of an associated project (matter). Specified involved properties are returned with the record.

updateInvolved

Updates an involved record. Properties that can be updated include categories and custom field values. Existing property values can be cleared.

InvolvedRepository Data Objects Summary

Data Object

Description

  1. involved
  2. involvedCreate
  3. involvedUpdate
  1. Involved record property container provides properties returned when you read or search involved parties. When defining a repository search's return properties, refer to the property names defined in this object.
  2. Involved record property container used to set a new involved party's properties.
  3. Involved record object property container used to update or clear an involved party's properties.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the TInvolved object.

TaskRepository

TaskRepository Requests Summary

Request

Description

deleteTask

Deletes a task record.

insertTask

Creates a task record.

postTask

Posts a task record.

readRecentlyViewedTasks

Read recently viewed tasks.

readTask

Reads and returns a task record. Specified task properties are returned with the record.

readTasksByCriteria

Searches for task records that meet a given search criteria. Specified task properties are returned with the resulting records.

reassign

Reassigns a task record to a different user.

updateTask

Updates a task record. Specified task properties are updated.

voidTask

Voids a task record.

TaskRepository Data Objects Summary

Data Object

Description

accountPostingStatus

See accountPostingStatus.

  1. taskAssignee
  2. taskAssigneeCreate
  3. taskAssigneeUpdate
  1. Task assignee record property container provides properties returned when you read or search tasks. When defining a repository search's return properties, refer to the property names defined in this object.
  2. Task assignee record property container used to set properties for a Task assignee.
  3. Task assignee record object property container used to update or clear properties for a Task assignee.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the JTask Assignee object.

taskPriority

An enumeration used to indicate the priority of a task. Options include:

  • HIGHEST
  • HIGH
  • NORMAL
  • LOW
  • LOWEST
  1. task
  2. taskCreate
  3. taskUpdate
  1. Task record property container returned when you read or search tasks.
  2. Task record property container used to set a new task's properties.
    This object is passed as a request parameter when you create (insert) a task.
  3. Task record property container used to update or clear a task's properties. This object is passed as a request parameter when you update a task.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the TTask object.

taskWorkStatus

An enumeration used to indicate the status of a task (like level of completion). Options include:

  • NOT_STARTED
  • STARTED
  • COMPLETED

UserAccountRepository

UserAccountRepository Requests Summary

Request

Description

insertUserAccount

Saves a new user account object to the repository.

updateUserAccount

Updates a previously saved user account.

readUserAccount

Retrieves a user account from the repository based on a unique key. For a list of available properties, see the type class, userAccount.

readUserAccountsByCriteria

Retrieves a set of user accounts based on specified criteria. If the criteria is empty, then the search will be for all user accounts. The specified limit takes precedence over the current system setting for the maximum number of search results to obtain. For a list of available properties, see the type class, userAccount.

deleteUserAccount

Deletes the user account specified by the unique key.

readRecentlyViewedUserAccounts

Read recently viewed user accounts.

UserAccountRepository Data Objects Summary

Data Object

Description

  1. userAccount
  2. userAccountCreate
  3. userAccountUpdate
  1. User account record property container returned when you read or search users.
  2. User account record property container used to set a new user's properties. This object is passed as a request parameter when you create (insert) a user.
  3. User account record property container used to update or clear a user's properties. This object is passed as a request parameter when you update a user.

Note: For more information about the data restrictions for properties that belong to the above-mentioned objects, see the Object Model Reference for the YUser object.

Note: To update a user's password through Web Services, you need to authenticate with that user name and password.

userType

An enumeration used to indicate a user's access to public and private records. Options include:

  • SUPER
  • NORMAL
  • LIMITED
  • Was this article helpful?