PracticePanther · Schema

Activity

JSON Schema for the PracticePanther Activity resource

LegalLaw Practice ManagementCase ManagementBillingTrust AccountingTime TrackingLegal Tech

Properties

Name Type Description
date string
shares array
workflowId integer
workflow object
activitiesSync array
guid string
id integer
googleId string
isEnabled boolean
isDeleted boolean
createdDate string
lastModifiedDate string
recurrenceStopDate string
createdById integer
createdBy object
lastModifiedBy object
lawToolboxCourtRule_Id string
lawToolboxCourtRule object
lawToolboxDeadlineId string
lawToolboxDeadlineNumber string
tenantId integer
tenant object
isHoursLoggedManually boolean sets if the activity should be marked as "time logged" even if no time was linked to it.
recurrenceId integer will show the realted recurrence for this event, if such exists
recurrence object
type string
accountId integer
account object
contactId integer
contact object
projectId integer
project object
saleDocumentId integer
saleDocument object
name string
description string
assignedToUsers array
assignedToContacts array
htmlBody object
dueDate string
taskCompleteDate string
startDateTime string
endDateTime string
isAllDayActivity boolean
location string
status string
mandrillId string
isPrivate boolean
priority string
isSendNotificationEmail boolean
isSendCompletedEmail boolean
isSendTaskCompleteEmail boolean
isRecurringActivity boolean
recurringActivityStartDate string
recurringActivityEndDate string
recurringRepeatType string
callType string
tags array
eventColor string
emailProperties object
noteProperties object
callProperties object
timeEntries array
flatFees array
eventBackgroundColor string
blobs array
invitees array
activityReminders array
activityConditionalTasks array
completedTask object
View JSON Schema on GitHub

JSON Schema

practicepanther-activity-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/practicepanther/main/json-schema/practicepanther-activity-schema.json",
  "title": "Activity",
  "description": "JSON Schema for the PracticePanther Activity resource",
  "type": "object",
  "properties": {
    "date": {
      "type": "string",
      "format": "date-time"
    },
    "shares": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Share"
      }
    },
    "workflowId": {
      "type": "integer",
      "format": "int64"
    },
    "workflow": {
      "$ref": "#/$defs/Workflow"
    },
    "activitiesSync": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ActivitySync"
      }
    },
    "guid": {
      "type": "string",
      "format": "uuid"
    },
    "id": {
      "type": "integer",
      "format": "int64"
    },
    "googleId": {
      "type": "string"
    },
    "isEnabled": {
      "type": "boolean"
    },
    "isDeleted": {
      "type": "boolean"
    },
    "createdDate": {
      "type": "string",
      "format": "date-time"
    },
    "lastModifiedDate": {
      "type": "string",
      "format": "date-time"
    },
    "recurrenceStopDate": {
      "type": "string",
      "format": "date-time"
    },
    "createdById": {
      "type": "integer",
      "format": "int32"
    },
    "createdBy": {
      "$ref": "#/$defs/User"
    },
    "lastModifiedBy": {
      "$ref": "#/$defs/User"
    },
    "lawToolboxCourtRule_Id": {
      "type": "string",
      "format": "uuid"
    },
    "lawToolboxCourtRule": {
      "$ref": "#/$defs/LawToolboxCourtRule"
    },
    "lawToolboxDeadlineId": {
      "type": "string"
    },
    "lawToolboxDeadlineNumber": {
      "type": "string"
    },
    "tenantId": {
      "type": "integer",
      "format": "int64"
    },
    "tenant": {
      "$ref": "#/$defs/Tenant"
    },
    "isHoursLoggedManually": {
      "type": "boolean",
      "description": "sets if the activity should be marked as \"time logged\" even if no time was linked to it."
    },
    "recurrenceId": {
      "type": "integer",
      "format": "int64",
      "description": "will show the realted recurrence for this event, if such exists"
    },
    "recurrence": {
      "$ref": "#/$defs/Recurrence"
    },
    "type": {
      "type": "string",
      "enum": [
        "Call",
        "Task",
        "Event",
        "Email",
        "Note"
      ]
    },
    "accountId": {
      "type": "integer",
      "format": "int64"
    },
    "account": {
      "$ref": "#/$defs/Account"
    },
    "contactId": {
      "type": "integer",
      "format": "int64"
    },
    "contact": {
      "$ref": "#/$defs/Contact"
    },
    "projectId": {
      "type": "integer",
      "format": "int64"
    },
    "project": {
      "$ref": "#/$defs/Project"
    },
    "saleDocumentId": {
      "type": "integer",
      "format": "int64"
    },
    "saleDocument": {
      "$ref": "#/$defs/SaleDocument"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "assignedToUsers": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/User"
      }
    },
    "assignedToContacts": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Contact"
      }
    },
    "htmlBody": {
      "$ref": "#/$defs/Blob"
    },
    "dueDate": {
      "type": "string",
      "format": "date-time"
    },
    "taskCompleteDate": {
      "type": "string",
      "format": "date-time"
    },
    "startDateTime": {
      "type": "string",
      "format": "date-time"
    },
    "endDateTime": {
      "type": "string",
      "format": "date-time"
    },
    "isAllDayActivity": {
      "type": "boolean"
    },
    "location": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "NotCompleted",
        "InProgress",
        "Completed",
        "Conditional"
      ]
    },
    "mandrillId": {
      "type": "string"
    },
    "isPrivate": {
      "type": "boolean"
    },
    "priority": {
      "type": "string",
      "enum": [
        "Low",
        "Medium",
        "High"
      ]
    },
    "isSendNotificationEmail": {
      "type": "boolean"
    },
    "isSendCompletedEmail": {
      "type": "boolean"
    },
    "isSendTaskCompleteEmail": {
      "type": "boolean"
    },
    "isRecurringActivity": {
      "type": "boolean"
    },
    "recurringActivityStartDate": {
      "type": "string",
      "format": "date-time"
    },
    "recurringActivityEndDate": {
      "type": "string",
      "format": "date-time"
    },
    "recurringRepeatType": {
      "type": "string",
      "enum": [
        "None",
        "Daily",
        "Weekly",
        "Monthly",
        "Yearly"
      ]
    },
    "callType": {
      "type": "string",
      "enum": [
        "Inbound",
        "Outbound"
      ]
    },
    "tags": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Tag"
      }
    },
    "eventColor": {
      "type": "string"
    },
    "emailProperties": {
      "$ref": "#/$defs/EmailProperties"
    },
    "noteProperties": {
      "$ref": "#/$defs/NoteProperties"
    },
    "callProperties": {
      "$ref": "#/$defs/CallProperties"
    },
    "timeEntries": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/TimeEntry"
      }
    },
    "flatFees": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/FlatFee"
      }
    },
    "eventBackgroundColor": {
      "type": "string"
    },
    "blobs": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Blob"
      }
    },
    "invitees": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Invitee"
      }
    },
    "activityReminders": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ActivityReminder"
      }
    },
    "activityConditionalTasks": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ActivityConditionalTask"
      }
    },
    "completedTask": {
      "$ref": "#/$defs/CompletedTask"
    }
  },
  "required": [
    "name"
  ]
}