Creates a new vendor, scoped by the company/business unit of the current user

post

https://api.hcssapps.com/contacts/api/v1/Vendors

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The vendor

A data transfer object for requesting the creation on a vendor.

code

string

required

length ≥ 1

The vendor's unique code.

name

string | null

The vendor's name.

typeId

uuid | null

The vendor's type unique identifier.

regionId

uuid | null

The unique identifier of the region the vendor operates in.

communicationMethod

string

enum

Allowed:

webAddress

string | null

The vendor's website address.

isBonded

boolean

A flag indicating if this vendor is bonded.

bondRate

double | null

The rate at which this vendor is bonded.

note

string | null

Notes about this vendor.

isUnion

boolean | null

A flag indicating if the vendor is in a union.

experienceModificationRating

double | null

0 to 2

The vendor's experience modification rating, which is used for workers' compensation premium.

rating

int32 | null

0 to 5

The rating this vendor has been given.

accountingCode

string | null

The vendor's accounting code.

Headers

BusinessUnitId

string

The business unit's guid

Responses

400

Bad Request. See https://developer.hcssapps.com/getting-started/troubleshoot-bad-request for more information.

401

Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.

403

Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Created