v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Companies

Create a Company

Adds a new company record to the system.

post/v1/company

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

idinteger

The identifier for the company.

namestring required

The name of the company.

frontOfficeIdinteger required

The identifier for the company's home office/branch. It occupies the following position in the Front Office hierarchy: Division → Region → Office/Branch. Refer to the <a href="https://developer.avionte.com/reference/getbranches">Get Branches</a> endpoint to retrieve the ID.

linkstring

The website of the company.

isArchivedboolean

An indication of whether the company record is archived or not.

representativeUsersinteger[]

The IDs of the representatives who are working with the company.

sourceNamestring

The name of the company source.

statusIdinteger

The identifier for the company status.

statusstring

The status of the company. When a new status value is passed, the status is added to the tenant's list of custom company statuses, else we match on the string value to an existing company status.

industrystring

The company industry.

createdDatestring date-time

The date the company profile was created. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.

originstring required

The partner or vendor that originated the request.

originRecordIdstring

The identifier for the company that can be used to link the record within the originating system.

weekEndDaystring

The Week End Day of the company. Valid values are 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', and 'Sunday'.

payPeriodstring

The Pay Period of the company. Valid values are 'Hourly', 'Daily', 'Weekly', 'BiWeekly', 'SemiMonthly', 'Monthly', and 'Yearly'.

payCyclestring

The Pay Cycle of the company. Valid values are '1', '2', '3', '4', and 'Last Week'.

billingPeriodstring

The Billing Period of the company. Valid values are 'Hourly', 'Daily', 'Weekly', 'BiWeekly', 'SemiMonthly', 'Monthly', and 'Yearly'.

billingCyclestring

The Billing Cycle of the company. Valid values are '1', '2', '3', '4', and 'Last Week'.

isParentboolean

Indicates whether the company is a parent company.

parentCompanyIdinteger

The identifier for the parent company if this company is a child.

phoneNumberstring

The phone number for the company.

Example request

{
  "id": 12345,
  "name": "Acme Corporation",
  "mainAddress": {
    "addressGuid": "cb63d8fc-6d06-f011-87a7-a0595061251e",
    "street1": "123 Main St.",
    "street2": "Suite 250",
    "city": "Minneapolis",
    "state": "MN",
    "postalCode": "55435",
    "country": "US"
  },
  "frontOfficeId": 12353,
  "link": "https://www.acmecorp.com",
  "representativeUsers": [
    123498,
    123499
  ],
  "sourceName": "Indeed",
  "statusId": 128,
  "status": "Active",
  "industry": "Information Technology",
  "origin": "Acme Partner",
  "originRecordId": "ACME-12345",
  "department": {
    "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"
  },
  "weekEndDay": "Friday",
  "payPeriod": "Weekly",
  "payCycle": "1",
  "billingPeriod": "BiWeekly",
  "billingCycle": "2",
  "isParent": true,
  "parentCompanyId": 13839,
  "phoneNumber": "305-555-01472"
}

Response

The created company.