v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Departments

Get a Department Address

Returns details about the specified department address.

get/v1/department/address/{addressId}

Path parameters

addressIdstring required

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

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.

addressGuidstring uuid

Unique identifier for the address, formatted as a UUID.

street1string required

Street address, line 1.

street2string

Street address, line 2.

citystring required

City.

statestring required

Province, state, or region.

postalCodestring required

ZIP/postal code.

countrystring required

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>.

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 identifier of whether the department address is archived or not.

isDefaultboolean

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

originstring

The origin of the address of the department.

Example response

{
  "addressGuid": "cb63d8fc-6d06-f011-87a7-a0595061251e",
  "street1": "123 Main St.",
  "street2": "Suite 250",
  "city": "Minneapolis",
  "state": "MN",
  "postalCode": "55435",
  "country": "US",
  "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"
    }
  ]
}