V4.0 Upgrage Guide

Changes to GET Agencies

The GET Agencies endpoint now returns information about which data scopes each subscribed agency has enabled. This enables integrations to selectively make requests only for features an agency has opted into.

This is a breaking change from the previous versions. Instead of an array of integers, the response is an array of objects. See the API documentation for details.

New endpoint POST Create Client

The new Create Client endpoint enables integrations to add new clients with contact information and limited policy details. The primary purpose of this endpoint is to create a "shell", which will be populated by a download once in the agency's system.

INFO

Note that the location of the optional Task has been moved out of the Log object for this endpoint. See the API documentation for details. To assist with the transition, a specific validation error message will be returned if a Task is included on the Log object.

Enhancements to POST Create Receipts

Receipts no longer need to be applied to an invoice. This enables integrations to add credit to a client account. Payments can be partially applied or not applied at all, meaning the sum of the Amounts on invoices may be less than the receipt Total.

The request and response are unchanged.