v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB

Matters

Create a matter

Creates a new matter.

Note: This endpoint can also be used to create a Lead.

When creating a Lead you MUST remember to set a valid lead specific matterTypeId field (see field description below for more details) and set the isLead field to true.

The clientRole and otherSideRole are optional and cannot be identical. They will be set to the default role(s) for the specified matter type - if not provided.

post/matters

Request body

externalSystemIdstring nullable

External system id for the matter.

numberstring nullable

Human-friendly number assigned to matter.

matterTypeIdstring nullable

Unique identifier of the matter type associated with the matter.

Matter types define what information can be saved to the matter, relevant to that area of law and state / location.

A pre-configured list of matter types can be obtained via the 'GET /mattertypes' API.

'Lead' matter types are different from the standard matter types used when creating a 'Matter'.

Use the 'Type' query parameter in the 'GET /mattertypes' API call to get 'Lead' specific matter types.

clientIdsstring[] nullable

List of 'Client' contact id's associated with the matter.

otherSideIdsstring[] nullable

List of 'OtherSide' contact id's associated with the matter.

branchIdstring nullable

Unique identifier of the associated branch.

branchProviderIdstring nullable

Unique identifier of the associated branch provider.

clientRolestring nullable

'Client' matter type representative option for the matter.

If unsure, this can be left empty and the default Client role will be used.

otherSideRolestring nullable

'OtherSide' matter type representative option for the matter.

If unsure, this can be left empty and the default OtherSide role will be used.

descriptionstring nullable

Brief description of the matter.

statusstring nullable

Current status of matter.

Possible values: Open, Pending, Closed, Deleted or Cancelled.

openedDatestring date-time nullable

Date the matter was opened. This can be backdated if required.

closedDatestring date-time nullable

Date the matter was closed. This can be backdated if required.

leadOpenedDatestring date-time nullable

Date the lead was opened. This can be backdated if required.

Only applies if isLead is true.

leadClosedDatestring date-time nullable

Date the lead was closed. This can be backdated if required.

Only applies if isLead is true.

leadClosedReasonstring nullable

Reason the lead was closed.

Only applies if isLead is true.

referralTypestring nullable

Referral Type of the matter.

Custom Referral Types are also supported, the name or id of the Custom Referral Type can be used. If the name is used, it is looked up and stored as the id.

See the Referral Types API for retrieval of all valid Referral Types.

Possible values may also differ per region.

referrerIdstring nullable

Contact id of the person that referred the matter.

referralAgreementFeeTypestring nullable

The referral agreement fee type.

Possible values: %, Flat fee, Other

referralAgreementFeenumber double nullable

The referral agreement fee value.

referralAgreementFeeCommentstring nullable

The referral agreement fee comment.

personResponsibleStaffIdstring nullable

Staff id of the person responsible for the matter (if applicable).

personAssistingStaffIdstring nullable

Staff id of the person assisting in the matter (if applicable).

personAssistingStaffIdsstring[] nullable

Staff ids of the other persons assisting in the matter (if applicable).

originatingStaffIdstring nullable

Staff id of the originating attorney (if in US) or an Introducer (if in AU)

originatingStaffIdsstring[] nullable

Staff ids of the other originating attorneys (if in US) or an Introducer (if in AU)

Required when SplitOriginatingStaffSettings is provided and enabled.

supervisorStaffIdstring nullable

Staff id of the supervisor of the matter.

Only supported in the UK.

clientCodestring nullable

Associates an external client code to this matter.

Only supported in AU and UK.

isLeadboolean

Optional boolean flag indicating if a 'Lead' is being created. This must be set to 'true' when creating a 'Lead'.

Example request

{
  "externalSystemId": "EXT01",
  "number": "FUS-124",
  "matterTypeId": "009f778f-83df-454a-b344-768a862a7e55",
  "clientIds": [
    "832e778f-83df-454a-b344-768a862a7e67"
  ],
  "otherSideIds": [
    "776e778f-83df-454a-b344-768a862a6e58"
  ],
  "branchId": "dd4e4381-b6a0-4c64-8feb-e8ea8016ea42",
  "branchProviderId": "Smokeball",
  "clientRole": "Buyer",
  "otherSideRole": "Seller",
  "description": "This is a brief description for the matter",
  "status": "Open",
  "openedDate": "2022-04-23T14:00:00Z",
  "closedDate": "2022-04-23T14:00:00Z",
  "leadOpenedDate": "2022-04-23T14:00:00Z",
  "leadClosedDate": "2022-04-23T14:00:00Z",
  "leadClosedReason": "No longer interested",
  "referralType": "Google",
  "referrerId": "97bbe49f-6460-4bfc-b287-34ddfdbb81ef",
  "personResponsibleStaffId": "c85d28cb-a760-4627-aa59-0a853c2e65ed",
  "personAssistingStaffId": "c85d28cb-a760-4627-aa59-0a853c2e65ed",
  "personAssistingStaffIds": [
    "c85d28cb-a760-4627-aa59-0a853c2e65ed"
  ],
  "originatingStaffId": "c85d28cb-a760-4627-aa59-0a853c2e65ed",
  "originatingStaffIds": [
    "c85d28cb-a760-4627-aa59-0a853c2e65ed"
  ],
  "supervisorStaffId": "c85d28cb-a760-4627-aa59-0a853c2e65ed",
  "clientCode": "Client A"
}

Response

When request is accepted. Returns a hypermedia 'Link' object of the matter to be created.

idstring nullable

hrefstring nullable

relationstring nullable

methodstring nullable