SaleDocument

JSON Schema for the PracticePanther SaleDocument resource

LegalLaw Practice ManagementCase ManagementBillingTrust AccountingTime TrackingLegal Tech

Properties

Name	Type	Description
guid	string
isMultiMatterInvoice	boolean
id	integer
currencyCode	string
type	string
invoiceType	string
isNotifyWhenViewedByClient	boolean
isNotifyWhenPaidByClient	boolean
isNotifyWhenApprovedByClient	boolean
isApplyDiscountTimeEntries	boolean
isApplyDiscountFlatFees	boolean
isApplyDiscountExpenses	boolean
isAllowOnlinePayment	boolean
isAllowPartialPayment	boolean
isEnabled	boolean
isDeleted	boolean
createdDate	string
lastModifiedDate	string
createdBy	object
lastModifiedBy	object
approvedBy	object
isApproved	boolean
isCarryForwardBalance	boolean
saleDocumentTemplateId	integer
saleDocumentTemplate	object
date	string
dueDate	string
expDate	string
approvalDate	string
shares	array
tenantId	integer
tenant	object
items	array
activities	array
bankAccountGuid	string	Used to set the reference in POST and PUT
bankAccount	object
accountId	integer
account	object
credit	object
refund	object
projectId	integer
project	object
contact	object
toShippingAddress	object
toBillingAddress	object
termsAndConditions	string
customerNotes	string
pdf	object
pdF_Id	integer
invoiceSentToSmsNumber	string
amountPaid	number
amountDue	number
feeds	array
saleDocumentPaymentReminders	array
sub	number
salesTaxData	array
tax	number
discount	number
discountPercent	number
total	number
saleDocumentPayments	array
isSentToCustomer	boolean
sentToCustomerDate	string
isViewedByCustomer	boolean
viewedByCustomerDate	string
viewedByCustomerNumOfTimes	integer
isInvoicedToCustomer	boolean
invoicedToCustomerDate	string
poNumber	string
isApprovedByCustomer	boolean
approvedByCustomerDate	string
isSendInvoicePaymentReminders	boolean
isSendQuoteApprovalReminders	boolean
quickbooksId	string
lastQuickbooksSyncDate	string
xeroId	string
lastXeroSyncDate	string
totalInterest	number
interestOptions	object
status	string
number	integer
numOfAutomaticInterestChargesAdded	integer
name	string
invoiceOrder	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/practicepanther/main/json-schema/practicepanther-saledocument-schema.json",
  "title": "SaleDocument",
  "description": "JSON Schema for the PracticePanther SaleDocument resource",
  "type": "object",
  "properties": {
    "guid": {
      "type": "string",
      "format": "uuid"
    },
    "isMultiMatterInvoice": {
      "type": "boolean"
    },
    "id": {
      "type": "integer",
      "format": "int32"
    },
    "currencyCode": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "enum": [
        "Invoice",
        "Quote"
      ]
    },
    "invoiceType": {
      "type": "string",
      "enum": [
        "Sale",
        "Refund",
        "Credit"
      ]
    },
    "isNotifyWhenViewedByClient": {
      "type": "boolean"
    },
    "isNotifyWhenPaidByClient": {
      "type": "boolean"
    },
    "isNotifyWhenApprovedByClient": {
      "type": "boolean"
    },
    "isApplyDiscountTimeEntries": {
      "type": "boolean"
    },
    "isApplyDiscountFlatFees": {
      "type": "boolean"
    },
    "isApplyDiscountExpenses": {
      "type": "boolean"
    },
    "isAllowOnlinePayment": {
      "type": "boolean"
    },
    "isAllowPartialPayment": {
      "type": "boolean"
    },
    "isEnabled": {
      "type": "boolean"
    },
    "isDeleted": {
      "type": "boolean"
    },
    "createdDate": {
      "type": "string",
      "format": "date-time"
    },
    "lastModifiedDate": {
      "type": "string",
      "format": "date-time"
    },
    "createdBy": {
      "$ref": "#/$defs/User"
    },
    "lastModifiedBy": {
      "$ref": "#/$defs/User"
    },
    "approvedBy": {
      "$ref": "#/$defs/User"
    },
    "isApproved": {
      "type": "boolean"
    },
    "isCarryForwardBalance": {
      "type": "boolean"
    },
    "saleDocumentTemplateId": {
      "type": "integer",
      "format": "int64"
    },
    "saleDocumentTemplate": {
      "$ref": "#/$defs/SaleDocumentTemplate"
    },
    "date": {
      "type": "string",
      "format": "date-time"
    },
    "dueDate": {
      "type": "string",
      "format": "date-time"
    },
    "expDate": {
      "type": "string",
      "format": "date-time"
    },
    "approvalDate": {
      "type": "string",
      "format": "date-time"
    },
    "shares": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Share"
      }
    },
    "tenantId": {
      "type": "integer",
      "format": "int64"
    },
    "tenant": {
      "$ref": "#/$defs/Tenant"
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/SaleDocumentItem"
      }
    },
    "activities": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Activity"
      }
    },
    "bankAccountGuid": {
      "type": "string",
      "format": "uuid",
      "description": "Used to set the reference in POST and PUT "
    },
    "bankAccount": {
      "$ref": "#/$defs/BankAccount"
    },
    "accountId": {
      "type": "integer",
      "format": "int64"
    },
    "account": {
      "$ref": "#/$defs/Account"
    },
    "credit": {
      "$ref": "#/$defs/Credit"
    },
    "refund": {
      "$ref": "#/$defs/Refund"
    },
    "projectId": {
      "type": "integer",
      "format": "int64"
    },
    "project": {
      "$ref": "#/$defs/Project"
    },
    "contact": {
      "$ref": "#/$defs/Contact"
    },
    "toShippingAddress": {
      "$ref": "#/$defs/Address"
    },
    "toBillingAddress": {
      "$ref": "#/$defs/Address"
    },
    "termsAndConditions": {
      "type": "string"
    },
    "customerNotes": {
      "type": "string"
    },
    "pdf": {
      "$ref": "#/$defs/Blob"
    },
    "pdF_Id": {
      "type": "integer",
      "format": "int64"
    },
    "invoiceSentToSmsNumber": {
      "type": "string"
    },
    "amountPaid": {
      "type": "number",
      "format": "double"
    },
    "amountDue": {
      "type": "number",
      "format": "double"
    },
    "feeds": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Feed"
      }
    },
    "saleDocumentPaymentReminders": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/SaleDocumentPaymentReminder"
      }
    },
    "sub": {
      "type": "number",
      "format": "double"
    },
    "salesTaxData": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/SalesTaxData"
      }
    },
    "tax": {
      "type": "number",
      "format": "double"
    },
    "discount": {
      "type": "number",
      "format": "double"
    },
    "discountPercent": {
      "type": "number",
      "format": "double"
    },
    "total": {
      "type": "number",
      "format": "double"
    },
    "saleDocumentPayments": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/SaleDocumentPayment"
      }
    },
    "isSentToCustomer": {
      "type": "boolean"
    },
    "sentToCustomerDate": {
      "type": "string",
      "format": "date-time"
    },
    "isViewedByCustomer": {
      "type": "boolean"
    },
    "viewedByCustomerDate": {
      "type": "string",
      "format": "date-time"
    },
    "viewedByCustomerNumOfTimes": {
      "type": "integer",
      "format": "int32"
    },
    "isInvoicedToCustomer": {
      "type": "boolean"
    },
    "invoicedToCustomerDate": {
      "type": "string",
      "format": "date-time"
    },
    "poNumber": {
      "type": "string"
    },
    "isApprovedByCustomer": {
      "type": "boolean"
    },
    "approvedByCustomerDate": {
      "type": "string",
      "format": "date-time"
    },
    "isSendInvoicePaymentReminders": {
      "type": "boolean"
    },
    "isSendQuoteApprovalReminders": {
      "type": "boolean"
    },
    "quickbooksId": {
      "type": "string"
    },
    "lastQuickbooksSyncDate": {
      "type": "string",
      "format": "date-time"
    },
    "xeroId": {
      "type": "string",
      "format": "uuid"
    },
    "lastXeroSyncDate": {
      "type": "string",
      "format": "date-time"
    },
    "totalInterest": {
      "type": "number",
      "format": "double"
    },
    "interestOptions": {
      "$ref": "#/$defs/InterestOptions"
    },
    "status": {
      "type": "string",
      "enum": [
        "Saved",
        "Approved",
        "Sent",
        "Paid",
        "Viewed",
        "Overdue",
        "Expired",
        "Invoiced",
        "Due",
        "PendingApproval"
      ]
    },
    "number": {
      "type": "integer",
      "format": "int32"
    },
    "numOfAutomaticInterestChargesAdded": {
      "type": "integer",
      "format": "int32"
    },
    "name": {
      "type": "string"
    },
    "invoiceOrder": {
      "type": "string",
      "enum": [
        "Name",
        "Number"
      ]
    }
  }
}