AVavionte
Departments

Get a Department Address

Returns details about the specified department address.

get/v1/department/address/{addressId}

Request

  • Base URL
    https://api.avionte.com/front-office
  • URL
    https://api.avionte.com/front-office/v1/department/address/{addressId}
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

addressIdstring required

Headers

RequestIdstring uuid

Unique request identifier in UUID format used to correlate request data to log entries and events.

Example:63680b86-c7e0-4a36-ae4a-d0d481089aff

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Response

The details of the department address.

street1string

Street address, line 1.

street2string

Street address, line 2.

citystring

City.

state_Provincestring

ISO 2-character code for the Province, State, or Region.

postalCodestring

ZIP/postal code.

countrystring

A 2-letter ISO 3166-1 alpha-2 code representing the country (e.g., "US", not "USA"). For details, see the <a href="https://developer.avionte.com/docs/general-guidelines#/data-formatting">General Guidelines</a>.

countystring

County.

geoCodestring

Numerical coordinate. The value is generated based on the ZIP code, city, and state of the address.

schoolDistrictCodestring

School district code based on the Geo Code.

addressIdinteger

The identifier for the department address.

branchIdinteger

The identifier for the company branch or department.

companyIdinteger

The identifier for the company.

addressType'Main' | 'Worksite' | 'Billing' | 'Unknown'

The address types available for selection for a department address.

phonestring

The department's phone number.

archiveboolean

An indication of whether the department address is archived or not.

isDefaultboolean

An indication of whether the department address is the default address for the department.

originstring

The origin of the address of the department.

Example response

{
  "street1": "123 Main Street",
  "street2": "Suite 100",
  "city": "St. Paul",
  "state_Province": "MN",
  "postalCode": "55121",
  "country": "US",
  "county": "Dakota",
  "geoCode": "241231070",
  "schoolDistrictCode": "00000",
  "addressId": 12345,
  "branchId": 12346,
  "companyId": 12347,
  "phone": "+1-555-123-4567",
  "isDefault": true,
  "origin": "Acme Partner",
  "salesTaxes": [
    {
      "configSalesTaxGUID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Minnesota State Tax",
      "description": "MN state sales tax rate",
      "state": "MN"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.