Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

Note - Events are sent sequentially and in realtime but upon receiving an event, a sequential order cannot be guaranteed.

...

Added application type to Client Model

Status
colourYellow
titleUK PREPROD

The application type is now mandatory to pass in when creating (

Status
colourGreen
titlePOST
) or updating (
Status
colourYellow
titlePUT
) a client. The application will be in the response body.

If the client is from a CRM system set the application to ‘CRM’

Code Block
"application" : "CRM",

By setting the application to CRM, additional information can now be saved in the extensionData field. See the CRM Integration functionality to Client changelog

To create or update a normal Arken client set the application to ‘ARKEN’ as part of the Client Model

Code Block
"application" : "ARKEN",

...

Added CRM Integration functionality to Client

Status
colourYellow
titleUK PREPROD

A client created in a CRM system should be created with the application set to ‘CRM’ as part of the Client Model

Code Block
"application" : "CRM",

This allows to pass in further CRM related fields:

  • The CRM Model. This is the name of the CRM Integration and is a constant value

  • The CRM Contact ID can be used to save the contact ID used in the CRM system

  • The CRM Matter ID is to add Matter references used when adding a document in Arken Professional

    Code Block
    "extensionData" : {
          	"CRMModel" :  "string",
            "CRMClientId" :  "string",
            "CRMMatterId" : ["string", "string"...]
    }

...

Removed Occupation from Client Model

...