Smokeball · Schema

Smokeball Memo

LegalLaw FirmPractice ManagementMattersContactsDocumentsBillingTrust AccountingTime Tracking

Properties

Name	Type	Description
href	string
relation	string
method	string
self	object
id	string	The unique identifier of the memo.
matterId	string	The unique identifier of the matter.
title	string	The title of the memo.
text	string	The text (content) of the memo. In RTF (Rich Text Format).
plainText	string	The plain text (content) of the memo.
createdDate	string	Date the memo was created.
createdByUserId	string	The unique identifier of the user who created the memo.
lastUpdated	string	Date and time that the memo was last updated.
updatedByUserId	string	The unique identifier of the user who last updated the memo.
isDeleted	boolean	Indicates whether or not the memo is deleted (true if it is, false if not).

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/smokeball/json-schema/smokeball-memo.json",
  "title": "Smokeball Memo",
  "type": "object",
  "properties": {
    "href": {
      "type": "string",
      "nullable": true
    },
    "relation": {
      "type": "string",
      "nullable": true
    },
    "method": {
      "type": "string",
      "default": "GET",
      "nullable": true
    },
    "self": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Link"
        }
      ],
      "nullable": true
    },
    "id": {
      "type": "string",
      "description": "The unique identifier of the memo.",
      "nullable": true,
      "example": "009f778f-83df-454a-b344-768a862a7e55"
    },
    "matterId": {
      "type": "string",
      "description": "The unique identifier of the matter.",
      "nullable": true,
      "example": "776e778f-83df-454a-b344-768a862a6e58"
    },
    "title": {
      "type": "string",
      "description": "The title of the memo.",
      "nullable": true,
      "example": "Update"
    },
    "text": {
      "type": "string",
      "description": "The text (content) of the memo.\r\n            \r\nIn RTF (Rich Text Format).",
      "nullable": true,
      "example": "{\\\\rtf1\\\\ansi\\\\ansicpg1252\\\\uc1\\\\htmautsp\\\\deff2{\\\\fonttbl{\\\\f0\\\\fcharset0 Times New Roman;}{\\\\f2\\\\fcharset0 Calibri;}}{\\\\colortbl\\\\red0\\\\green0\\\\blue0;\\\\red255\\\\green255\\\\blue255;}\\\\loch\\\\hich\\\\dbch\\\\pard\\\\plain\\\\ltrpar\\\\itap0{\\\\lang1033\\\\fs18\\\\f2\\\\cf0 \\\\cf0\\\\ql{\\\\f2 {\\\\ltrch There has been a recent update on this matter.}\\\\li0\\\\ri0\\\\sa0\\\\sb0\\\\fi0\\\\ql\\\\sl15\\\\slmult0\\\\par}\\r\\n}\\r\\n}"
    },
    "plainText": {
      "type": "string",
      "description": "The plain text (content) of the memo.",
      "nullable": true,
      "example": "There has been a recent update on this matter."
    },
    "createdDate": {
      "type": "string",
      "description": "Date the memo was created.",
      "format": "date-time",
      "example": "2022-04-23T14:00:00Z"
    },
    "createdByUserId": {
      "type": "string",
      "description": "The unique identifier of the user who created the memo.",
      "nullable": true,
      "example": "010f7d8e-82d1-454b-c324-760a862a7e22"
    },
    "lastUpdated": {
      "type": "string",
      "description": "Date and time that the memo was last updated.",
      "format": "date-time",
      "nullable": true,
      "example": "2022-05-02T16:22:02Z"
    },
    "updatedByUserId": {
      "type": "string",
      "description": "The unique identifier of the user who last updated the memo.",
      "nullable": true,
      "example": "010f7d8e-82d1-454b-c324-760a862a7e22"
    },
    "isDeleted": {
      "type": "boolean",
      "description": "Indicates whether or not the memo is deleted (true if it is, false if not)."
    }
  },
  "additionalProperties": false
}