Back
Jeevan Tokhi
Jeevan Tokhi Head of API for BGL

BGL API — March 2020 - CAS 360 API Improvements

BGL API — March 2020 - CAS 360 API Improvements

March 2020 - CAS360 Document Management, Attachment Improvements and Contact Improvements.

We have now released two new endpoints to both our production and staging environments for CAS 360 and several improvements Documents, Attachments and Contacts.

New Endpoints

  1. GET List of Status Types This endpoint allows you to retrieve the possible status types for documents in CAS 360. This list will be unique for each firm and a firm has the ability to have custom statuses.

  1. POST Assign a new Status for a Document Allows you to modify the status of a document in CAS 360

Document Improvements

Document Endpoints can now specify and retrieve an expanded status Object. Previously when a document was created its status was defaulted to ‘RECEIVED’, which is still the case if a status object is not provided. The details call will also return all attachments whereas previously it was limited to User Attachments. User attachments will have the prefix ‘UA’ whereas system generated forms will have the prefix ‘F’ followed by the id. This has been apllied to the following resources:

  1. GETList of Documents for Company
  2. GET Document Details
  3. POST Create New Document Record

Attachment Improvements

Attachments work the same as before, however, you can now download both user and system generated attachments. User attachments will have the prefix ‘UA’ whereas system generated forms will have the prefix ‘F’ followed by the id.You will still be able to GET and DELETE User Attachments as before, using just the id without the prefix. For system generated attachments/forms the prefix is mandatory. This has been apllied to the following resources:

  1. GET Download a Document Attachment
  2. POST Upload a New Attachment to a Given Document
  3. DEL Delete a Document Attachment

Contacts Improvements

We have also made improvements to existing endpoints to provide more details :

  1. GET List of Companies and GET Company Details New key ‘registered’ added to the reponse. Companies which return a result of “false” will display on the Company Registrations in CAS 360. This property is not mandatory to add a new company, it will default to true if not specified.

  1. POST Create new company New key ‘registered’ added to the reponse. Companies which return a result of “false” will display on the Company Registrations in CAS 360. This property is not mandatory to add a new company, it will default to true if not specified.

  2. GET List of Contacts and GET List of contacts by IDs Other Contacts can now specify a type, but will still default to ‘OTHER’ as was previously the case.The valid enum types are ‘OTHER’, ‘SMSF’, ‘PARTNERSHIP’ and ‘TRUST’.If the type property is not valid (for non-Other Entity contacts), it will NOT be returned in the response.

  1. POST Create Contact Other Contacts can now specify a type, but will still default to ‘OTHER’ as was previously the case. The valid enum types are ‘OTHER’, ‘SMSF’, ‘PARTNERSHIP’ and ‘TRUST’. If the type property is not valid (for non-Other Entity contacts), it will NOT be returned in the response.

What’s next?

We are working on providing an API to allow you to get document attachments in an ongoing process. Please let the team know which query criterias you are interested in, for example last hour, last 24 hours, last week etc.

Kind Regards

The BGL API Team
api@bglcorp.com.au

================================================== -->