Sign in
latestSwagger 2.02026-08-1766151238.8 KB

a444c5b1e78b

Invoice

Returns an invoice

get/api/invoice/{guid}

Path parameters

guidstring uuid required

Response

OK

isDeletedboolean
accountGuidstring uuid required

Used to set the reference in POST and PUT

projectGuidstring uuid

Used to set the reference in POST and PUTRequired for PracticePanther. Required for PracticePanther.

numOfPaymentsinteger

Indicates the number of payments applied on this invoice (SaleDocumentPayments). Indicates the number of payments applied on this invoice (SaleDocumentPayments).

discountPercentnumber double required

Discount (%) to be applied on this invoice. 10 = 10%, 1 = 1% etc.

lastModifiedDatestring date-time
termsAndConditionsstring

Terms and conditions for this invoice. Visible to the customer.

customerNotesstring

Specific notes for the customer. Visible to the customer.

isSendInvoicePaymentRemindersboolean

Set to true to send automatic payment reminders to this client.

isUseCreditToPayBalanceboolean

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.

isUseTrustToPayBalanceboolean

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.

isNotifyWhenViewedByClientboolean

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.

isNotifyWhenPaidByClientboolean

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.

isNotifyWhenApprovedByClientboolean

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.

isAllowOnlinePaymentboolean

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.

isAllowPartialPaymentboolean

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.

isCarryForwardBalanceboolean

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.

refundPaymentBankAccountGuidstring uuid

Used to set the reference in POST and PUT

saleDocumentTemplateGuidstring uuid required

Used to set the reference in POST and PUT

isMultiMatterInvoiceboolean
isSubmitInvoiceForApprovalboolean
isSentToCustomerboolean
bankAccountGuidstring uuid

Used to set the reference in POST and PUT

defaultBankAccountGuidstring uuid

Used to set the reference in POST and PUT

isHeadNoteEnabledboolean
invoiceOrder'Name' | 'Number'
isAccountingPlusboolean
isEditingLimitedboolean
nextAvailablePaymentDateFormattedstring
enableFutureAppliedDateWarningLabelboolean
automaticPaymentApplicationDatestring date-time
currencyCodestring required

This defines the currency for this account. Must be in ISO 4217 format. Must match the currency code for the Account (contact).

dueDatestring date-time

The due date for full payment on this invoice.

expDatestring date-time

The expiration date for this quote.

amountPaidnumber double

Total amount paid. Total amount paid.

amountDuenumber double

Total amount due. Total amount due.

subnumber double

Subtotal (sum of all Items.Sub) Subtotal (sum of all Items.Sub)

discountnumber double

Indicates the total discount on this invoice. Set by DiscountPercent. Indicates the total discount on this invoice. Set by DiscountPercent.

taxnumber double

Total tax applied on this invoice (sum of all Items.Tax + Items.Tax2). Total tax applied on this invoice (sum of all Items.Tax + Items.Tax2).

totalnumber double

Total (sum of all Items.Total) Total (sum of all Items.Total)

poNumberstring
isOverdueboolean

Indicates if this invoice is overdue. Indicates if this invoice is overdue.

isExpiredboolean

Indicates if this quote has expired.

status'Saved' | 'Approved' | 'Sent' | 'Paid' | 'Viewed' | 'Overdue' | 'Expired' | 'Invoiced' | 'Due' | 'PendingApproval'

Sets the status on this invoice. Sets the status on this invoice.

approvalDatestring date-time
isApprovedboolean
createdDatestring date-time
quickbooksIdstring
guidstring uuid
numberinteger
namestring
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.

datestring date-time required

The issue date for this invoice / quote.