Note: This section describes the current convention of a record's unique key. This definition may change in the future.

When updating, reading, or deleting records, you need to pass the desired record's unique key. The unique key format is like: TC_Object_Definition_Unique_Code + "_" + TC_record_primary_key (for example, an invoice's unique key might look like INVC_3055).

Note: The unique key value is not stored directly in the TeamConnect database. It is constructed by two values stored separately in the database.

If you don't know a record's unique key and want to read or retrieve its properties, you can alternatively use the readXByCriteria request. For example, to read a contact you can use the contactRepository readContactsByCriteria request. You can either specify the properties to read in the target record directly as a readContactsByCriteria parameter or you can just retrieve the uniqueKey property in the search results and pass this value in the readContact request. Typically you will search or use the readXByCriteria request to get a record's unique key. Then you can use the unique key for update, read, or delete operations.