DESCRIPTION
This endpoint creates a new matter with the provided parameters.
URL STRUCTURE
https://[hostname]/matter/newMETHOD
POST
HEADERS
**Authorization:** string Base64 [email]:[key]
PARAMETERS
| Name | Type | Description |
|---|---|---|
| category | int|string | Required. Matter category id, or name of matter category as it appears in the system, e.g. "9" or "Patent". |
| subcategory | int|string | Matter subcategory id or name/partial name of subcategory. |
| country | string | Required. Two letter country code. |
| client | int|string | Required. If int: the id of an organisation in the address book. If string: Exact name of client in address book, or new client is created and linked to case. |
| title | string | Required. |
| longTitle | string | |
| user | int|string | Required. User id or exact username of user |
| whoPaysTheBill | int|string | ID of location in address book or exact name of location in address book. |
| user2 | int|string | User id or exact username of user. |
| user3 | int|string | User id or exact username of user. |
| user4 | int|string | User id or exact username of user. |
| priority-date | string | |
| priority-country | string | |
| priority-code | string | |
| application-date | string | |
| application-country | string | |
| application-code | string | |
| publication-date | string | |
| publication-country | string | |
| publication-code | string | |
| grant-date | string | |
| grant-country | string | |
| grant-code | string | |
| natreg-entry-date | string | |
| natreg-entry-country | string | |
| natreg-entry-code | string | |
| natreg-publication-date | string | |
| natreg-publication-country | string | |
| natreg-publication-code | string | |
| history-dates | array | {
"202": {
"date": "2023-10-25",
"country": "GB",
"code": "111111.1"
}
}
|
| applicants | array | Can be: ID of applicant in address book, exact name of applicant in address book or new applicant which will be added to the address book and linked to the matter.{
50,
'Applicant Name',
'New Applicant',
}
|
| inventors | array | Can be: ID of inventor in address book, exact name of inventor in address book or new inventor which will be added to the address book and linked to the matter.{
50,
'Inventor Name',
'New Inventor',
}
|
| custom-fields | array | Json array of custom field ID's with corresponding values.{
"621": "Mechanised Suit"
}
|
| mattercode | string | Must not exist for the subscriber account already. If not provided the mattercode will be generated automatically using the subscribers settings. |
RETURNS
{
"id": "296",
"oldCode": null,
"oldId": null,
"country": "GB",
"countryName": "United Kingdom",
"status": {
"id": "0",
"name": "Open"
},
"matterCode": "000027GB",
"shortTitle": "Magic \"The Bean\" Beans",
"longTitle": "Magic \"The Bean\" Beans Sauce",
"formalTitle": null,
"clientRef": null,
"parentage": null,
"designatedCountries": null,
"application": {},
"publication": {},
"natRegEntry": {},
"natRegPublication": null,
"grant": {},
"priority": {},
"applicants": [
{
"id": "44",
"oldId": null,
"type": null,
"name": "Tom Wilfpp",
"formalName": "Tom Wilf",
"formalNameTitle": null,
"formalNameFirst": null,
"formalNameMiddle": null,
"formalNameLast": null,
"addressName": null,
"salutation": null,
"nationality": null,
"secondaryNationality": null,
"domicile": null,
"address": null,
"street1": null,
"street2": null,
"street3": null,
"city": null,
"county": null,
"postcode": null,
"phone": null,
"email": null,
"cc": null,
"dateOfBirth": null,
"notes": null,
"entity": null,
"active": null,
"licensee": null,
"checkedByUserId": null,
"entityType": "appInv"
}
],
"inventors": [],
"licensees": [],
"associates": [],
"otherSideClients": [],
"otherSideSolicitors": [],
"clientKeyContactId": null,
"category": {
"id": "36",
"definition": "registereddesigns",
"name": "Registered Designs"
},
"subCategory": {
"id": "1",
"name": "Registereddesigns - Product Designs",
"categoryType": "registereddesigns"
},
"imageId": "0",
"typeOfMark": "0",
"businessUnit": null,
"expiryDate": null,
"client": {
"id": "98",
"name": "Example Company",
"orgCode": "EXA",
"categories": [
{}
],
"type": {},
"secondaryType": null,
"marketSource": "0",
"marketNotes": null,
"exportNumber": "",
"tags": "",
"extraCareNotes": "",
"setupDateTime": "2018-11-06 09:29:50",
"setupByUser": "1782",
"nominator": "0",
"modifiedDateTime": null,
"modifiedByUser": null,
"hasGeneralPowerAttorney": "0",
"generalPowerAttorneyStartDate": "0000-00-00",
"generalPowerAttorneyStartEnd": "0000-00-00",
"contactChecked": "0",
"contactCheckedBy": "0",
"contactCheckedDate": null,
"linkedMatterId": "162",
"oldId": null,
"notes": null,
"correspondenceNotes": "",
"organisationGroupId": "0",
"entityType": "organisation",
"linkedMatter": null,
"customFields": []
},
"clientId": "98",
"billingAddress": {
"id": "86237",
"organisationId": "98",
"categories": [
{
"name": "Correspondence",
"id": "1"
},
{
"name": "Visiting",
"id": "2"
},
{
"name": "Billing",
"id": "3"
}
],
"type": null,
"name": "Example Company",
"address": "Example Company\r\n13 Placeholder Street\r\nTypical City\r\nSample County",
"street1": "",
"street2": "",
"street3": "",
"city": "",
"county": "",
"postCode": "BU88 73S",
"country": "GB",
"website": "",
"phone": "0122354575",
"phone2": "0122354575",
"phone3": null,
"email": "[email protected]",
"email2": null,
"email3": null,
"notes": "",
"extraCareNotes": "",
"extraCareNotesColor": "",
"setupDateTime": "2018-11-06 09:29:50",
"setupByUser": "1782",
"modifiedDateTime": "2018-11-06 09:29:50",
"modifiedByUser": "1782",
"active": "1",
"VATNumber": "",
"badPayer": "0",
"taxCode": "0",
"exportCode": "",
"oldId": null,
"companyNumber": "",
"bankAccount": "",
"matterToSaveInvoicesOn": "0",
"accountsContactId": "0",
"entityType": "location",
"invoiceSettings": null,
"defaultCurrency": null,
"customFields": [],
"addressString": "Example Company<br />\r\n13 Placeholder Street<br />\r\nTypical City<br />\r\nSample County,<br>BU88 73S"
},
"billingAddressId": "86237",
"user": {
"id": "1782",
"oldId": null,
"subscriberId": null,
"username": "twilf",
"email": null,
"secondaryEmail": [],
"firstName": "Tom",
"secondName": "Wilford",
"subscriberRef": null,
"clientSQL": null,
"loginCount": null,
"lastLogin": null,
"notes": null,
"gender": null,
"initials": null,
"legalEntity": null
},
"user2": {
"id": null,
"oldId": null,
"subscriberId": null,
"username": null,
"email": null,
"secondaryEmail": [],
"firstName": null,
"secondName": null,
"subscriberRef": null,
"clientSQL": null,
"loginCount": null,
"lastLogin": null,
"notes": null,
"gender": null,
"initials": null,
"legalEntity": null
},
"user3": {
"id": null,
"oldId": null,
"subscriberId": null,
"username": null,
"email": null,
"secondaryEmail": [],
"firstName": null,
"secondName": null,
"subscriberRef": null,
"clientSQL": null,
"loginCount": null,
"lastLogin": null,
"notes": null,
"gender": null,
"initials": null,
"legalEntity": null
},
"user4": {
"id": null,
"oldId": null,
"subscriberId": null,
"username": null,
"email": null,
"secondaryEmail": [],
"firstName": null,
"secondName": null,
"subscriberRef": null,
"clientSQL": null,
"loginCount": null,
"lastLogin": null,
"notes": null,
"gender": null,
"initials": null,
"legalEntity": null
},
"family": null,
"office": null,
"notes": null,
"familyId": "0",
"businessGroup": null,
"internationalRegistrationId": "0",
"classes": null,
"goods": null,
"openDate": "2019-11-05 10:50:25",
"designatedStates": "",
"parentMatterId": null,
"typeId": "7",
"correspondenceNotes": null,
"renewalClient": null,
"renewalClientId": null,
"renewalBillingAddress": null,
"renewalBillingAddressId": null,
"entityType": "matter",
"legalEntity": "6",
"allHistoryDates": null,
"goodsAndClasses": null,
"associatesLoaded": null,
"budgets": null,
"customFields": []
}