Company Addresses
Comprehensive address management system for companies supporting multiple address types, validation, and hierarchical relationships.
Address Types
Companies support multiple address types for different business purposes:
Type | Purpose | Description |
---|---|---|
delivery | Shipping | Primary delivery location for orders |
invoice | Invoicing | Billing address for financial transactions |
Key Features
- Multiple Addresses: Companies can have unlimited addresses
- Type-Specific Usage: Different addresses for different business functions
- Default Management: Automatic default address assignment
- Validation: Comprehensive field validation and formatting
- Bulk Operations: Efficient management of multiple addresses
Address Components
Location Information
- Street address with number and extension
- City, postal code, and country
- Regional information
Contact Details
- Phone and mobile numbers
- Email addresses
- Company-specific contact information
Personal Information
- Contact person names (first, middle, last)
- Gender specification
- Role and department information
Fields
Field | Type | Required | Description |
---|---|---|---|
id | integer | Auto-generated | Unique Propeller address identifier |
type | string (enum: delivery , invoice ) | yes | Address type used for routing and billing logic |
code | string | no | Client-defined unique code/identifier for the address |
company | string | no | Company name for the address label |
firstName | string | no | Contact person's first name |
middleName | string | no | Contact person's middle name/initials |
lastName | string | no | Contact person's last name |
gender | string (enum: M , F , U ) | no | Contact person's gender; default is U (unknown) |
street | string | yes | Street name |
number | string | no | House/building number |
numberExtension | string | no | Addition to the house number (e.g., A , bis ) |
postalCode | string | no | Postal/ZIP code |
city | string | yes | City |
region | string | no | State/Province/Region |
country | string (ISO 3166-1 alpha-2) | yes | Country code (e.g., NL , BE ) |
icp | string (enum: Y , N ) | no | Intra-Community supply indicator; default is N |
phone | string | no | Primary phone number |
mobile | string | no | Mobile phone number |
email | string | no | Email address |
url | string (URI) | no | Website URL |
isDefault | string (enum: Y , N ) | no | Whether this is the default address; default is N |
notes | string | no | Free-form notes related to the address |
Management Operations
CRUD Operations
- Create: Add new addresses with full validation
- Read: Retrieve individual or filtered address lists
- Update: Modify existing addresses with partial updates
- Delete: Safe removal with dependency checking
Bulk Operations
- Bulk Creation: Process multiple addresses in single requests
- Upsert Logic: Automatic create-or-update based on codes
- Batch Validation: Comprehensive validation across multiple addresses