Add a Department

post

https://api.avionte.com/front-office/v1/departments

Adds a new department record to the system.

Body Params

compId

int32

required

The identifier for company.

departmentName

string

required

length between 1 and 255

The name of the department.

officeId

int32

The identifier for the office.

statusId

int32

The identifier for the status.

parentDepartmentId

int32

The identifier for the parent department.

street1

string

length ≤ 255

Street address line 1 for the department.

street2

string

length ≤ 255

Street address line 2 for the department.

city

string

length ≤ 255

City for the department.

stateProvince

string

required

length between 1 and 255

Province, state, or region for the department.

postalCode

string

length ≤ 255

ZIP/postal code for the department.

country

string

required

length between 1 and 255

A 2-letter ISO 3166-1 alpha-2 code representing the department country (e.g., "US", not "USA"). For details, see the General Guidelines.

geoCode

string

length ≤ 50

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

departmentPhone

string

length ≤ 255

Phone number of the branch.

defaultJobOwnerIDs

array of int32s

User IDs of the default job owners of the department.

defaultJobOwnerIDs

origin

string

length ≤ 50

The origin of the department.

weekEndDate

string

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

payPeriod

string

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

payCycle

string

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

billingPeriod

string

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

billingCycle

string

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

originRecordId

string

length ≤ 255

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

Headers

RequestId

uuid

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

FrontOfficeTenantId

integer

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

Tenant

string

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

Responses

401

Unauthorized

403

Access Denied

405

Unsupported method

406

Unsupported format(s) indicated by Accept header

409

Operation could not be completed due to conflict.

415

Unsupported format(s) indicated by the Content-Type header

429

Too many requests

500

An unexpected error occurred

502

Service Unavailable

504

Gateway Timeout

201The created department.

400Bad Request

404Not found