PM
PMProject
A planned set of related tasks to be executed over a fixed period, within specific cost limit, and with other limitations. Each project consists of tasks that need to be completed to complete the project. The project budget, profitability, and balances are monitored in the scope of account groups.
View API Entity: Project
/entity/Default/25.200.001/Project| Field Name | Type | Display Name | Foreign Key | |
|---|---|---|---|---|
AIALevel | char(1) | AIA Level | - | |
Description:No description available | ||||
AccountingMode | nvarchar(1) | Inventory Tracking | - | |
Description:The way how the system manages inventory for the project. The field can have one of the following values: ""P"": Track by Project Quantity and Cost, ""V"": Track by Project Quantity, ""L"": Track by Location | ||||
ActivationDate | datetime | Activation Date | - | |
Description:No description available | ||||
AllocationID | nvarchar(15) | Allocation Rule | PMAllocation | |
Description:Gets or sets the allocation rule for the project. The allocation rule is set at the PMTask level. This field contains the default value for the tasks created under the given project. | ||||
AllowIssueFromFreeStock | bit | Allow Issue from Free Stock | - | |
Description:A Boolean value that indicates whether materials from stock not allocated to any project can be issued. | ||||
AllowNonProjectAccountGroups | bit | Allow Adding New Items on the Fly | - | |
Description:No description available | ||||
AllowOverride | bit | Enable Template Item Override | - | |
Description:This field is not used with projects. | ||||
AllowOverrideCury | bit | Enable Currency Override | - | |
Description:No description available | ||||
AllowOverrideRate | bit | Enable Rate Override | - | |
Description:No description available | ||||
ApplyOTMultiplierToFringeRate | bit | Use Overtime Multiplier for Fringe Rate | - | |
Description:No description available | ||||
Approved | bit | Approved | - | |
Description:Specifies (if set to true) that the project has been approved. | ||||
ApproverID | int | Time Activity Approver | EPEmployee | |
Description:The project manager for the project. The project manager can approve and reject activities that require approval. An activity requires an approval only if the PMTask.ApproverID is specified for a given PMTask. | ||||
AssistantID | int | Project Manager Assistant | BAccount | |
Description:The project manager's assistant. | ||||
AttributesNonexistent in DB | string | - | ||
Description:The entity attributes. | ||||
AutoAllocate | bit | Run Allocation on Release of Project Transactions | - | |
Description:Specifies (if set to true) that the allocation should be run every time a PMTran is released. | ||||
AutoRenew | bit | Mass Renewal | - | |
Description:This field in not used with projects. | ||||
AutoRenewDays | int | Renewal Point | - | |
Description:This field in not used with projects. | ||||
AutomaticReleaseAR | bit | Automatically Release AR Documents | - | |
Description:No description available | ||||
BalanceNonexistent in DB | decimal? | Balance | - | |
Description:No description available | ||||
BaseCuryID | nvarchar(5) | Base Currency | CurrencyList | |
Description:No description available | ||||
BaseType | char(1) | Base Type | - | |
Description:The type of the record. The value can be either Contract or Project. The default value is Project. | ||||
BenefitCodeReceivingFringeRate | int | Benefit Code to Use for Fringe Rate | PRDeductCode | |
Description:No description available | ||||
BenefitExpenseAcctID | int | Benefit Expense Account | Account | |
Description:No description available | ||||
BenefitExpenseSubID | int | Benefit Expense Subaccount | Sub | |
Description:No description available | ||||
BillAddressID | int | - | ||
Description:The identifier of the billing address that is associated with the customer. Corresponds to the PMAddress.AddressID field. | ||||
BillContactID | int | Billing Contact | PMContact | |
Description:The identifier of the billing contact that is associated with the customer. Corresponds to the ARContact.ContactID field. | ||||
BillingCuryID | nvarchar(5) | Billing Currency | CurrencyList | |
Description:The identifier of the billing currency of the project, which is used as the currency of the invoices created during the project billing. The value of this field corresponds to the value of the CurrencyList.CuryID field. | ||||
BillingID | nvarchar(15) | Billing Rule | PMBilling | |
Description:The billing rule for the project. The billing rule is set at the PMTask level. This field contains the default value for the tasks created under the given project. | ||||
BillingLineCntr | int | - | ||
Description:No description available | ||||
BudgetFinalized | bit | - | ||
Description:Specifies (if set to true) that the project budget is locked (using the Lock Budget action). | ||||
BudgetLevel | char(1) | Revenue Budget Level | - | |
Description:The detail level of the revenue budget. The field can have one of the following values: ""T"": Task, ""I"": Task and Item, ""C"": Task and Cost Code, ""D"": Task, Item, and Cost Code | ||||
BudgetMetricsEnabled | bit | Track Production Data | - | |
Description:No description available | ||||
CalendarID | nvarchar(10) | Calendar | CSCalendar | |
Description:No description available | ||||
CapAmountNonexistent in DB | decimal? | - | ||
Description:The retainage cap amount (in the base currency). | ||||
CaseItemID | int | Case Count Item | InventoryItem | |
Description:This field in not used with projects. | ||||
CertifiedJob | bit | Certified Job | - | |
Description:This field is used in the PMProject class. Specifies (if set to true) that the job performed in the scope of the project is a certified job performed for the government, such as a hospital construction project. | ||||
ChangeOrderWorkflow | bit | Change Order Workflow | - | |
Description:No description available | ||||
ChangeOrderWorkflowCopyNonexistent in DB | bool? | Change Order Workflow | - | |
Description:The copy of 'ChangeOrderWorkflow' which is used for visibility control in the classic UI. | ||||
ClassIDNonexistent in DB | string | ContractTemplate | ||
Description:The class ID for the attributes. Always returns the current GroupTypes.Project. | ||||
ClassType | char(1) | - | ||
Description:No description available | ||||
ContractAccountGroup | int | Account Group | PMAccountGroup | |
Description:No description available | ||||
ContractCD API | nvarchar | Contract ID | Contract | |
Description:The project CD. This is a segmented key. Its format is configured on the Segmented Keys (CS202000) form. | ||||
ContractID | int | Project ID | - | |
Description:The project ID. | ||||
ContractInfoNonexistent in DB | string | - | ||
Description:No description available | ||||
CostBudgetLevel | char(1) | Cost Budget Level | - | |
Description:The detail level of the cost budget. The field can have one of the following values: ""T"": Task, ""I"": Task and Item, ""C"": Task and Cost Code, ""D"": Task, Item, and Cost Code | ||||
CostTaxZoneID | nvarchar(10) | Cost Tax Zone | TaxZone | |
Description:Identifier of the cost tax zone associated with the document. Corresponds to the TaxZone.TaxZoneID field. | ||||
CountryUSNonexistent in DB | string | - | ||
Description:No description available | ||||
CreateProforma | bit | Create Pro Forma Invoice on Billing | - | |
Description:No description available | ||||
CreatedByID | uniqueidentifier | Created By | Users | |
Description:No description available | ||||
CreatedByScreenID | char(8) | - | ||
Description:No description available | ||||
CreatedDateTime | datetime | Created On | - | |
Description:No description available | ||||
CurrentRecurringNonexistent in DB | decimal? | Current Recurring | - | |
Description:No description available | ||||
CurrentRenewalNonexistent in DB | decimal? | Current Renewal | - | |
Description:No description available | ||||
CurrentSetupNonexistent in DB | decimal? | Current Setup | - | |
Description:No description available | ||||
CuryCapAmountNonexistent in DB | decimal? | Cap Amount | - | |
Description:The retainage cap amount. | ||||
CuryID | nvarchar(5) | Budget Currency | Currency | |
Description:The identifier of the project currency. The value of this field corresponds to the value of the CurrencyList.CuryID field. | ||||
CuryIDCopyNonexistent in DB | string | Project Currency | CurrencyList | |
Description:The identifier of the project currency. The value of this field corresponds to the value of the CurrencyList.CuryID field. | ||||
CuryInfoID | bigint | - | ||
Description:The identifier of the CurrencyInfo record associated with the project. | ||||
CuryRateNonexistent in DB | decimal? | - | ||
Description:No description available | ||||
CustomerID API | int | Customer | Customer | |
Description:The identifier of the customer for the project. Projects can be of the internal or external type. Internal projects are those that have the value of this property equal to NULL and hense are not billable. | ||||
DaysNonexistent in DB | string | - | ||
Description:No description available | ||||
DaysBeforeExpirationNonexistent in DB | string | - | ||
Description:No description available | ||||
DefaultAccrualAccountID | int | Accrual Account | Account | |
Description:The identifier of the default accrual account. The value of this field corresponds to the value of the Account.AccountID field. | ||||
DefaultAccrualSubID | int | Accrual Subaccount | Sub | |
Description:The default project accrual subaccount. The field is used depending on the PMSetup.ExpenseAccrualSubMask mask setting. | ||||
DefaultBranchID | int | Branch | Branch | |
Description:This field is used in the PMProject class. The identifier of the Branch associated with the project. The value of this field corresponds to the value of the Branch.BranchID field. | ||||
DefaultExpenseAccountID | int | Default Cost Account | Account | |
Description:The identifier of the default cost account. The value of this field corresponds to the value of the Account.AccountID field. | ||||
DefaultExpenseSubID | int | Default Cost Subaccount | Sub | |
Description:The default cost subaccount associated with the project. This subaccount can be used in allocation and cost transactions. | ||||
DefaultOverbillingAccountID | int | Overbilling Account | Account | |
Description:The default overbilling account of the project. | ||||
DefaultOverbillingSubID | int | Overbilling Subaccount | Sub | |
Description:The default overbilling subaccount of the project. | ||||
DefaultSalesAccountID | int | Default Sales Account | Account | |
Description:The identifier of the default sales account. The value of this field corresponds to the value of the Account.AccountID field. | ||||
DefaultSalesSubID | int | Default Sales Subaccount | Sub | |
Description:The default sales subaccount associated with the project. This subaccount can be used in allocation and billing rules. | ||||
DefaultUnderbillingAccountID | int | Underbilling Account | Account | |
Description:The default underbilling account of the project. | ||||
DefaultUnderbillingSubID | int | Underbilling Subaccount | Sub | |
Description:The default underbilling subaccount of the project. | ||||
Description API | nvarchar(255) | Description | - | |
Description:The project description. | ||||
DetailedBilling | int | Billing Format | - | |
Description:This field in not used with projects. | ||||
DiscontinueAfter | datetime | Discontinue After | - | |
Description:No description available | ||||
DiscountID | nvarchar(10) | Promo Code | ARDiscount | |
Description:No description available | ||||
DropshipExpenseAccountSource | char(1) | Use Expense Account From | - | |
Description:The source of the expense account to be used in the project drop-ship order. The field can have one of the following values: ""O"": Posting Class or Item, ""P"": Project, ""T"": Task | ||||
DropshipExpenseRecording | nvarchar(1) | Record Drop-Ship Expenses | - | |
Description:Defines when the expense transaction should be recorded. The field can have one of the following values: ""B"": On Bill Release, ""R"": On Receipt Release | ||||
DropshipExpenseSubMask | nvarchar(30) | Combine Expense Sub. From | - | |
Description:The subaccount mask for items used in the project drop-ships orders. | ||||
DropshipReceiptProcessing | nvarchar(1) | Drop-Ship Receipt Processing | - | |
Description:Defines whether a receipt will be generated for drop-shipped items that are purchased for the project. The field can have one of the following values: ""R"": Generate Receipt, ""S"": Skip Receipt Generation | ||||
Duration | int | Duration | - | |
Description:This field in not used with projects. | ||||
DurationType | char(1) | Duration Unit | - | |
Description:This field in not used with projects. | ||||
EarningsAcctID | int | Earnings Account | Account | |
Description:No description available | ||||
EarningsSubID | int | Earnings Subaccount | Sub | |
Description:No description available | ||||
EffectiveFrom | datetime | Effective From | - | |
Description:No description available | ||||
ExpireDate | datetime | End Date | - | |
Description:The end date of a project. | ||||
ExtRefNbr API | nvarchar(30) | External Ref. Nbr | - | |
Description:The external reference number. | ||||
FileEmptyCertifiedReport | bit | File Empty Report | - | |
Description:No description available | ||||
FinanceVisibleNonexistent in DB | int? | Finance Visible | - | |
Description:No description available | ||||
GraceDateNonexistent in DB | DateTime? | - | ||
Description:End Date of Grace Period. | ||||
GracePeriod | int | Grace Period | - | |
Description:This field in not used with projects. | ||||
GroupMask | varbinary | - | ||
Description:No description available | ||||
Hold API | bit | Hold | - | |
Description:Specifies (if set to true) that the project is on hold. | ||||
IncludeCO | bit | Include CO | - | |
Description:Include Change Orders in Contract Total | ||||
IncludeQtyInAIA | bit | Show Quantity in AIA Report | - | |
Description:No description available | ||||
IncludedNonexistent in DB | bool? | Included | - | |
Description:An unbound field used in the user interface to include the project into a restriction group. | ||||
IsActive | bit | Active | - | |
Description:Specifies (if set to true) that the project is active. Transactions can be added only to the active projects. | ||||
IsCancelled | bit | - | ||
Description:No description available | ||||
IsCompleted | bit | Completed | - | |
Description:Specifies (if set to true) that the project is completed. | ||||
IsContinuous | bit | Shift Expire Date on Renew | - | |
Description:This field in not used with projects. | ||||
IsLastActionUndoable | bit | - | ||
Description:No description available | ||||
IsPendingUpdate | bit | - | ||
Description:No description available | ||||
IsTemplateNonexistent in DBObsolete | bool? | - | ||
Description:No description available | ||||
LastActiveRevID | int | - | ||
Description:No description available | ||||
LastChangeOrderNumber | nvarchar(15) | Last Revenue Change Nbr. | - | |
Description:No description available | ||||
LastModifiedByID | uniqueidentifier | Last Modified By | Users | |
Description:No description available | ||||
LastModifiedByScreenID | char(8) | - | ||
Description:No description available | ||||
LastModifiedDateTime API | datetime | Last Modified On | - | |
Description:No description available | ||||
LastProformaNumber | nvarchar(15) | Last Application Nbr. | - | |
Description:This field is used in the PMProject class. The application number that has been assigned to the last pro forma invoice with progress billing lines prepared for the current project. | ||||
LimitsEnabled | bit | Use T&M Revenue Budget Limits | - | |
Description:No description available | ||||
LineCtr | int | - | ||
Description:No description available | ||||
LocationID | int | Customer Location | Location | |
Description:The customer location. | ||||
LockCommitments | bit | - | ||
Description:No description available | ||||
MasterContractID | int | Master Contract | Contract | |
Description:This field in not used with projects. | ||||
MinNonexistent in DB | string | - | ||
Description:No description available | ||||
NonProject | bit | Is Global | - | |
Description:Specifies (if set to true) that the project is a non-project. Only one project in the system is a non-project. A non-project is used whenever you have a transaction that is not applicable to any other project. | ||||
NoteID | uniqueidentifier | - | ||
Description:No description available | ||||
OriginalContractID | int | Contract | Contract | |
Description:This field in not used with projects. | ||||
OwnerID | int | Project Manager | Contact | |
Description:The user who is responsible for managing the project. | ||||
PTOExpenseAcctID | int | PTO Expense Account | Account | |
Description:No description available | ||||
PTOExpenseSubID | int | PTO Expense Subaccount | Sub | |
Description:No description available | ||||
PayrollWorkLocationID | int | Payroll Work Location | PRLocation | |
Description:No description available | ||||
PendingRecurringNonexistent in DB | decimal? | Pending Recurring | - | |
Description:No description available | ||||
PendingRenewalNonexistent in DB | decimal? | Pending Renewal | - | |
Description:No description available | ||||
PendingSetupNonexistent in DB | decimal? | Pending Setup | - | |
Description:No description available | ||||
PrepaymentDefCode | nvarchar(10) | Deferral Code | DRDeferredCode | |
Description:No description available | ||||
PrepaymentEnabled | bit | Use Prepaid Amount | - | |
Description:No description available | ||||
ProjectGroupID | nvarchar(15) | Project Group | PMProjectGroup | |
Description:The project group (PMProjectGroup), which the project belongs to. The project might not belong to any project group (the value is "null"). | ||||
ProjectTypeNonexistent in DB | string | Type | - | |
Description:The type of the project. | ||||
QuoteNbr | nvarchar(15) | Quote Ref. Nbr. | PMQuote | |
Description:No description available | ||||
RateTableID | nvarchar(15) | Rate Table Code | PMRateTable | |
Description:The rate table for the project. | ||||
RateTypeID | nvarchar(6) | Currency Rate Type | CurrencyRateType | |
Description:The default rate type for the currency rate that is used for the budget. The value of this field corresponds to the value of the CurrencyRateType.CuryRateTypeID field. | ||||
RefreshOnRenewal | bit | Refresh Items from Template on Renewal | - | |
Description:This field in not used with projects. | ||||
RefundPeriod | int | Refund Period | - | |
Description:No description available | ||||
Refundable | bit | Refundable | - | |
Description:No description available | ||||
Rejected | bit | Reject | - | |
Description:Specifies (if set to true) that the project has been rejected. | ||||
RenewalBillingStartDate | datetime | - | ||
Description:No description available | ||||
RestrictProjectSelectNonexistent in DB | string | Restrict Project Selection | - | |
Description:An option which defines whether a project can be selected in the document if the customer specified in the project differs from the customer specified in the document. The field can have one of the following values: ""A"": All Projects, ""C"": Customer Projects | ||||
RestrictToEmployeeList | bit | Restrict Employees | - | |
Description:This field is used in the PMProject class. Specifies (if set to true) that only the employees associated with the current project can create activities and documents that is associated with the current project. | ||||
RestrictToResourceList | bit | Restrict Equipment | - | |
Description:This field is used in the PMProject class. Specifies (if set to true) that equipment time cards can be associated with the current project for only the equipment that is associated with the current project. | ||||
RetainageMaxPct | decimal | Cap (%) | - | |
Description:Retainage Cap % | ||||
RetainageMode | char(1) | Retainage Mode | - | |
Description:Retainage Mode | ||||
RetainagePct | decimal | Retainage (%) | - | |
Description:The percent of an invoice amount issued for the project that is retained by the customer. | ||||
RevID | int | - | ||
Description:No description available | ||||
RevenueTaxZoneID | nvarchar(10) | Revenue Tax Zone | TaxZone | |
Description:Identifier of the revenue tax zone associated with the document. Corresponds to the TaxZone.TaxZoneID field. | ||||
SalesPersonID | int | Sales Person | SalesPerson | |
Description:No description available | ||||
ScheduleStartsOn | char(1) | Billing Schedule Starts On | - | |
Description:No description available | ||||
SelectedNonexistent in DB | bool? | Selected | - | |
Description:No description available | ||||
ServiceActivate | bit | - | ||
Description:This field in not used with projects. | ||||
SiteAddressObsolete | nvarchar(255) | Site Address | - | |
Description:No description available | ||||
SiteAddressID | int | - | ||
Description:The identifier of the project site address record associated with the project. | ||||
StartDate | datetime | Start Date | - | |
Description:The start date of the project. | ||||
Status API | char(1) | Status | - | |
Description:The status of the project. | ||||
StatusCode | int | - | ||
Description:Specifies the status code if the project is not valid after system upgrade. | ||||
SteppedRetainage | bit | Use Steps | - | |
Description:Stepped Retainage | ||||
SteppedRetainageOptionNonexistent in DB | string | Retainage Type | - | |
Description:Stepped Retainage | ||||
StrIsTemplateNonexistent in DB | string | Type | - | |
Description:No description available | ||||
TaxExpenseAcctID | int | Tax Expense Account | Account | |
Description:No description available | ||||
TaxExpenseSubID | int | Tax Expense Subaccount | Sub | |
Description:No description available | ||||
TemplateID API | int | Template | PMProject | |
Description:The template for the project. | ||||
TerminationDate | datetime | Termination Date | - | |
Description:The termination date of the project. | ||||
TermsID | nvarchar(10) | Terms | Terms | |
Description:The identifier of the credit terms object associated with the document. Defaults to the credit terms that are selected for the customer. Corresponds to the Terms.TermsID field. | ||||
ThroughDateSourceConditional | nvarchar | Through Date | - | |
Description:No description available | ||||
ThroughDateSourceUnconditional | nvarchar | Through Date | - | |
Description:No description available | ||||
TotalDueNonexistent in DB | decimal? | Total Due | - | |
Description:No description available | ||||
TotalPendingNonexistent in DB | decimal? | Total Pending | - | |
Description:No description available | ||||
TotalRecurringNonexistent in DB | decimal? | Recurring Total | - | |
Description:No description available | ||||
TotalUsageNonexistent in DB | decimal? | Extra Usage Total | - | |
Description:No description available | ||||
TotalsCalculatedNonexistent in DB | int? | - | ||
Description:No description available | ||||
Type | char(1) | Contract Type | - | |
Description:No description available | ||||
VisibleInAP | bit | AP | - | |
Description:Specifies (if set to true) that the project is visible in the AP module. If the project is invisible, it will not be displayed in the field selectors in this module. | ||||
VisibleInAR | bit | AR | - | |
Description:Specifies (if set to true) that the project is visible in the AR module. If the project is invisible, it will not be displayed in the field selectors in this module. | ||||
VisibleInCA | bit | CA | - | |
Description:Specifies (if set to true) that the project is visible in the CA module. If the project is invisible, it will not be displayed in the field selectors in this module. | ||||
VisibleInCR | bit | CRM | - | |
Description:Specifies (if set to true) that the project is visible in the CR module. If the project is invisible, it will not be displayed in the field selectors in this module. | ||||
VisibleInEA | bit | Expenses | - | |
Description:Specifies (if set to true) that the project is visible in the EP Expense module. If the project is invisible, it will not be displayed in the field selectors in this module. | ||||
VisibleInGL | bit | GL | - | |
Description:Specifies (if set to true) that the project is visible in the GL module. If the project is invisible, it will not be displayed in the field selectors in this module. | ||||
VisibleInIN | bit | IN | - | |
Description:Specifies (if set to true) that the project is visible in the IN module. If the project is invisible, it will not be displayed in the field selectors in this module. | ||||
VisibleInPO | bit | PO | - | |
Description:Specifies (if set to true) that the project is visible in the PO module. If the project is invisible, it will not be displayed in the field selectors in this module. | ||||
VisibleInPROD | bit | PROD | - | |
Description:No description available | ||||
VisibleInSO | bit | SO | - | |
Description:Specifies (if set to true) that the project is visible in the SO module. If the project is invisible, it will not be displayed in the field selectors in this module. | ||||
VisibleInTA | bit | Time Entries | - | |
Description:Specifies (if set to true) that the project is visible in the EP Time module. If the project is invisible, it will not be displayed in the field selectors in this module. | ||||
WageAbovePrevailingAnnualizationException | bit | Excess Pay Rate Annualization Exception | - | |
Description:No description available | ||||
WorkgroupIDNonexistent in DB | int? | - | ||
Description:The workgroup that is responsible for the document. | ||||
tstamp | timestamp | - | ||
Description:No description available | ||||