If split originating staff settings are enabled, originatingStaffIds and originatingStaffId cannot be updated
When updating via items, client role items and their sub-items must contain at least one item (cannot be empty), while non-client role items and their sub-items can be empty arrays to remove all items
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.
Example:
"009f778f-83df-454a-b344-768a862a7e55"
description
string | null
Brief description of the matter.
Example:
"This is a brief description for the matter"
status
string | null
Current status of matter.
Possible values: Open, Pending, Closed, Deleted or Cancelled.
Example:
"Open"
dateOpened
string<date-time> | null
Date when the matter was opened. This can be backdated if required.
Example:
"2022-04-23T14:00:00Z"
openedDate
string<date-time> | null
Date the matter was opened. This can be backdated if required.
Example:
"2022-04-23T14:00:00Z"
closedDate
string<date-time> | null
Date the matter was closed. This can be backdated if required.
Example:
"2022-04-23T14:00:00Z"
leadOpenedDate
string<date-time> | null
Date the lead was opened. This can be backdated if required.
Only applies if isLead is true.
Example:
"2022-04-23T14:00:00Z"
leadClosedDate
string<date-time> | null
Date the lead was closed. This can be backdated if required.
Only applies if isLead is true.
Example:
"2022-04-23T14:00:00Z"
leadClosedReason
string | null
Reason the lead was closed.
Only applies if isLead is true.
Example:
"No longer interested"
referralType
string | null
Referral Type of the matter.
Possible values are different per region.
Example:
"Google"
referrerId
string | null
Contact id of the person that referred the matter.
Example:
"97bbe49f-6460-4bfc-b287-34ddfdbb81ef"
referralAgreementFeeType
string | null
The referral agreement fee type.
Possible values: %, Flat fee, Other
referralAgreementFee
number<double> | null
The referral agreement fee value.
referralAgreementFeeComment
string | null
The referral agreement fee comment.
personResponsibleStaffId
string | null
Staff id of the person responsible for the matter (if applicable).
Example:
"c85d28cb-a760-4627-aa59-0a853c2e65ed"
personAssistingStaffId
string | null
Staff id of the person assisting in the matter (if applicable).
Example:
"c85d28cb-a760-4627-aa59-0a853c2e65ed"
personAssistingStaffIds
string[] | null
Staff ids of the other persons assisting in the matter (if applicable).
Example:
["c85d28cb-a760-4627-aa59-0a853c2e65ed"]
originatingStaffId
string | null
Staff id of the originating attorney (if in US) or an Introducer (if in AU)
Example:
"c85d28cb-a760-4627-aa59-0a853c2e65ed"
originatingStaffIds
string[] | null
Staff ids of the other originating attorneys (if in US) or an Introducer (if in AU)
Required when SplitOriginatingStaffSettings is provided and enabled.
This field must be included when updating SplitOriginatingStaffSettings.
Example:
["c85d28cb-a760-4627-aa59-0a853c2e65ed"]
splitOriginatingStaffSettings
object | null
Settings for splitting originating staff members on a matter.
When enabled, this allows distribution of originating staff responsibilities across multiple staff members
using either equal splits or custom ratios. The staff IDs specified in SplitMatterStaffs must exactly
match the OriginatingStaffIds provided.
OriginatingStaffIds must be included in the same request when updating these settings.
Validation rules:
OriginatingStaffIds must be provided when this setting is enabled
Staff ratios must sum to 10000 (100%) when using UseRatio split method
RemainderStaffId must be one of the staff members in the SplitMatterStaffs collection
No duplicate staff members allowed
Show child attributes
supervisorStaffId
string | null
Staff id of the supervisor of the matter.
Only supported in the UK.
Example:
"c85d28cb-a760-4627-aa59-0a853c2e65ed"
clientCode
string | null
Associates an external client code to this matter.
Only supported in AU and UK.
Example:
"Client A"
branchId
string | null
Unique identifier of the associated branch.
Example:
"c85d28cb-a760-4627-aa59-0a853c2e65ed"
branchProviderId
string | null
Unique identifier of the associated branch provider.
Example:
"c85d28cb-a760-4627-aa59-0a853c2e65ed"
clientRole
string | null
'Client' matter type representative option for the matter.
Required and only supported when converting a 'Lead' to 'Matter'.
Example:
"Buyer"
isLead
boolean
Optional boolean flag indicating if matter is a 'Lead'.
This must be set to 'false' when converting a 'Lead' to 'Matter'.
Example:
false
clientIds
string[] | null
List of unique identifiers of 'Client' contacts associated with the matter.
otherSideIds
string[] | null
List of unique identifiers of 'OtherSide' contacts associated with the matter.
items
object | null
Items associated with the matter.
Show child attributes
Response
When request is accepted. Returns a hypermedia 'Link' object of the matter to be patched.
id
string | null
href
string | null
relation
string | null
method
string | null
default:GET
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Smokeball","colors":{"primary":"#f2600c","light":"#f2600c","dark":"#f2600c"},"logo":{"light":"https://mintcdn.com/smokeball/M3xU16wx3zLWrCy3/logo/light.svg?fit=max\u0026auto=format\u0026n=M3xU16wx3zLWrCy3\u0026q=85\u0026s=9742e65825b3575ca562541e0e7571d3","dark":"https://mintcdn.com/smokeball/M3xU16wx3zLWrCy3/logo/dark.svg?fit=max\u0026auto=format\u0026n=M3xU16wx3zLWrCy3\u0026q=85\u0026s=41d28476531680072164e1c91ac71a92","href":"https://www.smokeball.com"},"favicon":"https://mintcdn.com/smokeball/LxpjiDzzIUXckVg2/favicon.png?fit=max\u0026auto=format\u0026n=LxpjiDzzIUXckVg2\u0026q=85\u0026s=7230aa1ad4ca565e84539a7635af36e2","appearance":{"default":"light"},"navbar":{"links":[{"href":"https://support.smokeball.com","label":"Support"}],"primary":{"type":"button","label":"Developer Console","href":"https://console.smokeball.com"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/smokeball-com","facebook":"https://www.facebook.com/SmokeballUS","youtube":"https://www.youtube.com/c/SmokeballNews"}},"fonts":{"heading":{"family":"Poppins"},"body":{"family":"Inter"}},"styling":{"codeblocks":"dark","latex":false},"navigation":{"global":{"anchors":[{"anchor":"Marketplace","icon":"store","href":"https://marketplace.smokeball.com"},{"anchor":"Blog","icon":"newspaper","href":"https://www.smokeball.com/blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"smokeball","hasAudioNarration":false,"actualSubdomain":"smokeball","customDomains":["docs.smokeball.com"],"gitSource":{"type":"github","owner":"smokeballdev","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afe4160603d74231fc4fed8","clientVersion":"0.0.4248","searchFilterCounts":[{"language":"default","tag":"API","count":212},{"language":"default","tag":"APIs","count":195},{"language":"default","tag":"SDK","count":40},{"language":"default","tag":"Documentation","count":15},{"language":"default","tag":"Matters","count":15},{"language":"default","tag":"Contacts","count":14},{"language":"default","tag":"Tasks","count":14},{"language":"default","tag":"Files","count":13},{"language":"default","tag":"Platform","count":11},{"language":"default","tag":"Bank Accounts","count":10}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"#hero-container{height:24rem;overflow:hidden}#hero-background{opacity:0.05}#hero-content{position:absolute;text-align:center;padding:0 1rem}#hero-title{font-weight:800;font-size:36px;margin:0;font-family:Poppins}#hero-description{margin-top:1rem;font-weight:400;font-size:16px;max-width:42rem;text-align:center;margin:1rem auto;font-family:Poppins}#home-search-entry{margin-top:2rem;max-width:24rem;font-family:Poppins;font-weight:700;font-size:1.1rem;letter-spacing:0.02em;border:2px solid transparent;cursor:pointer;transition:all 0.2s ease-in-out;outline:none;background-color:#FF5C00;box-shadow:0 4px 6px -1px rgba(0, 0, 0, 0.1), 0 2px 4px -1px rgba(0, 0, 0, 0.06)}#home-search-entry:hover{background-color:#FF7A33;transform:scale(1.02);box-shadow:0 6px 8px -1px rgba(0, 0, 0, 0.15), 0 3px 6px -1px rgba(0, 0, 0, 0.08)}#search-icon{margin-right:0.75rem;mask-image:url(\"https://mintlify.b-cdn.net/v6.5.1/solid/magnifying-glass.svg\");mask-repeat:no-repeat;mask-position:center center;background-color:currentColor}#main-content-container{margin-top:2rem;margin-bottom:8rem;max-width:70rem;margin-left:auto;margin-right:auto;padding-left:1.25rem;padding-right:1.25rem}#documentation-section{margin-top:2rem;margin-bottom:2rem}#documentation-title{font-size:2rem;font-weight:800;font-family:Poppins}#partner-section{margin-top:2rem;margin-bottom:2rem}#partner-title{font-size:2rem;font-weight:800;font-family:Poppins}#partner-description{font-size:1.05rem;margin-bottom:1rem}"}]}
{"page":{"pagePath":"api-reference/matters/patch-a-matter","slug":"/api-reference/matters/patch-a-matter","pageMetadata":{"title":"Patch a matter","description":"Patches a specified matter.\r\n \r\nNote: This endpoint can also be used to update a `Lead`, convert `Lead` to `Matter` and change the `Lead`/`Matter` type.\r\n \r\nSee `Matters` documentation for more details on how to use this.\r\n\r\nThe following actions are not supported:\r\n\r\n- `items` cannot be updated where either `clientIds` and/or `otherSideIds` are being updated\r\n \r\n- `items` cannot be updated when converting a `Lead` to `Matter` or changing the `Lead`/`Matter` type\r\n \r\n- `clientRole` cannot be updated, unless converting a `Lead` to `Matter` or changing the `Lead`/`Matter` type\r\n \r\n- `Matter` cannot be converted back to `Lead`\r\n \r\n- `splitOriginatingStaffSettings` cannot be updated without also providing `originatingStaffIds` in the same PATCH request\r\n \r\n- `personAssistingStaffIds` cannot contain `personAssistingStaffId`\r\n \r\n- `originatingStaffIds` cannot contain `originatingStaffId`\r\n \r\n- If split originating staff settings are enabled, `originatingStaffIds` and `originatingStaffId` cannot be updated\r\n \r\n- When updating via `items`, client role items and their sub-items must contain at least one item (cannot be empty), while non-client role items and their sub-items can be empty arrays to remove all items","deprecated":null,"version":null,"openapi":"/openapi.json patch /matters/{matterId}","href":"/api-reference/matters/patch-a-matter","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n li: \"li\",\n p: \"p\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Patches a specified matter.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Note: This endpoint can also be used to update a \", _jsx(_components.code, {\n children: \"Lead\"\n }), \", convert \", _jsx(_components.code, {\n children: \"Lead\"\n }), \" to \", _jsx(_components.code, {\n children: \"Matter\"\n }), \" and change the \", _jsx(_components.code, {\n children: \"Lead\"\n }), \"/\", _jsx(_components.code, {\n children: \"Matter\"\n }), \" type.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"See \", _jsx(_components.code, {\n children: \"Matters\"\n }), \" documentation for more details on how to use this.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"The following actions are not supported:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"items\"\n }), \" cannot be updated where either \", _jsx(_components.code, {\n children: \"clientIds\"\n }), \" and/or \", _jsx(_components.code, {\n children: \"otherSideIds\"\n }), \" are being updated\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"items\"\n }), \" cannot be updated when converting a \", _jsx(_components.code, {\n children: \"Lead\"\n }), \" to \", _jsx(_components.code, {\n children: \"Matter\"\n }), \" or changing the \", _jsx(_components.code, {\n children: \"Lead\"\n }), \"/\", _jsx(_components.code, {\n children: \"Matter\"\n }), \" type\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"clientRole\"\n }), \" cannot be updated, unless converting a \", _jsx(_components.code, {\n children: \"Lead\"\n }), \" to \", _jsx(_components.code, {\n children: \"Matter\"\n }), \" or changing the \", _jsx(_components.code, {\n children: \"Lead\"\n }), \"/\", _jsx(_components.code, {\n children: \"Matter\"\n }), \" type\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"Matter\"\n }), \" cannot be converted back to \", _jsx(_components.code, {\n children: \"Lead\"\n })]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"splitOriginatingStaffSettings\"\n }), \" cannot be updated without also providing \", _jsx(_components.code, {\n children: \"originatingStaffIds\"\n }), \" in the same PATCH request\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"personAssistingStaffIds\"\n }), \" cannot contain \", _jsx(_components.code, {\n children: \"personAssistingStaffId\"\n })]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"originatingStaffIds\"\n }), \" cannot contain \", _jsx(_components.code, {\n children: \"originatingStaffId\"\n })]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [\"If split originating staff settings are enabled, \", _jsx(_components.code, {\n children: \"originatingStaffIds\"\n }), \" and \", _jsx(_components.code, {\n children: \"originatingStaffId\"\n }), \" cannot be updated\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [\"When updating via \", _jsx(_components.code, {\n children: \"items\"\n }), \", client role items and their sub-items must contain at least one item (cannot be empty), while non-client role items and their sub-items can be empty arrays to remove all items\"]\n }), \"\\n\"]\n }), \"\\n\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Patch a matter","description":"Patches a specified matter.\r\n \r\nNote: This endpoint can also be used to update a `Lead`, convert `Lead` to `Matter` and change the `Lead`/`Matter` type.\r\n \r\nSee `Matters` documentation for more details on how to use this.\r\n\r\nThe following actions are not supported:\r\n\r\n- `items` cannot be updated where either `clientIds` and/or `otherSideIds` are being updated\r\n \r\n- `items` cannot be updated when converting a `Lead` to `Matter` or changing the `Lead`/`Matter` type\r\n \r\n- `clientRole` cannot be updated, unless converting a `Lead` to `Matter` or changing the `Lead`/`Matter` type\r\n \r\n- `Matter` cannot be converted back to `Lead`\r\n \r\n- `splitOriginatingStaffSettings` cannot be updated without also providing `originatingStaffIds` in the same PATCH request\r\n \r\n- `personAssistingStaffIds` cannot contain `personAssistingStaffId`\r\n \r\n- `originatingStaffIds` cannot contain `originatingStaffId`\r\n \r\n- If split originating staff settings are enabled, `originatingStaffIds` and `originatingStaffId` cannot be updated\r\n \r\n- When updating via `items`, client role items and their sub-items must contain at least one item (cannot be empty), while non-client role items and their sub-items can be empty arrays to remove all items","deprecated":null,"version":null,"openapi":"/openapi.json patch /matters/{matterId}","href":"/api-reference/matters/patch-a-matter","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/smokeball/5af3984d21ddfa7a/scripts/lib/claude-client.js","/_mintlify/custom/smokeball/4484f15c23b65054/scripts/lib/jira-client.js","/_mintlify/custom/smokeball/5079fd8276126440/scripts/lib/mdx-parser.js","/_mintlify/custom/smokeball/d3836391da5f0f6d/scripts/lib/summary-formatter.js","/_mintlify/custom/smokeball/b2629937faf7b0d7/scripts/update-release-notes.js"],"openApiReferenceData":{"operation":{"tags":["Matters"],"summary":"Patch a matter","description":"Patches a specified matter.\r\n \r\nNote: This endpoint can also be used to update a `Lead`, convert `Lead` to `Matter` and change the `Lead`/`Matter` type.\r\n \r\nSee `Matters` documentation for more details on how to use this.\r\n\r\nThe following actions are not supported:\r\n\r\n- `items` cannot be updated where either `clientIds` and/or `otherSideIds` are being updated\r\n \r\n- `items` cannot be updated when converting a `Lead` to `Matter` or changing the `Lead`/`Matter` type\r\n \r\n- `clientRole` cannot be updated, unless converting a `Lead` to `Matter` or changing the `Lead`/`Matter` type\r\n \r\n- `Matter` cannot be converted back to `Lead`\r\n \r\n- `splitOriginatingStaffSettings` cannot be updated without also providing `originatingStaffIds` in the same PATCH request\r\n \r\n- `personAssistingStaffIds` cannot contain `personAssistingStaffId`\r\n \r\n- `originatingStaffIds` cannot contain `originatingStaffId`\r\n \r\n- If split originating staff settings are enabled, `originatingStaffIds` and `originatingStaffId` cannot be updated\r\n \r\n- When updating via `items`, client role items and their sub-items must contain at least one item (cannot be empty), while non-client role items and their sub-items can be empty arrays to remove all items","operationId":"PatchMatter","parameters":["e7b0d02e-2cf6-40ff-94e3-2e26dda43905"],"requestBody":"f4decb6d-cf6a-4d9d-83f9-02eb2cb89d60","responses":{"202":"df617bbd-fe79-4b4e-a4bc-8313c7d7b06a","400":"6c02f27c-afc7-4a37-ac3f-ddb507231ddf","403":"01bfe09f-8332-4dba-8776-08aabbc157e2","404":"b4af7b92-30d4-4a4a-a865-79e6544a375e"},"method":"patch","type":"path","servers":["9cc1a8ed-beb8-4063-9b4b-88ca6a8304e6","0313fe5b-1d70-4640-ba62-536789bf8827","6a3bb7ed-506e-4d5d-8060-f4d63f19f1b7","c552891d-324d-49d4-b2b6-e8826a88a1da","7776c4fb-d6c6-4a5f-b608-dc777243c469","3a30fcfe-c69e-485e-b244-2a53c8968813"],"security":["174d6fee-2795-4ca9-a31c-90b8f8874248"],"path":"/matters/{matterId}","baseUrlOptions":["https://api.smokeball.com","https://api.smokeball.com.au","https://api.smokeball.co.uk","https://stagingapi.smokeball.com","https://stagingapi.smokeball.com.au","https://stagingapi.smokeball.co.uk"],"title":"Patch a matter","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"e7b0d02e-2cf6-40ff-94e3-2e26dda43905":{"name":"matterId","in":"path","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"content":{"application/json-patch+json":{"schema":{"type":"object","properties":{"externalSystemId":{"oneOf":[{"type":"string","description":"External system id for the matter.","example":"EXT01","uniqueKey":"externalSystemId.oneOf.0","typeLabel":"string"},{"type":"null","description":"External system id for the matter.","example":"EXT01","uniqueKey":"externalSystemId.oneOf.1","typeLabel":"null"}],"uniqueKey":"externalSystemId","typeLabel":"string | null"},"number":{"oneOf":[{"type":"string","description":"Human-friendly number assigned to matter.","example":"FUS-124","uniqueKey":"number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Human-friendly number assigned to matter.","example":"FUS-124","uniqueKey":"number.oneOf.1","typeLabel":"null"}],"uniqueKey":"number","typeLabel":"string | null"},"matterTypeId":{"oneOf":[{"type":"string","description":"Unique identifier of the matter type associated with the matter.\r\n \r\nMatter types define what information can be saved to the matter, relevant to that area of law and state / location.\r\n \r\nA pre-configured list of matter types can be obtained via the 'GET /mattertypes' API.\r\n \r\n'Lead' matter types are different from the standard matter types used when creating a 'Matter'.\r\n \r\nUse the 'Type' query parameter in the 'GET /mattertypes' API call to get 'Lead' specific matter types.","example":"009f778f-83df-454a-b344-768a862a7e55","uniqueKey":"matterTypeId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of the matter type associated with the matter.\r\n \r\nMatter types define what information can be saved to the matter, relevant to that area of law and state / location.\r\n \r\nA pre-configured list of matter types can be obtained via the 'GET /mattertypes' API.\r\n \r\n'Lead' matter types are different from the standard matter types used when creating a 'Matter'.\r\n \r\nUse the 'Type' query parameter in the 'GET /mattertypes' API call to get 'Lead' specific matter types.","example":"009f778f-83df-454a-b344-768a862a7e55","uniqueKey":"matterTypeId.oneOf.1","typeLabel":"null"}],"uniqueKey":"matterTypeId","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"Brief description of the matter.","example":"This is a brief description for the matter","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Brief description of the matter.","example":"This is a brief description for the matter","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"status":{"oneOf":[{"type":"string","description":"Current status of matter.\r\n\r\nPossible values: Open, Pending, Closed, Deleted or Cancelled.","example":"Open","uniqueKey":"status.oneOf.0","typeLabel":"string"},{"type":"null","description":"Current status of matter.\r\n\r\nPossible values: Open, Pending, Closed, Deleted or Cancelled.","example":"Open","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"string | null"},"dateOpened":{"oneOf":[{"type":"string","description":"Date when the matter was opened. This can be backdated if required.","format":"date-time","example":"2022-04-23T14:00:00Z","uniqueKey":"dateOpened.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Date when the matter was opened. This can be backdated if required.","format":"date-time","example":"2022-04-23T14:00:00Z","uniqueKey":"dateOpened.oneOf.1","typeLabel":"null"}],"uniqueKey":"dateOpened","typeLabel":"string\u003cdate-time> | null"},"openedDate":{"oneOf":[{"type":"string","description":"Date the matter was opened. This can be backdated if required.","format":"date-time","example":"2022-04-23T14:00:00Z","uniqueKey":"openedDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Date the matter was opened. This can be backdated if required.","format":"date-time","example":"2022-04-23T14:00:00Z","uniqueKey":"openedDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"openedDate","typeLabel":"string\u003cdate-time> | null"},"closedDate":{"oneOf":[{"type":"string","description":"Date the matter was closed. This can be backdated if required.","format":"date-time","example":"2022-04-23T14:00:00Z","uniqueKey":"closedDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Date the matter was closed. This can be backdated if required.","format":"date-time","example":"2022-04-23T14:00:00Z","uniqueKey":"closedDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"closedDate","typeLabel":"string\u003cdate-time> | null"},"leadOpenedDate":{"oneOf":[{"type":"string","description":"Date the lead was opened. This can be backdated if required.\r\n\r\nOnly applies if isLead is true.","format":"date-time","example":"2022-04-23T14:00:00Z","uniqueKey":"leadOpenedDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Date the lead was opened. This can be backdated if required.\r\n\r\nOnly applies if isLead is true.","format":"date-time","example":"2022-04-23T14:00:00Z","uniqueKey":"leadOpenedDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"leadOpenedDate","typeLabel":"string\u003cdate-time> | null"},"leadClosedDate":{"oneOf":[{"type":"string","description":"Date the lead was closed. This can be backdated if required.\r\n\r\nOnly applies if isLead is true.","format":"date-time","example":"2022-04-23T14:00:00Z","uniqueKey":"leadClosedDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Date the lead was closed. This can be backdated if required.\r\n\r\nOnly applies if isLead is true.","format":"date-time","example":"2022-04-23T14:00:00Z","uniqueKey":"leadClosedDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"leadClosedDate","typeLabel":"string\u003cdate-time> | null"},"leadClosedReason":{"oneOf":[{"type":"string","description":"Reason the lead was closed.\r\n\r\nOnly applies if isLead is true.","example":"No longer interested","uniqueKey":"leadClosedReason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Reason the lead was closed.\r\n\r\nOnly applies if isLead is true.","example":"No longer interested","uniqueKey":"leadClosedReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"leadClosedReason","typeLabel":"string | null"},"referralType":{"oneOf":[{"type":"string","description":"Referral Type of the matter.\r\n\r\nPossible values are different per region.","example":"Google","uniqueKey":"referralType.oneOf.0","typeLabel":"string"},{"type":"null","description":"Referral Type of the matter.\r\n\r\nPossible values are different per region.","example":"Google","uniqueKey":"referralType.oneOf.1","typeLabel":"null"}],"uniqueKey":"referralType","typeLabel":"string | null"},"referrerId":{"oneOf":[{"type":"string","description":"Contact id of the person that referred the matter.","example":"97bbe49f-6460-4bfc-b287-34ddfdbb81ef","uniqueKey":"referrerId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Contact id of the person that referred the matter.","example":"97bbe49f-6460-4bfc-b287-34ddfdbb81ef","uniqueKey":"referrerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"referrerId","typeLabel":"string | null"},"referralAgreementFeeType":{"oneOf":[{"type":"string","description":"The referral agreement fee type.\r\n\r\nPossible values: %, Flat fee, Other","uniqueKey":"referralAgreementFeeType.oneOf.0","typeLabel":"string"},{"type":"null","description":"The referral agreement fee type.\r\n\r\nPossible values: %, Flat fee, Other","uniqueKey":"referralAgreementFeeType.oneOf.1","typeLabel":"null"}],"uniqueKey":"referralAgreementFeeType","typeLabel":"string | null"},"referralAgreementFee":{"oneOf":[{"type":"number","description":"The referral agreement fee value.","format":"double","uniqueKey":"referralAgreementFee.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"The referral agreement fee value.","format":"double","uniqueKey":"referralAgreementFee.oneOf.1","typeLabel":"null"}],"uniqueKey":"referralAgreementFee","typeLabel":"number\u003cdouble> | null"},"referralAgreementFeeComment":{"oneOf":[{"type":"string","description":"The referral agreement fee comment.","uniqueKey":"referralAgreementFeeComment.oneOf.0","typeLabel":"string"},{"type":"null","description":"The referral agreement fee comment.","uniqueKey":"referralAgreementFeeComment.oneOf.1","typeLabel":"null"}],"uniqueKey":"referralAgreementFeeComment","typeLabel":"string | null"},"personResponsibleStaffId":{"oneOf":[{"type":"string","description":"Staff id of the person responsible for the matter (if applicable).","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"personResponsibleStaffId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Staff id of the person responsible for the matter (if applicable).","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"personResponsibleStaffId.oneOf.1","typeLabel":"null"}],"uniqueKey":"personResponsibleStaffId","typeLabel":"string | null"},"personAssistingStaffId":{"oneOf":[{"type":"string","description":"Staff id of the person assisting in the matter (if applicable).","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"personAssistingStaffId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Staff id of the person assisting in the matter (if applicable).","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"personAssistingStaffId.oneOf.1","typeLabel":"null"}],"uniqueKey":"personAssistingStaffId","typeLabel":"string | null"},"personAssistingStaffIds":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"personAssistingStaffIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Staff ids of the other persons assisting in the matter (if applicable).","example":["c85d28cb-a760-4627-aa59-0a853c2e65ed"],"uniqueKey":"personAssistingStaffIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Staff ids of the other persons assisting in the matter (if applicable).","example":["c85d28cb-a760-4627-aa59-0a853c2e65ed"],"uniqueKey":"personAssistingStaffIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"personAssistingStaffIds","typeLabel":"string[] | null"},"originatingStaffId":{"oneOf":[{"type":"string","description":"Staff id of the originating attorney (if in US) or an Introducer (if in AU)","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"originatingStaffId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Staff id of the originating attorney (if in US) or an Introducer (if in AU)","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"originatingStaffId.oneOf.1","typeLabel":"null"}],"uniqueKey":"originatingStaffId","typeLabel":"string | null"},"originatingStaffIds":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"originatingStaffIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Staff ids of the other originating attorneys (if in US) or an Introducer (if in AU)\r\n\r\nRequired when SplitOriginatingStaffSettings is provided and enabled.\r\nThis field must be included when updating SplitOriginatingStaffSettings.","example":["c85d28cb-a760-4627-aa59-0a853c2e65ed"],"uniqueKey":"originatingStaffIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Staff ids of the other originating attorneys (if in US) or an Introducer (if in AU)\r\n\r\nRequired when SplitOriginatingStaffSettings is provided and enabled.\r\nThis field must be included when updating SplitOriginatingStaffSettings.","example":["c85d28cb-a760-4627-aa59-0a853c2e65ed"],"uniqueKey":"originatingStaffIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"originatingStaffIds","typeLabel":"string[] | null"},"splitOriginatingStaffSettings":{"oneOf":[{"type":"object","description":"Settings for splitting originating staff members on a matter.\n\nWhen enabled, this allows distribution of originating staff responsibilities across multiple staff members\nusing either equal splits or custom ratios. The staff IDs specified in SplitMatterStaffs must exactly\nmatch the OriginatingStaffIds provided.\n\nOriginatingStaffIds must be included in the same request when updating these settings.\n\nValidation rules:\n- OriginatingStaffIds must be provided when this setting is enabled\n- Staff ratios must sum to 10000 (100%) when using UseRatio split method\n- RemainderStaffId must be one of the staff members in the SplitMatterStaffs collection\n- No duplicate staff members allowed","properties":{"isEnabled":{"type":"boolean","description":"Indicates whether the split matter staff settings are enabled or not.","uniqueKey":"splitOriginatingStaffSettings.oneOf.0.isEnabled","typeLabel":"boolean"},"splitMatterStaffs":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"matterStaffId":{"oneOf":[{"type":"string","description":"The unique identifier for the split matter staff.","uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMatterStaffs.oneOf.0.items.[INDEX].matterStaffId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The unique identifier for the split matter staff.","uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMatterStaffs.oneOf.0.items.[INDEX].matterStaffId.oneOf.1","typeLabel":"null"}],"uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMatterStaffs.oneOf.0.items.[INDEX].matterStaffId","typeLabel":"string | null"},"matterStaffRatio":{"type":"integer","description":"The split ratio for the matter staff.","format":"int64","uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMatterStaffs.oneOf.0.items.[INDEX].matterStaffRatio","typeLabel":"integer\u003cint64>"}},"additionalProperties":false,"uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMatterStaffs.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"List of staff members involved in the split matter settings.","uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMatterStaffs.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"matterStaffId":{"oneOf":[{"type":"string","description":"The unique identifier for the split matter staff."},{"type":"null","description":"The unique identifier for the split matter staff."}]},"matterStaffRatio":{"type":"integer","description":"The split ratio for the matter staff.","format":"int64"}},"additionalProperties":false},"description":"List of staff members involved in the split matter settings.","uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMatterStaffs.oneOf.1","typeLabel":"null"}],"uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMatterStaffs","typeLabel":"object[] | null"},"splitMethod":{"oneOf":[{"type":"string","description":"Method used to split the matter staff.\r\n\r\nPossible values: Unknown, SplitEvenly, UseRatio.","uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMethod.oneOf.0","typeLabel":"string"},{"type":"null","description":"Method used to split the matter staff.\r\n\r\nPossible values: Unknown, SplitEvenly, UseRatio.","uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMethod.oneOf.1","typeLabel":"null"}],"uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMethod","typeLabel":"string | null"},"remainderStaffId":{"oneOf":[{"type":"string","description":"The unique identifier for the staff member who will handle the remainder of the matter after the split.","uniqueKey":"splitOriginatingStaffSettings.oneOf.0.remainderStaffId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The unique identifier for the staff member who will handle the remainder of the matter after the split.","uniqueKey":"splitOriginatingStaffSettings.oneOf.0.remainderStaffId.oneOf.1","typeLabel":"null"}],"uniqueKey":"splitOriginatingStaffSettings.oneOf.0.remainderStaffId","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"splitOriginatingStaffSettings.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"splitOriginatingStaffSettings.oneOf.1","typeLabel":"null"}],"uniqueKey":"splitOriginatingStaffSettings","typeLabel":"object | null"},"supervisorStaffId":{"oneOf":[{"type":"string","description":"Staff id of the supervisor of the matter.\r\n\r\nOnly supported in the UK.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"supervisorStaffId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Staff id of the supervisor of the matter.\r\n\r\nOnly supported in the UK.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"supervisorStaffId.oneOf.1","typeLabel":"null"}],"uniqueKey":"supervisorStaffId","typeLabel":"string | null"},"clientCode":{"oneOf":[{"type":"string","description":"Associates an external client code to this matter.\r\n\r\nOnly supported in AU and UK.","example":"Client A","uniqueKey":"clientCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Associates an external client code to this matter.\r\n\r\nOnly supported in AU and UK.","example":"Client A","uniqueKey":"clientCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"clientCode","typeLabel":"string | null"},"branchId":{"oneOf":[{"type":"string","description":"Unique identifier of the associated branch.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"branchId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of the associated branch.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"branchId.oneOf.1","typeLabel":"null"}],"uniqueKey":"branchId","typeLabel":"string | null"},"branchProviderId":{"oneOf":[{"type":"string","description":"Unique identifier of the associated branch provider.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"branchProviderId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of the associated branch provider.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"branchProviderId.oneOf.1","typeLabel":"null"}],"uniqueKey":"branchProviderId","typeLabel":"string | null"},"clientRole":{"oneOf":[{"type":"string","description":"'Client' matter type representative option for the matter.\r\n\r\nRequired and only supported when converting a 'Lead' to 'Matter'.","example":"Buyer","uniqueKey":"clientRole.oneOf.0","typeLabel":"string"},{"type":"null","description":"'Client' matter type representative option for the matter.\r\n\r\nRequired and only supported when converting a 'Lead' to 'Matter'.","example":"Buyer","uniqueKey":"clientRole.oneOf.1","typeLabel":"null"}],"uniqueKey":"clientRole","typeLabel":"string | null"},"isLead":{"type":"boolean","description":"Optional boolean flag indicating if matter is a 'Lead'.\r\n \r\nThis must be set to 'false' when converting a 'Lead' to 'Matter'.","example":false,"uniqueKey":"isLead","typeLabel":"boolean"},"clientIds":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"clientIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"List of unique identifiers of 'Client' contacts associated with the matter.","uniqueKey":"clientIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"List of unique identifiers of 'Client' contacts associated with the matter.","uniqueKey":"clientIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"clientIds","typeLabel":"string[] | null"},"otherSideIds":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"otherSideIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"List of unique identifiers of 'OtherSide' contacts associated with the matter.","uniqueKey":"otherSideIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"List of unique identifiers of 'OtherSide' contacts associated with the matter.","uniqueKey":"otherSideIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"otherSideIds","typeLabel":"string[] | null"},"items":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Unique identifier of the matter item.","example":"009f778f-83df-454a-b344-768a862a7e55","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of the matter item.","example":"009f778f-83df-454a-b344-768a862a7e55","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].id","typeLabel":"string | null"},"contactId":{"oneOf":[{"type":"string","description":"Unique identifier of the associated contact.\r\n\r\nOnly applicable for 'role' matter items.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].contactId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of the associated contact.\r\n\r\nOnly applicable for 'role' matter items.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].contactId.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].contactId","typeLabel":"string | null"},"contact":{"oneOf":[{"type":"object","description":"Associated contact.\r\n\r\nOnly applicable for 'role' matter items.","properties":{"id":{"oneOf":[{"type":"string","description":"Unique identifier of the contact.","example":"009f778f-83df-454a-b344-768a862a7e55","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].contact.oneOf.0.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of the contact.","example":"009f778f-83df-454a-b344-768a862a7e55","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].contact.oneOf.0.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].contact.oneOf.0.id","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].contact.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].contact.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].contact","typeLabel":"object | null"},"roleDescription":{"oneOf":[{"type":"string","description":"Displayed name for the matter item.\r\n \r\nOnly applicable for 'role' matter items.","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].roleDescription.oneOf.0","typeLabel":"string"},{"type":"null","description":"Displayed name for the matter item.\r\n \r\nOnly applicable for 'role' matter items.","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].roleDescription.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].roleDescription","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"Description for the matter item.\r\n \r\nOnly applicable for 'role' matter items.","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Description for the matter item.\r\n \r\nOnly applicable for 'role' matter items.","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"subItems":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{"type":"array","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"},"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.0.additionalProperties.oneOf.0","typeLabel":"array"},{"type":"null","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"},"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.0.additionalProperties","typeLabel":"array | null"},"description":"SubItems associated with the matter item.\r\n\r\nNot applicable for matter sub items.","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{"type":"array","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"},"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.1.additionalProperties.oneOf.0","typeLabel":"array"},{"type":"null","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"},"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.1.additionalProperties","typeLabel":"array | null"},"description":"SubItems associated with the matter item.\r\n\r\nNot applicable for matter sub items.","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].subItems","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Unique identifier of the matter item.","example":"009f778f-83df-454a-b344-768a862a7e55"},{"type":"null","description":"Unique identifier of the matter item.","example":"009f778f-83df-454a-b344-768a862a7e55"}]},"contactId":{"oneOf":[{"type":"string","description":"Unique identifier of the associated contact.\r\n\r\nOnly applicable for 'role' matter items.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed"},{"type":"null","description":"Unique identifier of the associated contact.\r\n\r\nOnly applicable for 'role' matter items.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed"}]},"contact":{"oneOf":[{"type":"object","description":"Associated contact.\r\n\r\nOnly applicable for 'role' matter items.","properties":{"id":{"oneOf":[{"type":"string","description":"Unique identifier of the contact.","example":"009f778f-83df-454a-b344-768a862a7e55"},{"type":"null","description":"Unique identifier of the contact.","example":"009f778f-83df-454a-b344-768a862a7e55"}]}},"additionalProperties":false},{"type":"null"}]},"roleDescription":{"oneOf":[{"type":"string","description":"Displayed name for the matter item.\r\n \r\nOnly applicable for 'role' matter items."},{"type":"null","description":"Displayed name for the matter item.\r\n \r\nOnly applicable for 'role' matter items."}]},"description":{"oneOf":[{"type":"string","description":"Description for the matter item.\r\n \r\nOnly applicable for 'role' matter items."},{"type":"null","description":"Description for the matter item.\r\n \r\nOnly applicable for 'role' matter items."}]},"subItems":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{"type":"array","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"}},{"type":"null","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"}}]},"description":"SubItems associated with the matter item.\r\n\r\nNot applicable for matter sub items."},{"type":"null","additionalProperties":{"oneOf":[{"type":"array","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"}},{"type":"null","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"}}]},"description":"SubItems associated with the matter item.\r\n\r\nNot applicable for matter sub items."}]}},"additionalProperties":false},"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.0.additionalProperties","typeLabel":"object[] | null"},"description":"Items associated with the matter.","uniqueKey":"\\items.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Unique identifier of the matter item.","example":"009f778f-83df-454a-b344-768a862a7e55","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of the matter item.","example":"009f778f-83df-454a-b344-768a862a7e55","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].id","typeLabel":"string | null"},"contactId":{"oneOf":[{"type":"string","description":"Unique identifier of the associated contact.\r\n\r\nOnly applicable for 'role' matter items.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].contactId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of the associated contact.\r\n\r\nOnly applicable for 'role' matter items.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].contactId.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].contactId","typeLabel":"string | null"},"contact":{"oneOf":[{"type":"object","description":"Associated contact.\r\n\r\nOnly applicable for 'role' matter items.","properties":{"id":{"oneOf":[{"type":"string","description":"Unique identifier of the contact.","example":"009f778f-83df-454a-b344-768a862a7e55","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].contact.oneOf.0.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of the contact.","example":"009f778f-83df-454a-b344-768a862a7e55","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].contact.oneOf.0.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].contact.oneOf.0.id","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].contact.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].contact.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].contact","typeLabel":"object | null"},"roleDescription":{"oneOf":[{"type":"string","description":"Displayed name for the matter item.\r\n \r\nOnly applicable for 'role' matter items.","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].roleDescription.oneOf.0","typeLabel":"string"},{"type":"null","description":"Displayed name for the matter item.\r\n \r\nOnly applicable for 'role' matter items.","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].roleDescription.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].roleDescription","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"Description for the matter item.\r\n \r\nOnly applicable for 'role' matter items.","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Description for the matter item.\r\n \r\nOnly applicable for 'role' matter items.","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"subItems":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{"type":"array","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"},"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.0.additionalProperties.oneOf.0","typeLabel":"array"},{"type":"null","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"},"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.0.additionalProperties","typeLabel":"array | null"},"description":"SubItems associated with the matter item.\r\n\r\nNot applicable for matter sub items.","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{"type":"array","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"},"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.1.additionalProperties.oneOf.0","typeLabel":"array"},{"type":"null","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"},"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.1.additionalProperties","typeLabel":"array | null"},"description":"SubItems associated with the matter item.\r\n\r\nNot applicable for matter sub items.","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].subItems","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Unique identifier of the matter item.","example":"009f778f-83df-454a-b344-768a862a7e55"},{"type":"null","description":"Unique identifier of the matter item.","example":"009f778f-83df-454a-b344-768a862a7e55"}]},"contactId":{"oneOf":[{"type":"string","description":"Unique identifier of the associated contact.\r\n\r\nOnly applicable for 'role' matter items.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed"},{"type":"null","description":"Unique identifier of the associated contact.\r\n\r\nOnly applicable for 'role' matter items.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed"}]},"contact":{"oneOf":[{"type":"object","description":"Associated contact.\r\n\r\nOnly applicable for 'role' matter items.","properties":{"id":{"oneOf":[{"type":"string","description":"Unique identifier of the contact.","example":"009f778f-83df-454a-b344-768a862a7e55"},{"type":"null","description":"Unique identifier of the contact.","example":"009f778f-83df-454a-b344-768a862a7e55"}]}},"additionalProperties":false},{"type":"null"}]},"roleDescription":{"oneOf":[{"type":"string","description":"Displayed name for the matter item.\r\n \r\nOnly applicable for 'role' matter items."},{"type":"null","description":"Displayed name for the matter item.\r\n \r\nOnly applicable for 'role' matter items."}]},"description":{"oneOf":[{"type":"string","description":"Description for the matter item.\r\n \r\nOnly applicable for 'role' matter items."},{"type":"null","description":"Description for the matter item.\r\n \r\nOnly applicable for 'role' matter items."}]},"subItems":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{"type":"array","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"}},{"type":"null","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"}}]},"description":"SubItems associated with the matter item.\r\n\r\nNot applicable for matter sub items."},{"type":"null","additionalProperties":{"oneOf":[{"type":"array","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"}},{"type":"null","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"}}]},"description":"SubItems associated with the matter item.\r\n\r\nNot applicable for matter sub items."}]}},"additionalProperties":false},"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.1.additionalProperties","typeLabel":"object[] | null"},"description":"Items associated with the matter.","uniqueKey":"\\items.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"externalSystemId":"EXT01","number":"FUS-124","matterTypeId":"009f778f-83df-454a-b344-768a862a7e55","description":"This is a brief description for the matter","status":"Open","dateOpened":"2022-04-23T14:00:00Z","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","referralAgreementFeeType":"\u003cstring>","referralAgreementFee":123,"referralAgreementFeeComment":"\u003cstring>","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"],"splitOriginatingStaffSettings":{"isEnabled":true,"splitMatterStaffs":[{"matterStaffId":"\u003cstring>","matterStaffRatio":123}],"splitMethod":"\u003cstring>","remainderStaffId":"\u003cstring>"},"supervisorStaffId":"c85d28cb-a760-4627-aa59-0a853c2e65ed","clientCode":"Client A","branchId":"c85d28cb-a760-4627-aa59-0a853c2e65ed","branchProviderId":"c85d28cb-a760-4627-aa59-0a853c2e65ed","clientRole":"Buyer","isLead":false,"clientIds":["\u003cstring>"],"otherSideIds":["\u003cstring>"],"items":{}}}},"exampleType":"generated"},"application/json":{"schema":{"type":"object","properties":{"externalSystemId":{"oneOf":[{"type":"string","description":"External system id for the matter.","example":"EXT01","uniqueKey":"externalSystemId.oneOf.0","typeLabel":"string"},{"type":"null","description":"External system id for the matter.","example":"EXT01","uniqueKey":"externalSystemId.oneOf.1","typeLabel":"null"}],"uniqueKey":"externalSystemId","typeLabel":"string | null"},"number":{"oneOf":[{"type":"string","description":"Human-friendly number assigned to matter.","example":"FUS-124","uniqueKey":"number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Human-friendly number assigned to matter.","example":"FUS-124","uniqueKey":"number.oneOf.1","typeLabel":"null"}],"uniqueKey":"number","typeLabel":"string | null"},"matterTypeId":{"oneOf":[{"type":"string","description":"Unique identifier of the matter type associated with the matter.\r\n \r\nMatter types define what information can be saved to the matter, relevant to that area of law and state / location.\r\n \r\nA pre-configured list of matter types can be obtained via the 'GET /mattertypes' API.\r\n \r\n'Lead' matter types are different from the standard matter types used when creating a 'Matter'.\r\n \r\nUse the 'Type' query parameter in the 'GET /mattertypes' API call to get 'Lead' specific matter types.","example":"009f778f-83df-454a-b344-768a862a7e55","uniqueKey":"matterTypeId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of the matter type associated with the matter.\r\n \r\nMatter types define what information can be saved to the matter, relevant to that area of law and state / location.\r\n \r\nA pre-configured list of matter types can be obtained via the 'GET /mattertypes' API.\r\n \r\n'Lead' matter types are different from the standard matter types used when creating a 'Matter'.\r\n \r\nUse the 'Type' query parameter in the 'GET /mattertypes' API call to get 'Lead' specific matter types.","example":"009f778f-83df-454a-b344-768a862a7e55","uniqueKey":"matterTypeId.oneOf.1","typeLabel":"null"}],"uniqueKey":"matterTypeId","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"Brief description of the matter.","example":"This is a brief description for the matter","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Brief description of the matter.","example":"This is a brief description for the matter","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"status":{"oneOf":[{"type":"string","description":"Current status of matter.\r\n\r\nPossible values: Open, Pending, Closed, Deleted or Cancelled.","example":"Open","uniqueKey":"status.oneOf.0","typeLabel":"string"},{"type":"null","description":"Current status of matter.\r\n\r\nPossible values: Open, Pending, Closed, Deleted or Cancelled.","example":"Open","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"string | null"},"dateOpened":{"oneOf":[{"type":"string","description":"Date when the matter was opened. This can be backdated if required.","format":"date-time","example":"2022-04-23T14:00:00Z","uniqueKey":"dateOpened.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Date when the matter was opened. This can be backdated if required.","format":"date-time","example":"2022-04-23T14:00:00Z","uniqueKey":"dateOpened.oneOf.1","typeLabel":"null"}],"uniqueKey":"dateOpened","typeLabel":"string\u003cdate-time> | null"},"openedDate":{"oneOf":[{"type":"string","description":"Date the matter was opened. This can be backdated if required.","format":"date-time","example":"2022-04-23T14:00:00Z","uniqueKey":"openedDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Date the matter was opened. This can be backdated if required.","format":"date-time","example":"2022-04-23T14:00:00Z","uniqueKey":"openedDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"openedDate","typeLabel":"string\u003cdate-time> | null"},"closedDate":{"oneOf":[{"type":"string","description":"Date the matter was closed. This can be backdated if required.","format":"date-time","example":"2022-04-23T14:00:00Z","uniqueKey":"closedDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Date the matter was closed. This can be backdated if required.","format":"date-time","example":"2022-04-23T14:00:00Z","uniqueKey":"closedDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"closedDate","typeLabel":"string\u003cdate-time> | null"},"leadOpenedDate":{"oneOf":[{"type":"string","description":"Date the lead was opened. This can be backdated if required.\r\n\r\nOnly applies if isLead is true.","format":"date-time","example":"2022-04-23T14:00:00Z","uniqueKey":"leadOpenedDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Date the lead was opened. This can be backdated if required.\r\n\r\nOnly applies if isLead is true.","format":"date-time","example":"2022-04-23T14:00:00Z","uniqueKey":"leadOpenedDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"leadOpenedDate","typeLabel":"string\u003cdate-time> | null"},"leadClosedDate":{"oneOf":[{"type":"string","description":"Date the lead was closed. This can be backdated if required.\r\n\r\nOnly applies if isLead is true.","format":"date-time","example":"2022-04-23T14:00:00Z","uniqueKey":"leadClosedDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Date the lead was closed. This can be backdated if required.\r\n\r\nOnly applies if isLead is true.","format":"date-time","example":"2022-04-23T14:00:00Z","uniqueKey":"leadClosedDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"leadClosedDate","typeLabel":"string\u003cdate-time> | null"},"leadClosedReason":{"oneOf":[{"type":"string","description":"Reason the lead was closed.\r\n\r\nOnly applies if isLead is true.","example":"No longer interested","uniqueKey":"leadClosedReason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Reason the lead was closed.\r\n\r\nOnly applies if isLead is true.","example":"No longer interested","uniqueKey":"leadClosedReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"leadClosedReason","typeLabel":"string | null"},"referralType":{"oneOf":[{"type":"string","description":"Referral Type of the matter.\r\n\r\nPossible values are different per region.","example":"Google","uniqueKey":"referralType.oneOf.0","typeLabel":"string"},{"type":"null","description":"Referral Type of the matter.\r\n\r\nPossible values are different per region.","example":"Google","uniqueKey":"referralType.oneOf.1","typeLabel":"null"}],"uniqueKey":"referralType","typeLabel":"string | null"},"referrerId":{"oneOf":[{"type":"string","description":"Contact id of the person that referred the matter.","example":"97bbe49f-6460-4bfc-b287-34ddfdbb81ef","uniqueKey":"referrerId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Contact id of the person that referred the matter.","example":"97bbe49f-6460-4bfc-b287-34ddfdbb81ef","uniqueKey":"referrerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"referrerId","typeLabel":"string | null"},"referralAgreementFeeType":{"oneOf":[{"type":"string","description":"The referral agreement fee type.\r\n\r\nPossible values: %, Flat fee, Other","uniqueKey":"referralAgreementFeeType.oneOf.0","typeLabel":"string"},{"type":"null","description":"The referral agreement fee type.\r\n\r\nPossible values: %, Flat fee, Other","uniqueKey":"referralAgreementFeeType.oneOf.1","typeLabel":"null"}],"uniqueKey":"referralAgreementFeeType","typeLabel":"string | null"},"referralAgreementFee":{"oneOf":[{"type":"number","description":"The referral agreement fee value.","format":"double","uniqueKey":"referralAgreementFee.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"The referral agreement fee value.","format":"double","uniqueKey":"referralAgreementFee.oneOf.1","typeLabel":"null"}],"uniqueKey":"referralAgreementFee","typeLabel":"number\u003cdouble> | null"},"referralAgreementFeeComment":{"oneOf":[{"type":"string","description":"The referral agreement fee comment.","uniqueKey":"referralAgreementFeeComment.oneOf.0","typeLabel":"string"},{"type":"null","description":"The referral agreement fee comment.","uniqueKey":"referralAgreementFeeComment.oneOf.1","typeLabel":"null"}],"uniqueKey":"referralAgreementFeeComment","typeLabel":"string | null"},"personResponsibleStaffId":{"oneOf":[{"type":"string","description":"Staff id of the person responsible for the matter (if applicable).","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"personResponsibleStaffId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Staff id of the person responsible for the matter (if applicable).","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"personResponsibleStaffId.oneOf.1","typeLabel":"null"}],"uniqueKey":"personResponsibleStaffId","typeLabel":"string | null"},"personAssistingStaffId":{"oneOf":[{"type":"string","description":"Staff id of the person assisting in the matter (if applicable).","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"personAssistingStaffId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Staff id of the person assisting in the matter (if applicable).","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"personAssistingStaffId.oneOf.1","typeLabel":"null"}],"uniqueKey":"personAssistingStaffId","typeLabel":"string | null"},"personAssistingStaffIds":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"personAssistingStaffIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Staff ids of the other persons assisting in the matter (if applicable).","example":["c85d28cb-a760-4627-aa59-0a853c2e65ed"],"uniqueKey":"personAssistingStaffIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Staff ids of the other persons assisting in the matter (if applicable).","example":["c85d28cb-a760-4627-aa59-0a853c2e65ed"],"uniqueKey":"personAssistingStaffIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"personAssistingStaffIds","typeLabel":"string[] | null"},"originatingStaffId":{"oneOf":[{"type":"string","description":"Staff id of the originating attorney (if in US) or an Introducer (if in AU)","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"originatingStaffId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Staff id of the originating attorney (if in US) or an Introducer (if in AU)","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"originatingStaffId.oneOf.1","typeLabel":"null"}],"uniqueKey":"originatingStaffId","typeLabel":"string | null"},"originatingStaffIds":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"originatingStaffIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Staff ids of the other originating attorneys (if in US) or an Introducer (if in AU)\r\n\r\nRequired when SplitOriginatingStaffSettings is provided and enabled.\r\nThis field must be included when updating SplitOriginatingStaffSettings.","example":["c85d28cb-a760-4627-aa59-0a853c2e65ed"],"uniqueKey":"originatingStaffIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Staff ids of the other originating attorneys (if in US) or an Introducer (if in AU)\r\n\r\nRequired when SplitOriginatingStaffSettings is provided and enabled.\r\nThis field must be included when updating SplitOriginatingStaffSettings.","example":["c85d28cb-a760-4627-aa59-0a853c2e65ed"],"uniqueKey":"originatingStaffIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"originatingStaffIds","typeLabel":"string[] | null"},"splitOriginatingStaffSettings":{"oneOf":[{"type":"object","description":"Settings for splitting originating staff members on a matter.\n\nWhen enabled, this allows distribution of originating staff responsibilities across multiple staff members\nusing either equal splits or custom ratios. The staff IDs specified in SplitMatterStaffs must exactly\nmatch the OriginatingStaffIds provided.\n\nOriginatingStaffIds must be included in the same request when updating these settings.\n\nValidation rules:\n- OriginatingStaffIds must be provided when this setting is enabled\n- Staff ratios must sum to 10000 (100%) when using UseRatio split method\n- RemainderStaffId must be one of the staff members in the SplitMatterStaffs collection\n- No duplicate staff members allowed","properties":{"isEnabled":{"type":"boolean","description":"Indicates whether the split matter staff settings are enabled or not.","uniqueKey":"splitOriginatingStaffSettings.oneOf.0.isEnabled","typeLabel":"boolean"},"splitMatterStaffs":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"matterStaffId":{"oneOf":[{"type":"string","description":"The unique identifier for the split matter staff.","uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMatterStaffs.oneOf.0.items.[INDEX].matterStaffId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The unique identifier for the split matter staff.","uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMatterStaffs.oneOf.0.items.[INDEX].matterStaffId.oneOf.1","typeLabel":"null"}],"uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMatterStaffs.oneOf.0.items.[INDEX].matterStaffId","typeLabel":"string | null"},"matterStaffRatio":{"type":"integer","description":"The split ratio for the matter staff.","format":"int64","uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMatterStaffs.oneOf.0.items.[INDEX].matterStaffRatio","typeLabel":"integer\u003cint64>"}},"additionalProperties":false,"uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMatterStaffs.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"List of staff members involved in the split matter settings.","uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMatterStaffs.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"matterStaffId":{"oneOf":[{"type":"string","description":"The unique identifier for the split matter staff."},{"type":"null","description":"The unique identifier for the split matter staff."}]},"matterStaffRatio":{"type":"integer","description":"The split ratio for the matter staff.","format":"int64"}},"additionalProperties":false},"description":"List of staff members involved in the split matter settings.","uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMatterStaffs.oneOf.1","typeLabel":"null"}],"uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMatterStaffs","typeLabel":"object[] | null"},"splitMethod":{"oneOf":[{"type":"string","description":"Method used to split the matter staff.\r\n\r\nPossible values: Unknown, SplitEvenly, UseRatio.","uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMethod.oneOf.0","typeLabel":"string"},{"type":"null","description":"Method used to split the matter staff.\r\n\r\nPossible values: Unknown, SplitEvenly, UseRatio.","uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMethod.oneOf.1","typeLabel":"null"}],"uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMethod","typeLabel":"string | null"},"remainderStaffId":{"oneOf":[{"type":"string","description":"The unique identifier for the staff member who will handle the remainder of the matter after the split.","uniqueKey":"splitOriginatingStaffSettings.oneOf.0.remainderStaffId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The unique identifier for the staff member who will handle the remainder of the matter after the split.","uniqueKey":"splitOriginatingStaffSettings.oneOf.0.remainderStaffId.oneOf.1","typeLabel":"null"}],"uniqueKey":"splitOriginatingStaffSettings.oneOf.0.remainderStaffId","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"splitOriginatingStaffSettings.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"splitOriginatingStaffSettings.oneOf.1","typeLabel":"null"}],"uniqueKey":"splitOriginatingStaffSettings","typeLabel":"object | null"},"supervisorStaffId":{"oneOf":[{"type":"string","description":"Staff id of the supervisor of the matter.\r\n\r\nOnly supported in the UK.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"supervisorStaffId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Staff id of the supervisor of the matter.\r\n\r\nOnly supported in the UK.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"supervisorStaffId.oneOf.1","typeLabel":"null"}],"uniqueKey":"supervisorStaffId","typeLabel":"string | null"},"clientCode":{"oneOf":[{"type":"string","description":"Associates an external client code to this matter.\r\n\r\nOnly supported in AU and UK.","example":"Client A","uniqueKey":"clientCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Associates an external client code to this matter.\r\n\r\nOnly supported in AU and UK.","example":"Client A","uniqueKey":"clientCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"clientCode","typeLabel":"string | null"},"branchId":{"oneOf":[{"type":"string","description":"Unique identifier of the associated branch.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"branchId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of the associated branch.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"branchId.oneOf.1","typeLabel":"null"}],"uniqueKey":"branchId","typeLabel":"string | null"},"branchProviderId":{"oneOf":[{"type":"string","description":"Unique identifier of the associated branch provider.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"branchProviderId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of the associated branch provider.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"branchProviderId.oneOf.1","typeLabel":"null"}],"uniqueKey":"branchProviderId","typeLabel":"string | null"},"clientRole":{"oneOf":[{"type":"string","description":"'Client' matter type representative option for the matter.\r\n\r\nRequired and only supported when converting a 'Lead' to 'Matter'.","example":"Buyer","uniqueKey":"clientRole.oneOf.0","typeLabel":"string"},{"type":"null","description":"'Client' matter type representative option for the matter.\r\n\r\nRequired and only supported when converting a 'Lead' to 'Matter'.","example":"Buyer","uniqueKey":"clientRole.oneOf.1","typeLabel":"null"}],"uniqueKey":"clientRole","typeLabel":"string | null"},"isLead":{"type":"boolean","description":"Optional boolean flag indicating if matter is a 'Lead'.\r\n \r\nThis must be set to 'false' when converting a 'Lead' to 'Matter'.","example":false,"uniqueKey":"isLead","typeLabel":"boolean"},"clientIds":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"clientIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"List of unique identifiers of 'Client' contacts associated with the matter.","uniqueKey":"clientIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"List of unique identifiers of 'Client' contacts associated with the matter.","uniqueKey":"clientIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"clientIds","typeLabel":"string[] | null"},"otherSideIds":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"otherSideIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"List of unique identifiers of 'OtherSide' contacts associated with the matter.","uniqueKey":"otherSideIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"List of unique identifiers of 'OtherSide' contacts associated with the matter.","uniqueKey":"otherSideIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"otherSideIds","typeLabel":"string[] | null"},"items":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Unique identifier of the matter item.","example":"009f778f-83df-454a-b344-768a862a7e55","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of the matter item.","example":"009f778f-83df-454a-b344-768a862a7e55","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].id","typeLabel":"string | null"},"contactId":{"oneOf":[{"type":"string","description":"Unique identifier of the associated contact.\r\n\r\nOnly applicable for 'role' matter items.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].contactId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of the associated contact.\r\n\r\nOnly applicable for 'role' matter items.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].contactId.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].contactId","typeLabel":"string | null"},"contact":{"oneOf":[{"type":"object","description":"Associated contact.\r\n\r\nOnly applicable for 'role' matter items.","properties":{"id":{"oneOf":[{"type":"string","description":"Unique identifier of the contact.","example":"009f778f-83df-454a-b344-768a862a7e55","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].contact.oneOf.0.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of the contact.","example":"009f778f-83df-454a-b344-768a862a7e55","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].contact.oneOf.0.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].contact.oneOf.0.id","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].contact.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].contact.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].contact","typeLabel":"object | null"},"roleDescription":{"oneOf":[{"type":"string","description":"Displayed name for the matter item.\r\n \r\nOnly applicable for 'role' matter items.","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].roleDescription.oneOf.0","typeLabel":"string"},{"type":"null","description":"Displayed name for the matter item.\r\n \r\nOnly applicable for 'role' matter items.","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].roleDescription.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].roleDescription","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"Description for the matter item.\r\n \r\nOnly applicable for 'role' matter items.","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Description for the matter item.\r\n \r\nOnly applicable for 'role' matter items.","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"subItems":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{"type":"array","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"},"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.0.additionalProperties.oneOf.0","typeLabel":"array"},{"type":"null","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"},"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.0.additionalProperties","typeLabel":"array | null"},"description":"SubItems associated with the matter item.\r\n\r\nNot applicable for matter sub items.","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{"type":"array","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"},"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.1.additionalProperties.oneOf.0","typeLabel":"array"},{"type":"null","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"},"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.1.additionalProperties","typeLabel":"array | null"},"description":"SubItems associated with the matter item.\r\n\r\nNot applicable for matter sub items.","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].subItems","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Unique identifier of the matter item.","example":"009f778f-83df-454a-b344-768a862a7e55"},{"type":"null","description":"Unique identifier of the matter item.","example":"009f778f-83df-454a-b344-768a862a7e55"}]},"contactId":{"oneOf":[{"type":"string","description":"Unique identifier of the associated contact.\r\n\r\nOnly applicable for 'role' matter items.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed"},{"type":"null","description":"Unique identifier of the associated contact.\r\n\r\nOnly applicable for 'role' matter items.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed"}]},"contact":{"oneOf":[{"type":"object","description":"Associated contact.\r\n\r\nOnly applicable for 'role' matter items.","properties":{"id":{"oneOf":[{"type":"string","description":"Unique identifier of the contact.","example":"009f778f-83df-454a-b344-768a862a7e55"},{"type":"null","description":"Unique identifier of the contact.","example":"009f778f-83df-454a-b344-768a862a7e55"}]}},"additionalProperties":false},{"type":"null"}]},"roleDescription":{"oneOf":[{"type":"string","description":"Displayed name for the matter item.\r\n \r\nOnly applicable for 'role' matter items."},{"type":"null","description":"Displayed name for the matter item.\r\n \r\nOnly applicable for 'role' matter items."}]},"description":{"oneOf":[{"type":"string","description":"Description for the matter item.\r\n \r\nOnly applicable for 'role' matter items."},{"type":"null","description":"Description for the matter item.\r\n \r\nOnly applicable for 'role' matter items."}]},"subItems":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{"type":"array","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"}},{"type":"null","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"}}]},"description":"SubItems associated with the matter item.\r\n\r\nNot applicable for matter sub items."},{"type":"null","additionalProperties":{"oneOf":[{"type":"array","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"}},{"type":"null","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"}}]},"description":"SubItems associated with the matter item.\r\n\r\nNot applicable for matter sub items."}]}},"additionalProperties":false},"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.0.additionalProperties","typeLabel":"object[] | null"},"description":"Items associated with the matter.","uniqueKey":"\\items.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Unique identifier of the matter item.","example":"009f778f-83df-454a-b344-768a862a7e55","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of the matter item.","example":"009f778f-83df-454a-b344-768a862a7e55","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].id","typeLabel":"string | null"},"contactId":{"oneOf":[{"type":"string","description":"Unique identifier of the associated contact.\r\n\r\nOnly applicable for 'role' matter items.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].contactId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of the associated contact.\r\n\r\nOnly applicable for 'role' matter items.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].contactId.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].contactId","typeLabel":"string | null"},"contact":{"oneOf":[{"type":"object","description":"Associated contact.\r\n\r\nOnly applicable for 'role' matter items.","properties":{"id":{"oneOf":[{"type":"string","description":"Unique identifier of the contact.","example":"009f778f-83df-454a-b344-768a862a7e55","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].contact.oneOf.0.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of the contact.","example":"009f778f-83df-454a-b344-768a862a7e55","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].contact.oneOf.0.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].contact.oneOf.0.id","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].contact.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].contact.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].contact","typeLabel":"object | null"},"roleDescription":{"oneOf":[{"type":"string","description":"Displayed name for the matter item.\r\n \r\nOnly applicable for 'role' matter items.","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].roleDescription.oneOf.0","typeLabel":"string"},{"type":"null","description":"Displayed name for the matter item.\r\n \r\nOnly applicable for 'role' matter items.","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].roleDescription.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].roleDescription","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"Description for the matter item.\r\n \r\nOnly applicable for 'role' matter items.","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Description for the matter item.\r\n \r\nOnly applicable for 'role' matter items.","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"subItems":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{"type":"array","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"},"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.0.additionalProperties.oneOf.0","typeLabel":"array"},{"type":"null","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"},"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.0.additionalProperties","typeLabel":"array | null"},"description":"SubItems associated with the matter item.\r\n\r\nNot applicable for matter sub items.","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{"type":"array","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"},"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.1.additionalProperties.oneOf.0","typeLabel":"array"},{"type":"null","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"},"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.1.additionalProperties","typeLabel":"array | null"},"description":"SubItems associated with the matter item.\r\n\r\nNot applicable for matter sub items.","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].subItems","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Unique identifier of the matter item.","example":"009f778f-83df-454a-b344-768a862a7e55"},{"type":"null","description":"Unique identifier of the matter item.","example":"009f778f-83df-454a-b344-768a862a7e55"}]},"contactId":{"oneOf":[{"type":"string","description":"Unique identifier of the associated contact.\r\n\r\nOnly applicable for 'role' matter items.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed"},{"type":"null","description":"Unique identifier of the associated contact.\r\n\r\nOnly applicable for 'role' matter items.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed"}]},"contact":{"oneOf":[{"type":"object","description":"Associated contact.\r\n\r\nOnly applicable for 'role' matter items.","properties":{"id":{"oneOf":[{"type":"string","description":"Unique identifier of the contact.","example":"009f778f-83df-454a-b344-768a862a7e55"},{"type":"null","description":"Unique identifier of the contact.","example":"009f778f-83df-454a-b344-768a862a7e55"}]}},"additionalProperties":false},{"type":"null"}]},"roleDescription":{"oneOf":[{"type":"string","description":"Displayed name for the matter item.\r\n \r\nOnly applicable for 'role' matter items."},{"type":"null","description":"Displayed name for the matter item.\r\n \r\nOnly applicable for 'role' matter items."}]},"description":{"oneOf":[{"type":"string","description":"Description for the matter item.\r\n \r\nOnly applicable for 'role' matter items."},{"type":"null","description":"Description for the matter item.\r\n \r\nOnly applicable for 'role' matter items."}]},"subItems":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{"type":"array","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"}},{"type":"null","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"}}]},"description":"SubItems associated with the matter item.\r\n\r\nNot applicable for matter sub items."},{"type":"null","additionalProperties":{"oneOf":[{"type":"array","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"}},{"type":"null","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"}}]},"description":"SubItems associated with the matter item.\r\n\r\nNot applicable for matter sub items."}]}},"additionalProperties":false},"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.1.additionalProperties","typeLabel":"object[] | null"},"description":"Items associated with the matter.","uniqueKey":"\\items.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"externalSystemId":"EXT01","number":"FUS-124","matterTypeId":"009f778f-83df-454a-b344-768a862a7e55","description":"This is a brief description for the matter","status":"Open","dateOpened":"2022-04-23T14:00:00Z","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","referralAgreementFeeType":"\u003cstring>","referralAgreementFee":123,"referralAgreementFeeComment":"\u003cstring>","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"],"splitOriginatingStaffSettings":{"isEnabled":true,"splitMatterStaffs":[{"matterStaffId":"\u003cstring>","matterStaffRatio":123}],"splitMethod":"\u003cstring>","remainderStaffId":"\u003cstring>"},"supervisorStaffId":"c85d28cb-a760-4627-aa59-0a853c2e65ed","clientCode":"Client A","branchId":"c85d28cb-a760-4627-aa59-0a853c2e65ed","branchProviderId":"c85d28cb-a760-4627-aa59-0a853c2e65ed","clientRole":"Buyer","isLead":false,"clientIds":["\u003cstring>"],"otherSideIds":["\u003cstring>"],"items":{}}}},"exampleType":"generated"},"application/*+json":{"schema":{"type":"object","properties":{"externalSystemId":{"oneOf":[{"type":"string","description":"External system id for the matter.","example":"EXT01","uniqueKey":"externalSystemId.oneOf.0","typeLabel":"string"},{"type":"null","description":"External system id for the matter.","example":"EXT01","uniqueKey":"externalSystemId.oneOf.1","typeLabel":"null"}],"uniqueKey":"externalSystemId","typeLabel":"string | null"},"number":{"oneOf":[{"type":"string","description":"Human-friendly number assigned to matter.","example":"FUS-124","uniqueKey":"number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Human-friendly number assigned to matter.","example":"FUS-124","uniqueKey":"number.oneOf.1","typeLabel":"null"}],"uniqueKey":"number","typeLabel":"string | null"},"matterTypeId":{"oneOf":[{"type":"string","description":"Unique identifier of the matter type associated with the matter.\r\n \r\nMatter types define what information can be saved to the matter, relevant to that area of law and state / location.\r\n \r\nA pre-configured list of matter types can be obtained via the 'GET /mattertypes' API.\r\n \r\n'Lead' matter types are different from the standard matter types used when creating a 'Matter'.\r\n \r\nUse the 'Type' query parameter in the 'GET /mattertypes' API call to get 'Lead' specific matter types.","example":"009f778f-83df-454a-b344-768a862a7e55","uniqueKey":"matterTypeId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of the matter type associated with the matter.\r\n \r\nMatter types define what information can be saved to the matter, relevant to that area of law and state / location.\r\n \r\nA pre-configured list of matter types can be obtained via the 'GET /mattertypes' API.\r\n \r\n'Lead' matter types are different from the standard matter types used when creating a 'Matter'.\r\n \r\nUse the 'Type' query parameter in the 'GET /mattertypes' API call to get 'Lead' specific matter types.","example":"009f778f-83df-454a-b344-768a862a7e55","uniqueKey":"matterTypeId.oneOf.1","typeLabel":"null"}],"uniqueKey":"matterTypeId","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"Brief description of the matter.","example":"This is a brief description for the matter","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Brief description of the matter.","example":"This is a brief description for the matter","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"status":{"oneOf":[{"type":"string","description":"Current status of matter.\r\n\r\nPossible values: Open, Pending, Closed, Deleted or Cancelled.","example":"Open","uniqueKey":"status.oneOf.0","typeLabel":"string"},{"type":"null","description":"Current status of matter.\r\n\r\nPossible values: Open, Pending, Closed, Deleted or Cancelled.","example":"Open","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"string | null"},"dateOpened":{"oneOf":[{"type":"string","description":"Date when the matter was opened. This can be backdated if required.","format":"date-time","example":"2022-04-23T14:00:00Z","uniqueKey":"dateOpened.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Date when the matter was opened. This can be backdated if required.","format":"date-time","example":"2022-04-23T14:00:00Z","uniqueKey":"dateOpened.oneOf.1","typeLabel":"null"}],"uniqueKey":"dateOpened","typeLabel":"string\u003cdate-time> | null"},"openedDate":{"oneOf":[{"type":"string","description":"Date the matter was opened. This can be backdated if required.","format":"date-time","example":"2022-04-23T14:00:00Z","uniqueKey":"openedDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Date the matter was opened. This can be backdated if required.","format":"date-time","example":"2022-04-23T14:00:00Z","uniqueKey":"openedDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"openedDate","typeLabel":"string\u003cdate-time> | null"},"closedDate":{"oneOf":[{"type":"string","description":"Date the matter was closed. This can be backdated if required.","format":"date-time","example":"2022-04-23T14:00:00Z","uniqueKey":"closedDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Date the matter was closed. This can be backdated if required.","format":"date-time","example":"2022-04-23T14:00:00Z","uniqueKey":"closedDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"closedDate","typeLabel":"string\u003cdate-time> | null"},"leadOpenedDate":{"oneOf":[{"type":"string","description":"Date the lead was opened. This can be backdated if required.\r\n\r\nOnly applies if isLead is true.","format":"date-time","example":"2022-04-23T14:00:00Z","uniqueKey":"leadOpenedDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Date the lead was opened. This can be backdated if required.\r\n\r\nOnly applies if isLead is true.","format":"date-time","example":"2022-04-23T14:00:00Z","uniqueKey":"leadOpenedDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"leadOpenedDate","typeLabel":"string\u003cdate-time> | null"},"leadClosedDate":{"oneOf":[{"type":"string","description":"Date the lead was closed. This can be backdated if required.\r\n\r\nOnly applies if isLead is true.","format":"date-time","example":"2022-04-23T14:00:00Z","uniqueKey":"leadClosedDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Date the lead was closed. This can be backdated if required.\r\n\r\nOnly applies if isLead is true.","format":"date-time","example":"2022-04-23T14:00:00Z","uniqueKey":"leadClosedDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"leadClosedDate","typeLabel":"string\u003cdate-time> | null"},"leadClosedReason":{"oneOf":[{"type":"string","description":"Reason the lead was closed.\r\n\r\nOnly applies if isLead is true.","example":"No longer interested","uniqueKey":"leadClosedReason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Reason the lead was closed.\r\n\r\nOnly applies if isLead is true.","example":"No longer interested","uniqueKey":"leadClosedReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"leadClosedReason","typeLabel":"string | null"},"referralType":{"oneOf":[{"type":"string","description":"Referral Type of the matter.\r\n\r\nPossible values are different per region.","example":"Google","uniqueKey":"referralType.oneOf.0","typeLabel":"string"},{"type":"null","description":"Referral Type of the matter.\r\n\r\nPossible values are different per region.","example":"Google","uniqueKey":"referralType.oneOf.1","typeLabel":"null"}],"uniqueKey":"referralType","typeLabel":"string | null"},"referrerId":{"oneOf":[{"type":"string","description":"Contact id of the person that referred the matter.","example":"97bbe49f-6460-4bfc-b287-34ddfdbb81ef","uniqueKey":"referrerId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Contact id of the person that referred the matter.","example":"97bbe49f-6460-4bfc-b287-34ddfdbb81ef","uniqueKey":"referrerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"referrerId","typeLabel":"string | null"},"referralAgreementFeeType":{"oneOf":[{"type":"string","description":"The referral agreement fee type.\r\n\r\nPossible values: %, Flat fee, Other","uniqueKey":"referralAgreementFeeType.oneOf.0","typeLabel":"string"},{"type":"null","description":"The referral agreement fee type.\r\n\r\nPossible values: %, Flat fee, Other","uniqueKey":"referralAgreementFeeType.oneOf.1","typeLabel":"null"}],"uniqueKey":"referralAgreementFeeType","typeLabel":"string | null"},"referralAgreementFee":{"oneOf":[{"type":"number","description":"The referral agreement fee value.","format":"double","uniqueKey":"referralAgreementFee.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"The referral agreement fee value.","format":"double","uniqueKey":"referralAgreementFee.oneOf.1","typeLabel":"null"}],"uniqueKey":"referralAgreementFee","typeLabel":"number\u003cdouble> | null"},"referralAgreementFeeComment":{"oneOf":[{"type":"string","description":"The referral agreement fee comment.","uniqueKey":"referralAgreementFeeComment.oneOf.0","typeLabel":"string"},{"type":"null","description":"The referral agreement fee comment.","uniqueKey":"referralAgreementFeeComment.oneOf.1","typeLabel":"null"}],"uniqueKey":"referralAgreementFeeComment","typeLabel":"string | null"},"personResponsibleStaffId":{"oneOf":[{"type":"string","description":"Staff id of the person responsible for the matter (if applicable).","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"personResponsibleStaffId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Staff id of the person responsible for the matter (if applicable).","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"personResponsibleStaffId.oneOf.1","typeLabel":"null"}],"uniqueKey":"personResponsibleStaffId","typeLabel":"string | null"},"personAssistingStaffId":{"oneOf":[{"type":"string","description":"Staff id of the person assisting in the matter (if applicable).","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"personAssistingStaffId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Staff id of the person assisting in the matter (if applicable).","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"personAssistingStaffId.oneOf.1","typeLabel":"null"}],"uniqueKey":"personAssistingStaffId","typeLabel":"string | null"},"personAssistingStaffIds":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"personAssistingStaffIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Staff ids of the other persons assisting in the matter (if applicable).","example":["c85d28cb-a760-4627-aa59-0a853c2e65ed"],"uniqueKey":"personAssistingStaffIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Staff ids of the other persons assisting in the matter (if applicable).","example":["c85d28cb-a760-4627-aa59-0a853c2e65ed"],"uniqueKey":"personAssistingStaffIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"personAssistingStaffIds","typeLabel":"string[] | null"},"originatingStaffId":{"oneOf":[{"type":"string","description":"Staff id of the originating attorney (if in US) or an Introducer (if in AU)","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"originatingStaffId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Staff id of the originating attorney (if in US) or an Introducer (if in AU)","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"originatingStaffId.oneOf.1","typeLabel":"null"}],"uniqueKey":"originatingStaffId","typeLabel":"string | null"},"originatingStaffIds":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"originatingStaffIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Staff ids of the other originating attorneys (if in US) or an Introducer (if in AU)\r\n\r\nRequired when SplitOriginatingStaffSettings is provided and enabled.\r\nThis field must be included when updating SplitOriginatingStaffSettings.","example":["c85d28cb-a760-4627-aa59-0a853c2e65ed"],"uniqueKey":"originatingStaffIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Staff ids of the other originating attorneys (if in US) or an Introducer (if in AU)\r\n\r\nRequired when SplitOriginatingStaffSettings is provided and enabled.\r\nThis field must be included when updating SplitOriginatingStaffSettings.","example":["c85d28cb-a760-4627-aa59-0a853c2e65ed"],"uniqueKey":"originatingStaffIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"originatingStaffIds","typeLabel":"string[] | null"},"splitOriginatingStaffSettings":{"oneOf":[{"type":"object","description":"Settings for splitting originating staff members on a matter.\n\nWhen enabled, this allows distribution of originating staff responsibilities across multiple staff members\nusing either equal splits or custom ratios. The staff IDs specified in SplitMatterStaffs must exactly\nmatch the OriginatingStaffIds provided.\n\nOriginatingStaffIds must be included in the same request when updating these settings.\n\nValidation rules:\n- OriginatingStaffIds must be provided when this setting is enabled\n- Staff ratios must sum to 10000 (100%) when using UseRatio split method\n- RemainderStaffId must be one of the staff members in the SplitMatterStaffs collection\n- No duplicate staff members allowed","properties":{"isEnabled":{"type":"boolean","description":"Indicates whether the split matter staff settings are enabled or not.","uniqueKey":"splitOriginatingStaffSettings.oneOf.0.isEnabled","typeLabel":"boolean"},"splitMatterStaffs":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"matterStaffId":{"oneOf":[{"type":"string","description":"The unique identifier for the split matter staff.","uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMatterStaffs.oneOf.0.items.[INDEX].matterStaffId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The unique identifier for the split matter staff.","uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMatterStaffs.oneOf.0.items.[INDEX].matterStaffId.oneOf.1","typeLabel":"null"}],"uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMatterStaffs.oneOf.0.items.[INDEX].matterStaffId","typeLabel":"string | null"},"matterStaffRatio":{"type":"integer","description":"The split ratio for the matter staff.","format":"int64","uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMatterStaffs.oneOf.0.items.[INDEX].matterStaffRatio","typeLabel":"integer\u003cint64>"}},"additionalProperties":false,"uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMatterStaffs.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"List of staff members involved in the split matter settings.","uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMatterStaffs.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"matterStaffId":{"oneOf":[{"type":"string","description":"The unique identifier for the split matter staff."},{"type":"null","description":"The unique identifier for the split matter staff."}]},"matterStaffRatio":{"type":"integer","description":"The split ratio for the matter staff.","format":"int64"}},"additionalProperties":false},"description":"List of staff members involved in the split matter settings.","uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMatterStaffs.oneOf.1","typeLabel":"null"}],"uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMatterStaffs","typeLabel":"object[] | null"},"splitMethod":{"oneOf":[{"type":"string","description":"Method used to split the matter staff.\r\n\r\nPossible values: Unknown, SplitEvenly, UseRatio.","uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMethod.oneOf.0","typeLabel":"string"},{"type":"null","description":"Method used to split the matter staff.\r\n\r\nPossible values: Unknown, SplitEvenly, UseRatio.","uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMethod.oneOf.1","typeLabel":"null"}],"uniqueKey":"splitOriginatingStaffSettings.oneOf.0.splitMethod","typeLabel":"string | null"},"remainderStaffId":{"oneOf":[{"type":"string","description":"The unique identifier for the staff member who will handle the remainder of the matter after the split.","uniqueKey":"splitOriginatingStaffSettings.oneOf.0.remainderStaffId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The unique identifier for the staff member who will handle the remainder of the matter after the split.","uniqueKey":"splitOriginatingStaffSettings.oneOf.0.remainderStaffId.oneOf.1","typeLabel":"null"}],"uniqueKey":"splitOriginatingStaffSettings.oneOf.0.remainderStaffId","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"splitOriginatingStaffSettings.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"splitOriginatingStaffSettings.oneOf.1","typeLabel":"null"}],"uniqueKey":"splitOriginatingStaffSettings","typeLabel":"object | null"},"supervisorStaffId":{"oneOf":[{"type":"string","description":"Staff id of the supervisor of the matter.\r\n\r\nOnly supported in the UK.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"supervisorStaffId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Staff id of the supervisor of the matter.\r\n\r\nOnly supported in the UK.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"supervisorStaffId.oneOf.1","typeLabel":"null"}],"uniqueKey":"supervisorStaffId","typeLabel":"string | null"},"clientCode":{"oneOf":[{"type":"string","description":"Associates an external client code to this matter.\r\n\r\nOnly supported in AU and UK.","example":"Client A","uniqueKey":"clientCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Associates an external client code to this matter.\r\n\r\nOnly supported in AU and UK.","example":"Client A","uniqueKey":"clientCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"clientCode","typeLabel":"string | null"},"branchId":{"oneOf":[{"type":"string","description":"Unique identifier of the associated branch.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"branchId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of the associated branch.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"branchId.oneOf.1","typeLabel":"null"}],"uniqueKey":"branchId","typeLabel":"string | null"},"branchProviderId":{"oneOf":[{"type":"string","description":"Unique identifier of the associated branch provider.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"branchProviderId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of the associated branch provider.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"branchProviderId.oneOf.1","typeLabel":"null"}],"uniqueKey":"branchProviderId","typeLabel":"string | null"},"clientRole":{"oneOf":[{"type":"string","description":"'Client' matter type representative option for the matter.\r\n\r\nRequired and only supported when converting a 'Lead' to 'Matter'.","example":"Buyer","uniqueKey":"clientRole.oneOf.0","typeLabel":"string"},{"type":"null","description":"'Client' matter type representative option for the matter.\r\n\r\nRequired and only supported when converting a 'Lead' to 'Matter'.","example":"Buyer","uniqueKey":"clientRole.oneOf.1","typeLabel":"null"}],"uniqueKey":"clientRole","typeLabel":"string | null"},"isLead":{"type":"boolean","description":"Optional boolean flag indicating if matter is a 'Lead'.\r\n \r\nThis must be set to 'false' when converting a 'Lead' to 'Matter'.","example":false,"uniqueKey":"isLead","typeLabel":"boolean"},"clientIds":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"clientIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"List of unique identifiers of 'Client' contacts associated with the matter.","uniqueKey":"clientIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"List of unique identifiers of 'Client' contacts associated with the matter.","uniqueKey":"clientIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"clientIds","typeLabel":"string[] | null"},"otherSideIds":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"otherSideIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"List of unique identifiers of 'OtherSide' contacts associated with the matter.","uniqueKey":"otherSideIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"List of unique identifiers of 'OtherSide' contacts associated with the matter.","uniqueKey":"otherSideIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"otherSideIds","typeLabel":"string[] | null"},"items":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Unique identifier of the matter item.","example":"009f778f-83df-454a-b344-768a862a7e55","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of the matter item.","example":"009f778f-83df-454a-b344-768a862a7e55","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].id","typeLabel":"string | null"},"contactId":{"oneOf":[{"type":"string","description":"Unique identifier of the associated contact.\r\n\r\nOnly applicable for 'role' matter items.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].contactId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of the associated contact.\r\n\r\nOnly applicable for 'role' matter items.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].contactId.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].contactId","typeLabel":"string | null"},"contact":{"oneOf":[{"type":"object","description":"Associated contact.\r\n\r\nOnly applicable for 'role' matter items.","properties":{"id":{"oneOf":[{"type":"string","description":"Unique identifier of the contact.","example":"009f778f-83df-454a-b344-768a862a7e55","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].contact.oneOf.0.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of the contact.","example":"009f778f-83df-454a-b344-768a862a7e55","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].contact.oneOf.0.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].contact.oneOf.0.id","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].contact.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].contact.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].contact","typeLabel":"object | null"},"roleDescription":{"oneOf":[{"type":"string","description":"Displayed name for the matter item.\r\n \r\nOnly applicable for 'role' matter items.","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].roleDescription.oneOf.0","typeLabel":"string"},{"type":"null","description":"Displayed name for the matter item.\r\n \r\nOnly applicable for 'role' matter items.","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].roleDescription.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].roleDescription","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"Description for the matter item.\r\n \r\nOnly applicable for 'role' matter items.","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Description for the matter item.\r\n \r\nOnly applicable for 'role' matter items.","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"subItems":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{"type":"array","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"},"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.0.additionalProperties.oneOf.0","typeLabel":"array"},{"type":"null","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"},"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.0.additionalProperties","typeLabel":"array | null"},"description":"SubItems associated with the matter item.\r\n\r\nNot applicable for matter sub items.","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{"type":"array","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"},"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.1.additionalProperties.oneOf.0","typeLabel":"array"},{"type":"null","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"},"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.1.additionalProperties","typeLabel":"array | null"},"description":"SubItems associated with the matter item.\r\n\r\nNot applicable for matter sub items.","uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX].subItems","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Unique identifier of the matter item.","example":"009f778f-83df-454a-b344-768a862a7e55"},{"type":"null","description":"Unique identifier of the matter item.","example":"009f778f-83df-454a-b344-768a862a7e55"}]},"contactId":{"oneOf":[{"type":"string","description":"Unique identifier of the associated contact.\r\n\r\nOnly applicable for 'role' matter items.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed"},{"type":"null","description":"Unique identifier of the associated contact.\r\n\r\nOnly applicable for 'role' matter items.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed"}]},"contact":{"oneOf":[{"type":"object","description":"Associated contact.\r\n\r\nOnly applicable for 'role' matter items.","properties":{"id":{"oneOf":[{"type":"string","description":"Unique identifier of the contact.","example":"009f778f-83df-454a-b344-768a862a7e55"},{"type":"null","description":"Unique identifier of the contact.","example":"009f778f-83df-454a-b344-768a862a7e55"}]}},"additionalProperties":false},{"type":"null"}]},"roleDescription":{"oneOf":[{"type":"string","description":"Displayed name for the matter item.\r\n \r\nOnly applicable for 'role' matter items."},{"type":"null","description":"Displayed name for the matter item.\r\n \r\nOnly applicable for 'role' matter items."}]},"description":{"oneOf":[{"type":"string","description":"Description for the matter item.\r\n \r\nOnly applicable for 'role' matter items."},{"type":"null","description":"Description for the matter item.\r\n \r\nOnly applicable for 'role' matter items."}]},"subItems":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{"type":"array","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"}},{"type":"null","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"}}]},"description":"SubItems associated with the matter item.\r\n\r\nNot applicable for matter sub items."},{"type":"null","additionalProperties":{"oneOf":[{"type":"array","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"}},{"type":"null","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"}}]},"description":"SubItems associated with the matter item.\r\n\r\nNot applicable for matter sub items."}]}},"additionalProperties":false},"uniqueKey":"\\items.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.0.additionalProperties","typeLabel":"object[] | null"},"description":"Items associated with the matter.","uniqueKey":"\\items.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Unique identifier of the matter item.","example":"009f778f-83df-454a-b344-768a862a7e55","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of the matter item.","example":"009f778f-83df-454a-b344-768a862a7e55","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].id.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].id","typeLabel":"string | null"},"contactId":{"oneOf":[{"type":"string","description":"Unique identifier of the associated contact.\r\n\r\nOnly applicable for 'role' matter items.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].contactId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of the associated contact.\r\n\r\nOnly applicable for 'role' matter items.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].contactId.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].contactId","typeLabel":"string | null"},"contact":{"oneOf":[{"type":"object","description":"Associated contact.\r\n\r\nOnly applicable for 'role' matter items.","properties":{"id":{"oneOf":[{"type":"string","description":"Unique identifier of the contact.","example":"009f778f-83df-454a-b344-768a862a7e55","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].contact.oneOf.0.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of the contact.","example":"009f778f-83df-454a-b344-768a862a7e55","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].contact.oneOf.0.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].contact.oneOf.0.id","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].contact.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].contact.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].contact","typeLabel":"object | null"},"roleDescription":{"oneOf":[{"type":"string","description":"Displayed name for the matter item.\r\n \r\nOnly applicable for 'role' matter items.","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].roleDescription.oneOf.0","typeLabel":"string"},{"type":"null","description":"Displayed name for the matter item.\r\n \r\nOnly applicable for 'role' matter items.","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].roleDescription.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].roleDescription","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"Description for the matter item.\r\n \r\nOnly applicable for 'role' matter items.","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Description for the matter item.\r\n \r\nOnly applicable for 'role' matter items.","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"subItems":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{"type":"array","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"},"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.0.additionalProperties.oneOf.0","typeLabel":"array"},{"type":"null","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"},"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.0.additionalProperties","typeLabel":"array | null"},"description":"SubItems associated with the matter item.\r\n\r\nNot applicable for matter sub items.","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{"type":"array","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"},"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.1.additionalProperties.oneOf.0","typeLabel":"array"},{"type":"null","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"},"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.1.additionalProperties","typeLabel":"array | null"},"description":"SubItems associated with the matter item.\r\n\r\nNot applicable for matter sub items.","uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].subItems.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX].subItems","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Unique identifier of the matter item.","example":"009f778f-83df-454a-b344-768a862a7e55"},{"type":"null","description":"Unique identifier of the matter item.","example":"009f778f-83df-454a-b344-768a862a7e55"}]},"contactId":{"oneOf":[{"type":"string","description":"Unique identifier of the associated contact.\r\n\r\nOnly applicable for 'role' matter items.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed"},{"type":"null","description":"Unique identifier of the associated contact.\r\n\r\nOnly applicable for 'role' matter items.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed"}]},"contact":{"oneOf":[{"type":"object","description":"Associated contact.\r\n\r\nOnly applicable for 'role' matter items.","properties":{"id":{"oneOf":[{"type":"string","description":"Unique identifier of the contact.","example":"009f778f-83df-454a-b344-768a862a7e55"},{"type":"null","description":"Unique identifier of the contact.","example":"009f778f-83df-454a-b344-768a862a7e55"}]}},"additionalProperties":false},{"type":"null"}]},"roleDescription":{"oneOf":[{"type":"string","description":"Displayed name for the matter item.\r\n \r\nOnly applicable for 'role' matter items."},{"type":"null","description":"Displayed name for the matter item.\r\n \r\nOnly applicable for 'role' matter items."}]},"description":{"oneOf":[{"type":"string","description":"Description for the matter item.\r\n \r\nOnly applicable for 'role' matter items."},{"type":"null","description":"Description for the matter item.\r\n \r\nOnly applicable for 'role' matter items."}]},"subItems":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{"type":"array","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"}},{"type":"null","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"}}]},"description":"SubItems associated with the matter item.\r\n\r\nNot applicable for matter sub items."},{"type":"null","additionalProperties":{"oneOf":[{"type":"array","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"}},{"type":"null","items":{"$circularRef":"52b7069b-4785-43d4-b110-6c5b48681fe6"}}]},"description":"SubItems associated with the matter item.\r\n\r\nNot applicable for matter sub items."}]}},"additionalProperties":false},"uniqueKey":"\\items.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.oneOf.1.additionalProperties","typeLabel":"object[] | null"},"description":"Items associated with the matter.","uniqueKey":"\\items.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"externalSystemId":"EXT01","number":"FUS-124","matterTypeId":"009f778f-83df-454a-b344-768a862a7e55","description":"This is a brief description for the matter","status":"Open","dateOpened":"2022-04-23T14:00:00Z","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","referralAgreementFeeType":"\u003cstring>","referralAgreementFee":123,"referralAgreementFeeComment":"\u003cstring>","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"],"splitOriginatingStaffSettings":{"isEnabled":true,"splitMatterStaffs":[{"matterStaffId":"\u003cstring>","matterStaffRatio":123}],"splitMethod":"\u003cstring>","remainderStaffId":"\u003cstring>"},"supervisorStaffId":"c85d28cb-a760-4627-aa59-0a853c2e65ed","clientCode":"Client A","branchId":"c85d28cb-a760-4627-aa59-0a853c2e65ed","branchProviderId":"c85d28cb-a760-4627-aa59-0a853c2e65ed","clientRole":"Buyer","isLead":false,"clientIds":["\u003cstring>"],"otherSideIds":["\u003cstring>"],"items":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"df617bbd-fe79-4b4e-a4bc-8313c7d7b06a":{"description":"When request is accepted. Returns a hypermedia 'Link' object of the matter to be patched.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","uniqueKey":"id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"id.oneOf.1","typeLabel":"null"}],"uniqueKey":"id","typeLabel":"string | null"},"href":{"oneOf":[{"type":"string","uniqueKey":"href.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"href.oneOf.1","typeLabel":"null"}],"uniqueKey":"href","typeLabel":"string | null"},"relation":{"oneOf":[{"type":"string","uniqueKey":"relation.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"relation.oneOf.1","typeLabel":"null"}],"uniqueKey":"relation","typeLabel":"string | null"},"method":{"oneOf":[{"type":"string","default":"GET","uniqueKey":"method.oneOf.0","typeLabel":"string"},{"type":"null","default":"GET","uniqueKey":"method.oneOf.1","typeLabel":"null"}],"uniqueKey":"method","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","href":"\u003cstring>","relation":"\u003cstring>","method":"GET"}}},"exampleType":"generated"}},"exampleType":"generated"},"6c02f27c-afc7-4a37-ac3f-ddb507231ddf":{"description":"When an unsupported request is made.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"01bfe09f-8332-4dba-8776-08aabbc157e2":{"description":"When the authenticated account does not have access to the matter.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"b4af7b92-30d4-4a4a-a865-79e6544a375e":{"description":"When matter with specified id does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"174d6fee-2795-4ca9-a31c-90b8f8874248":{"api-key":{"type":"apiKey","name":"x-api-key","in":"header","scopes":[],"schemeName":"api-key"},"token":{"type":"apiKey","name":"Authorization","in":"header","x-amazon-apigateway-authtype":"cognito_user_pools","scopes":[],"schemeName":"token"}}},"servers":{"9cc1a8ed-beb8-4063-9b4b-88ca6a8304e6":{"url":"https://api.smokeball.com"},"0313fe5b-1d70-4640-ba62-536789bf8827":{"url":"https://api.smokeball.com.au"},"6a3bb7ed-506e-4d5d-8060-f4d63f19f1b7":{"url":"https://api.smokeball.co.uk"},"c552891d-324d-49d4-b2b6-e8826a88a1da":{"url":"https://stagingapi.smokeball.com"},"7776c4fb-d6c6-4a5f-b608-dc777243c469":{"url":"https://stagingapi.smokeball.com.au"},"3a30fcfe-c69e-485e-b244-2a53c8968813":{"url":"https://stagingapi.smokeball.co.uk"}},"schemas":{"52b7069b-4785-43d4-b110-6c5b48681fe6":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Unique identifier of the matter item.","example":"009f778f-83df-454a-b344-768a862a7e55"},{"type":"null","description":"Unique identifier of the matter item.","example":"009f778f-83df-454a-b344-768a862a7e55"}]},"contactId":{"oneOf":[{"type":"string","description":"Unique identifier of the associated contact.\r\n\r\nOnly applicable for 'role' matter items.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed"},{"type":"null","description":"Unique identifier of the associated contact.\r\n\r\nOnly applicable for 'role' matter items.","example":"c85d28cb-a760-4627-aa59-0a853c2e65ed"}]},"contact":{"oneOf":[{"type":"object","description":"Associated contact.\r\n\r\nOnly applicable for 'role' matter items.","properties":{"id":{"oneOf":[{"type":"string","description":"Unique identifier of the contact.","example":"009f778f-83df-454a-b344-768a862a7e55"},{"type":"null","description":"Unique identifier of the contact.","example":"009f778f-83df-454a-b344-768a862a7e55"}]}},"additionalProperties":false},{"type":"null"}]},"roleDescription":{"oneOf":[{"type":"string","description":"Displayed name for the matter item.\r\n \r\nOnly applicable for 'role' matter items."},{"type":"null","description":"Displayed name for the matter item.\r\n \r\nOnly applicable for 'role' matter items."}]},"description":{"oneOf":[{"type":"string","description":"Description for the matter item.\r\n \r\nOnly applicable for 'role' matter items."},{"type":"null","description":"Description for the matter item.\r\n \r\nOnly applicable for 'role' matter items."}]},"subItems":{"oneOf":[{"type":"object","description":"SubItems associated with the matter item.\r\n\r\nNot applicable for matter sub items.","additionalProperties":{"oneOf":[{"type":"array","items":{"oneOf":[{}]}},{"type":"null"}]}},{"type":"null","description":"SubItems associated with the matter item.\r\n\r\nNot applicable for matter sub items.","additionalProperties":{"oneOf":[{"type":"array","items":{"oneOf":[{}]}},{"type":"null"}]}}]}},"additionalProperties":false}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"x-api-key","in":"header","scopes":[],"schemeName":"api-key"},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"api-key","name":"x-api-key"},{"scheme":{"type":"apiKey","name":"Authorization","in":"header","x-amazon-apigateway-authtype":"cognito_user_pools","scopes":[],"schemeName":"token"},"schema":{"title":"Authorization","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"token","name":"Authorization"}],"title":"api-key \u0026 token"}]},"originalFileLocation":"openapi.json"},"subdomain":"smokeball","siteName":"Smokeball","title":"Patch a matter - Smokeball","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-19T00:23:03.725Z","originalFileLocation":"api-reference/matters/patch-a-matter.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Patches a specified matter. Note: This endpoint can also be used to update a Lead, convert Lead to Matter and change the Lead/Matter type. See Matters documentation for more details on how to use this. The following actions are not supported: - items cannot be updated where either clientIds and/or otherSideIds are being updated - items cannot be updated when converting a Lead to Matter or changing the Lead/Matter type - clientRole cannot be updated, unless converting a Lead to Matter or changing the Lead/Matter type - Matter cannot be converted back to Lead - splitOriginatingStaffSettings cannot be updated without also providing originatingStaffIds in the same PATCH request - personAssistingStaffIds cannot contain personAssistingStaffId - originatingStaffIds cannot contain originatingStaffId - If split originating staff settings are enabled, originatingStaffIds and originatingStaffId cannot be updated - When updating via items, client role items and their sub-items must contain at least one item (cannot be empty), while non-client role items and their sub-items can be empty arrays to remove all items\">\u003cmeta data-mint-head name=\"application-name\" content=\"Smokeball\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/smokeball/YT9oRRLb2fl_fJ6Z/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/smokeball/YT9oRRLb2fl_fJ6Z/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/smokeball/YT9oRRLb2fl_fJ6Z/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/smokeball/YT9oRRLb2fl_fJ6Z/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/smokeball/YT9oRRLb2fl_fJ6Z/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/smokeball/YT9oRRLb2fl_fJ6Z/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/smokeball/YT9oRRLb2fl_fJ6Z/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/smokeball/YT9oRRLb2fl_fJ6Z/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/smokeball/YT9oRRLb2fl_fJ6Z/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Patch a matter - Smokeball\">\u003cmeta data-mint-head property=\"og:description\" content=\"Patches a specified matter. Note: This endpoint can also be used to update a Lead, convert Lead to Matter and change the Lead/Matter type. See Matters documentation for more details on how to use this. The following actions are not supported: - items cannot be updated where either clientIds and/or otherSideIds are being updated - items cannot be updated when converting a Lead to Matter or changing the Lead/Matter type - clientRole cannot be updated, unless converting a Lead to Matter or changing the Lead/Matter type - Matter cannot be converted back to Lead - splitOriginatingStaffSettings cannot be updated without also providing originatingStaffIds in the same PATCH request - personAssistingStaffIds cannot contain personAssistingStaffId - originatingStaffIds cannot contain originatingStaffId - If split originating staff settings are enabled, originatingStaffIds and originatingStaffId cannot be updated - When updating via items, client role items and their sub-items must contain at least one item (cannot be empty), while non-client role items and their sub-items can be empty arrays to remove all items\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Smokeball\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.smokeball.com/api-reference/matters/patch-a-matter\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://smokeball.mintlify.site/_mintlify/api/og/v2?division=Matters\u0026amp;title=Patch+a+matter\u0026amp;description=Patches+a+specified+matter.%0D%0A++++++++++++%0D%0ANote%3A+This+endpoint+can+also+be+used+to+update+a+%60Lead%60%2C+convert+%60Lead%60+to+%60Matter%60+and+change+the+%60Lead%60%2F%60Matter%60+ty\u0026amp;theme=6f89cd78db6b339f049014d8\u0026amp;signature=c35bc69bb52f85efb8979240e5118a326b65296a5497993e8481440e7e5eaee1\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Patch a matter - Smokeball\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Patches a specified matter. Note: This endpoint can also be used to update a Lead, convert Lead to Matter and change the Lead/Matter type. See Matters documentation for more details on how to use this. The following actions are not supported: - items cannot be updated where either clientIds and/or otherSideIds are being updated - items cannot be updated when converting a Lead to Matter or changing the Lead/Matter type - clientRole cannot be updated, unless converting a Lead to Matter or changing the Lead/Matter type - Matter cannot be converted back to Lead - splitOriginatingStaffSettings cannot be updated without also providing originatingStaffIds in the same PATCH request - personAssistingStaffIds cannot contain personAssistingStaffId - originatingStaffIds cannot contain originatingStaffId - If split originating staff settings are enabled, originatingStaffIds and originatingStaffId cannot be updated - When updating via items, client role items and their sub-items must contain at least one item (cannot be empty), while non-client role items and their sub-items can be empty arrays to remove all items\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://smokeball.mintlify.site/_mintlify/api/og/v2?division=Matters\u0026amp;title=Patch+a+matter\u0026amp;description=Patches+a+specified+matter.%0D%0A++++++++++++%0D%0ANote%3A+This+endpoint+can+also+be+used+to+update+a+%60Lead%60%2C+convert+%60Lead%60+to+%60Matter%60+and+change+the+%60Lead%60%2F%60Matter%60+ty\u0026amp;theme=6f89cd78db6b339f049014d8\u0026amp;signature=c35bc69bb52f85efb8979240e5118a326b65296a5497993e8481440e7e5eaee1\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/smokeball/YT9oRRLb2fl_fJ6Z/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Smokeball\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#f2600c\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.smokeball.com/api-reference/matters/patch-a-matter\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/matters/patch-a-matter.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.smokeball.com/#organization\",\"name\":\"Smokeball\",\"url\":\"https://docs.smokeball.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/smokeball/M3xU16wx3zLWrCy3/logo/light.svg?fit=max\u0026auto=format\u0026n=M3xU16wx3zLWrCy3\u0026q=85\u0026s=9742e65825b3575ca562541e0e7571d3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.smokeball.com#website\",\"name\":\"Smokeball\",\"url\":\"https://docs.smokeball.com\",\"publisher\":{\"@id\":\"https://docs.smokeball.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.smokeball.com/api-reference/matters/patch-a-matter#webpage\",\"url\":\"https://docs.smokeball.com/api-reference/matters/patch-a-matter\",\"name\":\"Patch a matter\",\"description\":\"Patches a specified matter. Note: This endpoint can also be used to update a Lead, convert Lead to Matter and change the Lead/Matter type. See Matters documentation for more details on how to use this. The following actions are not supported: - items cannot be updated where either clientIds and/or otherSideIds are being updated - items cannot be updated when converting a Lead to Matter or changing the Lead/Matter type - clientRole cannot be updated, unless converting a Lead to Matter or changing the Lead/Matter type - Matter cannot be converted back to Lead - splitOriginatingStaffSettings cannot be updated without also providing originatingStaffIds in the same PATCH request - personAssistingStaffIds cannot contain personAssistingStaffId - originatingStaffIds cannot contain originatingStaffId - If split originating staff settings are enabled, originatingStaffIds and originatingStaffId cannot be updated - When updating via items, client role items and their sub-items must contain at least one item (cannot be empty), while non-client role items and their sub-items can be empty arrays to remove all items\",\"dateModified\":\"2026-11-19T00:23:03.725Z\",\"isPartOf\":{\"@id\":\"https://docs.smokeball.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.smokeball.com/api-reference/matters/patch-a-matter#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.smokeball.com/api-reference/matters/patch-a-matter#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"APIs\",\"item\":\"https://docs.smokeball.com/api-reference/activity-codes/get-an-activity-code\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Matters\",\"item\":\"https://docs.smokeball.com/api-reference/matters/get-the-archive-for-a-matter\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Patch a matter\",\"item\":\"https://docs.smokeball.com/api-reference/matters/patch-a-matter\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.smokeball.com/api-reference/matters/patch-a-matter#apireference\",\"headline\":\"Patch a matter\",\"name\":\"Patch a matter\",\"description\":\"Patches a specified matter. Note: This endpoint can also be used to update a Lead, convert Lead to Matter and change the Lead/Matter type. See Matters documentation for more details on how to use this. The following actions are not supported: - items cannot be updated where either clientIds and/or otherSideIds are being updated - items cannot be updated when converting a Lead to Matter or changing the Lead/Matter type - clientRole cannot be updated, unless converting a Lead to Matter or changing the Lead/Matter type - Matter cannot be converted back to Lead - splitOriginatingStaffSettings cannot be updated without also providing originatingStaffIds in the same PATCH request - personAssistingStaffIds cannot contain personAssistingStaffId - originatingStaffIds cannot contain originatingStaffId - If split originating staff settings are enabled, originatingStaffIds and originatingStaffId cannot be updated - When updating via items, client role items and their sub-items must contain at least one item (cannot be empty), while non-client role items and their sub-items can be empty arrays to remove all items\",\"url\":\"https://docs.smokeball.com/api-reference/matters/patch-a-matter\",\"mainEntityOfPage\":{\"@id\":\"https://docs.smokeball.com/api-reference/matters/patch-a-matter#webpage\"},\"dateModified\":\"2026-11-19T00:23:03.725Z\",\"publisher\":{\"@id\":\"https://docs.smokeball.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.smokeball.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Smokeball\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Smokeball\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/matters/patch-a-matter.md","siteName":"Smokeball","nav":{"global":{"anchors":[{"anchor":"Marketplace","icon":"store","href":"https://marketplace.smokeball.com"},{"anchor":"Blog","icon":"newspaper","href":"https://www.smokeball.com/blog"}]},"tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/home"}]},{"tab":"Platform","pages":[{"title":"Platform","href":"/docs/platform-docs/va20w41tid7py-get-started-overview"}]},{"tab":"API","groups":[{"group":"Documentation","pages":[{"group":"Getting Started","icon":"hand-wave","pages":[{"title":"Introduction","href":"/docs/api-docs/1e13a13124aee-introduction"},{"title":"Base URLs","href":"/docs/api-docs/z2q8vla6b77g8-base-urls"},{"title":"Rate Limits","href":"/docs/api-docs/vj4jovpoopdov-rate-limits"}]},{"group":"Authentication","icon":"lock","pages":[{"title":"Overview","href":"/docs/api-docs/c916c683c136e-authentication-overview"},{"title":"Authorization Code Grant","href":"/docs/api-docs/2t26gcuuqf1wk-authorization-code-grant"},{"title":"Client Credentials Grant","href":"/docs/api-docs/h72024p76i8e1-client-credentials-grant"},{"title":"Scopes","href":"/docs/api-docs/qf83nz2scopes-scopes"},{"title":"Logout Endpoint","href":"/docs/api-docs/9de98u0xqsckx-logout-endpoint"}]},{"title":"Making Requests","icon":"globe","href":"/docs/api-docs/ivmfjbc61tvjs-making-requests"},{"title":"Errors","icon":"circle-exclamation","href":"/docs/api-docs/e4f5a6b7c8d9e-errors"},{"title":"Searching","icon":"magnifying-glass","href":"/docs/api-docs/272770a37d359-searching"},{"title":"Plugins","icon":"plug","href":"/docs/api-docs/scmo7vmtln5hm-plugins"},{"title":"Webhooks","icon":"webhook","href":"/docs/api-docs/wivbkstcwngb5-webhooks"}]},{"group":"Tutorials","pages":[{"title":"Matters","icon":"book","href":"/docs/api-docs/voyymdyjn5yp3-matters"},{"title":"Leads","icon":"book","href":"/docs/api-docs/plu740klph0ho-leads"},{"title":"Files and Folders","icon":"book","href":"/docs/api-docs/wivbkstcwngb5-files-folders"},{"title":"Layouts","icon":"book","href":"/docs/api-docs/0d3adba1494ce-layouts"}]},{"group":"APIs","pages":[{"group":"Activity Codes","pages":[{"title":"Get an activity code","deprecated":null,"version":null,"openapi":"/openapi.json get /activitycodes/{id}","href":"/api-reference/activity-codes/get-an-activity-code"},{"title":"Update an activity code","deprecated":null,"version":null,"openapi":"/openapi.json put /activitycodes/{id}","href":"/api-reference/activity-codes/update-an-activity-code"},{"title":"Delete an activity code","deprecated":null,"version":null,"openapi":"/openapi.json delete /activitycodes/{id}","href":"/api-reference/activity-codes/delete-an-activity-code"},{"title":"Get activity codes","deprecated":null,"version":null,"openapi":"/openapi.json get /activitycodes","href":"/api-reference/activity-codes/get-activity-codes"},{"title":"Create an activity code","deprecated":null,"version":null,"openapi":"/openapi.json post /activitycodes","href":"/api-reference/activity-codes/create-an-activity-code"}]},{"group":"Authorization","pages":[{"title":"Get authorization groups","deprecated":null,"version":null,"openapi":"/openapi.json get /groups","href":"/api-reference/authorization/get-authorization-groups"},{"title":"Create an authorization group","deprecated":null,"version":null,"openapi":"/openapi.json post /groups","href":"/api-reference/authorization/create-an-authorization-group"},{"title":"Get an authorization group","deprecated":null,"version":null,"openapi":"/openapi.json get /groups/{id}","href":"/api-reference/authorization/get-an-authorization-group"},{"title":"Update an authorization group","deprecated":null,"version":null,"openapi":"/openapi.json put /groups/{id}","href":"/api-reference/authorization/update-an-authorization-group"},{"title":"Deletes an authorization group","deprecated":null,"version":null,"openapi":"/openapi.json delete /groups/{id}","href":"/api-reference/authorization/deletes-an-authorization-group"},{"title":"Get an authorization policy","deprecated":null,"version":null,"openapi":"/openapi.json get /policies/{reference}","href":"/api-reference/authorization/get-an-authorization-policy"},{"title":"Update an authorization policy","deprecated":null,"version":null,"openapi":"/openapi.json put /policies/{reference}","href":"/api-reference/authorization/update-an-authorization-policy"},{"title":"Create an authorization policy","deprecated":null,"version":null,"openapi":"/openapi.json post /policies","href":"/api-reference/authorization/create-an-authorization-policy"}]},{"group":"Bank Accounts","pages":[{"title":"Get a bank account","deprecated":null,"version":null,"openapi":"/openapi.json get /bankaccounts/{id}","href":"/api-reference/bank-accounts/get-a-bank-account"},{"title":"Get bank accounts","deprecated":null,"version":null,"openapi":"/openapi.json get /bankaccounts","href":"/api-reference/bank-accounts/get-bank-accounts"},{"title":"Get bank account matter balances","deprecated":null,"version":null,"openapi":"/openapi.json get /bankaccounts/{id}/matter-balances","href":"/api-reference/bank-accounts/get-bank-account-matter-balances"},{"title":"Get a protected bank account balance","deprecated":null,"version":null,"openapi":"/openapi.json get /bankaccounts/{id}/protected-balances/{protectionId}","href":"/api-reference/bank-accounts/get-a-protected-bank-account-balance"},{"title":"Protect bank account funds","deprecated":null,"version":null,"openapi":"/openapi.json post /bankaccounts/{id}/protect-funds","href":"/api-reference/bank-accounts/protect-bank-account-funds"},{"title":"Unprotect bank account funds","deprecated":null,"version":null,"openapi":"/openapi.json post /bankaccounts/{id}/unprotect-funds/{protectionId}","href":"/api-reference/bank-accounts/unprotect-bank-account-funds"},{"title":"Create a requisition","deprecated":null,"version":null,"openapi":"/openapi.json post /bankaccounts/{id}/requisitions","href":"/api-reference/bank-accounts/create-a-requisition"},{"title":"Get transactions","deprecated":null,"version":null,"openapi":"/openapi.json get /bankaccounts/{bankAccountId}/transactions","href":"/api-reference/bank-accounts/get-transactions"},{"title":"Create a transaction","deprecated":null,"version":null,"openapi":"/openapi.json post /bankaccounts/{bankAccountId}/transactions","href":"/api-reference/bank-accounts/create-a-transaction"},{"title":"Get a transaction","deprecated":null,"version":null,"openapi":"/openapi.json get /bankaccounts/{bankAccountId}/transactions/{id}","href":"/api-reference/bank-accounts/get-a-transaction"}]},{"group":"Contacts","pages":[{"title":"Get contact relations","deprecated":null,"version":null,"openapi":"/openapi.json get /contacts/{contactId}/relations","href":"/api-reference/contacts/get-contact-relations"},{"title":"Create a contact relation","deprecated":null,"version":null,"openapi":"/openapi.json post /contacts/{contactId}/relations","href":"/api-reference/contacts/create-a-contact-relation"},{"title":"Get a contact relation","deprecated":null,"version":null,"openapi":"/openapi.json get /contacts/{contactId}/relations/{relatedContactId}","href":"/api-reference/contacts/get-a-contact-relation"},{"title":"Update a contact relation","deprecated":null,"version":null,"openapi":"/openapi.json put /contacts/{contactId}/relations/{relatedContactId}","href":"/api-reference/contacts/update-a-contact-relation"},{"title":"Delete a contact relation","deprecated":null,"version":null,"openapi":"/openapi.json delete /contacts/{contactId}/relations/{relatedContactId}","href":"/api-reference/contacts/delete-a-contact-relation"},{"title":"Get contacts","deprecated":null,"version":null,"openapi":"/openapi.json get /contacts","href":"/api-reference/contacts/get-contacts"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/openapi.json post /contacts","href":"/api-reference/contacts/create-a-contact"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/openapi.json get /contacts/{id}","href":"/api-reference/contacts/get-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/openapi.json put /contacts/{id}","href":"/api-reference/contacts/update-a-contact"},{"title":"Delete a contact","deprecated":null,"version":null,"openapi":"/openapi.json delete /contacts/{id}","href":"/api-reference/contacts/delete-a-contact"},{"title":"Get contacts by ids","deprecated":null,"version":null,"openapi":"/openapi.json post /contacts/batch","href":"/api-reference/contacts/get-contacts-by-ids"},{"title":"Get contact tags","deprecated":null,"version":null,"openapi":"/openapi.json get /contacts/{id}/tags","href":"/api-reference/contacts/get-contact-tags"},{"title":"Add tags to a contact","deprecated":null,"version":null,"openapi":"/openapi.json post /contacts/{id}/tags","href":"/api-reference/contacts/add-tags-to-a-contact"},{"title":"Remove tags from a contact","deprecated":null,"version":null,"openapi":"/openapi.json delete /contacts/{id}/tags/{tagId}","href":"/api-reference/contacts/remove-tags-from-a-contact"}]},{"group":"Events","pages":[{"title":"Get events","deprecated":null,"version":null,"openapi":"/openapi.json get /events","href":"/api-reference/events/get-events"},{"title":"Create event","deprecated":null,"version":null,"openapi":"/openapi.json post /events","href":"/api-reference/events/create-event"},{"title":"Get an event","deprecated":null,"version":null,"openapi":"/openapi.json get /events/{eventId}","href":"/api-reference/events/get-an-event"},{"title":"Update event","deprecated":null,"version":null,"openapi":"/openapi.json put /events/{eventId}","href":"/api-reference/events/update-event"},{"title":"Delete event","deprecated":null,"version":null,"openapi":"/openapi.json delete /events/{eventId}","href":"/api-reference/events/delete-event"},{"title":"Gets reminders for an event","deprecated":null,"version":null,"openapi":"/openapi.json get /events/{eventId}/reminders","href":"/api-reference/events/gets-reminders-for-an-event"},{"title":"Create reminder for an event","deprecated":null,"version":null,"openapi":"/openapi.json post /events/{eventId}/reminders","href":"/api-reference/events/create-reminder-for-an-event"},{"title":"Update a reminder for an event","deprecated":null,"version":null,"openapi":"/openapi.json put /events/{eventId}/reminders/{reminderId}","href":"/api-reference/events/update-a-reminder-for-an-event"},{"title":"Delete reminder for an event","deprecated":null,"version":null,"openapi":"/openapi.json delete /events/{eventId}/reminders/{reminderId}","href":"/api-reference/events/delete-reminder-for-an-event"}]},{"group":"Expenses","pages":[{"title":"Get expenses","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/expenses","href":"/api-reference/expenses/get-expenses"},{"title":"Create an expense","deprecated":null,"version":null,"openapi":"/openapi.json post /matters/{matterId}/expenses","href":"/api-reference/expenses/create-an-expense"},{"title":"Get an expense","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/expenses/{id}","href":"/api-reference/expenses/get-an-expense"},{"title":"Update an expense","deprecated":null,"version":null,"openapi":"/openapi.json put /matters/{matterId}/expenses/{id}","href":"/api-reference/expenses/update-an-expense"},{"title":"Delete an expense","deprecated":null,"version":null,"openapi":"/openapi.json delete /matters/{matterId}/expenses/{id}","href":"/api-reference/expenses/delete-an-expense"},{"title":"Patch an expense","deprecated":null,"version":null,"openapi":"/openapi.json patch /matters/{matterId}/expenses/{id}","href":"/api-reference/expenses/patch-an-expense"}]},{"group":"Fees","pages":[{"title":"Get fees","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/fees","href":"/api-reference/fees/get-fees"},{"title":"Create a fee","deprecated":null,"version":null,"openapi":"/openapi.json post /matters/{matterId}/fees","href":"/api-reference/fees/create-a-fee"},{"title":"Get a fee","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/fees/{id}","href":"/api-reference/fees/get-a-fee"},{"title":"Update a fee","deprecated":null,"version":null,"openapi":"/openapi.json put /matters/{matterId}/fees/{id}","href":"/api-reference/fees/update-a-fee"},{"title":"Delete a fee","deprecated":null,"version":null,"openapi":"/openapi.json delete /matters/{matterId}/fees/{id}","href":"/api-reference/fees/delete-a-fee"},{"title":"Patch a fee","deprecated":null,"version":null,"openapi":"/openapi.json patch /matters/{matterId}/fees/{id}","href":"/api-reference/fees/patch-a-fee"}]},{"group":"Files","pages":[{"title":"Get files on a matter","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/documents/files","href":"/api-reference/files/get-files-on-a-matter"},{"title":"Add file to a matter","deprecated":null,"version":null,"openapi":"/openapi.json post /matters/{matterId}/documents/files","href":"/api-reference/files/add-file-to-a-matter"},{"title":"Get a file","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/documents/files/{fileId}","href":"/api-reference/files/get-a-file"},{"title":"Upload/update version or metadata of a file","deprecated":null,"version":null,"openapi":"/openapi.json put /matters/{matterId}/documents/files/{fileId}","href":"/api-reference/files/uploadupdate-version-or-metadata-of-a-file"},{"title":"Delete a file","deprecated":null,"version":null,"openapi":"/openapi.json delete /matters/{matterId}/documents/files/{fileId}","href":"/api-reference/files/delete-a-file"},{"title":"Patch a file","deprecated":null,"version":null,"openapi":"/openapi.json patch /matters/{matterId}/documents/files/{fileId}","href":"/api-reference/files/patch-a-file"},{"title":"Get download url for a file","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/documents/files/{fileId}/download","href":"/api-reference/files/get-download-url-for-a-file"},{"title":"Get upload url for a file","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/documents/files/{fileId}/upload","href":"/api-reference/files/get-upload-url-for-a-file"},{"title":"Get file history on a matter","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/documents/files/{fileId}/history","href":"/api-reference/files/get-file-history-on-a-matter"},{"title":"Add files to a matter","deprecated":null,"version":null,"openapi":"/openapi.json post /matters/{matterId}/documents/files/bulk","href":"/api-reference/files/add-files-to-a-matter"},{"title":"Get preview info for a file","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/documents/files/{fileId}/preview","href":"/api-reference/files/get-preview-info-for-a-file"},{"title":"Get or create a preview","deprecated":null,"version":null,"openapi":"/openapi.json post /matters/{matterId}/documents/files/{fileId}/preview","href":"/api-reference/files/get-or-create-a-preview"},{"title":"Get preview info for a file by document version","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/documents/files/{fileId}/preview/{documentVersionId}","href":"/api-reference/files/get-preview-info-for-a-file-by-document-version"}]},{"group":"Firm","pages":[{"title":"Get firm","deprecated":null,"version":null,"openapi":"/openapi.json get /firm","href":"/api-reference/firm/get-firm"},{"title":"Update firm","deprecated":null,"version":null,"openapi":"/openapi.json put /firm","href":"/api-reference/firm/update-firm"},{"title":"Create firm","deprecated":null,"version":null,"openapi":"/openapi.json post /firm","href":"/api-reference/firm/create-firm"},{"title":"Get firm user mappings","deprecated":null,"version":null,"openapi":"/openapi.json get /firmusers","href":"/api-reference/firm/get-firm-user-mappings"},{"title":"Get firm user mapping","deprecated":null,"version":null,"openapi":"/openapi.json get /firmusers/{id}","href":"/api-reference/firm/get-firm-user-mapping"},{"title":"Update firm user mapping","deprecated":null,"version":null,"openapi":"/openapi.json put /firmusers/{id}","href":"/api-reference/firm/update-firm-user-mapping"},{"title":"Delete firm user mapping","deprecated":null,"version":null,"openapi":"/openapi.json delete /firmusers/{id}","href":"/api-reference/firm/delete-firm-user-mapping"}]},{"group":"Folders","pages":[{"title":"Get folders/files under root folder","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/documents/folders","href":"/api-reference/folders/get-foldersfiles-under-root-folder"},{"title":"Create a folder","deprecated":null,"version":null,"openapi":"/openapi.json post /matters/{matterId}/documents/folders","href":"/api-reference/folders/create-a-folder"},{"title":"Get folders/files under a folder","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/documents/folders/{folderId}","href":"/api-reference/folders/get-foldersfiles-under-a-folder"},{"title":"Update a folder","deprecated":null,"version":null,"openapi":"/openapi.json put /matters/{matterId}/documents/folders/{folderId}","href":"/api-reference/folders/update-a-folder"},{"title":"Delete a folder","deprecated":null,"version":null,"openapi":"/openapi.json delete /matters/{matterId}/documents/folders/{folderId}","href":"/api-reference/folders/delete-a-folder"},{"title":"Patch a folder","deprecated":null,"version":null,"openapi":"/openapi.json patch /matters/{matterId}/documents/folders/{folderId}","href":"/api-reference/folders/patch-a-folder"},{"title":"Get folder path hierarchy","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/documents/folders/{folderId}/path","href":"/api-reference/folders/get-folder-path-hierarchy"},{"title":"Get folder history on a matter","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/documents/folders/{folderId}/history","href":"/api-reference/folders/get-folder-history-on-a-matter"}]},{"group":"Integrated Search","pages":[{"title":"Get mapping","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/integrated-search/mapping","href":"/api-reference/integrated-search/get-mapping"}]},{"group":"Invitations","pages":[{"title":"Search invitations","deprecated":null,"version":null,"openapi":"/openapi.json get /invitations","href":"/api-reference/invitations/search-invitations"},{"title":"Invite a person to join the firm","deprecated":null,"version":null,"openapi":"/openapi.json post /invitations","href":"/api-reference/invitations/invite-a-person-to-join-the-firm"},{"title":"Get an invitation","deprecated":null,"version":null,"openapi":"/openapi.json get /invitations/{id}","href":"/api-reference/invitations/get-an-invitation"},{"title":"Cancel an invitation","deprecated":null,"version":null,"openapi":"/openapi.json delete /invitations/{id}","href":"/api-reference/invitations/cancel-an-invitation"},{"title":"Resend an invitation","deprecated":null,"version":null,"openapi":"/openapi.json post /invitations/{id}/resend","href":"/api-reference/invitations/resend-an-invitation"},{"title":"Accept an invitation","deprecated":null,"version":null,"openapi":"/openapi.json post /invitations/{id}/accept","href":"/api-reference/invitations/accept-an-invitation"}]},{"group":"Invoices","pages":[{"title":"Get invoices","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/invoices","href":"/api-reference/invoices/get-invoices"},{"title":"Get an invoice","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/invoices/{invoiceId}","href":"/api-reference/invoices/get-an-invoice"},{"title":"Get download url for an invoice","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/invoices/{invoiceId}/download","href":"/api-reference/invoices/get-download-url-for-an-invoice"}]},{"group":"Layout Designs","pages":[{"title":"Get layout designs","deprecated":null,"version":null,"openapi":"/openapi.json get /layouts","href":"/api-reference/layout-designs/get-layout-designs"},{"title":"Get a layout design","deprecated":null,"version":null,"openapi":"/openapi.json get /layouts/{id}","href":"/api-reference/layout-designs/get-a-layout-design"}]},{"group":"Layout Matter Items","pages":[{"title":"Get layouts","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/layouts","href":"/api-reference/layout-matter-items/get-layouts"},{"title":"Add a new layout","deprecated":null,"version":null,"openapi":"/openapi.json post /matters/{matterId}/layouts","href":"/api-reference/layout-matter-items/add-a-new-layout"},{"title":"Get a layout","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/layouts/{itemId}","href":"/api-reference/layout-matter-items/get-a-layout"},{"title":"Remove a layout","deprecated":null,"version":null,"openapi":"/openapi.json delete /matters/{matterId}/layouts/{itemId}","href":"/api-reference/layout-matter-items/remove-a-layout"},{"title":"Merge a layout","deprecated":null,"version":null,"openapi":"/openapi.json patch /matters/{matterId}/layouts/{itemId}","href":"/api-reference/layout-matter-items/merge-a-layout"},{"title":"Get layout contacts","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/layouts/{itemId}/contacts","href":"/api-reference/layout-matter-items/get-layout-contacts"},{"title":"Add a contact to a layout","deprecated":null,"version":null,"openapi":"/openapi.json post /matters/{matterId}/layouts/{itemId}/contacts","href":"/api-reference/layout-matter-items/add-a-contact-to-a-layout"},{"title":"Remove a contact from a layout","deprecated":null,"version":null,"openapi":"/openapi.json delete /matters/{matterId}/layouts/{itemId}/contacts","href":"/api-reference/layout-matter-items/remove-a-contact-from-a-layout"}]},{"group":"Matter Items","pages":[{"title":"Get items on a matter","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/items","href":"/api-reference/matter-items/get-items-on-a-matter"},{"title":"Get an item on a matter","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/items/{id}","href":"/api-reference/matter-items/get-an-item-on-a-matter"}]},{"group":"Matter Types","pages":[{"title":"Get matter types","deprecated":null,"version":null,"openapi":"/openapi.json get /mattertypes","href":"/api-reference/matter-types/get-matter-types"},{"title":"Get a matter type","deprecated":null,"version":null,"openapi":"/openapi.json get /mattertypes/{id}","href":"/api-reference/matter-types/get-a-matter-type"},{"title":"Get matter types categories","deprecated":null,"version":null,"openapi":"/openapi.json get /mattertypes/categories","href":"/api-reference/matter-types/get-matter-types-categories"}]},{"group":"Matters","pages":[{"title":"Get the archive for a matter","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/archive","href":"/api-reference/matters/get-the-archive-for-a-matter"},{"title":"Update an archive for a matter.","deprecated":null,"version":null,"openapi":"/openapi.json put /matters/{matterId}/archive","href":"/api-reference/matters/update-an-archive-for-a-matter"},{"title":"Patch an archive for a matter","deprecated":null,"version":null,"openapi":"/openapi.json patch /matters/{matterId}/archive","href":"/api-reference/matters/patch-an-archive-for-a-matter"},{"title":"Get matter billing configuration","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/billingconfiguration","href":"/api-reference/matters/get-matter-billing-configuration"},{"title":"Update matter billing configuration","deprecated":null,"version":null,"openapi":"/openapi.json put /matters/{matterId}/billingconfiguration","href":"/api-reference/matters/update-matter-billing-configuration"},{"title":"Patch matter billing configuration","deprecated":null,"version":null,"openapi":"/openapi.json patch /matters/{matterId}/billingconfiguration","href":"/api-reference/matters/patch-matter-billing-configuration"},{"title":"Get matters","deprecated":null,"version":null,"openapi":"/openapi.json get /matters","href":"/api-reference/matters/get-matters"},{"title":"Create a matter","deprecated":null,"version":null,"openapi":"/openapi.json post /matters","href":"/api-reference/matters/create-a-matter"},{"title":"Get a matter","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}","href":"/api-reference/matters/get-a-matter"},{"title":"Update a matter","deprecated":null,"version":null,"openapi":"/openapi.json put /matters/{matterId}","href":"/api-reference/matters/update-a-matter"},{"title":"Delete a matter","description":"Deletes a specified matter.","deprecated":null,"version":null,"openapi":"/openapi.json delete /matters/{matterId}","href":"/api-reference/matters/delete-a-matter"},{"title":"Patch a matter","deprecated":null,"version":null,"openapi":"/openapi.json patch /matters/{matterId}","href":"/api-reference/matters/patch-a-matter"},{"title":"Get matter tags","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/tags","href":"/api-reference/matters/get-matter-tags"},{"title":"Add tags to a matter","deprecated":null,"version":null,"openapi":"/openapi.json post /matters/{matterId}/tags","href":"/api-reference/matters/add-tags-to-a-matter"},{"title":"Remove tags from a matter","deprecated":null,"version":null,"openapi":"/openapi.json delete /matters/{matterId}/tags/{tagId}","href":"/api-reference/matters/remove-tags-from-a-matter"}]},{"group":"Memos","pages":[{"title":"Get memos on a matter","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/memos","href":"/api-reference/memos/get-memos-on-a-matter"},{"title":"Create a memo on a matter","deprecated":null,"version":null,"openapi":"/openapi.json post /matters/{matterId}/memos","href":"/api-reference/memos/create-a-memo-on-a-matter"},{"title":"Get a memo","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/memos/{id}","href":"/api-reference/memos/get-a-memo"},{"title":"Update a memo","deprecated":null,"version":null,"openapi":"/openapi.json put /matters/{matterId}/memos/{id}","href":"/api-reference/memos/update-a-memo"},{"title":"Delete a memo","deprecated":null,"version":null,"openapi":"/openapi.json delete /matters/{matterId}/memos/{id}","href":"/api-reference/memos/delete-a-memo"}]},{"group":"Notifications","pages":[{"title":"Get a notification","deprecated":null,"version":null,"openapi":"/openapi.json get /notifications/{id}","href":"/api-reference/notifications/get-a-notification"},{"title":"Create a notification","deprecated":null,"version":null,"openapi":"/openapi.json post /notifications","href":"/api-reference/notifications/create-a-notification"}]},{"group":"Plugins","pages":[{"title":"Get a plugin","deprecated":null,"version":null,"openapi":"/openapi.json get /plugins/{pluginId}","href":"/api-reference/plugins/get-a-plugin"},{"title":"Update existing plugin","deprecated":null,"version":null,"openapi":"/openapi.json put /plugins/{pluginId}","href":"/api-reference/plugins/update-existing-plugin"},{"title":"Delete existing plugin","deprecated":null,"version":null,"openapi":"/openapi.json delete /plugins/{pluginId}","href":"/api-reference/plugins/delete-existing-plugin"},{"title":"Get plugins","deprecated":null,"version":null,"openapi":"/openapi.json get /plugins","href":"/api-reference/plugins/get-plugins"},{"title":"Create a new plugin","deprecated":null,"version":null,"openapi":"/openapi.json post /plugins","href":"/api-reference/plugins/create-a-new-plugin"},{"title":"Request plugin URL","deprecated":null,"version":null,"openapi":"/openapi.json post /plugins/{pluginId}/url","href":"/api-reference/plugins/request-plugin-url"},{"title":"Get a plugin subscription","deprecated":null,"version":null,"openapi":"/openapi.json get /plugins/{pluginId}/subscriptions/{id}","href":"/api-reference/plugins/get-a-plugin-subscription"},{"title":"Unsubscribes account from plugin","deprecated":null,"version":null,"openapi":"/openapi.json delete /plugins/{pluginId}/subscriptions/{id}","href":"/api-reference/plugins/unsubscribes-account-from-plugin"},{"title":"Get plugin subscriptions","deprecated":null,"version":null,"openapi":"/openapi.json get /plugins/{pluginId}/subscriptions","href":"/api-reference/plugins/get-plugin-subscriptions"},{"title":"Subscribe account to plugin","deprecated":null,"version":null,"openapi":"/openapi.json post /plugins/{pluginId}/subscriptions","href":"/api-reference/plugins/subscribe-account-to-plugin"}]},{"group":"Portal","pages":[{"title":"Creates a portal task","deprecated":null,"version":null,"openapi":"/openapi.json post /matters/{matterId}/portal/tasks","href":"/api-reference/portal/creates-a-portal-task"},{"title":"Sends a portal message","deprecated":null,"version":null,"openapi":"/openapi.json post /matters/{matterId}/portal/messages","href":"/api-reference/portal/sends-a-portal-message"},{"title":"Patch a portal task","deprecated":null,"version":null,"openapi":"/openapi.json patch /matters/{matterId}/portal/tasks/{taskId}","href":"/api-reference/portal/patch-a-portal-task"}]},{"group":"Referral Types","pages":[{"title":"Get referral types","deprecated":null,"version":null,"openapi":"/openapi.json get /referraltypes","href":"/api-reference/referral-types/get-referral-types"},{"title":"Get a referral type","deprecated":null,"version":null,"openapi":"/openapi.json get /referraltypes/{id}","href":"/api-reference/referral-types/get-a-referral-type"}]},{"group":"Relationships","pages":[{"title":"Get relationships on a matter","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/roles/{roleId}/relationships","href":"/api-reference/relationships/get-relationships-on-a-matter"},{"title":"Add relationship to a role","deprecated":null,"version":null,"openapi":"/openapi.json post /matters/{matterId}/roles/{roleId}/relationships","href":"/api-reference/relationships/add-relationship-to-a-role"},{"title":"Get relationship on a role","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/roles/{roleId}/relationships/{id}","href":"/api-reference/relationships/get-relationship-on-a-role"},{"title":"Update a relationship","deprecated":null,"version":null,"openapi":"/openapi.json put /matters/{matterId}/roles/{roleId}/relationships/{id}","href":"/api-reference/relationships/update-a-relationship"},{"title":"Remove relationship from a role in a matter.","deprecated":null,"version":null,"openapi":"/openapi.json delete /matters/{matterId}/roles/{roleId}/relationships/{id}","href":"/api-reference/relationships/remove-relationship-from-a-role-in-a-matter"}]},{"group":"Roles","pages":[{"title":"Get roles on a matter","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/roles","href":"/api-reference/roles/get-roles-on-a-matter"},{"title":"Add role to a matter","deprecated":null,"version":null,"openapi":"/openapi.json post /matters/{matterId}/roles","href":"/api-reference/roles/add-role-to-a-matter"},{"title":"Get role on a matter","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/roles/{id}","href":"/api-reference/roles/get-role-on-a-matter"},{"title":"Update role on a matter","deprecated":null,"version":null,"openapi":"/openapi.json put /matters/{matterId}/roles/{id}","href":"/api-reference/roles/update-role-on-a-matter"},{"title":"Remove role from a matter","deprecated":null,"version":null,"openapi":"/openapi.json delete /matters/{matterId}/roles/{id}","href":"/api-reference/roles/remove-role-from-a-matter"}]},{"group":"Search","pages":[{"title":"Search files with advanced filters","deprecated":null,"version":null,"openapi":"/openapi.json post /search/files","href":"/api-reference/search/search-files-with-advanced-filters"}]},{"group":"Staff","pages":[{"title":"Search firm staff members","deprecated":null,"version":null,"openapi":"/openapi.json get /staff","href":"/api-reference/staff/search-firm-staff-members"},{"title":"Create firm staff member","deprecated":null,"version":null,"openapi":"/openapi.json post /staff","href":"/api-reference/staff/create-firm-staff-member"},{"title":"Get firm staff member","deprecated":null,"version":null,"openapi":"/openapi.json get /staff/{id}","href":"/api-reference/staff/get-firm-staff-member"},{"title":"Update firm staff member","deprecated":null,"version":null,"openapi":"/openapi.json put /staff/{id}","href":"/api-reference/staff/update-firm-staff-member"},{"title":"Deletes a firm staff member","deprecated":null,"version":null,"openapi":"/openapi.json delete /staff/{id}","href":"/api-reference/staff/deletes-a-firm-staff-member"}]},{"group":"Stages","pages":[{"title":"Get stage to matter mappings in the firm","deprecated":null,"version":null,"openapi":"/openapi.json get /stages","href":"/api-reference/stages/get-stage-to-matter-mappings-in-the-firm"},{"title":"Get a matter stage information","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/stages","href":"/api-reference/stages/get-a-matter-stage-information"},{"title":"Get stage sets for the firm","deprecated":null,"version":null,"openapi":"/openapi.json get /stagesets","href":"/api-reference/stages/get-stage-sets-for-the-firm"},{"title":"Get a stage set","deprecated":null,"version":null,"openapi":"/openapi.json get /stagesets/{id}","href":"/api-reference/stages/get-a-stage-set"},{"title":"Get a stage on a stage set","deprecated":null,"version":null,"openapi":"/openapi.json get /stagesets/{stageSetId}/stages/{id}","href":"/api-reference/stages/get-a-stage-on-a-stage-set"}]},{"group":"Tasks","pages":[{"title":"Get a subtask","deprecated":null,"version":null,"openapi":"/openapi.json get /tasks/{taskId}/subtasks/{id}","href":"/api-reference/tasks/get-a-subtask"},{"title":"Update a subtask","deprecated":null,"version":null,"openapi":"/openapi.json put /tasks/{taskId}/subtasks/{id}","href":"/api-reference/tasks/update-a-subtask"},{"title":"Delete a subtask","deprecated":null,"version":null,"openapi":"/openapi.json delete /tasks/{taskId}/subtasks/{id}","href":"/api-reference/tasks/delete-a-subtask"},{"title":"Get subtasks","deprecated":null,"version":null,"openapi":"/openapi.json get /tasks/{taskId}/subtasks","href":"/api-reference/tasks/get-subtasks"},{"title":"Create a subtask","deprecated":null,"version":null,"openapi":"/openapi.json post /tasks/{taskId}/subtasks","href":"/api-reference/tasks/create-a-subtask"},{"title":"Get task documents","deprecated":null,"version":null,"openapi":"/openapi.json get /tasks/{taskId}/documents","href":"/api-reference/tasks/get-task-documents"},{"title":"Create a task document","deprecated":null,"version":null,"openapi":"/openapi.json post /tasks/{taskId}/documents","href":"/api-reference/tasks/create-a-task-document"},{"title":"Get a task document","deprecated":null,"version":null,"openapi":"/openapi.json get /tasks/{taskId}/documents/{id}","href":"/api-reference/tasks/get-a-task-document"},{"title":"Delete a task document","deprecated":null,"version":null,"openapi":"/openapi.json delete /tasks/{taskId}/documents/{id}","href":"/api-reference/tasks/delete-a-task-document"},{"title":"Get a task","deprecated":null,"version":null,"openapi":"/openapi.json get /tasks/{id}","href":"/api-reference/tasks/get-a-task"},{"title":"Update a task","deprecated":null,"version":null,"openapi":"/openapi.json put /tasks/{id}","href":"/api-reference/tasks/update-a-task"},{"title":"Delete a task","deprecated":null,"version":null,"openapi":"/openapi.json delete /tasks/{id}","href":"/api-reference/tasks/delete-a-task"},{"title":"Get tasks","deprecated":null,"version":null,"openapi":"/openapi.json get /tasks","href":"/api-reference/tasks/get-tasks"},{"title":"Create a task","deprecated":null,"version":null,"openapi":"/openapi.json post /tasks","href":"/api-reference/tasks/create-a-task"}]},{"group":"Users","pages":[{"title":"Get user registrations","deprecated":null,"version":null,"openapi":"/openapi.json get /users/registrations","href":"/api-reference/users/get-user-registrations"},{"title":"Get a user","deprecated":null,"version":null,"openapi":"/openapi.json get /users/{id}","href":"/api-reference/users/get-a-user"},{"title":"Remove a user","deprecated":null,"version":null,"openapi":"/openapi.json delete /users/{id}","href":"/api-reference/users/remove-a-user"},{"title":"Create a user","deprecated":null,"version":null,"openapi":"/openapi.json post /users","href":"/api-reference/users/create-a-user"},{"title":"Resend sign-in credentials","deprecated":null,"version":null,"openapi":"/openapi.json post /users/{id}/invite","href":"/api-reference/users/resend-sign-in-credentials"}]},{"group":"Webhooks","pages":[{"title":"Get event types","deprecated":null,"version":null,"openapi":"/openapi.json get /webhooks/types","href":"/api-reference/webhooks/get-event-types"},{"title":"Get webhook subscriptions","deprecated":null,"version":null,"openapi":"/openapi.json get /webhooks","href":"/api-reference/webhooks/get-webhook-subscriptions"},{"title":"Create new webhook subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /webhooks","href":"/api-reference/webhooks/create-new-webhook-subscription"},{"title":"Get a webhook subscription","deprecated":null,"version":null,"openapi":"/openapi.json get /webhooks/{id}","href":"/api-reference/webhooks/get-a-webhook-subscription"},{"title":"Update a webhook subscription","deprecated":null,"version":null,"openapi":"/openapi.json put /webhooks/{id}","href":"/api-reference/webhooks/update-a-webhook-subscription"},{"title":"Deletes a webhook subscription","deprecated":null,"version":null,"openapi":"/openapi.json delete /webhooks/{id}","href":"/api-reference/webhooks/deletes-a-webhook-subscription"},{"title":"Notify a webhook subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /webhooks/{id}/notify","href":"/api-reference/webhooks/notify-a-webhook-subscription"}]}]}]},{"tab":"SDK","pages":[{"title":"SDK","href":"/docs/sdk-docs/675c9816cdaf6-getting-started"}]},{"tab":"Status","pages":[{"title":"Status","href":"/docs/platform-docs/e8rdxqzugb5zf-status"}]},{"tab":"Release Notes","pages":[{"title":"Release Notes","href":"/docs/api-docs/98439555e1d41-release-notes"}]}]},"basePath":"","title":"Patch a matter - Smokeball","deploymentId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","buildId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BtG4DSkw.js","snippetPresets-C1k1xDhp.js","utils-PMJoEt4Y.js","style-to-object-BY3JEAdk.js","utils-DW3Pr7Jq.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DIISLO2w.js","conditional-requirements-CFM0id0Q.js","cloneDeep-BErNCZCm.js","_Uint8Array-f0PCu9f_.js","isObject-FP1Yky1u.js","ApiExamples-OjY-8mqu.js","usePlaygroundInputsStore-B2HS2hUb.js","shallow-DVFuuIDQ.js","isEqual-DG0UKiQC.js","CodeSnippets-Cy6FBgwN.js","CodeSnippet-D1PtG8ed.js","getApiPlaygroundDisplay-Dkx2eNtL.js","Page-C8Cg25if.js","DynamicMarkdown-BvJIe00T.js","SectionHeading-B0rKYV8d.js","icon-yclzBff4.js","MethodPill-DxA11cCF.js","getPastedJson-CpkIDpMk.js","DuplicateIcon-CFCQNJ-D.js","axios-CsQoIw0U.js","Markdown-CK5C-fmV.js","AssistantPageLink-Cw134Dd-.js","dist-3xM3Qrc7.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}