Skip to main content

Correspondence Types Reference

This page is the complete technical reference for all built-in correspondence types. For guidance on when to use each type, see Correspondence Types.

Common fields (all types)

FieldTypeRequiredDescription
typeenumYesCorrespondence type code
subjectstringYesSubject line, max 200 characters
bodyHTMLYesCorrespondence body, supports full HTML
priorityenumYesnormal, urgent, for_information
reference_numberstringAutoAuto-assigned at creation based on type prefix and counter
statusenumAutodraft, sent, responded, closed
toarrayYesPrimary recipient user IDs or email addresses
ccarrayNoCC recipient user IDs or email addresses
bccarrayNoBCC recipient user IDs or email addresses
due_datedateConditionalRequired if response_required = true for this type
attachmentsarrayNoFile references (stored in configured storage provider)
document_referencesarrayNoReferences to Document Register records
parent_idstringNoReference to parent correspondence (for threaded replies)
created_atdatetimeAutoCreation timestamp
sent_atdatetimeAutoDispatch timestamp (null if Draft)

Type-specific fields and defaults

RFI — Request for Information

AttributeValue
Type coderfi
Default prefixRFI-
Response requiredYes
Default due days14
Status on receiptTracked as "awaiting response" if past due date
Contractual significanceHigh — RFI responses are typically contractually binding

Typical fields included:

  • Clause/drawing reference (in body)
  • Question/request (in body)
  • Proposed solution (optional, in body)

NCR — Non-Conformance Report

AttributeValue
Type codencr
Default prefixNCR-
Response requiredYes
Default due days14
Status on receiptOpen until corrective action received and close-out confirmed
Contractual significanceHigh — NCRs are formal quality records

Typical fields included:

  • Description of non-conformance (in body)
  • Location/asset reference (in body)
  • Severity level (in custom metadata)
  • Corrective action required (in body)
  • Root cause (in reply body)
  • Close-out evidence reference (in reply attachments)

TQ — Technical Query

AttributeValue
Type codetq
Default prefixTQ-
Response requiredYes
Default due days14
Status on receiptTracked as "awaiting response"
Contractual significanceMedium — responses inform design decisions

SI — Site Instruction

AttributeValue
Type codesi
Default prefixSI-
Response requiredOptional (configurable)
Default due days2
Status on receiptActive until acknowledged or responded to
Contractual significanceHigh — SIs can create variation claims

General

AttributeValue
Type codegeneral
Default prefixGEN-
Response requiredNo
Default due daysNone
Status on receiptInformational only
Contractual significanceLow

Status values

StatusDescriptionWho sets it
draftComposed but not sentSystem (on save)
sentDispatched to recipientsSystem (on send)
respondedAt least one reply receivedSystem (on reply)
closedFormally resolvedUser (manual close)

Priority values

PriorityDescriptionEffect
normalStandard correspondenceNo special handling
urgentTime-criticalRed badge in register, triggers urgent distribution rules
for_informationNo response expectedResponse tracking disabled regardless of type setting

What's next