Skip to content

Agreement Addresses

The Addresses tab links agreement-specific address types to common address records. Each address row is an agreement child record plus a linked Common_Address record.

Empty installation setup

ConfigurationWhy it matters
Agency address typesThe address type lookup returns active address types available to the agreement context.
Country and jurisdiction enumsCanadian addresses require a valid jurisdiction enum value. Non-Canadian subdivisions are free text.
Agreement update permissionRequired to create, update, delete, and select address types.

Page flow

The tab shows agreement addresses and opens a modal for create and edit. The address type field only offers active address types that are valid for the agreement.

The list shows address type, street line 1, city, and postal or ZIP code. Address type is bilingual.

Fields

FieldNotes
Address typeRequired. Must be a configured agency address type valid for the agreement.
Street 1Required common address field.
Street 2 and street 3Optional common address fields.
CityRequired.
CountryRequired country enum.
SubdivisionRequired. For Canada, it must be one of the jurisdiction enum values. For other countries, it is entered as text.
GC address idOptional numeric field.
Federal riding idOptional numeric field.
Main phone and extensionOptional numeric fields.
Postal code or ZIP codeRequired.

Business rules

RuleBehaviour
Address type is validated before saveUsers can only save an address type that is valid for the agreement.
Address details and agreement link are saved togetherA new row creates both the address details and the agreement-specific address link.
Updates can change both address type and address detailsEditing an address can update the agreement address type and the address fields.
Delete is a soft deleteDeleted agreement addresses disappear from normal lists but remain available for historical integrity.
Canadian subdivisions are constrainedCanadian addresses require a valid province or territory.

Dependencies

Addresses do not drive the financial child workflows directly. They depend on agency reference data and the common address schema. They are useful for agreement administration, correspondence, and reporting where the implementation reads agreement addresses.