We improve the Smokeball API all the time by releasing new features, fixing bugs and updating the documentation. This changelog accounts for all of the changes as they are released, in chronological order.
organizer
field has been removed as it is no longer required.surcharge
field added to invoices that includes invoice surcharge type and amounts.outOfOffice
field added to staff members, this field contains startDate
and endDate
.users/write
scope.invoice.created
event type which is triggered when an invoice is created.No changes
isCompleted
query parameter to GET endpoint.isDuplicate
field to GET endpoints.matter.closed
event type which is triggered when a matter is closed.invoice.updated
event type.MatterId
to GET endpoint.CreatedFromActivityId
to GET endpoint.files.updated
event type which is triggered against a matter. Use the cursor returned to rereive the updated files via the files API.IsCancelled
and IsUploaded
to GET endpoint.correctionsReferenceNumber
and centrelinkReferenceNumber
to AU endpoints.isFavorite
field.name
to GET endpoint.matter.converted
event type which is triggered once a lead is converted to a matter.isInvoiceExternally
to GET.ClientIds
and OtherSideIds
.referralType
, referrerId
, closedDate
, leadOpenedDate
, leadClosedDate
, leadClosedReason
fields.matterId
.Finalized
field was being ignored on POST and PUT endpoints.productId
field to GET endpoint.MatterId
and StaffId
fields. These fields must now be valid GUID values, empty strings are no longer permitted. The StaffId
is mandatory.AssignToFirmOwner
option when creating an expense.DateModified
field when creating a file.DateModified
field when bulk creating files.Product
field and introduced the ProductId
field.IsLead
and ContactId
.ColorFill
and ColorStroke
fields.Matter
webhooks, notifications are more accurate as well as more deterministic.Memo
webhooks. Use the memo.created
, memo.updated
, memo.deleted
, memo.restored
event types to listen to changes made to memos.StaffId
, instead use Staff
.MatterId
, instead use Matter
.StaffId
, instead use Staff
.MatterId
, instead use Matter
.Task
webhooks. Use the task.created
, task.updated
, task.deleted
event types to listen to changes made to tasks.Event
webhooks. Use the event.created
, event.updated
, task.deleted
event types to listen to changes made to events.LayoutDesign
webhooks. Use the layoutdesign.updated
event type to listen to changes made to layout designs.Archive
webhooks. Use the archive.updated
event type to listen to changes made on a matters archive details.BillingConfiguration
GET and PUT endpoints. Billing configurations are set on the matter level.Locality
and County
fields.DateModified
field to GET responses.Email
field.DxAddress
field.Supervisor
field.status
. Multiple statuses can now be passed in the query parameters.UserId
field.BillingConfiguration
webhooks. Use the billingconfiguration.updated
event type to listen to changes to billing configurations on a matter level.Name
field to GET response for GroupOfPeople
contacts. This returns the combined names of the contacts in the group, saving you needing to retrieve the individual contacts.Owner
field to GET responses. This can be used to determine the whitelabel product linked to the firm.Type
field to GET responses. This can be used to determine if the type is for a Lead or Matter.Duration
field. This follows the ISO 8601
duration format (e.g. PT4H33M
)error
event type. This can be used to listen to errors when your API requests fail, see Error Handling.ExcludeDeletedContacts
query parameter).BirthFirstName
, BirthMiddleName
, BirthLastName
fields.PreviousNames
field.LanguageOfInterpreter
field.Gender
field.ContactId
query parameter).UserId
when using Client Credentials grant (see Acting on behalf of a user).UserId
when using Client Credentials grant (see Acting on behalf of a user).TaxInclusive
field returning incorrect value.MatterItems
webhooks.MatterTypeId
field missing in some matter.updated
event payloads.Branch
field.OtherSideIds
and OtherSideRole
to POST request so matters and leads can be created with clients as well as othersides.UserId
to POST and PUT requests to create or update a memo on behalf of a user.Fee
when performing PUT, requests are accepted and queued asynchonously like a POST.Expense
when performing PUT, requests are accepted and queued asynchonously like a POST.MatterStages
webhooks.RequestId
not propogating from some Matter API calls.Firm
update webhook events.Logo
field to GET responses.MaritalStatus
field.SpecialNeeds
field.CompletedDate
field.LastUpdated
field to GET responses.(BillingOnly, SmokeballMid and Smokeball)
.IsInternal
field when creating a firm so that a firm can be flagged as an internal firm and skip payment subscription.ABN
, ACN
and postal details, CareOf
, PoBoxType
and PoBoxNumber
to firm MailingAddress.MatterTypeId
, instead use MatterType
.ClientIds
, instead use Clients
.OtherSideIds
, instead use OtherSides
.PersonResponsibleStaffId
, instead use PersonResponsible
.PersonAssistingStaffId
, instead use PersonAssisting
.OriginatingStaffId
, instead use OriginatingStaff
.StaffIds
, instead use Staff
.PersonIds
, instead use People
.ContactId
, instead use Contact
.RepresentativeIds
, instead use Representatives
.RelationshipIds
, instead use Relationships
.IsOtherSide
field to determine if the role is the OtherSide of a matter.ContactId
, instead use Contact
.RepresentativeIds
, instead use Representatives
.UserId
to files and folders.LayoutMatterItem
webhooks.