Smokeball · Schema

Smokeball ContactDto

LegalLaw FirmPractice ManagementMattersContactsDocumentsBillingTrust AccountingTime Tracking

Properties

Name Type Description
externalSystemId string External system id for the contact.
person object Contact person details (if applicable).
company object Contact company details (if applicable).
trust object Contact trust details (if applicable). Only supported in US.
groupOfPeople object Contact group details (if applicable). Only supported in US and AU.
isDeleted boolean Contact can be restored by setting this to false.
View JSON Schema on GitHub

JSON Schema

smokeball-contactdto.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/smokeball/json-schema/smokeball-contactdto.json",
  "title": "Smokeball ContactDto",
  "type": "object",
  "properties": {
    "externalSystemId": {
      "type": "string",
      "description": "External system id for the contact.",
      "nullable": true,
      "example": "EXT01"
    },
    "person": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PersonDto"
        }
      ],
      "description": "Contact person details (if applicable).",
      "nullable": true
    },
    "company": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CompanyDto"
        }
      ],
      "description": "Contact company details (if applicable).",
      "nullable": true
    },
    "trust": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TrustDto"
        }
      ],
      "description": "Contact trust details (if applicable).\r\n\r\nOnly supported in US.",
      "nullable": true
    },
    "groupOfPeople": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GroupOfPeopleDto"
        }
      ],
      "description": "Contact group details (if applicable).\r\n\r\nOnly supported in US and AU.",
      "nullable": true
    },
    "isDeleted": {
      "type": "boolean",
      "description": "Contact can be restored by setting this to false.",
      "example": false
    }
  },
  "additionalProperties": false
}