Retainage records at the project/task level for a proposal in Transaction(PSAProjProposalRetain)

Latest version of the JSON entity definition is available on GitHub.

Traits

Traits for this entity are listed below.

is.identifiedBy
names a specifc identity attribute to use with an entity

Parameter	Value	Data type	Explanation
attribute	PSAProjProposalRetain/(resolvedAttributes)/RecId	attribute

is.CDM.entityVersion

Parameter	Value	Data type	Explanation
versionNumber	"1.1"	string	semantic version number of the entity

is.application.releaseVersion

Parameter	Value	Data type	Explanation
releaseVersion	"10.0.13.0"	string	semantic version number of the application introducing this entity

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Retainage records at the project/task level for a proposal	entity	a reference to the constant entity holding the list of localized text

Attributes

Name	Description	First Included in Instance
RecId		Transaction/PSAProjProposalRetain
CompletePercent		Transaction/PSAProjProposalRetain
ContractLineNum		Transaction/PSAProjProposalRetain
ContractValue		Transaction/PSAProjProposalRetain
FundingSource		Transaction/PSAProjProposalRetain
IncludeLower		Transaction/PSAProjProposalRetain
InvoiceAll		Transaction/PSAProjProposalRetain
Invoiced		Transaction/PSAProjProposalRetain
InvoiceDate		Transaction/PSAProjProposalRetain
InvoicedNow		Transaction/PSAProjProposalRetain
IsInitial		Transaction/PSAProjProposalRetain
IsRelease		Transaction/PSAProjProposalRetain
ProjId		Transaction/PSAProjProposalRetain
ProposalId		Transaction/PSAProjProposalRetain
ReleasedAmount		Transaction/PSAProjProposalRetain
ReleasedPercent		Transaction/PSAProjProposalRetain
Retained		Transaction/PSAProjProposalRetain
RetainedAmount		Transaction/PSAProjProposalRetain
RetainedNow		Transaction/PSAProjProposalRetain
RetainedPercent		Transaction/PSAProjProposalRetain
ScheduleId		Transaction/PSAProjProposalRetain
DataAreaId		Transaction/PSAProjProposalRetain
Relationship_ProjFundingSourceRelationshipId		Transaction/PSAProjProposalRetain
Relationship_ProjProposalJourRelationshipId		Transaction/PSAProjProposalRetain
Relationship_ProjTableRelationshipId		Transaction/PSAProjProposalRetain
Relationship_PSAContractLineItemsRelationshipId		Transaction/PSAProjProposalRetain
Relationship_PSAProjProposalProjRelationshipId		Transaction/PSAProjProposalRetain
Relationship_CompanyRelationshipId		Transaction/PSAProjProposalRetain

RecId

First included in: Transaction/PSAProjProposalRetain (this entity)

Properties

Name	Value
isPrimaryKey	true
dataFormat	int64
isReadOnly	true

Traits

List of traits for the RecId attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.identifiedBy
names a specifc identity attribute to use with an entity

Parameter	Value	Data type	Explanation
attribute	PSAProjProposalRetain/(resolvedAttributes)/RecId	attribute

is.readOnly
is.dataFormat.integer
is.dataFormat.big

CompletePercent

First included in: Transaction/PSAProjProposalRetain (this entity)

Properties

Name	Value
displayName	% complete
dataFormat	decimal
isNullable	true

Traits

List of traits for the CompletePercent attribute are listed below.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en % complete	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

ContractLineNum

First included in: Transaction/PSAProjProposalRetain (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the ContractLineNum attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

ContractValue

First included in: Transaction/PSAProjProposalRetain (this entity)

Properties

Name	Value
dataFormat	decimal
isNullable	true

Traits

List of traits for the ContractValue attribute are listed below.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

is.nullable
The attribute value may be set to NULL.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

FundingSource

First included in: Transaction/PSAProjProposalRetain (this entity)

Properties

Name	Value
dataFormat	int64
isNullable	true

Traits

List of traits for the FundingSource attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer
is.dataFormat.big

IncludeLower

First included in: Transaction/PSAProjProposalRetain (this entity)

Properties

Name	Value
displayName	Include lower levels
dataFormat	int32
isNullable	true

Traits

List of traits for the IncludeLower attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Include lower levels	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

InvoiceAll

First included in: Transaction/PSAProjProposalRetain (this entity)

Properties

Name	Value
displayName	Inv. all
dataFormat	int32
isNullable	true

Traits

List of traits for the InvoiceAll attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Inv. all	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

Invoiced

First included in: Transaction/PSAProjProposalRetain (this entity)

Properties

Name	Value
displayName	Invoiced
dataFormat	decimal
isNullable	true

Traits

List of traits for the Invoiced attribute are listed below.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Invoiced	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

InvoiceDate

First included in: Transaction/PSAProjProposalRetain (this entity)

Properties

Name	Value
dataFormat	date
isNullable	true

Traits

List of traits for the InvoiceDate attribute are listed below.

is.dataFormat.date
means.measurement.date
is.nullable
The attribute value may be set to NULL.

is.dataFormat.date

InvoicedNow

First included in: Transaction/PSAProjProposalRetain (this entity)

Properties

Name	Value
displayName	Now invoiced
dataFormat	decimal
isNullable	true

Traits

List of traits for the InvoicedNow attribute are listed below.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Now invoiced	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

IsInitial

First included in: Transaction/PSAProjProposalRetain (this entity)

Properties

Name	Value
displayName	Initial
dataFormat	int32
isNullable	true

Traits

List of traits for the IsInitial attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Initial	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

IsRelease

First included in: Transaction/PSAProjProposalRetain (this entity)

Properties

Name	Value
displayName	Release
dataFormat	int32
isNullable	true

Traits

List of traits for the IsRelease attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Release	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

ProjId

First included in: Transaction/PSAProjProposalRetain (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the ProjId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

ProposalId

First included in: Transaction/PSAProjProposalRetain (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the ProposalId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

ReleasedAmount

First included in: Transaction/PSAProjProposalRetain (this entity)

Properties

Name	Value
displayName	Retention release amount
dataFormat	decimal
isNullable	true

Traits

List of traits for the ReleasedAmount attribute are listed below.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Retention release amount	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

ReleasedPercent

First included in: Transaction/PSAProjProposalRetain (this entity)

Properties

Name	Value
displayName	% to invoice
dataFormat	decimal
isNullable	true

Traits

List of traits for the ReleasedPercent attribute are listed below.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en % to invoice	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

Retained

First included in: Transaction/PSAProjProposalRetain (this entity)

Properties

Name	Value
displayName	Retainage balance
dataFormat	decimal
isNullable	true

Traits

List of traits for the Retained attribute are listed below.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Retainage balance	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

RetainedAmount

First included in: Transaction/PSAProjProposalRetain (this entity)

Properties

Name	Value
displayName	Amount to retain
dataFormat	decimal
isNullable	true

Traits

List of traits for the RetainedAmount attribute are listed below.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Amount to retain	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

RetainedNow

First included in: Transaction/PSAProjProposalRetain (this entity)

Properties

Name	Value
displayName	Retained amount
dataFormat	decimal
isNullable	true

Traits

List of traits for the RetainedNow attribute are listed below.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Retained amount	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

RetainedPercent

First included in: Transaction/PSAProjProposalRetain (this entity)

Properties

Name	Value
displayName	Retention %
dataFormat	decimal
isNullable	true

Traits

List of traits for the RetainedPercent attribute are listed below.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Retention %	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

ScheduleId

First included in: Transaction/PSAProjProposalRetain (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the ScheduleId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

DataAreaId

First included in: Transaction/PSAProjProposalRetain (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true

Traits

List of traits for the DataAreaId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.readOnly
is.dataFormat.character
is.dataFormat.array

Relationship_ProjFundingSourceRelationshipId

First included in: Transaction/PSAProjProposalRetain (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_ProjFundingSourceRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/operationsCommon/Tables/ProfessionalServices/ProjectManagementAndAccounting/Main/ProjFundingSource.cdm.json/ProjFundingSource RecId	entity	a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

Relationship_ProjProposalJourRelationshipId

First included in: Transaction/PSAProjProposalRetain (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_ProjProposalJourRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/operationsCommon/Tables/ProfessionalServices/ProjectManagementAndAccounting/Transaction/ProjProposalJour.cdm.json/ProjProposalJour RecId	entity	a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

Relationship_ProjTableRelationshipId

First included in: Transaction/PSAProjProposalRetain (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_ProjTableRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/operationsCommon/Tables/ProfessionalServices/ProjectManagementAndAccounting/Main/ProjTable.cdm.json/ProjTable RecId	entity	a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

Relationship_PSAContractLineItemsRelationshipId

First included in: Transaction/PSAProjProposalRetain (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_PSAContractLineItemsRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/operationsCommon/Tables/ProfessionalServices/ProjectManagementAndAccounting/Miscellaneous/PSAContractLineItems.cdm.json/PSAContractLineItems RecId	entity	a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

Relationship_PSAProjProposalProjRelationshipId

First included in: Transaction/PSAProjProposalRetain (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_PSAProjProposalProjRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/operationsCommon/Tables/ProfessionalServices/ProjectManagementAndAccounting/Transaction/PSAProjProposalProj.cdm.json/PSAProjProposalProj RecId	entity	a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

Relationship_CompanyRelationshipId

First included in: Transaction/PSAProjProposalRetain (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_CompanyRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/operationsCommon/Tables/Finance/Ledger/Main/CompanyInfo.cdm.json/CompanyInfo RecId	entity	a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array