Skip to content

Family Case

FieldTypeIndexRequiredDescription
entityIdstringPKYThe document Id from the third-party system will be used in the Cloud to determine whether to update an existing record or create a new one.
namestringcase name
refEntityTypestringwks_family,
refDatasourceCodestringcc-family,
refEntityIdstringfamily related entity Id
statusstringThe status of the family is either new, pending, active, inactive, void,
dataobject
commentstring
disabledbool
tagsarraystring array
categorystringfundingsource for family case
metadataobjectset of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
FieldTypeDescription
specialiststring
sourcestring
reportCountystring
feeWaiverbool
cpsbool
familySizenumber
requestDatestring
reCertifyDatestring
noaEligibilityTypestring
noaNeedTypestring
contractCodestring
eligibilitystring
divisionNostring
trustLinePendingbool
calWorkActivitystring
signDatestring
initialSubsidystring
firstDateOfSubsidizedServicestring
stage1EndDatestring
stage2StarDatestring
stage2EndDatestring
stage3StarDatestring
customerFieldsobjectSet of key-value pairs that you can attach to an object