Create a matter (scope matters:write)

POST/api/v1/matters

Authorization

AuthorizationBearer token · headerrequired

Scoped API token (bnx_…). Required scopes are noted per operation.

Request body

application/json

namestringrequired

min length 1

clientRelationIdstringrequired

min length 1

departmentIdstring

min length 1

practiceAreastring

flavorstring

Allowed:legaldebt_collectioninsolvencyrolltax_lawgeneralemployment_law

responsibleRelationIdstring

acknowledgeConflictsboolean

Responses

201

Created resource

matterobject

Show properties

idstringrequired

numberstringrequired

namestringrequired

statusstringrequired

flavorstringrequired

practiceAreastring | nullrequired

departmentIdstring | nullrequired

accessLevelIdstring | nullrequired

solicitorResponsibleRelationIdstring | nullrequired

startDatestring | nullrequired

closedDatestring | nullrequired

createdAtstringrequired

updatedAtstringrequired

legalAidobject

Show properties

presentbooleanrequired

stagestringrequired

Allowed:nonerequestedassigned

hourlyFromstring | nullrequired

continuesAsHoursMatterbooleanrequired

Deprecated: derived as hourlyFrom !== null. Prefer hourlyFrom for the dated switch.

filterstringrequired

Allowed:yesnohours

conflictsobject[]

Show properties

Array of object

matterIdstringrequired

matterNumberstringrequired

matterNamestringrequired

relationIdstringrequired

relationNamestringrequired

rolestringrequired

400

Invalid request

errorstringrequired

codestringrequired

rulestring

401

Unauthenticated

errorstringrequired

codestringrequired

rulestring

403

Forbidden (missing scope or permission)

errorstringrequired

codestringrequired

rulestring

429

Rate limited

errorstringrequired

codestringrequired

rulestring

Request

curl -X POST '/api/v1/matters' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "clientRelationId": "string",
  "departmentId": "string",
  "practiceArea": "string",
  "flavor": "legal",
  "responsibleRelationId": "string",
  "acknowledgeConflicts": true
}'

const response = await fetch("/api/v1/matters", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"clientRelationId\": \"string\",\n  \"departmentId\": \"string\",\n  \"practiceArea\": \"string\",\n  \"flavor\": \"legal\",\n  \"responsibleRelationId\": \"string\",\n  \"acknowledgeConflicts\": true\n}"
});

import requests

response = requests.post(
    "/api/v1/matters",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"clientRelationId\": \"string\",\n  \"departmentId\": \"string\",\n  \"practiceArea\": \"string\",\n  \"flavor\": \"legal\",\n  \"responsibleRelationId\": \"string\",\n  \"acknowledgeConflicts\": true\n}",
)

Response

{
  "matter": {
    "id": "string",
    "number": "string",
    "name": "string",
    "status": "string",
    "flavor": "string",
    "practiceArea": "string",
    "departmentId": "string",
    "accessLevelId": "string",
    "solicitorResponsibleRelationId": "string",
    "startDate": "string",
    "closedDate": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "legalAid": {
      "present": true,
      "stage": "none",
      "hourlyFrom": "string",
      "continuesAsHoursMatter": true,
      "filter": "yes"
    }
  },
  "conflicts": [
    {
      "matterId": "string",
      "matterNumber": "string",
      "matterName": "string",
      "relationId": "string",
      "relationName": "string",
      "role": "string"
    }
  ]
}

{
  "error": "string",
  "code": "string",
  "rule": "string"
}

{
  "error": "string",
  "code": "string",
  "rule": "string"
}

{
  "error": "string",
  "code": "string",
  "rule": "string"
}

{
  "error": "string",
  "code": "string",
  "rule": "string"
}