The Invoice API from PracticePanther — 2 operation(s) for invoice.
openapi: 3.0.0
info:
version: v1
title: Legacy API (v1) Account Invoice API
description: ''
servers:
- url: https://app.practicepanther.com
tags:
- name: Invoice
paths:
/api/invoice/{guid}:
get:
tags:
- Invoice
summary: Returns an invoice
operationId: Invoice_GetInvoice
parameters:
- name: guid
in: path
description: ''
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SaleDocumentDTO_Detail'
text/json:
schema:
$ref: '#/components/schemas/SaleDocumentDTO_Detail'
security:
- oauth2:
- full
/api/invoice:
get:
tags:
- Invoice
summary: OData end point to get a list of all invoices accessible by the user
operationId: Invoice_GetInvoices
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SaleDocumentDTO'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/SaleDocumentDTO'
security:
- oauth2:
- full
delete:
tags:
- Invoice
summary: Marks an existing invoice as deleted, will remove all amounts applied on invoices.
operationId: Invoice_DeleteInvoice
parameters:
- name: guid
in: query
description: ''
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SaleDocumentDTO_Detail'
text/json:
schema:
$ref: '#/components/schemas/SaleDocumentDTO_Detail'
security:
- oauth2:
- full
components:
schemas:
AccountRef:
type: object
properties:
nameAndNumber:
description: ' '
type: string
readOnly: true
guid:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
utbmsIsEnabled:
type: boolean
id:
format: int64
type: integer
Contact:
description: Contact domain methods - business logic and factory methods
required:
- id
type: object
properties:
guid:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
id:
format: int64
type: integer
photo:
$ref: '#/components/schemas/Blob'
photoThumbnail:
type: array
items:
$ref: '#/components/schemas/Blob'
firstName:
type: string
lastName:
type: string
middleName:
type: string
fullName:
type: string
readOnly: true
displayName:
type: string
email:
type: string
mobile:
type: string
home:
type: string
office:
type: string
ext:
type: string
fax:
type: string
salutation:
type: string
position:
type: string
prefix:
type: string
notes:
type: string
skypeId:
type: string
twitter:
type: string
jobTitle:
type: string
gender:
enum:
- Male
- Female
type: string
isEmailOptOut:
type: boolean
isEnabled:
type: boolean
isDeleted:
type: boolean
type:
enum:
- Contact
- Lead
type: string
accountId:
format: int64
type: integer
tenant:
$ref: '#/components/schemas/Tenant'
BankAccount:
type: object
properties:
guid:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
name:
type: string
description:
type: string
type:
enum:
- Operating
- Trust
- CreditCard
type: string
isDefault:
type: boolean
isArchived:
type: boolean
tenantId:
format: int64
type: integer
tenant:
$ref: '#/components/schemas/Tenant'
createdDate:
format: date-time
type: string
lastModifiedDate:
format: date-time
type: string
openingBalance:
format: double
type: number
quickbooksId:
type: string
quickbooksIsDepositToUndepositedFunds:
type: boolean
isPrintDepositSlips:
description: If checked, we will add all cash and check payments to these accounts to the deposit slip queue
type: boolean
xeroId:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
lawPayAchAccountName:
type: string
lawPayAchAccountId:
type: string
lawPayMerchantAccountName:
type: string
lawPayMerchantAccountId:
type: string
headNoteId:
type: string
status:
enum:
- Created
- Failed
- Success
- Archived
type: string
currencyCode:
type: string
accountNumber:
type: string
routingNumber:
type: string
swiftCode:
type: string
accountHolder:
type: string
institution:
type: string
domicileBranch:
type: string
createdBy:
$ref: '#/components/schemas/User'
lastModifiedBy:
$ref: '#/components/schemas/User'
payments:
type: array
items:
$ref: '#/components/schemas/Payment'
firmPayments:
type: array
items:
$ref: '#/components/schemas/FirmPayment'
isDeleted:
type: boolean
isEnabled:
type: boolean
isDirty:
type: boolean
lastReconciledDate:
format: date-time
type: string
trustbooksOnboardingStep:
format: int32
type: integer
UserRef:
type: object
properties:
guid:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
displayName:
description: ' '
type: string
readOnly: true
name:
description: ' '
type: string
readOnly: true
timeZoneId:
type: string
InventoryTransfer:
type: object
properties:
id:
format: int64
type: integer
type:
enum:
- Transfer
- PurchaseOrder
- Update
type: string
isDeleted:
type: boolean
createdDate:
format: date-time
type: string
lastModifiedDate:
format: date-time
type: string
createdBy:
$ref: '#/components/schemas/User'
lastModifiedBy:
$ref: '#/components/schemas/User'
referenceNumber:
type: string
vendorId:
format: int64
type: integer
vendor:
$ref: '#/components/schemas/Account'
sentBy:
$ref: '#/components/schemas/User'
sentDate:
format: date-time
type: string
receivedBy:
$ref: '#/components/schemas/User'
receivedDate:
format: date-time
type: string
productLogs:
type: array
items:
$ref: '#/components/schemas/ProductLog'
status:
enum:
- Created
- Sent
- ReceivedOk
- ReceivedError
- Lost
type: string
readOnly: true
inventoryTransferItems:
type: array
items:
$ref: '#/components/schemas/InventoryTransferItem'
tenantId:
format: int64
type: integer
tenant:
$ref: '#/components/schemas/Tenant'
isReviewed:
type: boolean
reviewedBy:
$ref: '#/components/schemas/User'
reviewedDate:
format: date-time
type: string
description:
type: string
isAutoSend:
type: boolean
isAutoReceive:
type: boolean
shipments:
type: array
items:
$ref: '#/components/schemas/Shipment'
qtyReceived:
format: double
type: number
readOnly: true
qtySent:
format: double
type: number
readOnly: true
qtyLost:
format: double
type: number
readOnly: true
CustomFieldValue:
required:
- customField
type: object
properties:
id:
format: int64
type: integer
guid:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
accountId:
format: int64
type: integer
projectId:
format: int64
type: integer
contactId:
format: int64
type: integer
contact:
$ref: '#/components/schemas/Contact'
customFieldId:
format: int64
type: integer
valueContactId:
format: int64
type: integer
valueContact:
$ref: '#/components/schemas/Contact'
customField:
$ref: '#/components/schemas/CustomField'
valueString:
type: string
valueNumber:
format: double
type: number
valueDateTime:
format: date-time
type: string
valueBoolean:
type: boolean
ConversationParticipant:
type: object
properties:
guid:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
conversation:
$ref: '#/components/schemas/Conversation'
contact:
$ref: '#/components/schemas/Contact'
user:
$ref: '#/components/schemas/User'
lastReadDate:
format: date-time
type: string
status:
enum:
- Read
- Unread
type: string
isDeleted:
type: boolean
isArchived:
type: boolean
ExpenseRef:
type: object
properties:
guid:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
name:
description: ' '
type: string
readOnly: true
FirmPayment:
required:
- amount
- method
- name
- number
- isDeleted
- paymentDate
- guid
- tenantId
- firmPaymentType
type: object
properties:
id:
format: int64
type: integer
amount:
format: double
type: number
method:
enum:
- Cash
- Check
- CreditCard
- PayPal
- AuthorizeNet
- Other
- Stripe
- Wire
- Transfer
- LawPay
- PantherPaymentsCC
- PantherPaymentsECheck
- JournalEntry
type: string
name:
maxLength: 50
minLength: 0
type: string
number:
format: int32
type: integer
isDeleted:
type: boolean
createdDate:
format: date-time
type: string
lastModifiedDate:
format: date-time
type: string
createdById:
format: int32
type: integer
lastModifiedById:
format: int32
type: integer
paymentDate:
format: date-time
type: string
guid:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
notes:
maxLength: 1000
minLength: 0
type: string
tenantId:
format: int64
type: integer
firmPaymentType:
enum:
- Withdrawal
- Deposit
type: string
bankAccountGuid:
format: uuid
description: 'Used to set the reference in POST and PUT '
type: string
example: 00000000-0000-0000-0000-000000000000
trustBooksReconciledById:
format: int32
type: integer
trustBooksReconciledDate:
format: date-time
type: string
payeeId:
format: int64
type: integer
payorId:
format: int64
type: integer
checkIsPrinted:
type: boolean
checkNumber:
format: int64
type: integer
chartOfAccountId:
format: int64
type: integer
trustbooksJournalEntryGuid:
description: 'Used to set the reference in POST and PUT '
type: string
depositSlipId:
format: int64
type: integer
isDepositSlipPrinted:
type: boolean
receipt_Id:
format: int64
type: integer
referenceNumber:
type: string
reconciledById:
format: int32
type: integer
reconciledDate:
format: date-time
type: string
ProjectRef:
type: object
properties:
nameAndNumber:
description: This is a read only property This is a read only property
type: string
readOnly: true
guid:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
accountGuid:
format: uuid
description: 'Used to set the reference in POST and PUT '
type: string
example: 00000000-0000-0000-0000-000000000000
id:
format: int64
type: integer
Feed:
type: object
properties:
id:
format: int64
type: integer
guid:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
text:
type: string
title:
type: string
contactId:
format: int64
type: integer
contact:
$ref: '#/components/schemas/Contact'
accountId:
format: int64
type: integer
account:
$ref: '#/components/schemas/Account'
activityReminderId:
format: int64
type: integer
activityReminder:
$ref: '#/components/schemas/ActivityReminder'
paymentId:
format: int64
type: integer
payment:
$ref: '#/components/schemas/Payment'
saleDocumentId:
format: int32
type: integer
saleDocument:
$ref: '#/components/schemas/SaleDocument'
productId:
format: int64
type: integer
product:
$ref: '#/components/schemas/Product'
projectId:
format: int64
type: integer
project:
$ref: '#/components/schemas/Project'
userId:
format: int32
type: integer
user:
$ref: '#/components/schemas/User'
activityId:
format: int64
type: integer
activity:
$ref: '#/components/schemas/Activity'
campaignId:
format: int64
type: integer
campaign:
$ref: '#/components/schemas/Campaign'
blobId:
format: int64
type: integer
blob:
$ref: '#/components/schemas/Blob'
timeEntryId:
format: int64
type: integer
timeEntry:
$ref: '#/components/schemas/TimeEntry'
flatFeeId:
format: int64
type: integer
flatFee:
$ref: '#/components/schemas/FlatFee'
expenseId:
format: int64
type: integer
expense:
$ref: '#/components/schemas/Expense'
isDeleted:
type: boolean
createdDate:
format: date-time
type: string
createdById:
format: int32
type: integer
createdBy:
$ref: '#/components/schemas/User'
lastModifiedDate:
format: date-time
type: string
lastModifiedById:
format: int32
type: integer
lastModifiedBy:
$ref: '#/components/schemas/User'
tenantId:
format: int64
type: integer
tenant:
$ref: '#/components/schemas/Tenant'
type:
enum:
- Note
- Notification
- Reminder
- AccountingOnboardingCompleted
type: string
url:
type: string
readOnly: true
image:
type: string
readOnly: true
feedNotifications:
type: array
items:
$ref: '#/components/schemas/FeedNotification'
depositSlipFeed:
$ref: '#/components/schemas/DepositSlipFeed'
PaymentRef:
required:
- amount
- date
- method
type: object
properties:
guid:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
amount:
format: double
description: The total amount received.
type: number
name:
description: ' '
type: string
readOnly: true
date:
format: date-time
type: string
method:
enum:
- Cash
- Check
- CreditCard
- PayPal
- AuthorizeNet
- Other
- Stripe
- Wire
- Transfer
- LawPay
- PantherPaymentsCC
- PantherPaymentsECheck
- JournalEntry
type: string
methodName:
type: string
readOnly: true
UserPopUpSettings:
type: object
properties:
isHideWelcomePopup:
type: boolean
isHideClientPopup:
type: boolean
isHideProjectPopup:
type: boolean
isHideTimeEntryExpensePopup:
type: boolean
isHideInvoicePopup:
type: boolean
isHideEmailClientPopup:
type: boolean
isHideTaskPopup:
type: boolean
NoteProperties:
type: object
properties:
noteDateTime:
format: date-time
type: string
SaleDocumentItemDTO:
type: object
properties:
rowIndex:
format: int32
description: Controls the order of the items when displayed on the invoice/
type: integer
qty:
format: double
description: Can be either positive or negative. Set to negative to apply a discount on the invoice.
type: number
description:
type: string
entryDate:
format: date-time
description: Used for items of type "TimeEntry" to indicate the date of the time entry.
type: string
userName:
description: Used for items of type "TimeEntry" to indicate the user billing for the time.
type: string
price:
format: double
description: Must be positive.
type: number
tax1Data:
$ref: '#/components/schemas/SalesTaxData'
tax1:
format: double
description: Shows the total amount of Tax1 applied to this item/ Shows the total amount of Tax1 applied to this item/
type: number
readOnly: true
tax2Data:
$ref: '#/components/schemas/SalesTaxData'
tax2:
format: double
description: ' '
type: number
readOnly: true
projectGuid:
format: uuid
description: 'Used to set the reference in POST and PUT '
type: string
example: 00000000-0000-0000-0000-000000000000
projectName:
type: string
projectNumber:
format: int32
type: integer
discount:
format: double
description: Calculated from SaleDocument.DiscountPercent Calculated from SaleDocument.DiscountPercent
type: number
readOnly: true
sub:
format: double
description: Calculated as Qty * Price Calculated as Qty * Price
type: number
readOnly: true
total:
format: double
description: Calculated as Sub + (Sub * Tax) Calculated as Sub + (Sub * Tax)
type: number
readOnly: true
type:
description: Indicates if this is a regular invoice item or a time entry invoice item.
enum:
- RegularItem
- TimeEntryItem
- ExpenseItem
- InterestItem
- EmptyItem
type: string
timeEntries:
type: array
items:
$ref: '#/components/schemas/TimeEntryRef'
expenses:
type: array
items:
$ref: '#/components/schemas/ExpenseRef'
flatFees:
type: array
items:
$ref: '#/components/schemas/FlatFeeRef'
flatFeesGuids:
description: Used to set the reference in POST and PUTReferences the flat fees billed on this item. References the flat fees billed on this item.
type: string
timeEntriesGuids:
description: Used to set the reference in POST and PUTReferences the time entries billed on this item. References the time entries billed on this item.
type: string
expensesGuids:
description: Used to set the reference in POST and PUTReferences the expenses billed on this item. References the expenses billed on this item.
type: string
flatRateProjectId:
format: int64
description: References the flat rate projects that were billed on this item.
type: integer
ledesUtbmsCode:
type: string
ledesItemCode:
type: string
ledesExpenseCode:
type: string
ledesTimekeeperClass:
type: string
chartOfAccountId:
format: int64
type: integer
guid:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
name:
type: string
PaymentImportMatch:
required:
- matchId
type: object
properties:
tenant:
$ref: '#/components/schemas/Tenant'
tenantId:
format: int64
type: integer
payment:
$ref: '#/components/schemas/Payment'
paymentId:
format: int64
type: integer
depositSlipId:
format: int64
type: integer
depositSlip:
$ref: '#/components/schemas/DepositSlip'
matchId:
type: string
source:
enum:
- PLAID
- CSV
type: string
createdAt:
format: date-time
type: string
DefaultReminder:
type: object
properties:
guid:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
timeType:
enum:
- Day
- Hour
- Minute
type: string
time:
format: int32
type: integer
notificationType:
enum:
- Popup
- Email
- SMS
type: string
userId:
format: int32
type: integer
user:
$ref: '#/components/schemas/User'
workFlowEventId:
format: int64
type: integer
workFlowTaskId:
format: int64
type: integer
workFlowTask:
$ref: '#/components/schemas/WorkflowTask'
createdDate:
format: date-time
type: string
createdBy:
$ref: '#/components/schemas/User'
isDeleted:
type: boolean
Product:
required:
- id
- name
- salePrice
type: object
properties:
guid:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
id:
format: int64
type: integer
name:
type: string
code:
type: string
description:
type: string
costPrice:
format: double
type: number
salePrice:
format: double
type: number
isPriceIncludesTax:
type: boolean
isOverrideHourlyRate:
type: boolean
isEnabled:
type: boolean
isDeleted:
type: boolean
createdDate:
format: date-time
type: string
lastModifiedDate:
format: date-time
type: string
createdBy:
$ref: '#/components/schemas/User'
lastModifiedBy:
$ref: '#/components/schemas/User'
tenant_Id:
format: int64
type: integer
tenant:
$ref: '#/components/schemas/Tenant'
family:
$ref: '#/components/schemas/Family'
tax1Id:
format: int64
type: integer
tax1:
$ref: '#/components/schemas/SalesTax'
tax2Id:
format: int64
type: integer
tax2:
$ref: '#/components/schemas/SalesTax'
photos:
type: array
items:
$ref: '#/components/schemas/Blob'
isInventoried:
type: boolean
qtyAvailable:
format: double
type: number
partnerships:
type: array
items:
$ref: '#/components/schemas/Partnership'
productLogs:
type: array
items:
$ref: '#/components/schemas/ProductLog'
priceListItems:
type: array
items:
$ref: '#/components/schemas/PriceListItem'
productVendors:
type: array
items:
$ref: '#/components/schemas/ProductVendor'
inventories:
type: array
items:
$ref: '#/components/schemas/Inventory'
feeds:
type: array
items:
$ref: '#/components/schemas/Feed'
chartOfAccountId:
format: int64
type: integer
chartOfAccount:
$ref: '#/components/schemas/ChartOfAccount'
AccountProjectLink:
required:
- accountId
- projectId
type: object
properties:
isRelationshipSelected:
type: boolean
guid:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
id:
format: int64
type: integer
accountId:
format: int64
type: integer
account:
$ref: '#/components/schemas/Account'
contactId:
format: int64
type: integer
contact:
$ref: '#/components/schemas/Contact'
projectId:
format: int64
type: integer
project:
$ref: '#/components/schemas/Project'
relationshipName:
type: string
notes:
type: string
isEnabled:
type: boolean
isDeleted:
type: boolean
createdDate:
format: date-time
type: string
lastModifiedDate:
format: date-time
type: string
createdBy:
$ref: '#/components/schemas/User'
lastModifiedBy:
$ref: '#/components/schemas/User'
CustomFieldSet:
required:
- name
type: object
properties:
tenant:
$ref: '#/components/schemas/Tenant'
guid:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
name:
type: string
objectType:
enum:
- Account
- Project
- Contact
- User
- Address
type: string
customFields:
type: array
items:
$ref: '#/components/schemas/CustomField'
createdDate:
format: date-time
type: string
lastModifiedDate:
format: date-time
type: string
createdBy:
$ref: '#/components/schemas/User'
lastModifiedBy:
$ref: '#/components/schemas/User'
isDeleted:
type: boolean
MailServerSettings:
type: object
properties:
provider:
enum:
- AOL
- Gmail
- Hotmail
- iCloud
- Outlook
- Yahoo
- Other
- Office365
type: string
isEnabled:
type: boolean
serverAddress:
type: string
serverPort:
format: int32
type: integer
encryptionType:
enum:
- None
- SSL
type: string
username:
type: string
password:
type: string
isPasswordEncrypted:
type: boolean
isRequiresAuthentication:
type: boolean
WorkflowTask:
required:
- name
type: object
properties:
id:
format: int64
type: integer
workflowId:
format: int64
type: integer
workflow:
$ref: '#/components/schemas/Workflow'
name:
type: string
description:
type: string
isDueDate:
type: boolean
numOfDays:
format: int32
type: integer
daysType:
enum:
- Days
- BusinessDays
- Weeks
- Months
- Years
type: string
beforeOrAfter:
enum:
- Before
- After
type: string
dueOrCompletionDate:
enum:
- DueDate
- CompletionDate
type: string
workFlowParentTaskId:
format: int64
type: integer
workflowEventId:
format: int64
type: integer
workflowEvent:
$ref: '#/components/schemas/WorkflowEvent'
assignedToUsers:
type: array
items:
$ref: '#/components/schemas/User'
priority:
enum:
- Low
- Medium
- High
type: string
eventColor:
type: string
tags:
type: array
items:
$ref: '#/components/schemas/Tag'
isSendNotificationEmail:
type: boolean
reminders:
type: array
items:
$ref: '#/components/schemas/DefaultReminder'
isTaskConditional:
type: boolean
SaleDocumentTemplate:
type: object
properties:
name:
type: string
id:
format: int64
type: integer
guid:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
templateName:
enum:
- CustomCss
- Style
- Style2
- Style3
- Style4
- Style5
- Style6
- Style7
- Style8
- Style9
- Style10
- Style11
type: string
isDefault:
type: boolean
customTemplateCss:
type: string
company_IsShowCompanyLogo:
# --- truncated at 32 KB (204 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/practicepanther/refs/heads/main/openapi/practicepanther-invoice-api-openapi.yml