Vendors

Deletes an existing vendor by id, scoped by the company/business unit of the current user

Deletes the vendor and all associated products, contacts, and offices

Securitybearer
Request
path Parameters
vendorId
required
string <uuid>

The vendor guid

header Parameters
BusinessUnitId
string

The business unit's guid

Responses
204

No Content

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.

delete/api/v1/Vendors/{vendorId}
Request samples 
Returns a vendor with the provided id, scoped by the company/business unit of the current user
Securitybearer 
Request 
path Parameters
vendorId
required
string <uuid> 
The vendor guid


 
header Parameters
BusinessUnitId
string
The business unit's guid


 
Responses 
get/api/v1/Vendors/{vendorId}
Request samples 
Response samples 
application/json
{
  • "id": "8d667081-974b-4ebc-bbb5-ccb898166e09",
  • "businessUnitId": "4ab62450-6efc-4a9a-ac62-3d25bcf6a92a",
  • "name": "Petersons Construction INC",
  • "webAddress": "contact@petersons-construction.com",
  • "code": "PETERSONS",
  • "type": {
    },
  • "isBonded": false,
  • "bondRate": 0,
  • "note": "Specializing in Concrete",
  • "experienceModificationRating": 1,
  • "isUnion": false,
  • "rating": 1
}
Updates an existing vendor by id, scoped by the company/business unit of the current user
Securitybearer 
Request 
path Parameters
vendorId
required
string <uuid> 
The vendor guid


 
header Parameters
BusinessUnitId
string
The business unit's guid


 
Request Body schema: application/json
The vendor


id
string <uuid> 
The vendor's unique identifier.


 
code
required
string  non-empty 
The vendor's unique code.


 
name
string or null
The vendor's name.


 
typeId
string or null <uuid> 
The vendor type unique identifier.


 
regionId
string or null <uuid> 
The unique identifier of the region the vendor operates in.


 
communicationMethod
string (CommunicationMethod) 
 Enum: "None" "Email" "Fax" "Print"  
webAddress
string or null
The vendor's website address.


 
isBonded
boolean
A flag indicating if this vendor is bonded.


 
bondRate
number <double> 
The rate at which this vendor is bonded.


 
note
string or null
Notes about this vendor.


 
isUnion
boolean
A flag indicating if the vendor is in a union.


 
experienceModificationRating
number or null <double>   [ 0 .. 2 ] 
The vendor's experience modification rating, which is used for workers' compensation premium.


 
rating
integer or null <int32>   [ 0 .. 5 ] 
The rating this vendor has been given.


 
accountingCode
string or null
The vendor's accounting code.


 
Responses 
put/api/v1/Vendors/{vendorId}
Request samples 
application/json
{
  • "id": "c4f65254-b3c8-4f26-84e3-dfc113345326",
  • "code": "PETERSONS",
  • "name": "Petersons Construction INC",
  • "typeId": "85d1dd31-746c-4e59-8919-e9751d7e3895",
  • "regionId": "1ab24196-f83c-445e-9ec8-a2229454af52",
  • "communicationMethod": "Email",
  • "webAddress": "contact@petersons-construction.com",
  • "isBonded": false,
  • "bondRate": 0,
  • "note": "Specializing in Concrete",
  • "isUnion": false,
  • "experienceModificationRating": 1,
  • "rating": 1,
  • "accountingCode": "PETERSONS-ACC1"
}
Deletes an existing product, scoped by the company/business unit of the current user
Deletes a product that is currently associated with a vendor


Securitybearer 
Request 
path Parameters
vendorId
required
string <uuid> 
The vendor's guid.


 
productId
required
string <uuid> 
The product's guid.


 
header Parameters
BusinessUnitId
string
The business unit's guid


 
Responses 
204
No Content


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.


delete/api/v1/Vendors/{vendorId}/products/{productId}
Request samples 
Returns a list of all vendors, scoped by the company/business unit of the current user
Securitybearer 
Request 
header Parameters
BusinessUnitId
string
The business unit's guid


 
Responses 
get/api/v1/Vendors
Request samples 
Response samples 
application/json
[
  • {
    }
]
Creates a new vendor, scoped by the company/business unit of the current user
Securitybearer 
Request 
header Parameters
BusinessUnitId
string
The business unit's guid


 
Request Body schema: application/json
The vendor


code
required
string  non-empty 
The vendor's unique code.


 
name
string or null
The vendor's name.


 
typeId
string or null <uuid> 
The vendor's type unique identifier.


 
regionId
string or null <uuid> 
The unique identifier of the region the vendor operates in.


 
communicationMethod
string (CommunicationMethod) 
 Enum: "None" "Email" "Fax" "Print"  
webAddress
string or null
The vendor's website address.


 
isBonded
boolean
A flag indicating if this vendor is bonded.


 
bondRate
number <double> 
The rate at which this vendor is bonded.


 
note
string or null
Notes about this vendor.


 
isUnion
boolean
A flag indicating if the vendor is in a union.


 
experienceModificationRating
number or null <double>   [ 0 .. 2 ] 
The vendor's experience modification rating, which is used for workers' compensation premium.


 
rating
integer or null <int32>   [ 0 .. 5 ] 
The rating this vendor has been given.


 
accountingCode
string or null
The vendor's accounting code.


 
Responses 
post/api/v1/Vendors
Request samples 
application/json
{
  • "code": "PETERSONS",
  • "name": "Petersons Construction INC",
  • "typeId": "618a6c7d-6886-454d-9a55-2ec63b114a2d",
  • "regionId": "ac0cc7b9-9798-4358-b09c-b50c859688c2",
  • "communicationMethod": "Email",
  • "webAddress": "contact@petersons-construction.com",
  • "isBonded": false,
  • "bondRate": 0,
  • "note": "Specializing in Concrete",
  • "isUnion": false,
  • "experienceModificationRating": 1,
  • "rating": 1,
  • "accountingCode": "PETERSONS-ACC1"
}
Response samples 
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
Returns a list of all products of a vendor, scoped by the company/business unit of the current user
Securitybearer 
Request 
path Parameters
vendorId
required
string <uuid> 
The vendor guid


 
header Parameters
BusinessUnitId
string
The business unit's guid


 
Responses 
get/api/v1/Vendors/{vendorId}/products
Request samples 
Response samples 
application/json
[
  • {
    }
]
Creates a new product for a vendor, scoped by the company/business unit of the current user
Securitybearer 
Request 
path Parameters
vendorId
required
string <uuid> 
The vendor guid


 
header Parameters
BusinessUnitId
string
The business unit's guid


 
Request Body schema: 
The vendor


vendorId
required
string <uuid> 
The vendor's unique identifier.


 
productTypeId
required
string <uuid> 
The product type's unique identifier.


 
regionId
string or null <uuid> 
The product region's unique identifier.


 
date
string or null <date-time> 
The date.


 
Responses 
post/api/v1/Vendors/{vendorId}/products
Request samples 
{
  • "vendorId": "655bfdc2-0448-4d4a-9f72-fe3a6bf13a0b",
  • "productTypeId": "1f9a720d-23f5-4e34-a575-5900669183de",
  • "regionId": "4c6bfa35-f447-45b9-9b63-e8690ed51bfc",
  • "date": "2024-03-27T18:46:50.0363121Z"
}
Response samples 
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"