Departments

Get a Department

Returns details about the specified department.

get/v1/department/{departmentId}

Request

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

Path parameters

departmentIdstring required

Query parameters

includeAllAddressesboolean

An indication of whether all department addresses are included in the response. When true or empty (the default), addresses is returned. When false, addresses is returned as an empty array, and address data is not loaded. The main address is always returned.

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 requested department record.

idinteger

The identifier for the department.

namestring

The name of the department.

companyIdinteger

The identifier for the company.

officeIdinteger

The identifier for the office.

statusIdinteger

The identifier for the status.

statusstring

The status value.

statusTypestring

The status type value.

parentDepartmentIdinteger

The identifier for the parent department.

departmentPhonestring

Phone number of the department.

defaultJobOwnerIDsinteger[]

User IDs of the default job owners of the department.

originstring

The origin of the department.

originIdinteger

The identifier for the origin of the department.

weekendDaystring

The week end day for the department. Allowed values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.

payPeriodstring

The pay period for the department. Allowed values: Daily, Weekly, BiWeekly, Monthly, SemiMonthly, Yearly, Hourly.

payCyclestring

The pay cycle for the department. Allowed values: 1, 2, 3, 4, Last Week.

billingPeriodstring

The billing period for the department. Allowed values: Daily, Weekly, BiWeekly, Monthly, SemiMonthly, Yearly, Hourly.

billingCyclestring

The billing cycle for the department. Allowed values: 1, 2, 3, 4, Last Week.

originRecordIdstring

The identifier for the origin of the department from partner database.

Example response

{
  "id": 123456,
  "name": "Warehouse",
  "companyId": 12345,
  "officeId": 67890,
  "statusId": 143,
  "status": "Active",
  "statusType": "General",
  "parentDepartmentId": 98765,
  "address": {
    "street1": "123 Main Street",
    "street2": "Suite 100",
    "city": "St. Paul",
    "state_Province": "MN",
    "postalCode": "55121",
    "country": "US",
    "county": "Dakota",
    "geoCode": "241231070",
    "schoolDistrictCode": "00000"
  },
  "addresses": [
    {
      "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"
        }
      ]
    }
  ],
  "departmentPhone": "234-567-8900",
  "defaultJobOwnerIDs": [
    123456,
    789012
  ],
  "origin": "Acme Partner",
  "originId": 54321,
  "weekendDay": "Friday",
  "payPeriod": "Weekly",
  "payCycle": "2",
  "billingPeriod": "BiWeekly",
  "billingCycle": "2",
  "originRecordId": "DEPT-12345"
}

Changes

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