--- title: "Returns a project (matter)" method: GET path: "/api/project/{guid}" tags: ["Project"] --- # Returns a project (matter) `GET /api/project/{guid}` ## Path parameters - `guid` string, uuid, required ## Response `200` OK - ProjectDTODetail - `customFieldValues` CustomFieldValueDTODetail[] - `guid` string, uuid - `valueString` string — Used to set the value type for CustomField.ValueType of 'textBox', 'textEdit' and 'dropDownList'. - `valueNumber` number, double — Used to set the value type for CustomField.ValueType of 'number' and 'currency'. - `valueDateTime` string, date-time — Used to set the value type for CustomField.ValueType of 'dateTime' and 'date'. - `valueBoolean` boolean — Used to set the value type for CustomField.ValueType of 'checkbox' - `valueContactGuid` string, uuid — Used to set the reference in POST and PUT - `valueContact` ContactRef - `firstName` string - `lastName` string - `middleName` string - `accountName` string - `displayName` string - `guid` string, uuid - `email` string - `customField` CustomFieldDTODetail, required - `isIncludeInList` boolean - `isExportToLedes` boolean - `helpText` string - `tooltip` string - `objectType` 'Account' | 'Project' | 'Contact' | 'User' | 'Address', required - `rowIndex` integer — Defines the order of the custom fields on the object - `createdDate` string, date-time — Returns the number of CustomFieldValues which use this custom field. (ie, how many different contacts have a value for this custom field) Returns the number of CustomFieldValues which use this custom field. (ie, how many different contacts have a value for this custom field) - `lastModifiedDate` string, date-time — - `createdBy` UserRef - `guid` string, uuid - `displayName` string — - `name` string — - `timeZoneId` string - `lastModifiedBy` UserRef - `guid` string, uuid - `displayName` string — - `name` string — - `timeZoneId` string - `guid` string, uuid - `valueType` 'TextBox' | 'Date' | 'DateTime' | 'Number' | 'Currency' | 'TextEditor' | 'DropDownList' | 'Checkbox' | 'Contact', required — Sets the value type for this custom field. Will affect CustomFieldValues - `name` string, required - `isDeleted` boolean — - `isRequired` boolean - `isDefault` boolean - `dropDownListValues` string — Comma separated list of values for ValueType 'dropDownList'. - `isEmailSync` boolean - `isFilesSync` boolean - `isContactSync` boolean - `projectRates` ProjectRateDTO[] - `user` UserRef - `guid` string, uuid - `displayName` string — - `name` string — - `timeZoneId` string - `role` RoleRef - `guid` string, uuid - `name` string, required - `userGuid` string, uuid — Used to set the reference in POST and PUT - `roleGuid` string, uuid — Used to set the reference in POST and PUT - `hourlyRate` number, double - `rateType` 'User' | 'Role' | 'Everyone' - `usersFollowing` UserRef[] - `guid` string, uuid - `displayName` string — - `name` string — - `timeZoneId` string - `ledesClientMatterId` string - `createdBy` UserRef - `guid` string, uuid - `displayName` string — - `name` string — - `timeZoneId` string - `notes` string — Internal notes. - `originatedByGuid` string, uuid — Used to set the reference in POST and PUT - `lastModifiedBy` UserRef - `guid` string, uuid - `displayName` string — - `name` string — - `timeZoneId` string - `accountGuid` string, 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). - `presetProjectRateGuid` string, uuid — Used to set the reference in POST and PUT - `operatingUnappliedCredit` number, double — [OperatingUnappliedCredit] is a read only property . = OperatingPayments.AvailableFunds + CreditNotes.AvailableFunds: for this project (matter). - `invoicesDue` number, double — This is a read only property. Will show current outstanding amount on all invoices for this project (matter). - `hourlyRate` number, double — If this project (matter) has a different hourly rate, it can be set here. Will be used if HourlyRateType = 'ProjectRate'. - `flatRate` number, 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'. - `contingencyRatePercent` number, double — If this project (matter) has a contingency rate. - `isFlatRateBilled` boolean — 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). - `isContainsOnlyPendingInvoices` boolean — - `operatingPaid` number, double — This is a read only property. Will show the sum of all payments from operating bank accounts made for this project (matter). - `ccPaid` number, double — This is a read only property. Will show the sum of all payments from CC bank accounts made for this project (matter). - `name` string, required - `account` AccountRef - `nameAndNumber` string — - `guid` string, uuid - `utbmsIsEnabled` boolean - `id` integer - `tenantRefNumber` integer — The due date for this project (matter). will appear on the calendar. - `dueDate` string, date-time - `openDate` string, date-time - `closeDate` string, date-time - `createdDate` string, date-time — - `lastModifiedDate` string, date-time — - `evergreenIsAlert` boolean - `evergreenIsOn` boolean — If on, evergreen alerts will be activated based on the evergreen amount - `evergreenAmount` number, double - `isAddEvergreenToInvoice` boolean — 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 - `assignedTo` UserRef[] - `guid` string, uuid - `displayName` string — - `name` string — - `timeZoneId` string - `originatedBy` UserRef - `guid` string, uuid - `displayName` string — - `name` string — - `timeZoneId` string - `number` integer — Project number. Must be unique. - `assignedToGuids` string[], 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. - `tags` TagDTO[] - `name` string, required - `accountTags` TagDTO[] - `name` string, required - `tagNames` string[] — For compatibility reasons, this will return an array of tag names instead of a list of tag objects. - `accountTagsNames` string[] - `paid` number, 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). - `trustBalance` number, double — This is a read only property. Will indicate what is the trust account balance for this project (matter). - `operatingBalance` number, double — [OperatingBalance] is a read only property. = Sum of OperatingPayments.AvailableFunds + CreditNotes.AvailableFunds - Invoices.AmountDue: for this project (matter). - `billable` number, 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. - `saleDocumentTemplateGuid` string, uuid — Used to set the reference in POST and PUT - `saleDocumentTemplateName` string - `presetProjectRate` PresetProjectRateRef - `name` string - `description` string - `guid` string, uuid - `invoiceMatterRecipients` ContactRef[] - `firstName` string - `lastName` string - `middleName` string - `accountName` string - `displayName` string - `guid` string, uuid - `email` string - `invoiceMatterRecipientsGuids` string[] — Used to set the reference in POST and PUT - `nameAndNumber` string — This is a read only property This is a read only property - `guid` string, uuid - `id` integer --- [API](https://skmtc.net/practicepanther/apis/legacy-api-v1.md) · [All operations](https://skmtc.net/practicepanther/apis/legacy-api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/practicepanther/legacy-api-v1/revisions/a444c5b1e78b/schema)