VendorContract

Returns vendor contractsDeprecated

DEPRECATED Please use the endpoint "/api/v1/vendorContracts"

This call returns a list of vendor contracts for the specified job.

Securitybearer
Request
path Parameters
jobId
required
string <uuid>

The job to query by.

Responses
get/api/v1/jobs/{jobId}/vendorContracts
Request samples 
Response samples 
application/json
[
  • {
    }
]
Creates a new vendor contract.
Securitybearer 
Request 
path Parameters
jobId
required
string <uuid> 
The job id.


 
Request Body schema: 
The vendor contract to be created.


orderStatus
string (OrderStatus) 
 Enum: "notStarted" "inProgress" "completed" "cancelled"  
dateIssued
string or null <date-time> 
The date vendor contract was issued.


 
description
string or null
The vendor contract description.


 
vendorId
string or null <uuid> 
The vendor id for the vendor contract.


 
vendorContract
required
string  non-empty 
The vendor contract name.


 
Responses 
post/api/v1/jobs/{jobId}/vendorContracts
Request samples 
{
  • "vendorContract": "VCConcrete",
  • "orderStatus": "inProgress",
  • "dateIssued": "2019-01-01",
  • "description": "Subcontract for concrete pour",
  • "vendorId": "563a5017-2405-4c07-85d3-518caae7d374"
}
Response samples 
application/json
{
  • "id": "eb918b91-acac-4498-9db8-35248ebb1bce",
  • "jobId": "d805eafa-bcd2-41a9-9f82-264cd2d6a104",
  • "orderStatus": "inProgress",
  • "dateIssued": "2019-01-01",
  • "vendorName": "Smith Company",
  • "vendorDescription": "Smith & Sons Contracting Company",
  • "vendorContract": "VCConcrete",
  • "description": "Subcontract for concrete pour",
  • "vendorId": "563a5017-2405-4c07-85d3-518caae7d374"
}
Returns vendor contracts
This call returns a list of vendor contracts for a specified job, business unit, vendor contract or modified since date.


Securitybearer 
Request 
query Parameters
jobId
string <uuid> 
The job id.


 
businessUnitId
string <uuid> 
The business unit id.


 
vendorContractId
string <uuid> 
The vendor contract id.


 
modifiedSince
string <date-time> 
The date of the last modification.


 
isDeleted
boolean
If true, returns deleted vendor contract items.


 
limit
integer <int32>   [ 1 .. 1000 ] 
 Default:  1000
The maximum number of results that should be returned.


 
cursor
string
Optional.  When there are additional results, the metadata nextCursor field should be passed to retrieve the next page of results.


 
Responses 
get/api/v1/vendorContracts
Request samples 
Response samples 
application/json
{
  • "results": [
    ],
  • "metadata": {
    }
}
Updates a vendor contract
This call updates an existing vendor contract by its id.  Cancelling a vendor
contract is not supported yet.


Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The vendor contract id.


 
Request Body schema: 
The vendor contract details to be updated.


orderStatus
string (OrderStatus) 
 Enum: "notStarted" "inProgress" "completed" "cancelled"  
dateIssued
string or null <date-time> 
The date vendor contract was issued.


 
description
string or null
The vendor contract description.


 
vendorContract
string or null
The vendor contract name.


 
vendorId
string or null <uuid> 
The vendor id for the vendor contract.


 
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.


put/api/v1/vendorContracts/{id}
Request samples 
{
  • "orderStatus": "inProgress",
  • "dateIssued": "2019-01-01",
  • "description": "Subcontract for concrete pour",
  • "vendorContract": "VCConcrete",
  • "vendorId": "563a5017-2405-4c07-85d3-518caae7d374"
}
Returns a list of vendor contract details.
Securitybearer 
Request 
path Parameters
vendorContractId
required
string <uuid> 
 
Responses 
get/api/v1/vendorContracts/{vendorContractId}/details
Request samples 
Response samples 
application/json
[
  • {
    }
]
Creates a vendor contract detail
This call creates a new vendor contract detail.


Securitybearer 
Request 
path Parameters
vendorContractId
required
string <uuid> 
The vendor contract id.


 
Request Body schema: 
The vendor contract detail to be created.


isComplete
boolean or null
Whether the work item is complete.
default is false


 
jobSubcontractId
required
string <uuid> 
The job subcontract id.


 
sequence
required
number <double> 
The sequence number of the vendor contract detail.
used to sort the vendor contract details


 
note
string or null
The note.


 
quantity
required
number <double> 
The item quantity.


 
unitCost
required
number <double> 
The item unit cost.


 
unitOfMeasure
required
string  non-empty 
The item unit of measure.


 
salesTaxPercent
number <double> 
The item sales tax represented in percent.


 
isCancelled
boolean
Whether the vendor contract detail is canceled.


 
alternateDescription
string or null
An alternate description for this vendor contract detail.


 
vendorItemNumber
string or null
The vendor item number.


 
Responses 
post/api/v1/vendorContracts/{vendorContractId}/details
Request samples 
{
  • "jobSubcontractId": "943b4d54-a063-4587-8241-69877ab20ed0",
  • "sequence": 15.5,
  • "note": "Vendor contract detail note",
  • "quantity": 245.5,
  • "unitCost": 14.75,
  • "unitOfMeasure": "TON",
  • "salesTaxPercent": 10.25,
  • "isCancelled": false,
  • "alternateDescription": "Alternate description",
  • "vendorItemNumber": "VCI-1",
  • "isComplete": false
}
Response samples 
application/json
{
  • "id": "70d6d634-66c6-45d2-8b79-a6a5276ec88f",
  • "vendorContractId": "15d98e0f-9b7d-423d-ad51-24394749a6d3",
  • "jobSubcontractId": "dd27f2a2-3061-44bc-9b08-1b1cae6fed9c",
  • "sequence": 20.1,
  • "isComplete": false,
  • "note": "Note 1",
  • "quantity": 100.5,
  • "unitCost": 10.5,
  • "unitOfMeasure": "EA",
  • "salesTaxPercent": 8.25,
  • "isCancelled": false,
  • "alternateDescription": "alt5",
  • "vendorItemNumber": "180.00.5"
}
Returns vendor contract items
This call returns a list of vendor contract items for the specified job, business unit, vendor contract, and modified since date.


Securitybearer 
Request 
query Parameters
jobId
string <uuid> 
The job id.


 
businessUnitId
string <uuid> 
The business unit id.


 
vendorContractId
string <uuid> 
The vendor contract id.


 
modifiedSince
string <date-time> 
The date of the last modification.


 
isDeleted
boolean
If true, returns deleted vendor contract items.


 
limit
integer <int32>   [ 1 .. 1000 ] 
 Default:  1000
The maximum number of results that should be returned.


 
cursor
string
Optional.  When there are additional results, the metadata nextCursor field should be passed to retrieve the next page of results.


 
Responses 
get/api/v1/vendorContractItems
Request samples 
Response samples 
application/json
{
  • "results": [
    ],
  • "metadata": {
    }
}
Updates a vendor contract detail
This call updates an existing vendor contract detail by its id.
Currently, update is limited to IsCompleted field only.


Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The vendor contract detail id.


 
Request Body schema: 
The vendor contract details to be updated.


isComplete
boolean or null
Whether the work item is complete.
default is false


 
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.


put/api/v1/vendorContracts/details/{id}
Request samples 
{
  • "isComplete": true
}