Skip to main content

CompanyAddressSearch

Physical address associated with a company for location-based operations.

Represents a complete address record including contact information, location details, and address metadata. Used for shipping, billing, correspondence, and location-based business operations. Supports multiple address types per company with default address designation.

type CompanyAddressSearch {
  id: Int!
  firstName: String
  lastName: String
  street: String!
  number: String
  numberExtension: String
  postalCode: String!
  city: String!
  region: String
  country: String!
  phone: String
  mobile: String
  email: String
  code: String
  notes: String
  name: String
  isDefault: YesNo
  type: AddressType!
  active: YesNo
  createdAt: DateTime!
  lastModifiedAt: DateTime!
}

Fields​

CompanyAddressSearch.id ● Int! non-null scalar​

Unique identifier for the address record.

Primary key used to reference this address throughout the system and for all address-related operations.

CompanyAddressSearch.firstName ● String scalar​

First name of the person associated with this address.

Personal name for address-specific contact identification, useful for delivery instructions and personal correspondence at this location.

CompanyAddressSearch.lastName ● String scalar​

Last name of the person associated with this address.

Family name for address-specific contact identification, useful for delivery instructions and formal correspondence at this location.

CompanyAddressSearch.street ● String! non-null scalar​

Street name for the physical address location.

Primary street identifier for the address, used for navigation, delivery, and official correspondence.

CompanyAddressSearch.number ● String scalar​

Street number for precise address identification.

Building or property number on the street, essential for accurate delivery and location identification.

CompanyAddressSearch.numberExtension ● String scalar​

Additional street number information for complex addresses.

Extensions like apartment numbers, suite numbers, or building designations that provide additional location specificity.

CompanyAddressSearch.postalCode ● String! non-null scalar​

Postal code for mail delivery and location services.

ZIP code or postal code used by postal services for efficient mail routing and geographic identification.

CompanyAddressSearch.city ● String! non-null scalar​

City name for geographic and administrative identification.

Municipality or city name used for location identification, administrative purposes, and geographic classification.

CompanyAddressSearch.region ● String scalar​

State, province, or region for broader geographic classification.

Administrative region above city level, used for geographic organization and location context.

CompanyAddressSearch.country ● String! non-null scalar​

Country code for international address identification.

Country identifier for international operations, shipping, and geographic classification.

CompanyAddressSearch.phone ● String scalar​

Fixed phone number for this address location.

Landline telephone number associated with this specific address. Must be between 6 and 30 characters. Used for location-specific communication and verification.

CompanyAddressSearch.mobile ● String scalar​

Mobile phone number for this address location.

Cell phone number associated with this specific address. Must be between 6 and 30 characters. Used for direct communication and delivery coordination.

CompanyAddressSearch.email ● String scalar​

Email address for correspondence to this location.

Email contact specific to this address location. Must be a valid email format. Used for address-specific communication and notifications.

CompanyAddressSearch.code ● String scalar​

Internal reference code for the address.

Custom identifier or reference code used for internal address management and categorization.

CompanyAddressSearch.notes ● String scalar​

Delivery instructions and additional address information.

Free-form text for delivery notes, access instructions, or additional context about this address location.

CompanyAddressSearch.name ● String scalar​

Friendly display name for the address.

Human-readable name or label for easy address identification.

CompanyAddressSearch.isDefault ● YesNo enum​

Indicates if this is the default address for its type.

Designates whether this address serves as the primary address for its specific address type within the company.

CompanyAddressSearch.type ● AddressType! non-null enum​

Classification of the address purpose and usage.

Defines how this address is used within business operations - [one of 'home', 'delivery', 'invoice'].

CompanyAddressSearch.active ● YesNo enum​

Indicates if the address is currently active and usable.

Status flag showing whether this address is available for current business operations and communications.

CompanyAddressSearch.createdAt ● DateTime! non-null scalar​

Address record creation timestamp.

Date and time when this address was initially added to the system, used for auditing and record tracking.

CompanyAddressSearch.lastModifiedAt ● DateTime! non-null scalar​

Address record last modification timestamp.

Date and time when any address information was last updated, used for change tracking and data synchronization.

Member Of​

CompanySearch object