APIs

Update a Company

put
https://api.avionte.com/front-office/v1/company

Updates information about the specified company.

Query Params
boolean

An indication of whether to bypass the duplicate company name check when updating a company record. If set to true, the duplicate name validation is skipped; if set to false or not provided, the validation is applied and the update is rejected if a duplicate name is found.

Body Params
int32

The identifier for the company.

string
required
length ≤ 255

The name of the company.

mainAddress

The main address of the company.

billingAddress

The billing address of the company.

int32
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 Get Branches endpoint to retrieve the ID.

string
length ≤ 255

The website of the company.

boolean

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

representativeUsers
array of int32s

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

representativeUsers
string
length ≤ 255

The name of the company source.

int32

The identifier for the company status.

string
length ≤ 255

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.

string
length ≤ 100

The company industry.

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.

string
required
length ≤ 50

The partner or vendor that originated the request.

string
length ≤ 255

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

department

The department object for company.

string

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

string

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

string

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

string

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

string

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

boolean

Indicates whether the company is a parent company.

int32

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

string
length ≤ 255

The phone number for the company.

Headers
uuid

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

integer

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

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

Updated about 1 year ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago