Address

A postal address.

type Address {
  addressLine1: String
  addressLine2: String
  city: String
  contactEmail: String
  contactName: String
  contactPhone: String
  coordinates: JSON
  country: String
  createdAt: DateTime!
  deletedAt: DateTime
  deletedBy: String
  enteredBy: String!
  id: ID!
  instructions: String
  isActive: Boolean!
  isDefault: Boolean!
  isDualPurpose: Boolean!
  label: String
  landmark: String
  latitude: Float
  longitude: Float
  metadata: JSON
  notes: String
  organizationId: String!
  partnerId: String
  postalCode: String
  priority: String
  role: String
  state: String
  street1: String
  street2: String
  type: String!
  updatedAt: DateTime!
  updatedBy: String!
}

Fields

Address.addressLine1 ● String scalar

The first line of the address.

Address.addressLine2 ● String scalar

The second line of the address.

Address.city ● String scalar

The city.

Address.contactEmail ● String scalar

The email address of the contact at the address.

Address.contactName ● String scalar

The name of the contact at the address.

Address.contactPhone ● String scalar

The phone number of the contact at the address.

Address.coordinates ● JSON scalar

The map coordinates, as JSON.

Address.country ● String scalar

The country.

Address.createdAt ● DateTime! non-null scalar

When the record was created.

Address.deletedAt ● DateTime scalar

When the record was deleted. Empty while the record is live.

Address.deletedBy ● String scalar

The ID of the user who deleted the record.

Address.enteredBy ● String! non-null scalar

The ID of the user who created the record.

Address.id ● ID! non-null scalar

The unique ID of this record.

Address.instructions ● String scalar

Delivery or access instructions.

Address.isActive ● Boolean! non-null scalar

Whether the record is active.

Address.isDefault ● Boolean! non-null scalar

Whether this is the default.

Address.isDualPurpose ● Boolean! non-null scalar

True when the one address serves both billing and delivery.

Address.label ● String scalar

A label for the address, such as Head office.

Address.landmark ● String scalar

A nearby landmark.

Address.latitude ● Float scalar

The latitude of the address on the map.

Address.longitude ● Float scalar

The longitude of the address on the map.

Address.metadata ● JSON scalar

Additional data attached to the record, as JSON.

Address.notes ● String scalar

Notes about the address.

Address.organizationId ● String! non-null scalar

The ID of the organization the record belongs to.

Address.partnerId ● String scalar

The ID of the partner.

Address.postalCode ● String scalar

The postal code.

Address.priority ● String scalar

Whether the address is the primary or a secondary one.

Address.role ● String scalar

Whether the address is for a customer or a vendor role.

Address.state ● String scalar

The state or region.

Address.street1 ● String scalar

The first line of the street address.

Address.street2 ● String scalar

The second line of the street address.

Address.type ● String! non-null scalar

The kind of address, for example billing or shipping.

Address.updatedAt ● DateTime! non-null scalar

When the record was last changed.

Address.updatedBy ● String! non-null scalar

The ID of the user who last changed the record.

Member Of

Customer object