--- title: "Marks an existing invoice as deleted, will remove all amounts applied on invoices." method: DELETE path: "/api/invoice" tags: ["Invoice"] --- # Marks an existing invoice as deleted, will remove all amounts applied on invoices. `DELETE /api/invoice` ## Query parameters - `guid` string, uuid, required ## Response `200` OK - SaleDocumentDTODetail - `interestOptions` InterestOptions - `isChargeInterest` boolean - `annualPercent` number, double - `interestType` 'Simple' | 'Compound' - `chargeEachNumOfDays` integer - `isDeleted` boolean — - `accountGuid` string, uuid, required — Used to set the reference in POST and PUT - `projectGuid` string, uuid — Used to set the reference in POST and PUTRequired for PracticePanther. Required for PracticePanther. - `numOfPayments` integer — Indicates the number of payments applied on this invoice (SaleDocumentPayments). Indicates the number of payments applied on this invoice (SaleDocumentPayments). - `discountPercent` number, double, required — Discount (%) to be applied on this invoice. 10 = 10%, 1 = 1% etc. - `lastModifiedBy` UserRef - `guid` string, uuid - `displayName` string — - `name` string — - `timeZoneId` string - `lastModifiedDate` string, date-time — - `saleDocumentPayments` SaleDocumentPaymentRef[] - `guid` string, uuid - `amount` number, double, required — The amount of payment or credit applied on this invoice - `saleDocument` SaleDocumentRef - `guid` string, uuid - `number` integer - `name` string — - `type` 'Invoice' | 'Quote' — Indicates if this sale document is an Invoice or a Quote - `invoiceType` 'Sale' | 'Refund' | 'Credit' — If this sale document is of type 'invoice', will indicate if this is a sale, refund or credit invoice. - `date` string, date-time, required — The issue date for this invoice / quote. - `payment` PaymentRef - `guid` string, uuid - `amount` number, double, required — The total amount received. - `name` string — - `date` string, date-time, required - `method` 'Cash' | 'Check' | 'CreditCard' | 'PayPal' | 'AuthorizeNet' | 'Other' | 'Stripe' | 'Wire' | 'Transfer' | 'LawPay' | 'PantherPaymentsCC' | 'PantherPaymentsECheck' | 'JournalEntry', required - `methodName` string - `credit` CreditRef - `guid` string, uuid - `creditAmount` number, double — Total credit amount Total credit amount - `creditApplied` number, double — Credit amount applied towards invoices Credit amount applied towards invoices - `creditAvailable` number, double — Credit amount available (not applied towards invoices) Credit amount available (not applied towards invoices) - `creditForSaleDocument` SaleDocumentRef, required - `guid` string, uuid - `number` integer - `name` string — - `type` 'Invoice' | 'Quote' — Indicates if this sale document is an Invoice or a Quote - `invoiceType` 'Sale' | 'Refund' | 'Credit' — If this sale document is of type 'invoice', will indicate if this is a sale, refund or credit invoice. - `date` string, date-time, required — The issue date for this invoice / quote. - `items` SaleDocumentItemDTO[] - `rowIndex` integer — Controls the order of the items when displayed on the invoice/ - `qty` number, double — Can be either positive or negative. Set to negative to apply a discount on the invoice. - `description` string - `entryDate` string, date-time — Used for items of type "TimeEntry" to indicate the date of the time entry. - `userName` string — Used for items of type "TimeEntry" to indicate the user billing for the time. - `price` number, double — Must be positive. - `tax1Data` SalesTaxData - `id` integer - `name` string - `rate` number, double - `isCompound` boolean - `amount` number, double - `tax1` number, double — Shows the total amount of Tax1 applied to this item/ Shows the total amount of Tax1 applied to this item/ - `tax2Data` SalesTaxData - `id` integer - `name` string - `rate` number, double - `isCompound` boolean - `amount` number, double - `tax2` number, double — - `projectGuid` string, uuid — Used to set the reference in POST and PUT - `projectName` string - `projectNumber` integer - `discount` number, double — Calculated from SaleDocument.DiscountPercent Calculated from SaleDocument.DiscountPercent - `sub` number, double — Calculated as Qty * Price Calculated as Qty * Price - `total` number, double — Calculated as Sub + (Sub * Tax) Calculated as Sub + (Sub * Tax) - `type` 'RegularItem' | 'TimeEntryItem' | 'ExpenseItem' | 'InterestItem' | 'EmptyItem' — Indicates if this is a regular invoice item or a time entry invoice item. - `timeEntries` TimeEntryRef[] - `guid` string, uuid - `name` string — - `expenses` ExpenseRef[] - `guid` string, uuid - `name` string — - `flatFees` FlatFeeRef[] - `guid` string, uuid - `name` string — - `flatFeesGuids` string — Used to set the reference in POST and PUTReferences the flat fees billed on this item. References the flat fees billed on this item. - `timeEntriesGuids` string — Used to set the reference in POST and PUTReferences the time entries billed on this item. References the time entries billed on this item. - `expensesGuids` string — Used to set the reference in POST and PUTReferences the expenses billed on this item. References the expenses billed on this item. - `flatRateProjectId` integer — References the flat rate projects that were billed on this item. - `ledesUtbmsCode` string - `ledesItemCode` string - `ledesExpenseCode` string - `ledesTimekeeperClass` string - `chartOfAccountId` integer - `guid` string, uuid - `name` string - `credit` CreditDTO - `saleDocumentPayments` SaleDocumentPaymentRef[] - `guid` string, uuid - `amount` number, double, required — The amount of payment or credit applied on this invoice - `saleDocument` SaleDocumentRef - `guid` string, uuid - `number` integer - `name` string — - `type` 'Invoice' | 'Quote' — Indicates if this sale document is an Invoice or a Quote - `invoiceType` 'Sale' | 'Refund' | 'Credit' — If this sale document is of type 'invoice', will indicate if this is a sale, refund or credit invoice. - `date` string, date-time, required — The issue date for this invoice / quote. - `payment` PaymentRef - `guid` string, uuid - `amount` number, double, required — The total amount received. - `name` string — - `date` string, date-time, required - `method` 'Cash' | 'Check' | 'CreditCard' | 'PayPal' | 'AuthorizeNet' | 'Other' | 'Stripe' | 'Wire' | 'Transfer' | 'LawPay' | 'PantherPaymentsCC' | 'PantherPaymentsECheck' | 'JournalEntry', required - `methodName` string - `credit` CreditRef - `guid` string, uuid - `creditAmount` number, double — Total credit amount Total credit amount - `creditApplied` number, double — Credit amount applied towards invoices Credit amount applied towards invoices - `creditAvailable` number, double — Credit amount available (not applied towards invoices) Credit amount available (not applied towards invoices) - `creditForSaleDocument` SaleDocumentRef, required - `guid` string, uuid - `number` integer - `name` string — - `type` 'Invoice' | 'Quote' — Indicates if this sale document is an Invoice or a Quote - `invoiceType` 'Sale' | 'Refund' | 'Credit' — If this sale document is of type 'invoice', will indicate if this is a sale, refund or credit invoice. - `date` string, date-time, required — The issue date for this invoice / quote. - `guid` string, uuid - `creditAmount` number, double — Total credit amount Total credit amount - `creditApplied` number, double — Credit amount applied towards invoices Credit amount applied towards invoices - `creditAvailable` number, double — Credit amount available (not applied towards invoices) Credit amount available (not applied towards invoices) - `creditForSaleDocument` SaleDocumentRef, required - `guid` string, uuid - `number` integer - `name` string — - `type` 'Invoice' | 'Quote' — Indicates if this sale document is an Invoice or a Quote - `invoiceType` 'Sale' | 'Refund' | 'Credit' — If this sale document is of type 'invoice', will indicate if this is a sale, refund or credit invoice. - `date` string, date-time, required — The issue date for this invoice / quote. - `termsAndConditions` string — Terms and conditions for this invoice. Visible to the customer. - `customerNotes` string — Specific notes for the customer. Visible to the customer. - `isSendInvoicePaymentReminders` boolean — Set to true to send automatic payment reminders to this client. - `isUseCreditToPayBalance` boolean — Used during PUT/POST. If set to true all available operating account credit (for this account / project) will automatically be applied to this invoice to pay any amount due. - `isUseTrustToPayBalance` boolean — Used during PUT/POST. If set to true will automatically transfer funds from the trust account to the operating account and apply them on this invoice. - `isNotifyWhenViewedByClient` boolean — Send an email to the user which created this invoice and to the account and project owners when this invoice is viewed by the customer. - `isNotifyWhenPaidByClient` boolean — Invoices only, if set to true will send an email to the user which created this invoice and to the account and project owners when this invoice is paid by the customer. - `isNotifyWhenApprovedByClient` boolean — Quotes only. If set to true, will send an email to the user which created this invoice and to the account and project owners when this quote is approved by the customer. - `isAllowOnlinePayment` boolean — Invoices of type Sale only. If set to true, will accept online payment on this invoice. Online payments must be enabled for this to apply. - `isAllowPartialPayment` boolean — Invoices of type Sale only. If set to true, will accept online payment on this invoice for less than the full amount due. Online payments must be enabled for this to apply. - `isCarryForwardBalance` boolean — Invoices of type Sale only. If set to true, will add to the total balance all unpaid invoices - `refundPaymentMethod` 'Cash' | 'Check' | 'CreditCard' | 'PayPal' | 'AuthorizeNet' | 'Other' | 'Stripe' | 'Wire' | 'Transfer' | 'LawPay' | 'PantherPaymentsCC' | 'PantherPaymentsECheck' | 'JournalEntry' — Invoices of type Refund only. Indicates the method funds were refunded to the client. - `refundPaymentBankAccountGuid` string, uuid — Used to set the reference in POST and PUT - `saleDocumentTemplateGuid` string, uuid, required — Used to set the reference in POST and PUT - `isMultiMatterInvoice` boolean - `isSubmitInvoiceForApproval` boolean - `isSentToCustomer` boolean - `bankAccountGuid` string, uuid — Used to set the reference in POST and PUT - `defaultBankAccountGuid` string, uuid — Used to set the reference in POST and PUT - `bankAccount` BankAccount - `guid` string, uuid - `name` string - `description` string - `type` 'Operating' | 'Trust' | 'CreditCard' - `isDefault` boolean - `isArchived` boolean - `tenantId` integer - `tenant` Tenant - `guid` string, uuid - `id` integer - `name` string - `logo` Blob - `shares` Share[] - `guid` string, uuid - `sharedDate` string, date-time - `sharedByUserId` integer - `sharedByUser` User - `guid` string, uuid - `photoUserGuid` string, uuid — Used to set the reference in POST and PUT - `iCalGuid` string, uuid — Used to set the reference in POST and PUT - `emailGuid` string, uuid — Used to set the reference in POST and PUT - `id` integer, required - `fullName` string - `displayName` string - `name` string - `firstName` string - `lastName` string - `middleName` string - `email` string, required - `isEmailConfirmed` boolean — Sets to true once user confirms email and sets password - `isPasswordSet` boolean - `password` string - `confirmPassword` string - `timeZoneId` string - `ledesTimekeeperId` string - `mobile` string - `home` string - `office` string - `ext` string - `fax` string - `salutation` string - `position` string - `notes` string - `skypeId` string - `twitter` string - `gender` 'Male' | 'Female' - `directMailAdditionalEmailAddresses` string - `photo` Blob — recursive - `photoThumbnail` Blob — recursive - `lastLoginDate` string, date-time - `lastDateOfPaymentPlanMigrationSnooze` string, date-time - `lastDateUpdateTenantInfoPopUpSnooze` string, date-time - `lastDatePantherPaymentMigrationPopUpSnooze` string, date-time - `birthday` string, date-time - `isDeleted` boolean - `isEnabled` boolean - `createdDate` string, date-time - `lastModifiedDate` string, date-time - `syncSettings` SyncSettings - … - `googleUsername` string - `isGoogleSyncEnabled` boolean - `lastGoogleSyncDate` string, date-time - `microsoftLiveConnectAuthToken` string - `isMicrosoftLiveConnectEnabled` boolean - `lastMicrosoftLiveSyncDate` string, date-time - `isExchangeIntegrationEnabled` boolean - `lastExchangeSyncDate` string, date-time - `exchangeUsername` string - `exchangeEmailAddress` string - `exchangeURL` string - `exchangePassword` string - `isExchangePasswordEncrypted` boolean - `hourlyRate` number, double - `hourlyCost` number, double - `timeEntries_IsRoundingEnabled` boolean - `timeEntries_RoundDirection` 'Up' | 'Down' - `timeEntries_RoundToNearest` number, double - `portals` Portal[] - … - `isHideWelcomePage` boolean - `isEmailActivityAssigneeByDefault` boolean - `isEmailUserTaskCompletedByDefault` boolean - `isReceiveDailyAgendaEmail` boolean - `isReceiveWeeklySummaryEmail` boolean - `isReceiveActivityEmails` boolean - `isReceiveNotificationPopups` boolean - `roleId` integer - `role` Role - … - `imapServer` MailServerSettings - … - `smtpServer` MailServerSettings - … - `notificationsSettings` NotificationSettings - … - `mixpanelDistinctId` string - `popUpSettings` UserPopUpSettings - … - `goToWebinarWebinarKey` integer - `goToWebinarRegistrantKey` integer - `chatStatus` 'Offline' | 'Online' - `supportAccessExpiration` string, date-time - `supportEncryptedAccessCode` string - `isSupportRecordingEnabled` boolean - `supportRecordingExpiration` string, date-time - `doesHaveBankAccountViewPermissions` boolean - `sharedByContactId` integer - `sharedByContact` Contact — Contact domain methods - business logic and factory methods - `guid` string, uuid - `id` integer, required - `photo` Blob — recursive - `photoThumbnail` Blob[] - `firstName` string - `lastName` string - `middleName` string - `fullName` string - `displayName` string - `email` string - `mobile` string - `home` string - `office` string - `ext` string - `fax` string - `salutation` string - `position` string - `prefix` string - `notes` string - `skypeId` string - `twitter` string - `jobTitle` string - `gender` 'Male' | 'Female' - `isEmailOptOut` boolean - `isEnabled` boolean - `isDeleted` boolean - `type` 'Contact' | 'Lead' - `accountId` integer - `tenant` Tenant — recursive - `activity` Activity - `date` string, date-time - `shares` Share[] - `workflowId` integer - `workflow` Workflow - … - `activitiesSync` ActivitySync[] - … - `guid` string, uuid - `id` integer - `googleId` string - `isEnabled` boolean - `isDeleted` boolean - `createdDate` string, date-time - `lastModifiedDate` string, date-time - `recurrenceStopDate` string, date-time - `createdById` integer - `createdBy` User - … - `lastModifiedBy` User - … - `lawToolboxCourtRule_Id` string, uuid - `lawToolboxCourtRule` LawToolboxCourtRule - … - `lawToolboxDeadlineId` string - `lawToolboxDeadlineNumber` string - `tenantId` integer - `tenant` Tenant — recursive - `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` Recurrence - … - `type` 'Call' | 'Task' | 'Event' | 'Email' | 'Note' - `accountId` integer - `account` Account — Account domain methods - business logic and aggregate root operations - … - `contactId` integer - `contact` Contact — Contact domain methods - business logic and factory methods - … - `projectId` integer - `project` Project - … - `saleDocumentId` integer - `saleDocument` SaleDocument - … - `name` string, required - `description` string - `assignedToUsers` User[] - … - `assignedToContacts` Contact[] - … - `htmlBody` Blob — recursive - `dueDate` string, date-time - `taskCompleteDate` string, date-time - `startDateTime` string, date-time - `endDateTime` string, date-time - `isAllDayActivity` boolean - `location` string - `status` 'NotCompleted' | 'InProgress' | 'Completed' | 'Conditional' - `mandrillId` string - `isPrivate` boolean - `priority` 'Low' | 'Medium' | 'High' - `isSendNotificationEmail` boolean - `isSendCompletedEmail` boolean - `isSendTaskCompleteEmail` boolean - `isRecurringActivity` boolean - `recurringActivityStartDate` string, date-time - `recurringActivityEndDate` string, date-time - `recurringRepeatType` 'None' | 'Daily' | 'Weekly' | 'Monthly' | 'Yearly' - `callType` 'Inbound' | 'Outbound' - `tags` Tag[] - … - `eventColor` string - `emailProperties` EmailProperties - … - `noteProperties` NoteProperties - … - `callProperties` CallProperties - … - `timeEntries` TimeEntry[] - … - `flatFees` FlatFee[] - … - `eventBackgroundColor` string - `blobs` Blob[] - `invitees` Invitee[] - … - `activityReminders` ActivityReminder[] - … - `activityConditionalTasks` ActivityConditionalTask[] - … - `completedTask` CompletedTask - … - `saleDocument` SaleDocument - `guid` string, uuid - `isMultiMatterInvoice` boolean - `id` integer - `currencyCode` string - `type` 'Invoice' | 'Quote' - `invoiceType` 'Sale' | 'Refund' | 'Credit' - `isNotifyWhenViewedByClient` boolean - `isNotifyWhenPaidByClient` boolean - `isNotifyWhenApprovedByClient` boolean - `isApplyDiscountTimeEntries` boolean - `isApplyDiscountFlatFees` boolean - `isApplyDiscountExpenses` boolean - `isAllowOnlinePayment` boolean - `isAllowPartialPayment` boolean - `isEnabled` boolean - `isDeleted` boolean - `createdDate` string, date-time - `lastModifiedDate` string, date-time - `createdBy` User - … - `lastModifiedBy` User - … - `approvedBy` User - … - `isApproved` boolean - `isCarryForwardBalance` boolean - `saleDocumentTemplateId` integer - `saleDocumentTemplate` SaleDocumentTemplate - … - `date` string, date-time - `dueDate` string, date-time - `expDate` string, date-time - `approvalDate` string, date-time - `shares` Share[] - `tenantId` integer - `tenant` Tenant — recursive - `items` SaleDocumentItem[] - … - `activities` Activity[] - … - `bankAccountGuid` string, uuid — Used to set the reference in POST and PUT - `bankAccount` BankAccount — recursive - `accountId` integer - `account` Account — Account domain methods - business logic and aggregate root operations - … - `credit` Credit - … - `refund` Refund - … - `projectId` integer - `project` Project - … - `contact` Contact — Contact domain methods - business logic and factory methods - … - `toShippingAddress` Address — Address domain methods - factory methods for creating addresses - … - `toBillingAddress` Address — Address domain methods - factory methods for creating addresses - … - `termsAndConditions` string - `customerNotes` string - `pdf` Blob — recursive - `pdF_Id` integer - `invoiceSentToSmsNumber` string - `amountPaid` number, double - `amountDue` number, double - `feeds` Feed[] - … - `saleDocumentPaymentReminders` SaleDocumentPaymentReminder[] - … - `sub` number, double - `salesTaxData` SalesTaxData[] - … - `tax` number, double - `discount` number, double - `discountPercent` number, double - `total` number, double - `saleDocumentPayments` SaleDocumentPayment[] - … - `isSentToCustomer` boolean - `sentToCustomerDate` string, date-time - `isViewedByCustomer` boolean - `viewedByCustomerDate` string, date-time - `viewedByCustomerNumOfTimes` integer - `isInvoicedToCustomer` boolean - `invoicedToCustomerDate` string, date-time - `poNumber` string - `isApprovedByCustomer` boolean - `approvedByCustomerDate` string, date-time - `isSendInvoicePaymentReminders` boolean - `isSendQuoteApprovalReminders` boolean - `quickbooksId` string - `lastQuickbooksSyncDate` string, date-time - `xeroId` string, uuid - `lastXeroSyncDate` string, date-time - `totalInterest` number, double - `interestOptions` InterestOptions - … - `status` 'Saved' | 'Approved' | 'Sent' | 'Paid' | 'Viewed' | 'Overdue' | 'Expired' | 'Invoiced' | 'Due' | 'PendingApproval' - `number` integer - `numOfAutomaticInterestChargesAdded` integer - `name` string - `invoiceOrder` 'Name' | 'Number' - `payment` Payment - `guid` string, uuid - `notes` string - `isPaymentCleared` boolean - `id` integer - `currencyCode` string - `number` integer - `name` string - `amount` number, double - `amountApplied` number, double - `amountCredited` number, double - `method` 'Cash' | 'Check' | 'CreditCard' | 'PayPal' | 'AuthorizeNet' | 'Other' | 'Stripe' | 'Wire' | 'Transfer' | 'LawPay' | 'PantherPaymentsCC' | 'PantherPaymentsECheck' | 'JournalEntry' - `refund` Refund - … - `authNumber` string - `transactionId` string - `bankAcctName` string - `bankName` string - `bankRoutingNumber` string - `bankAcctType` 'Operating' | 'Trust' | 'CreditCard' - `checkAcctNumber` string - `isDepositSlipPrinted` boolean — If the payment is associated with a bank account where BankAccount.IsPrintDepositSlips = true, this will indicate whether this payment had a deposit slip printed for it or not - `checkNumber` integer - `checkPayeeId` integer - `checkPayee` Account — Account domain methods - business logic and aggregate root operations - … - `checkIsPrinted` boolean - `creditCardNameOnCard` string - `creditCardLast4Digits` string - `creditCardType` 'Unknown' | 'Visa' | 'Mastercard' | 'AmericanExpress' | 'Diners' | 'Other' - `creditCardExpMonth` integer - `creditCardExpYear` integer - `details` string - `type` 'OfflinePayment' | 'OnlinePayment' | 'Transfer' | 'HardCostExpense' | 'FirmPayment' - `saleDocumentPayments` SaleDocumentPayment[] - … - `accountId` integer - `account` Account — Account domain methods - business logic and aggregate root operations - … - `projectId` integer - `isProjectRequired` boolean - `project` Project - … - `tenant` Tenant — recursive - `tenantId` integer - `blobs` Blob[] - `isEnabled` boolean - `isDeleted` boolean - `date` string, date-time - `createdDate` string, date-time - `lastModifiedDate` string, date-time - `createdBy_Id` integer - `createdBy` User - … - `lastModifiedBy_Id` integer - `lastModifiedBy` User - … - `quickbooksId` string - `quickbooksPurchaseId` string - `quickbooksDepositId` string - `lastQuickbooksSyncDate` string, date-time - `xeroId` string, uuid - `lastXeroSyncDate` string, date-time - `bankAccountGuid` string, uuid — Used to set the reference in POST and PUT - `bankAccount` BankAccount — recursive - `isReconciled` boolean - `reconciledDate` string, date-time - `trustBooksReconciledDate` string, date-time - `reconciledBy` User - … - `trustBooksReconciledById` integer - `trustBooksReconciledBy` User - … - `hardCostExpenses` Expense[] - … - `feeAmountInCents` number, double - `status` 'Pending' | 'Failed' | 'Success' | 'Refunded' | 'RefundPending' | 'Canceled' - `refundParentPaymentGuid` string, uuid — Used to set the reference in POST and PUT - `oneLinkTemplate` OneLinkTemplate - … - `oneLinkTemplateId` integer - `depositSlipId` integer - `depositSlip` DepositSlip - … - `lastModifiedHeadNoteDateUtc` string, date-time - `paymentSourceGuid` string, uuid — Used to set the reference in POST and PUT - `paymentSource` PaymentSource - … - `surchargeAmountInCents` integer - `surchargeAmountGuid` string, uuid — Used to set the reference in POST and PUT - `chartOfAccountId` integer - `trustbooksJournalEntryGuid` string, uuid — Used to set the reference in POST and PUT - `referenceNumber` string - `transferId` integer - `paymentImportMatch` PaymentImportMatch - … - `blob` Blob — recursive - `guid` string, uuid - `isHidden` boolean — If true, the blob will not be visible to the tenant in the list of attachments. Used for invoices etc. - `id` integer - `uri` string - `size` integer - `type` string - `description` string - `name` string - `containerName` string - `isEnabled` boolean - `isDeleted` boolean - `boxFileId` string - `dropboxFileId` string - `logoThumbnail` Blob - `shares` Share[] - `guid` string, uuid - `sharedDate` string, date-time - `sharedByUserId` integer - `sharedByUser` User - `guid` string, uuid - `photoUserGuid` string, uuid — Used to set the reference in POST and PUT - `iCalGuid` string, uuid — Used to set the reference in POST and PUT - `emailGuid` string, uuid — Used to set the reference in POST and PUT - `id` integer, required - `fullName` string - `displayName` string - `name` string - `firstName` string - `lastName` string - `middleName` string - `email` string, required - `isEmailConfirmed` boolean — Sets to true once user confirms email and sets password - `isPasswordSet` boolean - `password` string - `confirmPassword` string - `timeZoneId` string - `ledesTimekeeperId` string - `mobile` string - `home` string - `office` string - `ext` string - `fax` string - `salutation` string - `position` string - `notes` string - `skypeId` string - `twitter` string - `gender` 'Male' | 'Female' - `directMailAdditionalEmailAddresses` string - `photo` Blob — recursive - `photoThumbnail` Blob — recursive - `lastLoginDate` string, date-time - `lastDateOfPaymentPlanMigrationSnooze` string, date-time - `lastDateUpdateTenantInfoPopUpSnooze` string, date-time - `lastDatePantherPaymentMigrationPopUpSnooze` string, date-time - `birthday` string, date-time - `isDeleted` boolean - `isEnabled` boolean - `createdDate` string, date-time - `lastModifiedDate` string, date-time - `syncSettings` SyncSettings - … - `googleUsername` string - `isGoogleSyncEnabled` boolean - `lastGoogleSyncDate` string, date-time - `microsoftLiveConnectAuthToken` string - `isMicrosoftLiveConnectEnabled` boolean - `lastMicrosoftLiveSyncDate` string, date-time - `isExchangeIntegrationEnabled` boolean - `lastExchangeSyncDate` string, date-time - `exchangeUsername` string - `exchangeEmailAddress` string - `exchangeURL` string - `exchangePassword` string - `isExchangePasswordEncrypted` boolean - `hourlyRate` number, double - `hourlyCost` number, double - `timeEntries_IsRoundingEnabled` boolean - `timeEntries_RoundDirection` 'Up' | 'Down' - `timeEntries_RoundToNearest` number, double - `portals` Portal[] - … - `isHideWelcomePage` boolean - `isEmailActivityAssigneeByDefault` boolean - `isEmailUserTaskCompletedByDefault` boolean - `isReceiveDailyAgendaEmail` boolean - `isReceiveWeeklySummaryEmail` boolean - `isReceiveActivityEmails` boolean - `isReceiveNotificationPopups` boolean - `roleId` integer - `role` Role - … - `imapServer` MailServerSettings - … - `smtpServer` MailServerSettings - … - `notificationsSettings` NotificationSettings - … - `mixpanelDistinctId` string - `popUpSettings` UserPopUpSettings - … - `goToWebinarWebinarKey` integer - `goToWebinarRegistrantKey` integer - `chatStatus` 'Offline' | 'Online' - `supportAccessExpiration` string, date-time - `supportEncryptedAccessCode` string - `isSupportRecordingEnabled` boolean - `supportRecordingExpiration` string, date-time - `doesHaveBankAccountViewPermissions` boolean - `sharedByContactId` integer - `sharedByContact` Contact — Contact domain methods - business logic and factory methods - `guid` string, uuid - `id` integer, required - `photo` Blob — recursive - `photoThumbnail` Blob[] - `firstName` string - `lastName` string - `middleName` string - `fullName` string - `displayName` string - `email` string - `mobile` string - `home` string - `office` string - `ext` string - `fax` string - `salutation` string - `position` string - `prefix` string - `notes` string - `skypeId` string - `twitter` string - `jobTitle` string - `gender` 'Male' | 'Female' - `isEmailOptOut` boolean - `isEnabled` boolean - `isDeleted` boolean - `type` 'Contact' | 'Lead' - `accountId` integer - `tenant` Tenant — recursive - `activity` Activity - `date` string, date-time - `shares` Share[] - `workflowId` integer - `workflow` Workflow - … - `activitiesSync` ActivitySync[] - … - `guid` string, uuid - `id` integer - `googleId` string - `isEnabled` boolean - `isDeleted` boolean - `createdDate` string, date-time - `lastModifiedDate` string, date-time - `recurrenceStopDate` string, date-time - `createdById` integer - `createdBy` User - … - `lastModifiedBy` User - … - `lawToolboxCourtRule_Id` string, uuid - `lawToolboxCourtRule` LawToolboxCourtRule - … - `lawToolboxDeadlineId` string - `lawToolboxDeadlineNumber` string - `tenantId` integer - `tenant` Tenant — recursive - `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` Recurrence - … - `type` 'Call' | 'Task' | 'Event' | 'Email' | 'Note' - `accountId` integer - `account` Account — Account domain methods - business logic and aggregate root operations - … - `contactId` integer - `contact` Contact — Contact domain methods - business logic and factory methods - … - `projectId` integer - `project` Project - … - `saleDocumentId` integer - `saleDocument` SaleDocument - … - `name` string, required - `description` string - `assignedToUsers` User[] - … - `assignedToContacts` Contact[] - … - `htmlBody` Blob — recursive - `dueDate` string, date-time - `taskCompleteDate` string, date-time - `startDateTime` string, date-time - `endDateTime` string, date-time - `isAllDayActivity` boolean - `location` string - `status` 'NotCompleted' | 'InProgress' | 'Completed' | 'Conditional' - `mandrillId` string - `isPrivate` boolean - `priority` 'Low' | 'Medium' | 'High' - `isSendNotificationEmail` boolean - `isSendCompletedEmail` boolean - `isSendTaskCompleteEmail` boolean - `isRecurringActivity` boolean - `recurringActivityStartDate` string, date-time - `recurringActivityEndDate` string, date-time - `recurringRepeatType` 'None' | 'Daily' | 'Weekly' | 'Monthly' | 'Yearly' - `callType` 'Inbound' | 'Outbound' - `tags` Tag[] - … - `eventColor` string - `emailProperties` EmailProperties - … - `noteProperties` NoteProperties - … - `callProperties` CallProperties - … - `timeEntries` TimeEntry[] - … - `flatFees` FlatFee[] - … - `eventBackgroundColor` string - `blobs` Blob[] - `invitees` Invitee[] - … - `activityReminders` ActivityReminder[] - … - `activityConditionalTasks` ActivityConditionalTask[] - … - `completedTask` CompletedTask - … - `saleDocument` SaleDocument - `guid` string, uuid - `isMultiMatterInvoice` boolean - `id` integer - `currencyCode` string - `type` 'Invoice' | 'Quote' - `invoiceType` 'Sale' | 'Refund' | 'Credit' - `isNotifyWhenViewedByClient` boolean - `isNotifyWhenPaidByClient` boolean - `isNotifyWhenApprovedByClient` boolean - `isApplyDiscountTimeEntries` boolean - `isApplyDiscountFlatFees` boolean - `isApplyDiscountExpenses` boolean - `isAllowOnlinePayment` boolean - `isAllowPartialPayment` boolean - `isEnabled` boolean - `isDeleted` boolean - `createdDate` string, date-time - `lastModifiedDate` string, date-time - `createdBy` User - … - `lastModifiedBy` User - … - `approvedBy` User - … - `isApproved` boolean - `isCarryForwardBalance` boolean - `saleDocumentTemplateId` integer - `saleDocumentTemplate` SaleDocumentTemplate - … - `date` string, date-time - `dueDate` string, date-time - `expDate` string, date-time - `approvalDate` string, date-time - `shares` Share[] - `tenantId` integer - `tenant` Tenant — recursive - `items` SaleDocumentItem[] - … - `activities` Activity[] - … - `bankAccountGuid` string, uuid — Used to set the reference in POST and PUT - `bankAccount` BankAccount — recursive - `accountId` integer - `account` Account — Account domain methods - business logic and aggregate root operations - … - `credit` Credit - … - `refund` Refund - … - `projectId` integer - `project` Project - … - `contact` Contact — Contact domain methods - business logic and factory methods - … - `toShippingAddress` Address — Address domain methods - factory methods for creating addresses - … - `toBillingAddress` Address — Address domain methods - factory methods for creating addresses - … - `termsAndConditions` string - `customerNotes` string - `pdf` Blob — recursive - `pdF_Id` integer - `invoiceSentToSmsNumber` string - `amountPaid` number, double - `amountDue` number, double - `feeds` Feed[] - … - `saleDocumentPaymentReminders` SaleDocumentPaymentReminder[] - … - `sub` number, double - `salesTaxData` SalesTaxData[] - … - `tax` number, double - `discount` number, double - `discountPercent` number, double - `total` number, double - `saleDocumentPayments` SaleDocumentPayment[] - … - `isSentToCustomer` boolean - `sentToCustomerDate` string, date-time - `isViewedByCustomer` boolean - `viewedByCustomerDate` string, date-time - `viewedByCustomerNumOfTimes` integer - `isInvoicedToCustomer` boolean - `invoicedToCustomerDate` string, date-time - `poNumber` string - `isApprovedByCustomer` boolean - `approvedByCustomerDate` string, date-time - `isSendInvoicePaymentReminders` boolean - `isSendQuoteApprovalReminders` boolean - `quickbooksId` string - `lastQuickbooksSyncDate` string, date-time - `xeroId` string, uuid - `lastXeroSyncDate` string, date-time - `totalInterest` number, double - `interestOptions` InterestOptions - … - `status` 'Saved' | 'Approved' | 'Sent' | 'Paid' | 'Viewed' | 'Overdue' | 'Expired' | 'Invoiced' | 'Due' | 'PendingApproval' - `number` integer - `numOfAutomaticInterestChargesAdded` integer - `name` string - `invoiceOrder` 'Name' | 'Number' - `payment` Payment - `guid` string, uuid - `notes` string - `isPaymentCleared` boolean - `id` integer - `currencyCode` string - `number` integer - `name` string - `amount` number, double - `amountApplied` number, double - `amountCredited` number, double - `method` 'Cash' | 'Check' | 'CreditCard' | 'PayPal' | 'AuthorizeNet' | 'Other' | 'Stripe' | 'Wire' | 'Transfer' | 'LawPay' | 'PantherPaymentsCC' | 'PantherPaymentsECheck' | 'JournalEntry' - `refund` Refund - … - `authNumber` string - `transactionId` string - `bankAcctName` string - `bankName` string - `bankRoutingNumber` string - `bankAcctType` 'Operating' | 'Trust' | 'CreditCard' - `checkAcctNumber` string - `isDepositSlipPrinted` boolean — If the payment is associated with a bank account where BankAccount.IsPrintDepositSlips = true, this will indicate whether this payment had a deposit slip printed for it or not - `checkNumber` integer - `checkPayeeId` integer - `checkPayee` Account — Account domain methods - business logic and aggregate root operations - … - `checkIsPrinted` boolean - `creditCardNameOnCard` string - `creditCardLast4Digits` string - `creditCardType` 'Unknown' | 'Visa' | 'Mastercard' | 'AmericanExpress' | 'Diners' | 'Other' - `creditCardExpMonth` integer - `creditCardExpYear` integer - `details` string - `type` 'OfflinePayment' | 'OnlinePayment' | 'Transfer' | 'HardCostExpense' | 'FirmPayment' - `saleDocumentPayments` SaleDocumentPayment[] - … - `accountId` integer - `account` Account — Account domain methods - business logic and aggregate root operations - … - `projectId` integer - `isProjectRequired` boolean - `project` Project - … - `tenant` Tenant — recursive - `tenantId` integer - `blobs` Blob[] - `isEnabled` boolean - `isDeleted` boolean - `date` string, date-time - `createdDate` string, date-time - `lastModifiedDate` string, date-time - `createdBy_Id` integer - `createdBy` User - … - `lastModifiedBy_Id` integer - `lastModifiedBy` User - … - `quickbooksId` string - `quickbooksPurchaseId` string - `quickbooksDepositId` string - `lastQuickbooksSyncDate` string, date-time - `xeroId` string, uuid - `lastXeroSyncDate` string, date-time - `bankAccountGuid` string, uuid — Used to set the reference in POST and PUT - `bankAccount` BankAccount — recursive - `isReconciled` boolean - `reconciledDate` string, date-time - `trustBooksReconciledDate` string, date-time - `reconciledBy` User - … - `trustBooksReconciledById` integer - `trustBooksReconciledBy` User - … - `hardCostExpenses` Expense[] - … - `feeAmountInCents` number, double - `status` 'Pending' | 'Failed' | 'Success' | 'Refunded' | 'RefundPending' | 'Canceled' - `refundParentPaymentGuid` string, uuid — Used to set the reference in POST and PUT - `oneLinkTemplate` OneLinkTemplate - … - `oneLinkTemplateId` integer - `depositSlipId` integer - `depositSlip` DepositSlip - … - `lastModifiedHeadNoteDateUtc` string, date-time - `paymentSourceGuid` string, uuid — Used to set the reference in POST and PUT - `paymentSource` PaymentSource - … - `surchargeAmountInCents` integer - `surchargeAmountGuid` string, uuid — Used to set the reference in POST and PUT - `chartOfAccountId` integer - `trustbooksJournalEntryGuid` string, uuid — Used to set the reference in POST and PUT - `referenceNumber` string - `transferId` integer - `paymentImportMatch` PaymentImportMatch - … - `blob` Blob — recursive - `guid` string, uuid - `isHidden` boolean — If true, the blob will not be visible to the tenant in the list of attachments. Used for invoices etc. - `id` integer - `uri` string - `size` integer - `type` string - `description` string - `name` string - `containerName` string - `isEnabled` boolean - `isDeleted` boolean - `boxFileId` string - `dropboxFileId` string - `headerLogo` Blob - `shares` Share[] - `guid` string, uuid - `sharedDate` string, date-time - `sharedByUserId` integer - `sharedByUser` User - `guid` string, uuid - `photoUserGuid` string, uuid — Used to set the reference in POST and PUT - `iCalGuid` string, uuid — Used to set the reference in POST and PUT - `emailGuid` string, uuid — Used to set the reference in POST and PUT - `id` integer, required - `fullName` string - `displayName` string - `name` string - `firstName` string - `lastName` string - `middleName` string - `email` string, required - `isEmailConfirmed` boolean — Sets to true once user confirms email and sets password - `isPasswordSet` boolean - `password` string - `confirmPassword` string - `timeZoneId` string - `ledesTimekeeperId` string - `mobile` string - `home` string - `office` string - `ext` string - `fax` string - `salutation` string - `position` string - `notes` string - `skypeId` string - `twitter` string - `gender` 'Male' | 'Female' - `directMailAdditionalEmailAddresses` string - `photo` Blob — recursive - `photoThumbnail` Blob — recursive - `lastLoginDate` string, date-time - `lastDateOfPaymentPlanMigrationSnooze` string, date-time - `lastDateUpdateTenantInfoPopUpSnooze` string, date-time - `lastDatePantherPaymentMigrationPopUpSnooze` string, date-time - `birthday` string, date-time - `isDeleted` boolean - `isEnabled` boolean - `createdDate` string, date-time - `lastModifiedDate` string, date-time - `syncSettings` SyncSettings - … - `googleUsername` string - `isGoogleSyncEnabled` boolean - `lastGoogleSyncDate` string, date-time - `microsoftLiveConnectAuthToken` string - `isMicrosoftLiveConnectEnabled` boolean - `lastMicrosoftLiveSyncDate` string, date-time - `isExchangeIntegrationEnabled` boolean - `lastExchangeSyncDate` string, date-time - `exchangeUsername` string - `exchangeEmailAddress` string - `exchangeURL` string - `exchangePassword` string - `isExchangePasswordEncrypted` boolean - `hourlyRate` number, double - `hourlyCost` number, double - `timeEntries_IsRoundingEnabled` boolean - `timeEntries_RoundDirection` 'Up' | 'Down' - `timeEntries_RoundToNearest` number, double - `portals` Portal[] - … - `isHideWelcomePage` boolean - `isEmailActivityAssigneeByDefault` boolean - `isEmailUserTaskCompletedByDefault` boolean - `isReceiveDailyAgendaEmail` boolean - `isReceiveWeeklySummaryEmail` boolean - `isReceiveActivityEmails` boolean - `isReceiveNotificationPopups` boolean - `roleId` integer - `role` Role - … - `imapServer` MailServerSettings - … - `smtpServer` MailServerSettings - … - `notificationsSettings` NotificationSettings - … - `mixpanelDistinctId` string - `popUpSettings` UserPopUpSettings - … - `goToWebinarWebinarKey` integer - `goToWebinarRegistrantKey` integer - `chatStatus` 'Offline' | 'Online' - `supportAccessExpiration` string, date-time - `supportEncryptedAccessCode` string - `isSupportRecordingEnabled` boolean - `supportRecordingExpiration` string, date-time - `doesHaveBankAccountViewPermissions` boolean - `sharedByContactId` integer - `sharedByContact` Contact — Contact domain methods - business logic and factory methods - `guid` string, uuid - `id` integer, required - `photo` Blob — recursive - `photoThumbnail` Blob[] - `firstName` string - `lastName` string - `middleName` string - `fullName` string - `displayName` string - `email` string - `mobile` string - `home` string - `office` string - `ext` string - `fax` string - `salutation` string - `position` string - `prefix` string - `notes` string - `skypeId` string - `twitter` string - `jobTitle` string - `gender` 'Male' | 'Female' - `isEmailOptOut` boolean - `isEnabled` boolean - `isDeleted` boolean - `type` 'Contact' | 'Lead' - `accountId` integer - `tenant` Tenant — recursive - `activity` Activity - `date` string, date-time - `shares` Share[] - `workflowId` integer - `workflow` Workflow - … - `activitiesSync` ActivitySync[] - … - `guid` string, uuid - `id` integer - `googleId` string - `isEnabled` boolean - `isDeleted` boolean - `createdDate` string, date-time - `lastModifiedDate` string, date-time - `recurrenceStopDate` string, date-time - `createdById` integer - `createdBy` User - … - `lastModifiedBy` User - … - `lawToolboxCourtRule_Id` string, uuid - `lawToolboxCourtRule` LawToolboxCourtRule - … - `lawToolboxDeadlineId` string - `lawToolboxDeadlineNumber` string - `tenantId` integer - `tenant` Tenant — recursive - `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` Recurrence - … - `type` 'Call' | 'Task' | 'Event' | 'Email' | 'Note' - `accountId` integer - `account` Account — Account domain methods - business logic and aggregate root operations - … - `contactId` integer - `contact` Contact — Contact domain methods - business logic and factory methods - … - `projectId` integer - `project` Project - … - `saleDocumentId` integer - `saleDocument` SaleDocument - … - `name` string, required - `description` string - `assignedToUsers` User[] - … - `assignedToContacts` Contact[] - … - `htmlBody` Blob — recursive - `dueDate` string, date-time - `taskCompleteDate` string, date-time - `startDateTime` string, date-time - `endDateTime` string, date-time - `isAllDayActivity` boolean - `location` string - `status` 'NotCompleted' | 'InProgress' | 'Completed' | 'Conditional' - `mandrillId` string - `isPrivate` boolean - `priority` 'Low' | 'Medium' | 'High' - `isSendNotificationEmail` boolean - `isSendCompletedEmail` boolean - `isSendTaskCompleteEmail` boolean - `isRecurringActivity` boolean - `recurringActivityStartDate` string, date-time - `recurringActivityEndDate` string, date-time - `recurringRepeatType` 'None' | 'Daily' | 'Weekly' | 'Monthly' | 'Yearly' - `callType` 'Inbound' | 'Outbound' - `tags` Tag[] - … - `eventColor` string - `emailProperties` EmailProperties - … - `noteProperties` NoteProperties - … - `callProperties` CallProperties - … - `timeEntries` TimeEntry[] - … - `flatFees` FlatFee[] - … - `eventBackgroundColor` string - `blobs` Blob[] - `invitees` Invitee[] - … - `activityReminders` ActivityReminder[] - … - `activityConditionalTasks` ActivityConditionalTask[] - … - `completedTask` CompletedTask - … - `saleDocument` SaleDocument - `guid` string, uuid - `isMultiMatterInvoice` boolean - `id` integer - `currencyCode` string - `type` 'Invoice' | 'Quote' - `invoiceType` 'Sale' | 'Refund' | 'Credit' - `isNotifyWhenViewedByClient` boolean - `isNotifyWhenPaidByClient` boolean - `isNotifyWhenApprovedByClient` boolean - `isApplyDiscountTimeEntries` boolean - `isApplyDiscountFlatFees` boolean - `isApplyDiscountExpenses` boolean - `isAllowOnlinePayment` boolean - `isAllowPartialPayment` boolean - `isEnabled` boolean - `isDeleted` boolean - `createdDate` string, date-time - `lastModifiedDate` string, date-time - `createdBy` User - … - `lastModifiedBy` User - … - `approvedBy` User - … - `isApproved` boolean - `isCarryForwardBalance` boolean - `saleDocumentTemplateId` integer - `saleDocumentTemplate` SaleDocumentTemplate - … - `date` string, date-time - `dueDate` string, date-time - `expDate` string, date-time - `approvalDate` string, date-time - `shares` Share[] - `tenantId` integer - `tenant` Tenant — recursive - `items` SaleDocumentItem[] - … - `activities` Activity[] - … - `bankAccountGuid` string, uuid — Used to set the reference in POST and PUT - `bankAccount` BankAccount — recursive - `accountId` integer - `account` Account — Account domain methods - business logic and aggregate root operations - … - `credit` Credit - … - `refund` Refund - … - `projectId` integer - `project` Project - … - `contact` Contact — Contact domain methods - business logic and factory methods - … - `toShippingAddress` Address — Address domain methods - factory methods for creating addresses - … - `toBillingAddress` Address — Address domain methods - factory methods for creating addresses - … - `termsAndConditions` string - `customerNotes` string - `pdf` Blob — recursive - `pdF_Id` integer - `invoiceSentToSmsNumber` string - `amountPaid` number, double - `amountDue` number, double - `feeds` Feed[] - … - `saleDocumentPaymentReminders` SaleDocumentPaymentReminder[] - … - `sub` number, double - `salesTaxData` SalesTaxData[] - … - `tax` number, double - `discount` number, double - `discountPercent` number, double - `total` number, double - `saleDocumentPayments` SaleDocumentPayment[] - … - `isSentToCustomer` boolean - `sentToCustomerDate` string, date-time - `isViewedByCustomer` boolean - `viewedByCustomerDate` string, date-time - `viewedByCustomerNumOfTimes` integer - `isInvoicedToCustomer` boolean - `invoicedToCustomerDate` string, date-time - `poNumber` string - `isApprovedByCustomer` boolean - `approvedByCustomerDate` string, date-time - `isSendInvoicePaymentReminders` boolean - `isSendQuoteApprovalReminders` boolean - `quickbooksId` string - `lastQuickbooksSyncDate` string, date-time - `xeroId` string, uuid - `lastXeroSyncDate` string, date-time - `totalInterest` number, double - `interestOptions` InterestOptions - … - `status` 'Saved' | 'Approved' | 'Sent' | 'Paid' | 'Viewed' | 'Overdue' | 'Expired' | 'Invoiced' | 'Due' | 'PendingApproval' - `number` integer - `numOfAutomaticInterestChargesAdded` integer - `name` string - `invoiceOrder` 'Name' | 'Number' - `payment` Payment - `guid` string, uuid - `notes` string - `isPaymentCleared` boolean - `id` integer - `currencyCode` string - `number` integer - `name` string - `amount` number, double - `amountApplied` number, double - `amountCredited` number, double - `method` 'Cash' | 'Check' | 'CreditCard' | 'PayPal' | 'AuthorizeNet' | 'Other' | 'Stripe' | 'Wire' | 'Transfer' | 'LawPay' | 'PantherPaymentsCC' | 'PantherPaymentsECheck' | 'JournalEntry' - `refund` Refund - … - `authNumber` string - `transactionId` string - `bankAcctName` string - `bankName` string - `bankRoutingNumber` string - `bankAcctType` 'Operating' | 'Trust' | 'CreditCard' - `checkAcctNumber` string - `isDepositSlipPrinted` boolean — If the payment is associated with a bank account where BankAccount.IsPrintDepositSlips = true, this will indicate whether this payment had a deposit slip printed for it or not - `checkNumber` integer - `checkPayeeId` integer - `checkPayee` Account — Account domain methods - business logic and aggregate root operations - … - `checkIsPrinted` boolean - `creditCardNameOnCard` string - `creditCardLast4Digits` string - `creditCardType` 'Unknown' | 'Visa' | 'Mastercard' | 'AmericanExpress' | 'Diners' | 'Other' - `creditCardExpMonth` integer - `creditCardExpYear` integer - `details` string - `type` 'OfflinePayment' | 'OnlinePayment' | 'Transfer' | 'HardCostExpense' | 'FirmPayment' - `saleDocumentPayments` SaleDocumentPayment[] - … - `accountId` integer - `account` Account — Account domain methods - business logic and aggregate root operations - … - `projectId` integer - `isProjectRequired` boolean - `project` Project - … - `tenant` Tenant — recursive - `tenantId` integer - `blobs` Blob[] - `isEnabled` boolean - `isDeleted` boolean - `date` string, date-time - `createdDate` string, date-time - `lastModifiedDate` string, date-time - `createdBy_Id` integer - `createdBy` User - … - `lastModifiedBy_Id` integer - `lastModifiedBy` User - … - `quickbooksId` string - `quickbooksPurchaseId` string - `quickbooksDepositId` string - `lastQuickbooksSyncDate` string, date-time - `xeroId` string, uuid - `lastXeroSyncDate` string, date-time - `bankAccountGuid` string, uuid — Used to set the reference in POST and PUT - `bankAccount` BankAccount — recursive - `isReconciled` boolean - `reconciledDate` string, date-time - `trustBooksReconciledDate` string, date-time - `reconciledBy` User - … - `trustBooksReconciledById` integer - `trustBooksReconciledBy` User - … - `hardCostExpenses` Expense[] - … - `feeAmountInCents` number, double - `status` 'Pending' | 'Failed' | 'Success' | 'Refunded' | 'RefundPending' | 'Canceled' - `refundParentPaymentGuid` string, uuid — Used to set the reference in POST and PUT - `oneLinkTemplate` OneLinkTemplate - … - `oneLinkTemplateId` integer - `depositSlipId` integer - `depositSlip` DepositSlip - … - `lastModifiedHeadNoteDateUtc` string, date-time - `paymentSourceGuid` string, uuid — Used to set the reference in POST and PUT - `paymentSource` PaymentSource - … - `surchargeAmountInCents` integer - `surchargeAmountGuid` string, uuid — Used to set the reference in POST and PUT - `chartOfAccountId` integer - `trustbooksJournalEntryGuid` string, uuid — Used to set the reference in POST and PUT - `referenceNumber` string - `transferId` integer - `paymentImportMatch` PaymentImportMatch - … - `blob` Blob — recursive - `guid` string, uuid - `isHidden` boolean — If true, the blob will not be visible to the tenant in the list of attachments. Used for invoices etc. - `id` integer - `uri` string - `size` integer - `type` string - `description` string - `name` string - `containerName` string - `isEnabled` boolean - `isDeleted` boolean - `boxFileId` string - `dropboxFileId` string - `headerColor` string - `isChatEnabled` boolean - `isEnabled` boolean - `isDeleted` boolean - `isDefaultSubmitInvoicesForApproval` boolean - `isPortalEnabled` boolean - `portalHeaderText` string - `primaryUserId` integer - `isEmailConfirmed` boolean - `confirmEmailUrl` string - `createdDate` string, date-time - `conversionDate` string, date-time - `lastModifiedDate` string, date-time - `sfAccountOwnerId` string - `emailInvoiceReminderSubjectTemplate` string - `emailInvoiceReminderTemplate` string - `emailPaymentRequestSubjectTemplate` string - `emailPaymentRequestTemplate` string - `emailInvoiceReminderFrequency` 'Daily' | 'Every2Days' | 'Every3Days' | 'Every4Days' | 'Every5Days' | 'Every6Days' | 'Weekly' | 'Monthly' | 'NeverSendReminders' - `emailInvoiceReminderMaxTimes` integer - `emailQuoteReminderSubjectTemplate` string - `emailQuoteReminderTemplate` string - `emailQuoteReminderFrequency` 'Daily' | 'Every2Days' | 'Every3Days' | 'Every4Days' | 'Every5Days' | 'Every6Days' | 'Weekly' | 'Monthly' | 'NeverSendReminders' - `emailQuoteReminderMaxTimes` integer - `emailInvoiceTemplate` string - `emailInvoiceSubjectTemplate` string - `emailQuoteTemplate` string - `emailQuoteSubjectTemplate` string - `emailPaymentTemplate` string - `emailPaymentSubjectTemplate` string - `boxFolderId` string - `isBoxIntegrationEnabled` boolean - `boxOwnerUserGuid` string, uuid — Used to set the reference in POST and PUT - `boxSharedFolderUrl` string - `dropboxFolderId` string - `dropboxAuthToken` string - `googleDriveFolderId` string - `isGoogleDriveIntegrationEnabled` boolean - `xeroAuthToken` string - `xeroBankOperatingAccountId` string, uuid - `defaultSyncEmailsForAccount` boolean - `defaultSyncFilesForAccount` boolean - `defaultSyncContactsForAccount` boolean - `defaultSyncEmailsForProject` boolean - `defaultSyncFilesForProject` boolean - `defaultSyncContactsForProject` boolean - `maxActiveUsers` integer - `maxInvoicesPerMonth` integer - `maxAccounts` integer - `storageMaxContainerSize` integer - `storageCurrentContainerSize` integer - `isAuthorizeNetEnabled` boolean - `isAuthorizeNetTestMode` boolean - `authorizeNetLoginId` string - `authorizeNetTransactionKey` string - `authorizeNetPublicKey` string - `isAuthorizeNetTransactionKeyEncrypted` boolean - `isOnlinePaymentsEnabled` boolean - `isPayPalEnabled` boolean - `payPalEmailAddress` string - `payPalFirstName` string - `payPalLastName` string - `isStripeEnabled` boolean - `stripeSecretKey` string - `isStripeSecretKeyEncrypted` boolean - `stripePublishableKey` string - `isLawPayEnabled` boolean - `isLawPaySecretKeyEncrypted` boolean - `lawPaySecretKey` string - `lawPayPublicKey` string - `isLawPayOperatingMerchantEnabled` boolean - `lawPayOperatingMerchantAccountId` string - `isLawPayOperatingAchEnabled` boolean - `lawPayOperatingAchAccountId` string - `isLawPayTrustMerchantEnabled` boolean - `lawPayTrustMerchantAccountId` string - `isLawPayTrustAchEnabled` boolean - `lawPayTrustAchAccountId` string - `lawPayAccessToken` string - `isHeadNoteEnabled` boolean - `isInventoryManagementEnabled` boolean - `isMarketingEnabled` boolean - `maxMarketingEmailsPerMonth` integer - `chargifySubscriptionId` string - `chargifySubscriptionStatus` 'Active' | 'Cancelled' | 'Oustanding' - `chargifyCustomerId` string - `chargifyProductId` string - `chargifyProductHandle` string - `isAppComfirmedSignup` boolean — This is used to track whether we submitted a conversion to adwords/capterra/analytics etc or not. If set to true, we already submitted a conversion. If set to false we need to submit a conversion and we will then call the google tag manager to report all conversions. Managed at _ConversionTracking.cshtml - `evergreenIsOnDefault` boolean - `evergreenAmountDefault` number, double - `billingEmailAddress` string - `mobile` string - `home` string - `office` string - `ext` string - `fax` string - `isWizardComplete` boolean - `timeZoneId` string - `cultureName` string - `currencyCode` string - `language` 'Beta' | 'Vip' - `website` string - `type` 'PayPanther' | 'PracticePanther' - `isAllowClientsToViewAllOutstandingInvoices` boolean - `isAllowClientsToViewAllPayments` boolean - `isAllowClientsToViewAccountBalances` boolean - `isAllowClientToViewAllPaidInvoices` boolean - `isRequirePortalLoginToViewInvoice` boolean - `isMailchimpIntegrationEnabled` boolean - `mailchimpApiKey` string - `mailchimpListId` string - `headNoteStatus` 'STARTED' | 'SUBMITTED' | 'PROVISIONED' | 'DECLINED' | 'UNVERIFIED' | 'VERIFIED' | 'UNDER_REVIEW' | 'PAUSED' | 'DISABLED' | 'IGNORED' | 'Step1' | 'Step2' | 'Step3' | 'Transacted' - `gA_LandingPage` string - `gA_ClientId` string - `gA_CampaignContent` string - `gA_CampaignMedium` string - `gA_CampaignName` string - `gA_CampaignSource` string - `gA_CampaignTerm` string - `gA_CampaignClickId` string - `gA_Gclid` string - `retargeting_CampaignName` string - `retargeting_CampaignSource` string - `retargeting_CampaignContent` string - `retargeting_CampaignMedium` string - `urlReferrer` string - `firstContactDateTime` string, date-time - `ambassadorReferringShortCode` string - `ambassadorCampaignId` integer - `ambassadorDiscountValue` string - `isAmbassadorDiscountValueUsed` boolean - `ledesIsEnabled` boolean - `taxpayerId` string - `utbmsIsEnabled` boolean - `isUtbmsRequiredForTimeEntries` boolean - `isUtbmsRequiredForExpenses` boolean - `isUtbmsRequiredForFlatFees` boolean - `isUtbmsDefaultForNewAccounts` boolean - `utbmsIsABA_Bankruptcy` boolean - `utbmsIsABA_Counselling` boolean - `utbmsIsABA_Litigation` boolean - `utbmsIsABA_Project` boolean - `utbmsIsABA_WorkersComp` boolean - `utbmsIsLOC_Ediscovery` boolean - `utbmsIsLOC_Grc` boolean - `utbmsIsLOC_Patent` boolean - `utbmsIsLOC_Project` boolean - `utbmsIsLOC_Trademark` boolean - `utbmsIsEW_Civil_Litigation` boolean - `defaultInterest` InterestOptions - `isChargeInterest` boolean - `annualPercent` number, double - `interestType` 'Simple' | 'Compound' - `chargeEachNumOfDays` integer - `defaultInvoiceTermsAndConditions` string - `defaultQuoteTermsAndConditions` string - `saleDocument_Default_DueDate_Days` integer — Set to true to send automatic payment reminders to this client. - `saleDocument_Default_DueDate_Option` 'DaysAfterInvoiceDate' | 'OfTheCurrentMonth' | 'OfTheFollowingMonth' - `saleDocument_Default_IsSendInvoicePaymentReminders` boolean — Set to true to send automatic payment reminders to this client. - `saleDocument_Default_IsSendQuoteApprovalReminders` boolean - `saleDocument_Default_IsUseCreditToPayBalance` boolean — Used during PUT/POST. If set to true all available operating account credit (for this account / project) will automatically be applied to this invoice to pay any amount due. - `saleDocument_Default_IsUseTrustToPayBalance` boolean — Used during PUT/POST. If set to true will automatically transfer funds from the trust account to the operating account and apply them on this invoice. - `saleDocument_Default_IsAllowOnlinePayment` boolean — Invoices of type Sale only. If set to true, will accept online payment on this invoice. Online payments must be enabled for this to apply. - `saleDocument_Default_IsAllowPartialPayment` boolean — Invoices of type Sale only. If set to true, will accept online payment on this invoice for less than the full amount due. Online payments must be enabled for this to apply. - `saleDocument_Default_IsCarryForwardBalance` boolean — Invoices of type Sale only. If set to true, will add to the total balance all unpaid invoices - `saleDocument_Default_CarryForwardBalanceType` 'Account' | 'Project' - `saleDocument_Default_Tax1Guid` string, uuid — Used to set the reference in POST and PUT - `saleDocument_Default_Tax2Guid` string, uuid — Used to set the reference in POST and PUT - `projectDisplayNameFormat` 'NumberProjectName' | 'ProjectName' | 'NumberContactNameProjectName' | 'NumberOpenDateYearOpenDateMonthProjectName' | 'NumberOpenDateYearProjectName' | 'ContactNameProjectName' | 'ContactNumberProjectNumberProjectName' | 'ContactNumberProjectName' - `accountDisplayNameFormat` 'NumberFirstLast' | 'NumberLastFirst' | 'FirstLast' | 'LastFirst' - `userDisplayNameFormat` 'FirstLast' | 'LastFirst' - `isAutoNumberingEnabledForAccounts` boolean - `isAutoNumberingEnabledForProjects` boolean - `isCalendarRulesEnabled` boolean - `isCalendarRulesServiceStarted` boolean - `calendarRulesLoginToken` string - `isDeveloperAccount` boolean — If set to true, the tenant will have access to generate client id and client secret for API access purposes - `oneDriveFolderId` string - `isOneDriveIntegrationEnabled` boolean - `oneDriveAuthToken` string - `isDuplicateContactCheckOn` boolean - `isAuthorizedSignOn` boolean - `federal_tax_id` string - `structure` string - `business_incorporated_date` string, date-time - `business_incorporated_state` string - `owner_email` string - `owner_first_name` string - `owner_last_name` string - `owner_social_security_number` string - `owner_address1` string - `owner_address2` string - `owner_city` string - `owner_state` string - `owner_zip_code` string - `owner_phone_number` string - `owner_office_phone_number` string - `owner_Bar_Number` string - `owner_Bar_State` string - `owner_percentage_Ownership` number, double - `ignoredUpdateYourInfo` boolean - `headNoteVerficationDate` string, date-time - `lastDateRecurringPaymentMigrationNotice` string, date-time - `numberOfAttorneys` string - `practiceAreas` string - `country` string - `isDisableEcheck` boolean - `subscriptionType` 'Trial' | 'SoloMonthly' | 'SoloYearly' | 'SoloFree' | 'EssentialMonthly' | 'EssentialYearly' | 'EssentialFree' | 'BusinessMonthly' | 'BusinessYearly' | 'BusinessFree' - `createdDate` string, date-time - `lastModifiedDate` string, date-time - `openingBalance` number, double - `quickbooksId` string - `quickbooksIsDepositToUndepositedFunds` boolean - `isPrintDepositSlips` boolean — If checked, we will add all cash and check payments to these accounts to the deposit slip queue - `xeroId` string, uuid - `lawPayAchAccountName` string - `lawPayAchAccountId` string - `lawPayMerchantAccountName` string - `lawPayMerchantAccountId` string - `headNoteId` string - `status` 'Created' | 'Failed' | 'Success' | 'Archived' - `currencyCode` string - `accountNumber` string - `routingNumber` string - `swiftCode` string - `accountHolder` string - `institution` string - `domicileBranch` string - `createdBy` User - `guid` string, uuid - `photoUserGuid` string, uuid — Used to set the reference in POST and PUT - `iCalGuid` string, uuid — Used to set the reference in POST and PUT - `emailGuid` string, uuid — Used to set the reference in POST and PUT - `id` integer, required - `fullName` string - `displayName` string - `name` string - `firstName` string - `lastName` string - `middleName` string - `email` string, required - `isEmailConfirmed` boolean — Sets to true once user confirms email and sets password - `isPasswordSet` boolean - `password` string - `confirmPassword` string - `timeZoneId` string - `ledesTimekeeperId` string - `mobile` string - `home` string - `office` string - `ext` string - `fax` string - `salutation` string - `position` string - `notes` string - `skypeId` string - `twitter` string - `gender` 'Male' | 'Female' - `directMailAdditionalEmailAddresses` string - `photo` Blob - `shares` Share[] - `guid` string, uuid - `sharedDate` string, date-time - `sharedByUserId` integer - `sharedByUser` User — recursive - `sharedByContactId` integer - `sharedByContact` Contact — Contact domain methods - business logic and factory methods - `guid` string, uuid - `id` integer, required - `photo` Blob — recursive - `photoThumbnail` Blob[] - `firstName` string - `lastName` string - `middleName` string - `fullName` string - `displayName` string - `email` string - `mobile` string - `home` string - `office` string - `ext` string - `fax` string - `salutation` string - `position` string - `prefix` string - `notes` string - `skypeId` string - `twitter` string - `jobTitle` string - `gender` 'Male' | 'Female' - `isEmailOptOut` boolean - `isEnabled` boolean - `isDeleted` boolean - `type` 'Contact' | 'Lead' - `accountId` integer - `tenant` Tenant - … - `activity` Activity - `date` string, date-time - `shares` Share[] - `workflowId` integer - `workflow` Workflow - … - `activitiesSync` ActivitySync[] - … - `guid` string, uuid - `id` integer - `googleId` string - `isEnabled` boolean - `isDeleted` boolean - `createdDate` string, date-time - `lastModifiedDate` string, date-time - `recurrenceStopDate` string, date-time - `createdById` integer - `createdBy` User — recursive - `lastModifiedBy` User — recursive - `lawToolboxCourtRule_Id` string, uuid - `lawToolboxCourtRule` LawToolboxCourtRule - … - `lawToolboxDeadlineId` string - `lawToolboxDeadlineNumber` string - `tenantId` integer - `tenant` Tenant - … - `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` Recurrence - … - `type` 'Call' | 'Task' | 'Event' | 'Email' | 'Note' - `accountId` integer - `account` Account — Account domain methods - business logic and aggregate root operations - … - `contactId` integer - `contact` Contact — Contact domain methods - business logic and factory methods - … - `projectId` integer - `project` Project - … - `saleDocumentId` integer - `saleDocument` SaleDocument - … - `name` string, required - `description` string - `assignedToUsers` User[] - `assignedToContacts` Contact[] - … - `htmlBody` Blob — recursive - `dueDate` string, date-time - `taskCompleteDate` string, date-time - `startDateTime` string, date-time - `endDateTime` string, date-time - `isAllDayActivity` boolean - `location` string - `status` 'NotCompleted' | 'InProgress' | 'Completed' | 'Conditional' - `mandrillId` string - `isPrivate` boolean - `priority` 'Low' | 'Medium' | 'High' - `isSendNotificationEmail` boolean - `isSendCompletedEmail` boolean - `isSendTaskCompleteEmail` boolean - `isRecurringActivity` boolean - `recurringActivityStartDate` string, date-time - `recurringActivityEndDate` string, date-time - `recurringRepeatType` 'None' | 'Daily' | 'Weekly' | 'Monthly' | 'Yearly' - `callType` 'Inbound' | 'Outbound' - `tags` Tag[] - … - `eventColor` string - `emailProperties` EmailProperties - … - `noteProperties` NoteProperties - … - `callProperties` CallProperties - … - `timeEntries` TimeEntry[] - … - `flatFees` FlatFee[] - … - `eventBackgroundColor` string - `blobs` Blob[] - `invitees` Invitee[] - … - `activityReminders` ActivityReminder[] - … - `activityConditionalTasks` ActivityConditionalTask[] - … - `completedTask` CompletedTask - … - `saleDocument` SaleDocument - `guid` string, uuid - `isMultiMatterInvoice` boolean - `id` integer - `currencyCode` string - `type` 'Invoice' | 'Quote' - `invoiceType` 'Sale' | 'Refund' | 'Credit' - `isNotifyWhenViewedByClient` boolean - `isNotifyWhenPaidByClient` boolean - `isNotifyWhenApprovedByClient` boolean - `isApplyDiscountTimeEntries` boolean - `isApplyDiscountFlatFees` boolean - `isApplyDiscountExpenses` boolean - `isAllowOnlinePayment` boolean - `isAllowPartialPayment` boolean - `isEnabled` boolean - `isDeleted` boolean - `createdDate` string, date-time - `lastModifiedDate` string, date-time - `createdBy` User — recursive - `lastModifiedBy` User — recursive - `approvedBy` User — recursive - `isApproved` boolean - `isCarryForwardBalance` boolean - `saleDocumentTemplateId` integer - `saleDocumentTemplate` SaleDocumentTemplate - … - `date` string, date-time - `dueDate` string, date-time - `expDate` string, date-time - `approvalDate` string, date-time - `shares` Share[] - `tenantId` integer - `tenant` Tenant - … - `items` SaleDocumentItem[] - … - `activities` Activity[] - … - `bankAccountGuid` string, uuid — Used to set the reference in POST and PUT - `bankAccount` BankAccount — recursive - `accountId` integer - `account` Account — Account domain methods - business logic and aggregate root operations - … - `credit` Credit - … - `refund` Refund - … - `projectId` integer - `project` Project - … - `contact` Contact — Contact domain methods - business logic and factory methods - … - `toShippingAddress` Address — Address domain methods - factory methods for creating addresses - … - `toBillingAddress` Address — Address domain methods - factory methods for creating addresses - … - `termsAndConditions` string - `customerNotes` string - `pdf` Blob — recursive - `pdF_Id` integer - `invoiceSentToSmsNumber` string - `amountPaid` number, double - `amountDue` number, double - `feeds` Feed[] - … - `saleDocumentPaymentReminders` SaleDocumentPaymentReminder[] - … - `sub` number, double - `salesTaxData` SalesTaxData[] - … - `tax` number, double - `discount` number, double - `discountPercent` number, double - `total` number, double - `saleDocumentPayments` SaleDocumentPayment[] - … - `isSentToCustomer` boolean - `sentToCustomerDate` string, date-time - `isViewedByCustomer` boolean - `viewedByCustomerDate` string, date-time - `viewedByCustomerNumOfTimes` integer - `isInvoicedToCustomer` boolean - `invoicedToCustomerDate` string, date-time - `poNumber` string - `isApprovedByCustomer` boolean - `approvedByCustomerDate` string, date-time - `isSendInvoicePaymentReminders` boolean - `isSendQuoteApprovalReminders` boolean - `quickbooksId` string - `lastQuickbooksSyncDate` string, date-time - `xeroId` string, uuid - `lastXeroSyncDate` string, date-time - `totalInterest` number, double - `interestOptions` InterestOptions - … - `status` 'Saved' | 'Approved' | 'Sent' | 'Paid' | 'Viewed' | 'Overdue' | 'Expired' | 'Invoiced' | 'Due' | 'PendingApproval' - `number` integer - `numOfAutomaticInterestChargesAdded` integer - `name` string - `invoiceOrder` 'Name' | 'Number' - `payment` Payment - `guid` string, uuid - `notes` string - `isPaymentCleared` boolean - `id` integer - `currencyCode` string - `number` integer - `name` string - `amount` number, double - `amountApplied` number, double - `amountCredited` number, double - `method` 'Cash' | 'Check' | 'CreditCard' | 'PayPal' | 'AuthorizeNet' | 'Other' | 'Stripe' | 'Wire' | 'Transfer' | 'LawPay' | 'PantherPaymentsCC' | 'PantherPaymentsECheck' | 'JournalEntry' - `refund` Refund - … - `authNumber` string - `transactionId` string - `bankAcctName` string - `bankName` string - `bankRoutingNumber` string - `bankAcctType` 'Operating' | 'Trust' | 'CreditCard' - `checkAcctNumber` string - `isDepositSlipPrinted` boolean — If the payment is associated with a bank account where BankAccount.IsPrintDepositSlips = true, this will indicate whether this payment had a deposit slip printed for it or not - `checkNumber` integer - `checkPayeeId` integer - `checkPayee` Account — Account domain methods - business logic and aggregate root operations - … - `checkIsPrinted` boolean - `creditCardNameOnCard` string - `creditCardLast4Digits` string - `creditCardType` 'Unknown' | 'Visa' | 'Mastercard' | 'AmericanExpress' | 'Diners' | 'Other' - `creditCardExpMonth` integer - `creditCardExpYear` integer - `details` string - `type` 'OfflinePayment' | 'OnlinePayment' | 'Transfer' | 'HardCostExpense' | 'FirmPayment' - `saleDocumentPayments` SaleDocumentPayment[] - … - `accountId` integer - `account` Account — Account domain methods - business logic and aggregate root operations - … - `projectId` integer - `isProjectRequired` boolean - `project` Project - … - `tenant` Tenant - … - `tenantId` integer - `blobs` Blob[] - `isEnabled` boolean - `isDeleted` boolean - `date` string, date-time - `createdDate` string, date-time - `lastModifiedDate` string, date-time - `createdBy_Id` integer - `createdBy` User — recursive - `lastModifiedBy_Id` integer - `lastModifiedBy` User — recursive - `quickbooksId` string - `quickbooksPurchaseId` string - `quickbooksDepositId` string - `lastQuickbooksSyncDate` string, date-time - `xeroId` string, uuid - `lastXeroSyncDate` string, date-time - `bankAccountGuid` string, uuid — Used to set the reference in POST and PUT - `bankAccount` BankAccount — recursive - `isReconciled` boolean - `reconciledDate` string, date-time - `trustBooksReconciledDate` string, date-time - `reconciledBy` User — recursive - `trustBooksReconciledById` integer - `trustBooksReconciledBy` User — recursive - `hardCostExpenses` Expense[] - … - `feeAmountInCents` number, double - … truncated; see the full OpenAPI document linked below --- [API](https://skmtc.dev/practicepanther/apis/legacy-api-v1.md) · [All operations](https://skmtc.dev/practicepanther/apis/legacy-api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/practicepanther/legacy-api-v1/revisions/be94bc4c7582/schema)