PurchaseOrder

Get all purchase orders.

For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens

Securitybearer
Request
query Parameters
approvalStatus
string (PurchaseOrderApprovalStatusEnum)

The approval status to filter purchase orders by.

Enum: "unreviewed" "approved" "denied"
Responses
200

Success

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.

404

Endpoint Not Found. This response may occur if the on-premises E360 service does not exist or is not currently running.

get/api/v1/purchaseOrders
Request samples 
Response samples 
application/json
[
  • {
    }
]
Creates a new purchase order.
For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens


Securitybearer 
Request 
Request Body schema: 
businessUnitId
string or null <uuid> 
The business unit id.


 
dateIssued
required
string <date-time> 
The date purchase order was issued. If not specified, the default
value is the server time.


 
vendorId
required
string <uuid> 
The vendor id for the purchase order.


 
referenceNumber
string or null
The reference number to be used on the invoice.


 
taxRatePercent
number or null <double> 
The tax rate, expressed as a percent (e.g., 8 means 8% tax).
Defaults to vendor's default tax rate if not provided.


 
estimatedTotal
number or null <double> 
The estimated total amount of the purchase order (in dollars).


 
Array of objects or null (ApiNoteCreate) 
The notes for the purchase order.


 
Responses 
200
Success


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.


404
Endpoint Not Found. This response may occur if the on-premises E360 service does not exist or is not currently running.


post/api/v1/purchaseOrder
Request samples 
{
  • "businessUnitId": "42686835-dd20-4187-8429-39bcea2b1cfc",
  • "dateIssued": "2019-01-21",
  • "vendorId": "9431a6b9-959e-4e59-b3d7-cbd9b3786f73",
  • "referenceNumber": "ref123",
  • "taxRatePercent": 8.25,
  • "estimatedTotal": 1000.5,
  • "notes": [
    ]
}
Response samples 
application/json
{
  • "id": "03de8151-cbe4-4cc8-83b5-87c0d9837377",
  • "businessUnitID": "42686835-dd20-4187-8429-39bcea2b1cfc",
  • "purchaseOrderNumber": 28,
  • "dateIssued": "2019-01-21T00:00:00Z",
  • "vendorId": "d21e0cfc-94c6-42db-9d34-0d1713acaacb",
  • "referenceNumber": "ref123",
  • "taxRatePercent": 8.25,
  • "estimatedTotal": 1000.5,
  • "approvalStatus": "unreviewed",
  • "notes": [
    ]
}
Gets purchase order details by purchase order id.
For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens


Securitybearer 
Request 
path Parameters
purchaseOrderId
required
string <uuid> 
The purchase order id.


 
Responses 
200
Success


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.


404
Endpoint Not Found. This response may occur if the on-premises E360 service does not exist or is not currently running.


get/api/v1/purchaseOrders/{purchaseOrderId}/details
Request samples 
Response samples 
application/json
[
  • {
    },
  • {
    }
]
Adds a detail to the purchase order.
For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens


Securitybearer 
Request 
path Parameters
purchaseOrderId
required
string <uuid> 
Purchase Order Id for the detail being created.


 
Request Body schema: 
Details about the purchase order to add.


partId
string or null <uuid> 
The part id (not required if there's a charge item).


 
vendorPartNumber
string or null
Vendor part number.


 
purchaseUnitOfMeasureId
string or null <uuid> 
The purchase unit of measure id (not required if there's a charge item).


 
partLocationId
string or null <uuid> 
The inventory location id (to pre-populate inventory location on the invoice).


 
quantity
required
integer <int32> 
The quantity of the item.


 
unitPrice
required
number <double> 
The unit price of the item.


 
isTaxable
boolean or null
Whether the item is taxable.


 
chargeItem
string or null
A miscellaneous charge item (there will be no partId when this is on the detail).


 
Responses 
200
Success


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.


404
Endpoint Not Found. This response may occur if the on-premises E360 service does not exist or is not currently running.


post/api/v1/purchaseOrders/{purchaseOrderId}/details
Request samples 
{
  • "partId": "7982a4cd-242c-47a1-82ba-47f5d2c8be99",
  • "vendorPartNumber": "QW-32X",
  • "purchaseUnitOfMeasureId": "b1109c99-da34-4f66-9c44-036c2f958bf6",
  • "partLocationId": "f3227c9d-d482-4faa-bd9e-34aeb7baef2e",
  • "quantity": 3,
  • "unitPrice": 9.25,
  • "isTaxable": true,
  • "chargeItem": "CHARGE_ITEM"
}
Response samples 
application/json
{
  • "id": "96a03ce9-c24e-4b47-b90f-84fde8c88233",
  • "purchaseOrderId": "96a03ce9-c24e-4b47-b90f-84fde8c88233",
  • "orderQuantityReceived": 2,
  • "taxAmount": 15.55,
  • "totalCost": 59.1,
  • "type": "details",
  • "approvalStatus": "unreviewed",
  • "partId": "138bc3da-efda-4c33-9416-66bfe44b6f87",
  • "vendorPartNumber": "abc",
  • "purchaseUnitOfMeasureId": "e341a583-2c6a-4523-8b17-4662cec8c2ca",
  • "partLocationId": "96a03ce9-c24e-4b47-b90f-84fde8c88233",
  • "quantity": 2,
  • "unitPrice": 29.55,
  • "isTaxable": true,
  • "chargeItem": "Charge item"
}
Creates a new purchase order note.
For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens


Securitybearer 
Request 
path Parameters
purchaseOrderId
required
string <uuid> 
The purchase order id.


 
Request Body schema: 
note
string or null
The note.


 
Responses 
200
Success


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.


404
Endpoint Not Found. This response may occur if the on-premises E360 service does not exist or is not currently running.


post/api/v1/purchaseOrders/{purchaseOrderId}/notes
Request samples 
{
  • "note": "All service recalls completed."
}
Response samples 
application/json
{
  • "id": "47827b28-008a-46f2-88e1-bf286df33842",
  • "createdBy": "John Collins",
  • "createdDate": "2020-04-20T00:00:00Z",
  • "modifiedBy": "Sam Johnson",
  • "modifiedDate": "2020-05-20T00:00:00Z",
  • "note": "All service recalls completed."
}