v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Departments

Add a Department

Adds a new department record to the system.

post/v1/departments

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.

Request body

compIdinteger required

The identifier for company.

departmentNamestring required

The name of the department.

officeIdinteger

The identifier for the office.

statusIdinteger

The identifier for the status.

parentDepartmentIdinteger

The identifier for the parent department.

street1string

Street address line 1 for the department.

street2string

Street address line 2 for the department.

citystring

City for the department.

stateProvincestring required

Province, state, or region for the department.

postalCodestring

ZIP/postal code for the department.

countrystring required

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

geoCodestring

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

departmentPhonestring

Phone number of the branch.

defaultJobOwnerIDsinteger[]

User IDs of the default job owners of the department.

originstring

The origin of the department.

weekEndDatestring

Week End Date for the department. Allowed values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.

payPeriodstring

Pay Period for the department. Allowed values: Daily, Weekly, BiWeekly, Monthly, SemiMonthly, Yearly, Hourly.

payCyclestring

Pay Cycle for the department. Allowed values: 1, 2, 3, 4, Last Week.

billingPeriodstring

Billing Period for the department. Allowed values: Daily, Weekly, BiWeekly, Monthly, SemiMonthly, Yearly, Hourly.

billingCyclestring

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 request

{
  "compId": 123456,
  "departmentName": "Warehouse",
  "officeId": 789012,
  "statusId": 263,
  "parentDepartmentId": 345678,
  "street1": "123 Main Street",
  "street2": "Suite 100",
  "city": "Eagan",
  "stateProvince": "MN",
  "postalCode": "55121",
  "country": "US",
  "geoCode": "241234892",
  "departmentPhone": "651-555-1234",
  "defaultJobOwnerIDs": [
    12345,
    67890
  ],
  "origin": "PartnerXYZ",
  "weekEndDate": "Friday",
  "payPeriod": "Weekly",
  "payCycle": "1",
  "billingPeriod": "BiWeekly",
  "billingCycle": "2",
  "originRecordId": "12345-abcde"
}

Response

The created department.

companyExternalIdstring nullable

The unique system-defined identifier for the Company.

companyGuidstring uuid nullable

The Back Office unique identifier for the Company, formatted as a UUID.

departmentExternalIdstring nullable

The unique system-defined identifier for the Company Department.

departmentGuidstring uuid nullable

The Back Office unique identifier for the Department, formatted as a UUID.

departmentNamestring

The name of the company department.