Skip to main content
Version: 1.0.0-beta

Field Reference — PBC

PBC Request Fields

FieldTypeRequiredDescription
idIntegerAutoUnique identifier
engagement_idIntegerParent engagement
titleStringRequest group title
descriptionStringOptionalContext for the client
statusStringAutoDRAFT, OPEN, IN_PROGRESS, SUBMITTED, ACCEPTED, RETURNED, CLOSED
due_dateDateTimeOptionalWhen documents are needed
assigned_to_emailStringOptionalExternal client email
assigned_to_user_idStringOptionalInternal user ID
assigned_to_nameStringOptionalDisplay name of assignee
created_atDateTimeAutoCreation timestamp
created_by_idStringAutoAuditor who created the request

Request Item Fields

FieldTypeRequiredDescription
idIntegerAutoUnique identifier
request_idIntegerParent PBC request
descriptionStringWhat document or data is needed
statusStringAutoOPEN, SUBMITTED, ACCEPTED, RETURNED

Submission Fields

FieldTypeRequiredDescription
idIntegerAutoUnique identifier
item_idIntegerParent request item
evidence_idIntegerLink to Evidence (chain-of-custody)
submitted_by_idStringAutoWho submitted
submitted_atDateTimeAutoSubmission timestamp
noteStringOptionalExplanation of the submission

Comment Fields

FieldTypeRequiredDescription
idIntegerAutoUnique identifier
item_idIntegerParent request item
user_idStringAutoComment author
contentStringComment text
created_atDateTimeAutoWhen the comment was posted