Pipeliner CRM Hybrid API

We are pleased to announce that on May 4, 2017, we released the new Pipeliner CRM Server API.

The most recent version of the Pipeliner CRM Server API is version 11.0, which was introduced on October 29, 2016.

Here is the upgrade guide, with the change log, that helps you prepare your integration with Pipeliner CRM for this new release.

Changelog

1. Deleted Entities

  • Activity – has been renamed to Task (‼ breaking change)
  • ActivityRecurrence – has been renamed to TaskRecurrence (‼ breaking change)
  • AddressbookRelation – has been renamed to ContactAccountRelation (‼ breaking change)
  • ActivityType – has been split to TaskType & AppointmentType (‼ breaking change)

2. New Entities

  • AppointmentClientInviteesRelation
  • AppointmentContactInviteesRelation
  • AppointmentType
  • Task
  • TaskType
  • TaskRecurrence
  • ContactAccountRelation

3. Changed Entities

Task (formerly Activity)

  • renamed field ACTIVITY_TYPES_ID to ACTIVITY_TYPE_ID (‼ breaking change)
  • removed field COMPLETED_AT and COMPLETED_BY (‼ breaking change)
  • renamed field RECIPIENTS_SALES_UNIT_ID to SHARING_UNITS (‼ breaking change)
  • renamed field RECIPIENTS_CLIENT_ID to SHARING_CLIENTS (‼ breaking change)
  • field RELATIONS_ADDRESSBOOK has split between ACCOUNT_RELATIONS and CONTACT_RELATIONS (‼ breaking change)
  • field RELATIONS_OPPTY has split between LEAD_RELATIONS and OPPTY_RELATIONS (‼ breaking change)
  • added field SALES_UNIT_ID (‼ breaking change)
  • added field ACCESS_LEVEL

Appointment

  • renamed field ACTIVITY_TYPES_ID to ACTIVITY_TYPE_ID (‼ breaking change)
  • removed field RECIPIENTS_SALES_UNIT_ID and RECIPIENTS_CLIENT_ID (‼ breaking change)
  • field RELATIONS_ADDRESSBOOK has split between ACCOUNT_RELATIONS and CONTACT_RELATIONS (‼ breaking change)
  • field RELATIONS_OPPTY has split between LEAD_RELATIONS and OPPTY_RELATIONS (‼ breaking change)
  • added field SALES_UNIT_ID (‼ breaking change)
  • added field INVITEES_CLIENTS
  • added field INVITEES_CONTACTS

Email

  • renamed field RECIPIENTS_CLIENT_ID to SHARING_CLIENTS (‼ breaking change)
  • field RELATIONS_ADDRESSBOOK has split between ACCOUNT_RELATIONS and CONTACT_RELATIONS (‼ breaking change)
  • field RELATIONS_OPPTY has split between LEAD_RELATIONS and OPPTY_RELATIONS (‼ breaking change)

Message

  • renamed field RECIPIENTS_SALES_UNIT_ID to SHARING_UNITS (‼ breaking change)
  • renamed field RECIPIENTS_CLIENT_ID to SHARING_CLIENTS (‼ breaking change)
  • field RELATIONS_ADDRESSBOOK has split between ACCOUNT_RELATIONS and CONTACT_RELATIONS (‼ breaking change)
  • field RELATIONS_OPPTY has split between LEAD_RELATIONS and OPPTY_RELATIONS (‼ breaking change)

Contact

  • joined fields SALES_TEAM and WATCHERS into SHARING_CLIENTS (‼ breaking change)
  • joined fields SALES_UNIT_EDITORS and SALES_UNIT_WATCHERS into SHARING_UNITS (‼ breaking change)
  • removed field PUBLISH_STATE (‼ breaking change)

Account

  • joined fields SALES_TEAM and WATCHERS into SHARING_CLIENTS (‼ breaking change)
  • joined fields SALES_UNIT_EDITORS and SALES_UNIT_WATCHERS into SHARING_UNITS (‼ breaking change)
  • removed field PUBLISH_STATE (‼ breaking change)

Lead

  • joined fields SALES_TEAM and WATCHERS into SHARING_CLIENTS (‼ breaking change)
  • joined fields SALES_UNIT_EDITORS and SALES_UNIT_WATCHERS into SHARING_UNITS (‼ breaking change)
  • removed field PUBLISH_STATE (‼ breaking change)

Opportunity

  • joined fields SALES_TEAM and WATCHERS into SHARING_CLIENTS (‼ breaking change)
  • joined fields SALES_UNIT_EDITORS and SALES_UNIT_WATCHERS into SHARING_UNITS (‼ breaking change)
  • renamed field PUBLISH_STATE to WAS_QUALIFIED (‼ breaking change)
  • renamed field OPPORTUNITY_VALUE to BASE_VALUE (‼ breaking change)
  • renamed field OPPORTUNITY_VALUE_FOREGIN to FOREIGN_VALUE (‼ breaking change)

AppointmentType & TaskType (formerly ActivityType)

  • removed field FORM_TYPE (‼ breaking change)
  • renamed field ICON_ID to ICON (‼ breaking change)

Other Changes

  • Structure for custom foreign currency fields has changed. (‼ breaking change)
  • Added revisioning engine (through revision parameter).
  • Added few flags for batch updates.

Upgrade Notes

This is one of the biggest API release for Pipeliner CRM.

For the upcoming release of API support database v22 (Pipeliner CRM v12.0.0) there are breaking changes in all major LACO entities (Lead, Account, Contact and Opportunity) as well as Tasks, Appointments, Emails and Messages.

There are also changes which affect some minor entities like AppointmentTypes and TaskTypes. Few entities were renamed.

1. Upgrading LACO entities

Sharing properties for all LACO entities has changed in the same way. Fields SALES_TEAM and class=”inline-code”WATCHERS migrated class=”inline-code”SHARING_CLIENTS. Fields class=”inline-code”SALES_UNIT_EDITORS and class=”inline-code”SALES_UNIT_WATCHERS migrated into class=”inline-code”SHARING_UNITS field. Here are a few examples, how to migrate these fields:

Copy to Clipboard
Copy to Clipboard

In all LACO entities, except Opportunity a field PUBLISHED_STATE was removed. In the Opportunity, this field has migrated into WAS_QUALIFIED.

If you were using a custom currency foreign fields. Their structure has slightly changed as shown in the table below:

Copy to Clipboard

In addition to Opportunity, fields OPPORTUNITY_VALUE as well as OPPORTUNITY_VALUE_FOREGIN were renamed into BASE_VALUE and FOREIGN_VALUE. This way, these fields have unified API names with the API names of the currency foreign field type subfields.

2. Upgrading Task, Appointments, Emails and Messages

Another breaking changes are related to these entities. Their common changes are way how relations between LACO entities were created. Until now, relations to Contacts and Accounts had same shared property RELATIONS_ADDRESSBOOK. This property has been split to CONTACT_RELATIONS and ACCOUNT_RELATIONS. Similar with relations to Leads and Opportunities. Until now, these relations were using same property RELATIONS_OPPTY. This property has been split to LEAD_RELATIONS and OPPTY_RELATIONS.

Tasks (formerly Activities) and Appointments

Please note that Activities were renamed to Tasks. Both entities – Tasks and Appointments have a new required field SALES_UNIT_ID. Also field ACTIVITY_TYPES_ID were renamed to ACTIVITY_TYPE_ID.

Tasks

Entity Task has a few specific breaking changes. Its fields COMPLETED_BY and COMPLETED_AT were removed.

Also sharing properties were changed similar way as in LACO entities. RECIPIENTS_CLIENT_ID was renamed to SHARING_CLIENTS, RECIPIENTS_SALES_UNIT_ID was renamed to SHARING_UNITS. See examples below:

Copy to Clipboard
Copy to Clipboard
Messages

While Tasks renamed and changed sharing properties, Messages just simply renamed these properties. So when upgrading, just rename RECIPIENTS_CLIENT_ID to SHARING_CLIENTS and rename RECIPIENTS_SALES_UNIT_ID to SHARING_UNITS. There is nothing more to do, as all these recipients are just watcher and it is not possible to set an editor for a Message entity.

Emails

Same as Message entity. Just rename RECIPIENTS_CLIENT_ID to SHARING_CLIENTS and you are done here.

Appointments

Special case is for Appointments. Field RECIPIENTS_SALES_UNIT_ID has been dropped, as it was never used in the application. However, field RECIPIENTS_SALES_UNIT_ID was migrated slightly different way as other sharing properties. A new field INVITEES_CLIENTS was added instead. This field represents attendees of the Appointment). Each client has become object of these invitees with a proper response. You can find more information about attendees (with their responses) under AppointmentClientInviteesRelation entity. Here is an example how to migrate recipients to a new invitees property:

Copy to Clipboard

3. Minor entities

TaskType & AppointmentType (formerly ActivityType)

Former entity ActivityType has split into TaskType and AppointmentType. For this reason field FORM_TYPE was not longer needed and was dropped. Also ICON_ID field has renamed into ICON.

TaskRecurrence (formerly ActivityRecurrence)

This entity was just renamed into a new name, so instead of ActivityRecurrence, use a TaskRecurrence as entity name.