Sign in
latestSwagger 2.02026-08-1766151238.8 KB

a444c5b1e78b

Project

Marks an existing project (matter) as deleted

delete/api/project

Query parameters

guidstring uuid required

Response

OK

isEmailSyncboolean
isFilesSyncboolean
isContactSyncboolean
ledesClientMatterIdstring
notesstring

Internal notes.

originatedByGuidstring uuid

Used to set the reference in POST and PUT

accountGuidstring uuid

Used to set the reference in POST and PUTRequired for PracticePanther. When creating or updating a time entry, this is used to associate a time entry with an account (contact). Required for PracticePanther. When creating or updating a time entry, this is used to associate a time entry with an account (contact).

presetProjectRateGuidstring uuid

Used to set the reference in POST and PUT

operatingUnappliedCreditnumber double

[OperatingUnappliedCredit] is a read only property . = OperatingPayments.AvailableFunds + CreditNotes.AvailableFunds: for this project (matter).

invoicesDuenumber double

This is a read only property. Will show current outstanding amount on all invoices for this project (matter).

hourlyRatenumber double

If this project (matter) has a different hourly rate, it can be set here. Will be used if HourlyRateType = 'ProjectRate'.

flatRatenumber double

If this project (matter) has a flat rate (and a zero ($0) hourly rate), it can be set here. Will be used if HourlyRateType = 'FlatRate'.

contingencyRatePercentnumber double

If this project (matter) has a contingency rate.

isFlatRateBilledboolean

Indicates if the flat rate has been billed. If false, the flat rate is still billable and will be added to the account (contact) and project (matter) billable totals.

hourlyRateType'ItemRate' | 'UserRate' | 'ProjectRate' | 'FlatRate' | 'Contingency' | 'PresetProjectRate' required

Sets the hourly rate type for this project (matter).

isContainsOnlyPendingInvoicesboolean
operatingPaidnumber double

This is a read only property. Will show the sum of all payments from operating bank accounts made for this project (matter).

ccPaidnumber double

This is a read only property. Will show the sum of all payments from CC bank accounts made for this project (matter).

namestring required
tenantRefNumberinteger

The due date for this project (matter). will appear on the calendar.

dueDatestring date-time
openDatestring date-time
closeDatestring date-time
createdDatestring date-time
lastModifiedDatestring date-time
evergreenIsAlertboolean
evergreenIsOnboolean

If on, evergreen alerts will be activated based on the evergreen amount

evergreenAmountnumber double
isAddEvergreenToInvoiceboolean

If set to true, we will add the amount required to replenish the retainer to the evergreen amount to the invoice.

status'Closed' | 'Pending' | 'Open' | 'Archived' required
numberinteger

Project number. Must be unique.

assignedToGuidsstring[] required

Used to set the reference in POST and PUTFor compatibility reasons, this will return an array of guids for the assigned to users instead of a list of UserRef objects. For compatibility reasons, this will return an array of guids for the assigned to users instead of a list of UserRef objects.

tagNamesstring[]

For compatibility reasons, this will return an array of tag names instead of a list of tag objects.

accountTagsNamesstring[]
paidnumber double

This is a read only property. Will show the sum of all payments from operating bank accounts and CC bank accounts made for this project (matter).

trustBalancenumber double

This is a read only property. Will indicate what is the trust account balance for this project (matter).

operatingBalancenumber double

[OperatingBalance] is a read only property. = Sum of OperatingPayments.AvailableFunds + CreditNotes.AvailableFunds - Invoices.AmountDue: for this project (matter).

billablenumber double

This is a read only property. Will indicate how much is currently billable for this project (matter). will include expenses, time entries and flat rate.

saleDocumentTemplateGuidstring uuid

Used to set the reference in POST and PUT

saleDocumentTemplateNamestring
invoiceMatterRecipientsGuidsstring[]

Used to set the reference in POST and PUT

nameAndNumberstring

This is a read only property This is a read only property

guidstring uuid
idinteger

Example response

{
  "customFieldValues": [
    {
      "guid": "00000000-0000-0000-0000-000000000000",
      "valueContactGuid": "00000000-0000-0000-0000-000000000000",
      "valueContact": {
        "guid": "00000000-0000-0000-0000-000000000000"
      },
      "customField": {
        "createdBy": {
          "guid": "00000000-0000-0000-0000-000000000000"
        },
        "lastModifiedBy": {
          "guid": "00000000-0000-0000-0000-000000000000"
        },
        "guid": "00000000-0000-0000-0000-000000000000"
      }
    }
  ],
  "projectRates": [
    {
      "user": {
        "guid": "00000000-0000-0000-0000-000000000000"
      },
      "role": {
        "guid": "00000000-0000-0000-0000-000000000000"
      },
      "userGuid": "00000000-0000-0000-0000-000000000000",
      "roleGuid": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "usersFollowing": [
    {
      "guid": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "createdBy": {
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "originatedByGuid": "00000000-0000-0000-0000-000000000000",
  "lastModifiedBy": {
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "accountGuid": "00000000-0000-0000-0000-000000000000",
  "presetProjectRateGuid": "00000000-0000-0000-0000-000000000000",
  "account": {
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "assignedTo": [
    {
      "guid": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "originatedBy": {
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "assignedToGuids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "saleDocumentTemplateGuid": "00000000-0000-0000-0000-000000000000",
  "presetProjectRate": {
    "guid": "00000000-0000-0000-0000-000000000000"
  },
  "invoiceMatterRecipients": [
    {
      "guid": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "invoiceMatterRecipientsGuids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "guid": "00000000-0000-0000-0000-000000000000"
}